zeus::RemoteProcessCall Class Reference

#include <RemoteProcessCall.hpp>

Inheritance diagram for zeus::RemoteProcessCall:

Public Member Functions
	RemoteProcessCall ()
void	setDescription (const std::string &_desc)
std::string	getDescription ()
void	setVersion (const std::string &_vers)
std::string	getVersion ()
void	addAuthor (const std::string &_name, const std::string &_email)
const std::vector< std::pair< std::string, std::string > > &	getAuthors () const
std::vector< std::string >	getAuthors2 ()
std::string	getType ()
void	setType (const std::string &_type, uint16_t _version)
std::vector< std::string >	getFunctions ()
AbstractFunction *	getFunction (std::string _funcName)
template<class ZEUS_RETURN_VALUE , class... ZEUS_FUNC_ARGS_TYPE>
zeus::AbstractFunction *	advertise (const std::string &_name, ZEUS_RETURN_VALUE(*_func)(ZEUS_FUNC_ARGS_TYPE... _args))
template<class ZEUS_RETURN_VALUE , class ZEUS_CLASS_TYPE , class... ZEUS_FUNC_ARGS_TYPE>
zeus::AbstractFunction *	advertise (std::string _name, ZEUS_RETURN_VALUE(ZEUS_CLASS_TYPE::*_func)(ZEUS_FUNC_ARGS_TYPE... _args))

Protected Member Functions
virtual bool	isFunctionAuthorized (uint64_t _clientSessionID, const std::string &_funcName)

Protected Attributes
std::vector< zeus::AbstractFunction * >	m_listFunction
std::string	m_description
std::string	m_version
std::vector< std::pair< std::string, std::string > >	m_authors
std::string	m_type

Detailed Description

Local declaration of call local data.

Constructor & Destructor Documentation

RemoteProcessCall()

zeus::RemoteProcessCall::RemoteProcessCall

(

)

Basic constructor.

Member Function Documentation

addAuthor()

void zeus::RemoteProcessCall::addAuthor	(	const std::string &	_name,
		const std::string &	_email
	)

List of autors of the module (name, email)

Add an author on this service

Parameters

[in]	_name	Nazme of the Author: (Surname NAME)
[in]	_email	email of the author to add

advertise() [1/2]

template<class ZEUS_RETURN_VALUE , class... ZEUS_FUNC_ARGS_TYPE>

zeus::AbstractFunction* zeus::RemoteProcessCall::advertise ( const std::string &  _name, ZEUS_RETURN_VALUE(*)(ZEUS_FUNC_ARGS_TYPE... _args)  _func  )

inline

Parameters

[in]

advertise() [2/2]

template<class ZEUS_RETURN_VALUE , class ZEUS_CLASS_TYPE , class... ZEUS_FUNC_ARGS_TYPE>

zeus::AbstractFunction* zeus::RemoteProcessCall::advertise ( std::string  _name, ZEUS_RETURN_VALUE(ZEUS_CLASS_TYPE::*)(ZEUS_FUNC_ARGS_TYPE... _args)  _func  )

inline

Parameters

[in]

getAuthors()

const std::vector<std::pair<std::string,std::string> >& zeus::RemoteProcessCall::getAuthors

(

)

const

Get the list of the Authors.

Returns

Lisl of authors in a pair of name and email

getAuthors2()

std::vector<std::string> zeus::RemoteProcessCall::getAuthors2

(

)

Get simple list of authors.

Returns

List Of user and email in form: "john WHO <jhon.who@here.net>"

getDescription()

std::string zeus::RemoteProcessCall::getDescription

(

)

Get service description.

Returns

String with the describe of the service

getFunction()

AbstractFunction* zeus::RemoteProcessCall::getFunction

(

std::string

_funcName

)

Parameters

[in]

getFunctions()

std::vector<std::string> zeus::RemoteProcessCall::getFunctions

(

)

Parameters

[in]

getType()

std::string zeus::RemoteProcessCall::getType

(

)

Parameters

[in]

getVersion()

std::string zeus::RemoteProcessCall::getVersion

(

)

Get the Version of the service.

Returns

String containing the version (form: 1.0[.x[.y]][-dev]

isFunctionAuthorized()

virtual bool zeus::RemoteProcessCall::isFunctionAuthorized ( uint64_t  _clientSessionID, const std::string &  _funcName  )

protectedvirtual

Parameters

[in]

Reimplemented in zeus::ServiceType< ZEUS_TYPE_SERVICE, ZEUS_USER_ACCESS >.

setDescription()

void zeus::RemoteProcessCall::setDescription

(

const std::string &

_desc

)

Set service description.

Parameters

[in]

_desc

String with the describe of the service

setType()

void zeus::RemoteProcessCall::setType	(	const std::string &	_type,
		uint16_t	_version
	)

Parameters

[in]

setVersion()

void zeus::RemoteProcessCall::setVersion

(

const std::string &

_vers

)

Set the Version of the service.

Parameters

[in]

_vers

String containing the version (form: 1.0[.x[.y]][-dev]

Member Data Documentation

m_description

std::string zeus::RemoteProcessCall::m_description

protected

Description of the service.

m_listFunction

std::vector<zeus::AbstractFunction*> zeus::RemoteProcessCall::m_listFunction

protected

List of all functions callable.

m_type

std::string zeus::RemoteProcessCall::m_type

protected

Generic type of the service.

m_version

std::string zeus::RemoteProcessCall::m_version

protected

Version of the service.

---

The documentation for this class was generated from the following file:

• framework/atria-soft/zeus/zeus/RemoteProcessCall.hpp