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...
#include <ClientSHMTransportContext.h>
|
std::unique_ptr
< ClientTransportContext > | build () |
| Builds the ClientSHMTransportContext based on the configuration that has been set on the Builder. More...
|
|
| Builder () |
| Construct a new instance of this Builder object. 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...
|
|
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...
|
|
Builder & | 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...
|
|
Builder & | withLockWait (const int count) |
| Sets the waiting time (in nanoseconds) for yielding a spin lock. Advanced configuration option, use judiciously. More...
|
|
Builder & | withLowLatency (bool flag) |
| Used to disable/enable low latency mode (on by default). If low latency mode is true then the application will be very CPU intensive and ideally consume an core of the machine. This allows the Transport to respond as fast as possible when new data arrives. If this mode is set to false then the Transport will be less CPU intensive but latency will be increased slightly as a consequence. More...
|
|
Builder & | withSpinCount (const longlong count) |
| Sets the spin count for reading data from an SHM input stream. Advanced configuration option, use judiciously. More...
|
|
|
std::string | getCiphers () |
| Get the value that is currently set for the OpenSSL formatted cipher string list 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 | getHost () |
| Returns the current value that has been set for the host name 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...
|
|
longlong | getSpinCount () |
| Gets the current active spin count. Advanced option for SHM transports only. More...
|
|
std::string | getTrustStore () |
| Get the value that is currently set for the path to the trust store on the local machine More...
|
|
bool | isLowLatency () |
| Determines whether low latency mode is enabled. More...
|
|
ClientContextBuilder * | withCiphers (const std::string &ciphers) |
| Set the cipher list to use for SSL, the format of the string is OpenSSL formatted cipher string More...
|
|
ClientContextBuilder * | 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...
|
|
ClientContextBuilder * | withHost (const std::string &host) |
| Sets the host of the server that you want to connect to e.g. um.terracotta.org More...
|
|
ClientContextBuilder * | withLockWait (const int count) |
| Sets the waiting time (in nanoseconds) for yielding a spin lock. Advanced configuration option, use judiciously. More...
|
|
ClientContextBuilder * | withLowLatency (bool flag) |
| Used to disable/enable low latency mode (on by default). If low latency mode is true then the application will be very CPU intensive and ideally consume an core of the machine. This allows the Transport to respond as fast as possible when new data arrives. If this mode is set to false then the Transport will be less CPU intensive but latency will be increased slightly as a consequence. More...
|
|
ClientContextBuilder * | withPort (int port) |
| Sets the port of the server that you want to connect to e.g. 9000 More...
|
|
ClientContextBuilder * | withSpinCount (const longlong count) |
| Sets the spin count for reading data from an SHM input stream. Advanced configuration option, use judiciously. More...
|
|
ClientContextBuilder * | withTrustStore (const std::string &trustStore) |
| Set the path the the trust store that will be used to validate the server provided certificate More...
|
|
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:
context = ClientSHMTransportContext::Builder()
.withFilePath("/path/to/directory")
.build();
com::softwareag::umtransport::ClientSHMTransportContext::Builder::Builder |
( |
| ) |
|
Construct a new instance of this Builder object.
std::unique_ptr<ClientTransportContext> com::softwareag::umtransport::ClientSHMTransportContext::Builder::build |
( |
| ) |
|
std::string com::softwareag::umtransport::ClientSHMTransportContext::Builder::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.
- Returns
- the file path that will be used by the Transport
int com::softwareag::umtransport::ClientSHMTransportContext::Builder::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::Builder::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::Builder::isLowLatency |
( |
| ) |
|
Determines whether low latency mode is enabled.
- Returns
- true if low latency is enabled for this Builder; false otherwise
Builder& com::softwareag::umtransport::ClientSHMTransportContext::Builder::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.
- Parameters
-
path | of the directory used for communication |
- Returns
- this Builder object to allow methods to be chained
Builder& com::softwareag::umtransport::ClientSHMTransportContext::Builder::withLockWait |
( |
const int |
count | ) |
|
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
Builder& com::softwareag::umtransport::ClientSHMTransportContext::Builder::withLowLatency |
( |
bool |
flag | ) |
|
Used to disable/enable low latency mode (on by default). If low latency mode is true then the application will be very CPU intensive and ideally consume an core of the machine. This allows the Transport to respond as fast as possible when new data arrives. If this mode is set to false then the Transport will be less CPU intensive but latency will be increased slightly as a consequence.
- Parameters
-
flag | true if you want to enable low latency mode |
- Returns
- this Builder object so that method calls can be chained.
Builder& com::softwareag::umtransport::ClientSHMTransportContext::Builder::withSpinCount |
( |
const longlong |
count | ) |
|
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