Apache Ignite C++
Public Member Functions | List of all members
ignite::thin::IgniteClientConfiguration Class Reference

Ignite thin client configuration. More...

#include <ignite_client_configuration.h>

Public Member Functions

 IgniteClientConfiguration ()
 Default constructor. More...
 
const std::string & GetEndPoints () const
 Get server end points. More...
 
void SetEndPoints (const std::string &endPoints)
 Set addressess of the remote servers to connect. More...
 
const std::string & GetUser () const
 Get user name used for the authentication. More...
 
void SetUser (const std::string &user)
 Set user name to use for the authentication. More...
 
const std::string & GetPassword () const
 Get password used for the authentication. More...
 
void SetPassword (const std::string &password)
 Set password to use for the authentication. More...
 
SslMode::Type GetSslMode () const
 Get SSL mode. More...
 
void SetSslMode (SslMode::Type sslMode)
 Set SSL mode. More...
 
const std::string & GetSslCertFile () const
 Get file path to SSL certificate to use during connection establishment. More...
 
void SetSslCertFile (const std::string &sslCertFile)
 Set file path to SSL certificate to use during connection establishment. More...
 
const std::string & GetSslKeyFile () const
 Get file path to SSL private key to use during connection establishment. More...
 
void SetSslKeyFile (const std::string &sslKeyFile)
 Set file path to SSL private key to use during connection establishment. More...
 
const std::string & GetSslCaFile () const
 Get file path to SSL certificate authority to authenticate server certificate during connection establishment. More...
 
void SetSslCaFile (const std::string &sslCaFile)
 Set file path to SSL certificate authority to authenticate server certificate during connection establishment. More...
 

Detailed Description

Ignite thin client configuration.

Used to configure IgniteClient.

Constructor & Destructor Documentation

ignite::thin::IgniteClientConfiguration::IgniteClientConfiguration ( )
inline

Default constructor.

Constructs configuration with all parameters set to default values.

Member Function Documentation

const std::string& ignite::thin::IgniteClientConfiguration::GetEndPoints ( ) const
inline

Get server end points.

See also
SetEndPoints for format.
Returns
Server end points.
const std::string& ignite::thin::IgniteClientConfiguration::GetPassword ( ) const
inline

Get password used for the authentication.

Returns
Password.
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.
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.
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.
SslMode::Type ignite::thin::IgniteClientConfiguration::GetSslMode ( ) const
inline

Get SSL mode.

See also
SslMode for details.
Returns
SSL mode.
const std::string& ignite::thin::IgniteClientConfiguration::GetUser ( ) const
inline

Get user name used for the authentication.

Returns
User name.
void ignite::thin::IgniteClientConfiguration::SetEndPoints ( const std::string &  endPoints)
inline

Set addressess of the remote servers to connect.

The format of the addresse 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
endPointsAddressess of the remote servers to connect.
void ignite::thin::IgniteClientConfiguration::SetPassword ( const std::string &  password)
inline

Set password to use for the authentication.

Parameters
passwordPassword.
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
sslCaFileFile path to SSL certificate authority.
void ignite::thin::IgniteClientConfiguration::SetSslCertFile ( const std::string &  sslCertFile)
inline

Set file path to SSL certificate to use during connection establishment.

Parameters
sslCertFileFile path to SSL certificate.
void ignite::thin::IgniteClientConfiguration::SetSslKeyFile ( const std::string &  sslKeyFile)
inline

Set file path to SSL private key to use during connection establishment.

Parameters
sslKeyFileFile path to SSL private key.
void ignite::thin::IgniteClientConfiguration::SetSslMode ( SslMode::Type  sslMode)
inline

Set SSL mode.

See also
SslMode for details.
Parameters
sslModeSSL mode.
void ignite::thin::IgniteClientConfiguration::SetUser ( const std::string &  user)
inline

Set user name to use for the authentication.

Parameters
userUser name.

The documentation for this class was generated from the following file: