Data Structures | Public Member Functions
com::softwareag::umtransport::ServerSHMTransportContext Class Reference

Constructed using the ServerSHMTransportContext.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 <ServerSHMTransportContext.h>

Inheritance diagram for com::softwareag::umtransport::ServerSHMTransportContext:
com::softwareag::umtransport::ServerTransportContext com::softwareag::umtransport::TransportContext

Data Structures

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

Public Member Functions

int getBufferSize ()
 Get the buffer size in bytes that will be used by ServerTransports created using this ServerTransportContext More...
 
std::string getFilePath ()
 Get the path that will be used by ServerTransports created using this context. The path is used to store the memory mapped files required for shared memory communication. 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...
 
int getTimeout ()
 The time in ms that the SHM Transport will wait for information before timing out a connection More...
 
virtual bool supportsAsync ()
 This ServerTransportContext does not currently support Async which means that an exception will be thrown if you try to create an AsynchronousServerTransport using the TransportFactory.bind variant which takes callback objects. More...
 

Detailed Description

Constructed using the ServerSHMTransportContext.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

int com::softwareag::umtransport::ServerSHMTransportContext::getBufferSize ( )

Get the buffer size in bytes that will be used by ServerTransports created using this ServerTransportContext

Returns
the size that has been set for the buffer. Returns a default value if the value is not set, or could not be converted/translated.
std::string com::softwareag::umtransport::ServerSHMTransportContext::getFilePath ( )

Get the path that will be used by ServerTransports created using this context. The path is used to store the memory mapped files required for shared memory communication.

Returns
String file path set for this ServerContext
int com::softwareag::umtransport::ServerSHMTransportContext::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 a default value if the value is not set, or could not be converted/translated.
longlong com::softwareag::umtransport::ServerSHMTransportContext::getSpinCount ( )

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

Returns
the spin count used by the SHM Transport. Returns a default value if the value is not set, or could not be converted/translated.
int com::softwareag::umtransport::ServerSHMTransportContext::getTimeout ( )

The time in ms that the SHM Transport will wait for information before timing out a connection

Returns
time in ms before an idle connection is closed. Returns a default value if the value is not set, or could not be converted/translated.
virtual bool com::softwareag::umtransport::ServerSHMTransportContext::supportsAsync ( )
virtual

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

Returns
false

Implements com::softwareag::umtransport::TransportContext.