Constructed using the ClientSHMTransportContext.Builder. All information must be set on the Builder so that when this object is built, it is validated. It is used to create Transport objects using TransportFactory.connect. Communication on the transport is transmitted using Shared Memory. More...

#include <ClientSHMTransportContext.h>

Inheritance diagram for com::softwareag::umtransport::ClientSHMTransportContext:

Data Structures
class	Builder
	This Builder object is used to build a ClientSHMTransportContext. The ClientSHMTransportContext is configured using the builder so that once build() is called, the ClientSHMTransportContext is only returned if it is valid. You can use the Builder to create simple readable code like this: More...

Public Member Functions
std::string	getFilePath ()
	Get the file path that is currently set. The path will be used to store the memory mapped files required by the SHM Transport. More...

int	getLockWait ()
	Get the current wait time for yielding a spin lock. Advanced option for SHM transports only. More...

longlong	getSpinCount ()
	Gets the current active spin count. Advanced option for SHM transports only. More...

bool	isLowLatency ()
	Determines whether low latency mode is enabled. More...

virtual bool	supportsAsync ()
	This ClientTransportContext does not currently support Async which means that an exception will be thrown if you try to create an AsynchronousTransport using the TransportFactory.connect variant which takes callback objects. More...

Detailed Description

Constructed using the ClientSHMTransportContext.Builder. All information must be set on the Builder so that when this object is built, it is validated. It is used to create Transport objects using TransportFactory.connect. Communication on the transport is transmitted using Shared Memory.

Member Function Documentation

std::string com::softwareag::umtransport::ClientSHMTransportContext::getFilePath ( )

Get the file path that is currently set. The path will be used to store the memory mapped files required by the SHM Transport.

int com::softwareag::umtransport::ClientSHMTransportContext::getLockWait ( )

Get the current wait time for yielding a spin lock. Advanced option for SHM transports only.

Returns: the wait time (in nanoseconds) used by the SHM Transport. Returns 0 if the value is not set, or could not be converted/translated.

longlong com::softwareag::umtransport::ClientSHMTransportContext::getSpinCount ( )

Gets the current active spin count. Advanced option for SHM transports only.

Returns: the spin count used by the SHM Transport. Returns 0 if the value is not set, or could not be converted/translated.

bool com::softwareag::umtransport::ClientSHMTransportContext::isLowLatency ( )

Determines whether low latency mode is enabled.

virtual bool com::softwareag::umtransport::ClientSHMTransportContext::supportsAsync ( )

virtual

This ClientTransportContext does not currently support Async which means that an exception will be thrown if you try to create an AsynchronousTransport using the TransportFactory.connect variant which takes callback objects.