Public Member Functions | Protected Attributes

GridClientSyncTcpConnection Class Reference

#include <gridclienttcpconnection.hpp>

Inheritance diagram for GridClientSyncTcpConnection:
GridClientTcpConnection GridClientConnection GridClientAsyncTcpConnection

List of all members.

Public Member Functions

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

Protected Attributes

boost::mutex pingMux

Detailed Description

Synchronous implementation of TCP connection.


Constructor & Destructor Documentation

GridClientSyncTcpConnection::GridClientSyncTcpConnection (  )  [inline]

Non-SSL TCP connection constructor.

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

SSL TCP connection constructor.

Parameters:
ctx Shared pointer to a Boost SSL context.

Member Function Documentation

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

Authenticate client and store session token for later use.

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

Implements GridClientTcpConnection.

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

Connect to a host/port.

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

Implements GridClientTcpConnection.

void GridClientSyncTcpConnection::send ( const GridClientTcpPacket &  gridTcpPacket,
GridClientTcpPacket &  result 
) [virtual]

Sends a TCP packet over connection and receives a reply.

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

Implements GridClientTcpConnection.

Reimplemented in GridClientAsyncTcpConnection.

void GridClientSyncTcpConnection::sendPing (  )  [virtual]

Sends a ping packet to the peer.

Implements GridClientConnection.

std::string GridClientSyncTcpConnection::sessionToken (  )  [virtual]

Returns session token associated with this connection.

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

Implements GridClientTcpConnection.


Member Data Documentation

boost::mutex GridClientSyncTcpConnection::pingMux [protected]

Ping mutex, that protects from concurrent ping write intersection.


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