zeus::Client Class Reference

#include <Client.hpp>

Inheritance diagram for zeus::Client:

Public Member Functions
	Client ()
virtual	~Client ()
bool	connect (const std::string &_address)
bool	connect (const std::string &_address, const std::string &_userPassword)
bool	connect (const std::string &_address, const std::string &_clientName, const std::string &_clientTocken)
void	disconnect ()
zeus::ServiceRemote	getService (const std::string &_serviceName)
template<class... _ARGS>
zeus::FutureBase	call (const std::string &_functionName, _ARGS &&... _args)
template<class... _ARGS>
zeus::FutureBase	callAction (const std::string &_functionName, _ARGS &&... _args, zeus::FutureData::ObserverFinish _callback)

Public Attributes
eproperty::Value< std::string >	propertyIp
eproperty::Value< uint16_t >	propertyPort
Public Attributes inherited from eproperty::Interface
eproperty::InterfaceData	properties

Protected Member Functions
bool	connectTo (const std::string &_address)

Friends
class	ServiceRemote

Detailed Description

Client interface to acces on the remote service and gateway.

Constructor & Destructor Documentation

Client()

zeus::Client::Client

(

)

Create a client on a specific user in a client mode with the tocken associated.

Parameters

[in]	_address	Address of the user: "ABCD.efgh#atria-soft.com:1993"
[in]

~Client()

virtual zeus::Client::~Client ( )

virtual

Parameters

[in]

Member Function Documentation

call()

template<class... _ARGS>

zeus::FutureBase zeus::Client::call ( const std::string &  _functionName, _ARGS &&...  _args  )

inline

Create a call on the interface gateway.

Parameters

[in]	_functionName	name of the function to call
[in]	_args...	multiple argument neededs

Returns

a future that will contain the aswer when receiveed (need to transmit over ethernet)

callAction()

template<class... _ARGS>

zeus::FutureBase zeus::Client::callAction ( const std::string &  _functionName, _ARGS &&...  _args, zeus::FutureData::ObserverFinish  _callback  )

inline

Create a call on the interface gateway.

Parameters

[in]	_functionName	name of the function to call
[in]	_args...	multiple argument neededs
[in]	_callback	Observer to call when the data is compleately arrived

Returns

a future that will contain the aswer when receiveed (need to transmit over ethernet)

connect() [1/3]

bool zeus::Client::connect

(

const std::string &

_address

)

Create a client on a specific user in an ANONIMOUS way.

Parameters

[in]

_address

Address of the user: "ABCD.efgh~atria-soft.com:1993"

connect() [2/3]

bool zeus::Client::connect	(	const std::string &	_address,
		const std::string &	_userPassword
	)

Create a client on a specific user in a user mode (connect to your personnal account)

Parameters

[in]	_address	Address of the user: "ABCD.efgh~atria-soft.com:1993"
[in]	_userPassword	Password of the user

connect() [3/3]

bool zeus::Client::connect	(	const std::string &	_address,
		const std::string &	_clientName,
		const std::string &	_clientTocken
	)

Create a client on a specific user in a client mode with the tocken associated.

Parameters

[in]	_address	Address of the user: "ABCD.efgh~atria-soft.com:1993"
[in]

connectTo()

bool zeus::Client::connectTo ( const std::string &  _address )

protected

Connetc to a remote extern server.

Parameters

[in]

_address

Address of the user: "ABCD.efgh~atria-soft.com:1993"

disconnect()

void zeus::Client::disconnect

(

)

Disconnect of the current interface.

getService()

zeus::ServiceRemote zeus::Client::getService

(

const std::string &

_serviceName

)

Get a remote service.

Parameters

[in]

_serviceName

Name of the service

Returns

Pointer on an interface of remote service

Member Data Documentation

propertyIp

eproperty::Value<std::string> zeus::Client::propertyIp

Ip of WebSocket TCP connection.

propertyPort

eproperty::Value<uint16_t> zeus::Client::propertyPort

Port of the WebSocket connection.

---

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

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