DynamicInvocationClientChannelSharedMemoryBase< MutexType, EventType, SharedMemoryType > Class Template Reference

Base for dynamic invocation client channel shared memory. More...

Detailed Description

template<class MutexType, class EventType, class SharedMemoryType>
class ConceptRT::DynamicInvocationClientChannelSharedMemoryBase< MutexType, EventType, SharedMemoryType >

Base for dynamic invocation client channel shared memory.

Inheritance diagram for DynamicInvocationClientChannelSharedMemoryBase< MutexType, EventType, SharedMemoryType >:

Public Member Methods
	DynamicInvocationClientChannelSharedMemoryBase (PCChar8 name)
	Constructor. More...
DynamicInvocationRequest &	GetInvocationRequest ()
	Gets the invocation request. More...
bool	Lock (TimeSpan timeOut=TimeInfinite)
	Locks. More...
bool	PerformInvocation (TimeSpan timeOut=TimeInfinite)
	Perform invocation. More...
const DynamicInvocationResult &	GetInvocationResult ()
	Gets the invocation result. More...
void	Unlock ()
	Unlocks this object. More...

Constructor & Destructor Documentation

DynamicInvocationClientChannelSharedMemoryBase

(

PCChar8

name

)

Constructor.

Parameters

name	The name of the shared memory.

Methods Documentation

DynamicInvocationRequest & GetInvocationRequest ( )

virtual

Gets the invocation request.

Returns

The invocation request.

Implements DynamicInvocationClientChannel.

const DynamicInvocationResult & GetInvocationResult ( )

virtual

Gets the invocation result.

Returns

The invocation result.

Implements DynamicInvocationClientChannel.

bool Lock ( TimeSpan  timeOut = TimeInfinite )

virtual

Locks.

Parameters

timeOut

(optional) the time out.

Returns

true if it succeeds, false if it timeout occurs.

Implements DynamicInvocationClientChannel.

bool PerformInvocation ( TimeSpan  timeOut = TimeInfinite )

virtual

Perform invocation.

Parameters

timeOut

(optional) the time out.

Returns

true if it succeeds, false if it timeout occurs.

RT Exceptions:

RT_ERROR_INTERNAL_DYNAMIC_INVOCATION_CLIENT_SHAREDMEMORY_BAD_ID

Implements DynamicInvocationClientChannel.

void Unlock ( )

virtual

Unlocks this object.

Implements DynamicInvocationClientChannel.