kanzi::connect::RPCCallStore Class Reference

#include <rpcresult.hpp>

Public Member Functions
RPCTypes::CommHandle	allocateHandle ()
	Allocates a unique handle to be used in communication. More...
bool	completeBool (RPCTypes::CommHandle handle, int32_t rpcstatus, bool value)
	Complete bool type of item. More...
bool	completeFloat (RPCTypes::CommHandle handle, int32_t rpcstatus, float value)
	Complete float type of item. More...
bool	completeInt (RPCTypes::CommHandle handle, int32_t rpcstatus, int32_t value)
	Complete int type of item. More...
bool	completeString (RPCTypes::CommHandle handle, int32_t rpcstatus, string value)
	Complete string type of item. More...
void	completeTimedOut ()
	Completes all timed out RPC calls. More...
bool	completeVoid (RPCTypes::CommHandle handle, int32_t rpcstatus)
	Complete void type of item. More...
bool	contains (RPCTypes::CommHandle handle)
	Checks whether response with provided handle is known. More...
void	handleLinkBroken ()
	Called when underlying link that carries RPC methods. More...
void	put (RPCResult< void > item)
	Insert item to store. More...
void	put (RPCResult< int32_t > item)
	Insert item to store. More...
void	put (RPCResult< string > item)
	Insert item to store. More...
void	put (RPCResult< bool > item)
	Insert item to store. More...
void	put (RPCResult< float > item)
	Insert item to store. More...
	RPCCallStore ()
	Constructor. More...

Constructor & Destructor Documentation

RPCCallStore()

kanzi::connect::RPCCallStore::RPCCallStore

(

)

Constructor.

Member Function Documentation

allocateHandle()

RPCTypes::CommHandle kanzi::connect::RPCCallStore::allocateHandle

(

)

Allocates a unique handle to be used in communication.

Returns

the unique handle. Quaranteed not to return 0 in any scenario.

completeBool()

bool kanzi::connect::RPCCallStore::completeBool	(	RPCTypes::CommHandle	handle,
		int32_t	rpcstatus,
		bool	value
	)

Complete bool type of item.

Parameters

handle	identifies the item to complete
rpcstatus	low layer status for completion
value	value to set.

Returns

true if rpc operation was pending and got completed.

completeFloat()

bool kanzi::connect::RPCCallStore::completeFloat	(	RPCTypes::CommHandle	handle,
		int32_t	rpcstatus,
		float	value
	)

Complete float type of item.

Parameters

handle	identifies the item to complete
rpcstatus	low layer status for completion
value	value to set.

Returns

true if rpc operation was pending and got completed.

completeInt()

bool kanzi::connect::RPCCallStore::completeInt	(	RPCTypes::CommHandle	handle,
		int32_t	rpcstatus,
		int32_t	value
	)

Complete int type of item.

Parameters

handle	identifies the item to complete
rpcstatus	low layer status for completion
value	value to set.

Returns

true if rpc operation was pending and got completed.

completeString()

bool kanzi::connect::RPCCallStore::completeString	(	RPCTypes::CommHandle	handle,
		int32_t	rpcstatus,
		string	value
	)

Complete string type of item.

Parameters

handle	identifies the item to complete
rpcstatus	low layer status for completion
value	value to set.

Returns

true if rpc operation was pending and got completed.

completeTimedOut()

void kanzi::connect::RPCCallStore::completeTimedOut

(

)

Completes all timed out RPC calls.

completeVoid()

bool kanzi::connect::RPCCallStore::completeVoid	(	RPCTypes::CommHandle	handle,
		int32_t	rpcstatus
	)

Complete void type of item.

Parameters

handle	identifies the item to complete
rpcstatus	low layer status for completion

Returns

true if rpc operation was pending and got completed.

contains()

bool kanzi::connect::RPCCallStore::contains

(

RPCTypes::CommHandle

handle

)

Checks whether response with provided handle is known.

Parameters

handle

the identifier of the operation

Returns

true

handleLinkBroken()

void kanzi::connect::RPCCallStore::handleLinkBroken

(

)

Called when underlying link that carries RPC methods.

put() [1/5]

void kanzi::connect::RPCCallStore::put

(

RPCResult< void >

item

)

Insert item to store.

Parameters

item

to insert

put() [2/5]

void kanzi::connect::RPCCallStore::put

(

RPCResult< int32_t >

item

)

Insert item to store.

Parameters

item

to insert

put() [3/5]

void kanzi::connect::RPCCallStore::put

(

RPCResult< string >

item

)

Insert item to store.

Parameters

item

to insert

put() [4/5]

void kanzi::connect::RPCCallStore::put

(

RPCResult< bool >

item

)

Insert item to store.

Parameters

item

to insert

put() [5/5]

void kanzi::connect::RPCCallStore::put

(

RPCResult< float >

item

)

Insert item to store.

Parameters

item

to insert

---

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

• connect/rpcresult.hpp