Ignite thin client configuration.
More...
#include <ignite_client_configuration.h>
Ignite thin client configuration.
Used to configure IgniteClient.
◆ IgniteClientConfiguration()
ignite::thin::IgniteClientConfiguration::IgniteClientConfiguration |
( |
| ) |
|
|
inline |
Default constructor.
Constructs configuration with all parameters set to default values.
◆ GetConnectionsLimit()
uint32_t ignite::thin::IgniteClientConfiguration::GetConnectionsLimit |
( |
| ) |
const |
|
inline |
Get connection limit.
By default, C++ thin client establishes a connection to every server node listed in endPoints
. Use this setting to limit the number of active connections. This reduces initial connection time and the resource usage, but can have a negative effect on cache operation performance, especially if partition awareness is used.
Zero value means that number of active connections is not limited.
The default value is zero.
- Returns
- Active connection limit.
◆ GetEndPoints()
const std::string& ignite::thin::IgniteClientConfiguration::GetEndPoints |
( |
| ) |
const |
|
inline |
Get server end points.
- See also
- SetEndPoints for format.
- Returns
- Server end points.
◆ GetPassword()
const std::string& ignite::thin::IgniteClientConfiguration::GetPassword |
( |
| ) |
const |
|
inline |
Get password used for the authentication.
- Returns
- Password.
◆ GetSslCaFile()
const std::string& ignite::thin::IgniteClientConfiguration::GetSslCaFile |
( |
| ) |
const |
|
inline |
Get file path to SSL certificate authority to authenticate server certificate during connection establishment.
- Returns
- File path to SSL certificate authority.
◆ GetSslCertFile()
const std::string& ignite::thin::IgniteClientConfiguration::GetSslCertFile |
( |
| ) |
const |
|
inline |
Get file path to SSL certificate to use during connection establishment.
- Returns
- File path to SSL certificate.
◆ GetSslKeyFile()
const std::string& ignite::thin::IgniteClientConfiguration::GetSslKeyFile |
( |
| ) |
const |
|
inline |
Get file path to SSL private key to use during connection establishment.
- Returns
- File path to SSL private key.
◆ GetSslMode()
SslMode::Type ignite::thin::IgniteClientConfiguration::GetSslMode |
( |
| ) |
const |
|
inline |
Get SSL mode.
- See also
- SslMode for details.
- Returns
- SSL mode.
◆ GetUser()
const std::string& ignite::thin::IgniteClientConfiguration::GetUser |
( |
| ) |
const |
|
inline |
Get user name used for the authentication.
- Returns
- User name.
◆ IsPartitionAwareness()
bool ignite::thin::IgniteClientConfiguration::IsPartitionAwareness |
( |
| ) |
const |
|
inline |
Get Partition Awareness flag.
- See also
- SetPartitionAwareness() for details.
- Returns
true
if partition awareness is enabled and false
otherwise.
◆ SetConnectionsLimit()
void ignite::thin::IgniteClientConfiguration::SetConnectionsLimit |
( |
uint32_t |
limit | ) |
|
|
inline |
Set connection limit.
- See also
- GetConnectionsLimit for details.
- Parameters
-
connectionsLimit | Connections limit to set. |
◆ SetEndPoints()
void ignite::thin::IgniteClientConfiguration::SetEndPoints |
( |
const std::string & |
endPoints | ) |
|
|
inline |
Set addresses of the remote servers to connect.
The format of the addresses is: <host>[:<port>[..<port_range>]]. If port is not specified, default port is used (10800). You can enlist several hosts separated by comma.
For example: "localhost,example.com:12345,127.0.0.1:10800..10900,192.168.3.80:5893".
- Parameters
-
endPoints | Addressess of the remote servers to connect. |
◆ SetPartitionAwareness()
void ignite::thin::IgniteClientConfiguration::SetPartitionAwareness |
( |
bool |
enable | ) |
|
|
inline |
Set Partition Awareness.
Enable or disable feature that enables thin client to consider data affinity when making requests to the cluster. It means, thin client is going to connect to all available cluster servers listed by SetEndPoints() method and try to send request to a node which stores related data.
Disabled by default.
- Parameters
-
enable | Enable partition awareness. |
◆ SetPassword()
void ignite::thin::IgniteClientConfiguration::SetPassword |
( |
const std::string & |
password | ) |
|
|
inline |
Set password to use for the authentication.
- Parameters
-
◆ SetSslCaFile()
void ignite::thin::IgniteClientConfiguration::SetSslCaFile |
( |
const std::string & |
sslCaFile | ) |
|
|
inline |
Set file path to SSL certificate authority to authenticate server certificate during connection establishment.
- Parameters
-
sslCaFile | File path to SSL certificate authority. |
◆ SetSslCertFile()
void ignite::thin::IgniteClientConfiguration::SetSslCertFile |
( |
const std::string & |
sslCertFile | ) |
|
|
inline |
Set file path to SSL certificate to use during connection establishment.
- Parameters
-
sslCertFile | File path to SSL certificate. |
◆ SetSslKeyFile()
void ignite::thin::IgniteClientConfiguration::SetSslKeyFile |
( |
const std::string & |
sslKeyFile | ) |
|
|
inline |
Set file path to SSL private key to use during connection establishment.
- Parameters
-
sslKeyFile | File path to SSL private key. |
◆ SetSslMode()
void ignite::thin::IgniteClientConfiguration::SetSslMode |
( |
SslMode::Type |
sslMode | ) |
|
|
inline |
Set SSL mode.
- See also
- SslMode for details.
- Parameters
-
◆ SetUser()
void ignite::thin::IgniteClientConfiguration::SetUser |
( |
const std::string & |
user | ) |
|
|
inline |
Set user name to use for the authentication.
- Parameters
-
The documentation for this class was generated from the following file: