Classes | Public Member Functions | Static Public Attributes

GridClientProtocolConfiguration Class Reference

#include <gridclientprotocolconfiguration.hpp>

List of all members.

Classes

class  Impl

Public Member Functions

 GridClientProtocolConfiguration ()
 GridClientProtocolConfiguration (const GridClientProtocolConfiguration &other)
GridClientProtocolConfiguration & operator= (const GridClientProtocolConfiguration &rhs)
virtual ~GridClientProtocolConfiguration ()
GridClientProtocol protocol () const
void protocol (GridClientProtocol p)
int connectTimeout () const
void connectTimeout (int t)
bool sslEnabled () const
void sslEnabled (bool ssl)
std::string certificateFilePath () const
void certificateFilePath (const std::string &cert)
std::string certificateFilePassword () const
void certificateFilePassword (const std::string &pass)
GridClientUuid uuid () const
std::string credentials () const
void credentials (const std::string &cred)
long maxConnectionIdleTime () const
void maxConnectionIdleTime (long maxTime)

Static Public Attributes

static const GridClientProtocol DFLT_CLIENT_PROTOCOL = TCP
static const long DFLT_MAX_CONN_TIMEOUT = 20000L
static const long DFLT_MAX_CONN_IDLE_TIME = 30000L
static const int DFLT_TCP_PORT = 11211
static const int DFLT_HTTP_PORT = 8080

Detailed Description

Protocol configuration.


Constructor & Destructor Documentation

GridClientProtocolConfiguration::GridClientProtocolConfiguration (  ) 

Default public constructor.

GridClientProtocolConfiguration::GridClientProtocolConfiguration ( const GridClientProtocolConfiguration &  other  ) 

Copy constructor.

Parameters:
other Another instance of configuration.
GridClientProtocolConfiguration::~GridClientProtocolConfiguration (  )  [virtual]

Destructor.


Member Function Documentation

std::string GridClientProtocolConfiguration::certificateFilePassword (  )  const

Password for the certificate.

Returns:
Password.
void GridClientProtocolConfiguration::certificateFilePassword ( const std::string &  pass  ) 

Password for the certificate.

Parameters:
pass New password.
std::string GridClientProtocolConfiguration::certificateFilePath (  )  const

Path to file where SSL certificate is stored. If path is not absolute, it's considered relative to GRIDGAIN_HOME.

Returns:
path to file.
void GridClientProtocolConfiguration::certificateFilePath ( const std::string &  cert  ) 

Path to file where SSL certificate is stored. If path is not absolute, it's considered relative to GRIDGAIN_HOME.

Parameters:
cert New value.
int GridClientProtocolConfiguration::connectTimeout (  )  const

Gets timeout for socket connect operation.

Returns:
Socket connect timeout in milliseconds.
void GridClientProtocolConfiguration::connectTimeout ( int  t  ) 

Sets timeout for socket connect operation.

Parameters:
t Socket connect timeout in milliseconds.
std::string GridClientProtocolConfiguration::credentials (  )  const

Gets client credentials to authenticate with.

Returns:
Credentials.
void GridClientProtocolConfiguration::credentials ( const std::string &  cred  ) 

Sets client credentials to authenticate with.

Parameters:
cred New value for the credentials.
void GridClientProtocolConfiguration::maxConnectionIdleTime ( long  maxTime  ) 

Sets maximum amount of time that client connection can be idle before it is closed.

Parameters:
maxTime Maximum idle time in milliseconds.
long GridClientProtocolConfiguration::maxConnectionIdleTime (  )  const

Gets maximum amount of time that client connection can be idle before it is closed.

Returns:
Maximum idle time in milliseconds.
GridClientProtocolConfiguration & GridClientProtocolConfiguration::operator= ( const GridClientProtocolConfiguration &  rhs  ) 

Assignment operator override.

Parameters:
rhs Right-hand side of the assignment operator.
Returns:
This instance of the class.
void GridClientProtocolConfiguration::protocol ( GridClientProtocol  p  ) 

Sets protocol for communication between client and remote grid.

Parameters:
p Protocol for communication between client and remote grid.
GridClientProtocol GridClientProtocolConfiguration::protocol (  )  const

Gets protocol for communication between client and remote grid.

Returns:
Protocol for communication between client and remote grid.
bool GridClientProtocolConfiguration::sslEnabled (  )  const

Flag indicating whether client should try to connect server with secure socket layer enabled (regardless of protocol used).

Returns:
True if SSL should be enabled.

Flag indicating whether client should try to connect server with secure socket layer enabled (regardless of protocol used).

Returns:
 True 
if SSL should be enabled.
void GridClientProtocolConfiguration::sslEnabled ( bool  ssl  ) 

Flag indicating whether client should try to connect server with secure socket layer enabled (regardless of protocol used).

Parameters:
ssl New value for the flag.
GridClientUuid GridClientProtocolConfiguration::uuid (  )  const

Returns UUID used to authenticate


Member Data Documentation

const GridClientProtocol GridClientProtocolConfiguration::DFLT_CLIENT_PROTOCOL = TCP [static]

Default client protocol.

Default port for communication using HTTP.

Default maximum time connection can be idle.

Default maximum time for a connection timeout.

Default port for communication using binary TCP/IP protocol.


The documentation for this class was generated from the following files:
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends