com.softwareag.um.io.ServerSHMTransportContext Class Reference

Constructed using the ServerSHMTransportContext.Builder. More...

Inheritance diagram for com.softwareag.um.io.ServerSHMTransportContext:
com.softwareag.um.io.ServerTransportContext com.softwareag.um.io.TransportContext

Public Member Functions

int getBufferSize ()
 Get the buffer size in bytes that will be used by ServerTransports created using this ServerTransportContext. More...
 
String getFilePath ()
 Get the path that will be used by ServerTransports created using this context. More...
 
int getTimeout ()
 The time in ms that the SHM Transport will wait for information before timing out a connection. More...
 
boolean 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.um.io.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
String com.softwareag.um.io.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.um.io.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.
boolean com.softwareag.um.io.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.um.io.TransportContext.