This is an abstract builder object that is used to create ServerTransports More...

#include <ServerContextBuilder.h>

Inheritance diagram for com::softwareag::umtransport::ServerContextBuilder:

Protected Member Functions
std::string	getAdapter ()
	Get the value that is currently set for the adapter on this machine that Socket Transport will bind to, or gets the value that is currently set for the adapter on this machine that RDMA Transport will bind to. Connections will only be accepted on this adapter. "0.0.0.0" means all adapters on the machine. More...

int	getBufferSize ()
	Get the buffer size in bytes that will be used by the ServerTransports More...

std::string	getEnabledCiphers ()
	Get the ciphers that should be enabled (if supported) on the ServerTransport More...

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...

std::string	getKeyStore ()
	Get the location of the key store where the server certificate is stored More...

std::string	getKeyStorePassword ()
	Get the password that should be used to access the key store on the local machine More...

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

int	getPort ()
	Returns the current value that has been set for the port More...

int	getReadBufferSize ()
	Get the current value that has been set for the read buffer size More...

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

int	getTimeout ()
	Returns the current value that has been set for the socket timeout, or gets the current value for the time in ms that the SHM Transport should wait for information before timing out a connection More...

std::string	getTrustStore ()
	Get the location set of the trust store on the local machine More...

int	getWriteBufferSize ()
	Get the current value that has been set for the write buffer size More...

bool	isClientCertificateValidationRequired ()
	Used to determine whether or not the client is required to present a certificate. Currently client certificate validation is not supported. More...

ServerContextBuilder *	withAdapter (const std::string &s)
	Set the value for the adapter on this machine that SocketTransport will bind to, or sets the value for the adapter on this machine that the Infiniband RDMA driver will bind to. Connections will only be accepted on this adapter. "0.0.0.0" means all adapters on the machine. More...

ServerContextBuilder *	withBufferSize (int bufferSize)
	Set the buffer size in bytes that will be used by the SHM ServerTransports More...

ServerContextBuilder *	withEnabledCiphers (const std::string &enabledCiphers)
	Set the ciphers that should be enabled (if supported) on the ServerTransport More...

ServerContextBuilder *	withFilePath (const std::string &path)
	Set the path to the directory which will be used to store the memory mapped files used by the SHM Transport. More...

ServerContextBuilder *	withKeyStore (const std::string &keyStore)
	Set the location of the key store where the server certificate is stored More...

ServerContextBuilder *	withKeyStorePassword (const std::string &keyStorePassword)
	Set the password that should be used to access the key store keyStorePassword the key store password More...

ServerContextBuilder *	withLockWait (const int count)
	Sets the waiting time (in nanoseconds) for yielding a spin lock. Advanced configuration option, use judiciously. More...

ServerContextBuilder *	withPort (int port)
	Sets the server port that the ServerTransport should bind to More...

ServerContextBuilder *	withReadBufferSize (int readBufferSize)
	Set the size in bytes of the read buffer that the ServerTransport should use More...

ServerContextBuilder *	withSpinCount (const longlong count)
	Sets the spin count for reading data from an SHM input stream. Advanced configuration option, use judiciously. More...

ServerContextBuilder *	withTimeout (int timeout)
	Sets the server timeout that any ServerSocket's created from this Builder will adhere to, or sets the time in ms that the SHM Transport should wait for information before timing out a connection More...

ServerContextBuilder *	withTrustStore (const std::string &trustStore)
	Set the location of the trust store where certificates will be validated More...

ServerContextBuilder *	withWriteBufferSize (int writeBufferSize)
	Set the size in bytes of the write buffer that the ServerTransport should use More...

Detailed Description

This is an abstract builder object that is used to create ServerTransports

<seealso cref= ServerSocketTransportContext::Builder

<seealso cref= ServerSSLTransportContext::Builder

<seealso cref= ServerRDMATransportContext::Builder

<seealso cref= ServerSHMTransportContext::Builder

Member Function Documentation

std::string com::softwareag::umtransport::ServerContextBuilder::getAdapter ( )

protected

Get the value that is currently set for the adapter on this machine that Socket Transport will bind to, or gets the value that is currently set for the adapter on this machine that RDMA Transport will bind to. Connections will only be accepted on this adapter. "0.0.0.0" means all adapters on the machine.

Returns: String the adapter that the ServerTransport will use

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

protected

Get the buffer size in bytes that will be used by the ServerTransports

Returns: the size that has been set for the buffer

std::string com::softwareag::umtransport::ServerContextBuilder::getEnabledCiphers ( )

protected

Get the ciphers that should be enabled (if supported) on the ServerTransport

Returns: the enabled ciphers

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

protected

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

Returns: the file path that will be used by the Transport

std::string com::softwareag::umtransport::ServerContextBuilder::getKeyStore ( )

protected

Get the location of the key store where the server certificate is stored

Returns: the path to the key store

std::string com::softwareag::umtransport::ServerContextBuilder::getKeyStorePassword ( )

protected

Get the password that should be used to access the key store on the local machine

Returns: the password of the key store

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

protected

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.

int com::softwareag::umtransport::ServerContextBuilder::getPort ( )

protected

Returns the current value that has been set for the port

