Public Member Functions | Protected Member Functions

GridClientTcpConnection Class Reference

#include <gridclienttcpconnection.hpp>

Inheritance diagram for GridClientTcpConnection:
GridClientConnection GridClientRawSyncTcpConnection GridClientSyncTcpConnection GridClientAsyncTcpConnection

List of all members.

Public Member Functions

 GridClientTcpConnection ()
 GridClientTcpConnection (boost::shared_ptr< boost::asio::ssl::context > &ctx)
virtual ~GridClientTcpConnection ()
virtual void connect (const std::string &host, int port)=0
virtual void authenticate (const std::string &clientId, const std::string &creds)=0
virtual std::string sessionToken ()=0
virtual void send (const GridClientTcpPacket &gridTcpPacket, GridClientTcpPacket &result)=0

Protected Member Functions

int getPacketSize (const int8_t *header)

Detailed Description

TCP connection class used for sending data and storing session token associated with it in case of secure connection.


Constructor & Destructor Documentation

GridClientTcpConnection::GridClientTcpConnection (  )  [inline]

Non-SSL TCP connection constructor.

GridClientTcpConnection::GridClientTcpConnection ( boost::shared_ptr< boost::asio::ssl::context > &  ctx  )  [inline]

SSL TCP connection constructor.

Parameters:
ctx Shared pointer to a Boost SSL context.
virtual GridClientTcpConnection::~GridClientTcpConnection (  )  [inline, virtual]

Destructor.


Member Function Documentation

virtual void GridClientTcpConnection::authenticate ( const std::string &  clientId,
const std::string &  creds 
) [pure virtual]

Authenticate client and store session token for later use.

Parameters:
clientId Client ID to authenticate.
creds Credentials to use.

Implemented in GridClientSyncTcpConnection, and GridClientRawSyncTcpConnection.

virtual void GridClientTcpConnection::connect ( const std::string &  host,
int  port 
) [pure virtual]

Connect to a host/port.

Parameters:
pHost Host name.
pPort Port to connect to.

Implemented in GridClientSyncTcpConnection, and GridClientRawSyncTcpConnection.

int GridClientTcpConnection::getPacketSize ( const int8_t *  header  )  [protected]

Calculates packet size from packet data.

Parameters:
header Packet header.
Returns:
Packet size.
virtual void GridClientTcpConnection::send ( const GridClientTcpPacket &  gridTcpPacket,
GridClientTcpPacket &  result 
) [pure virtual]

Sends a TCP packet over connection and receives a reply.

Parameters:
gridTcpPacket Binary data to send.
result Binary response.

Implemented in GridClientSyncTcpConnection, GridClientRawSyncTcpConnection, and GridClientAsyncTcpConnection.

virtual std::string GridClientTcpConnection::sessionToken (  )  [pure virtual]

Returns session token associated with this connection.

Returns:
Session token or empty string if this is not a secure session.

Implemented in GridClientSyncTcpConnection, and GridClientRawSyncTcpConnection.


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