Public Member Functions | Protected Attributes

GridClientSharedData Class Reference

#include <gridclientshareddata.hpp>

List of all members.

Public Member Functions

 GridClientSharedData (const GridClientUuid &pClientId, const GridClientConfiguration &cfg, std::shared_ptr< GridClientCommandExecutorPrivate > exec)
virtual ~GridClientSharedData ()
std::string clientUniqueId () const
GridClientUuid & clientUniqueUuid ()
GridClientUuid clientUuid () const
TGridClientTopologyPtr topology () const
std::shared_ptr
< GridClientCommandExecutorPrivate > 
executor () const
const TGridClientLoadBalancerPtr loadBalancer () const
const
GridClientProtocolConfiguration 
protocolCfg () const
GridClientProtocol protocol () const
std::vector
< GridClientSocketAddress > 
servers () const
const GridClientConfiguration & clientConfiguration () const

Protected Attributes

GridClientUuid clientId
TGridClientTopologyPtr top
GridClientConfiguration clientCfg
std::shared_ptr
< GridClientCommandExecutorPrivate > 
executor_

Detailed Description

Common client data.


Constructor & Destructor Documentation

GridClientSharedData::GridClientSharedData ( const GridClientUuid &  pClientId,
const GridClientConfiguration &  cfg,
std::shared_ptr< GridClientCommandExecutorPrivate >  exec 
) [inline]

Public constructor.

Parameters:
pClientId Client id.
cfg Grid client configuration.
exec Command executor.
virtual GridClientSharedData::~GridClientSharedData (  )  [inline, virtual]

Public destructor.


Member Function Documentation

const GridClientConfiguration& GridClientSharedData::clientConfiguration (  )  const [inline]

Returns a constant reference to current client configuration.

std::string GridClientSharedData::clientUniqueId (  )  const [inline]

Returns the unique id of the client.

Returns:
Client UUID in string form.
GridClientUuid& GridClientSharedData::clientUniqueUuid (  )  [inline]

Returns the unique id of the client.

Returns:
Client UUID in GridClientUuid form.
GridClientUuid GridClientSharedData::clientUuid (  )  const [inline]

Method for accessing client UUID.

Returns:
Client UUID.
std::shared_ptr<GridClientCommandExecutorPrivate> GridClientSharedData::executor (  )  const [inline]

Returns the reference to the command executor - class which allows to execute any client commands based on the configured communication layer.

Returns:
Actual executor.
const TGridClientLoadBalancerPtr GridClientSharedData::loadBalancer (  )  const [inline]

Method for retrieving current load balancer.

Returns:
Actual load balancer.
GridClientProtocol GridClientSharedData::protocol (  )  const [inline]

Return protocol currently used.

Returns:
Current protocol.
const GridClientProtocolConfiguration GridClientSharedData::protocolCfg (  )  const [inline]

Method for retrieving current protocol configuration.

Returns:
Actual protocol configuration.
std::vector<GridClientSocketAddress> GridClientSharedData::servers (  )  const [inline]

Get the list of servers, specified by client for initial connection.

Returns:
List of host/port pairs.
TGridClientTopologyPtr GridClientSharedData::topology (  )  const [inline]

Returns the actual version of the topology.

Returns:
Client topology.

Member Data Documentation

Configuration of the client

Unique Id of the client

The main interface for execution of commands via the communication layer.

TGridClientTopologyPtr GridClientSharedData::top [protected]

Actual version of the topology.


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