Returns: the port that this Builder will set for the ServerTransportContext

int com::softwareag::umtransport::ServerContextBuilder::getReadBufferSize ( )

protected

Get the current value that has been set for the read buffer size

Returns: the read buffer size in bytes

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

protected

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.

int com::softwareag::umtransport::ServerContextBuilder::getTimeout ( )

protected

Returns the current value that has been set for the socket timeout, or gets the current value for the time in ms that the SHM Transport should wait for information before timing out a connection

Returns: the timeout that this Builder will set for the ServerTransportContext

std::string com::softwareag::umtransport::ServerContextBuilder::getTrustStore ( )

protected

Get the location set of the trust store on the local machine

Returns: the location of the trust store

int com::softwareag::umtransport::ServerContextBuilder::getWriteBufferSize ( )

protected

Get the current value that has been set for the write buffer size

Returns: the write buffer size in bytes

bool com::softwareag::umtransport::ServerContextBuilder::isClientCertificateValidationRequired ( )

protected

Used to determine whether or not the client is required to present a certificate. Currently client certificate validation is not supported.

Returns: false

ServerContextBuilder* com::softwareag::umtransport::ServerContextBuilder::withAdapter ( const std::string & s )

protected

Set the value for the adapter on this machine that SocketTransport will bind to, or sets the value for the adapter on this machine that the Infiniband RDMA driver will bind to. Connections will only be accepted on this adapter. "0.0.0.0" means all adapters on the machine.

Returns: this Builder object so that method calls can be chained

ServerContextBuilder* com::softwareag::umtransport::ServerContextBuilder::withBufferSize ( int bufferSize )

protected

Set the buffer size in bytes that will be used by the SHM ServerTransports

Returns: this Builder object so that methods can be chained

ServerContextBuilder* com::softwareag::umtransport::ServerContextBuilder::withEnabledCiphers ( const std::string & enabledCiphers )

protected

Set the ciphers that should be enabled (if supported) on the ServerTransport

Parameters

enabledCiphers openSSL formatted string of ciphers to use

Returns: this Builder object so that method calls can be chained

ServerContextBuilder* com::softwareag::umtransport::ServerContextBuilder::withFilePath ( const std::string & path )

protected

Set the path to the directory which will be used to store the memory mapped files used by the SHM Transport.

Parameters

path	of the directory used for communication

Returns: this Builder object to allow methods to be chained

ServerContextBuilder* com::softwareag::umtransport::ServerContextBuilder::withKeyStore ( const std::string & keyStore )

protected

Set the location of the key store where the server certificate is stored

Parameters

keyStore the location of the key store

Returns: this Builder object so that method calls can be chained

ServerContextBuilder* com::softwareag::umtransport::ServerContextBuilder::withKeyStorePassword ( const std::string & keyStorePassword )

protected

Set the password that should be used to access the key store keyStorePassword the key store password

Returns: this Builder object so that method calls can be chained

ServerContextBuilder* com::softwareag::umtransport::ServerContextBuilder::withLockWait ( const int count )

protected

Sets the waiting time (in nanoseconds) for yielding a spin lock. Advanced configuration option, use judiciously.

Parameters

count the time (in nanoseconds) to yield a spin lock

Returns: this Builder object to allow methods to be chained

ServerContextBuilder* com::softwareag::umtransport::ServerContextBuilder::withPort ( int port )

protected

Sets the server port that the ServerTransport should bind to

Parameters

port	the port that will be bound to by the ServerTranport

Returns: this Builder object so that method calls can be chained

ServerContextBuilder* com::softwareag::umtransport::ServerContextBuilder::withReadBufferSize ( int readBufferSize )

protected

Set the size in bytes of the read buffer that the ServerTransport should use

Parameters

readBufferSize size of the buffer in bytes

Returns: this Builder object so that method calls can be chained

ServerContextBuilder* com::softwareag::umtransport::ServerContextBuilder::withSpinCount ( const longlong count )

protected

Sets the spin count for reading data from an SHM input stream. Advanced configuration option, use judiciously.

Parameters

count the number of times to spin waiting for data to arrive

Returns: this Builder object to allow methods to be chained

ServerContextBuilder* com::softwareag::umtransport::ServerContextBuilder::withTimeout ( int timeout )

protected

Sets the server timeout that any ServerSocket's created from this Builder will adhere to, or sets the time in ms that the SHM Transport should wait for information before timing out a connection

Parameters

timeout the timeout that will be bound to by the ServerTransport in milliseconds

Returns: this Builder object so that method calls can be chained

ServerContextBuilder* com::softwareag::umtransport::ServerContextBuilder::withTrustStore ( const std::string & trustStore )

protected

Set the location of the trust store where certificates will be validated

Parameters

trustStore the location of the trust store

Returns: this Builder object so that method calls can be chained

ServerContextBuilder* com::softwareag::umtransport::ServerContextBuilder::withWriteBufferSize ( int writeBufferSize )

protected

Set the size in bytes of the write buffer that the ServerTransport should use

Parameters

writeBufferSize size of the buffer in bytes

Returns: this Builder object so that method calls can be chained

Protected Member Functions

Detailed Description

Member Function Documentation