Eris::Connection Class Reference

Connection tracks the life-time of a client-server session; note this may extend beyond a single TCP connection, if re-connections occur. More...

#include <Connection.h>

Inheritance diagram for Eris::Connection:

Eris::BaseConnection List of all members.

Public Member Functions

 Connection (const std::string &cnm, const std::string &host, short port, bool debug)
 Create a new connection, with the client-name string specified.
int connect ()
 If the underlying socket cannot be opened, connect will return an error number immediately.
int disconnect ()
 Initiate disconnection from the server.
TypeServicegetTypeService () const
ResponseTracker * getResponder () const
virtual void send (const Atlas::Objects::Root &obj)
 If the connection is not fully connected, an exception will be thrown.
void setDefaultRouter (Router *router)
void clearDefaultRouter ()
void registerRouterForTo (Router *router, const std::string toId)
void unregisterRouterForTo (Router *router, const std::string toId)
void registerRouterForFrom (Router *router, const std::string fromId)
void unregisterRouterForFrom (Router *router, const std::string fromId)
void lock ()
 Lock then connection's state.
void unlock ()
 Unlock the connection (permit status change).
void refreshServerInfo ()
 Update the information stored about the current server.
void getServerInfo (ServerInfo &) const
 Retrive the current server information.

Public Attributes

sigc::signal< void > GotServerInfo
sigc::signal< bool > Disconnecting
 Emitted when the disconnection process is initiated.
sigc::signal< void, const
std::string & > 
Failure
 Emitted when a non-fatal error occurs.
sigc::signal< void, StatusStatusChanged
 emitted when the connection status changes; This will often correspond to the emission of a more specific signal (such as Connected), which should be used where available.

Protected Member Functions

virtual void setStatus (Status sc)
 update the connection status (and emit the appropriate signal)
virtual void handleFailure (const std::string &msg)
 Process failures (to track when reconnection should be permitted).
virtual void handleTimeout (const std::string &msg)
virtual void onConnect ()
 derived-class notification when connection and negotiation is completed
void objectArrived (const Atlas::Objects::Root &obj)

Protected Attributes

const std::string _host
 the host name we're connected to
const short _port
 port of the server
bool _debug

Friends

class Redispatch
class TestInjector

Detailed Description

Connection tracks the life-time of a client-server session; note this may extend beyond a single TCP connection, if re-connections occur.


Constructor & Destructor Documentation

Eris::Connection::Connection ( const std::string &  cnm,
const std::string &  host,
short  port,
bool  debug 
)

Create a new connection, with the client-name string specified.

The client-name is sent during Atlas negotiation of the connection.

Parameters:
debug Perform extra (slower) validation on the connection


Member Function Documentation

int Eris::Connection::connect (  ) 

If the underlying socket cannot be opened, connect will return an error number immediately.

Providing the basic connection is established, other failures will be reported via the Failure signal.

void Eris::Connection::send ( const Atlas::Objects::Root &  obj  )  [virtual]

If the connection is not fully connected, an exception will be thrown.

To correctly handle disconnection, callers should therefore validate the connection using IsConnected first

void Eris::Connection::lock (  ) 

Lock then connection's state.

This prevents the connection changing status until a corresponding unlock() call is issued. The only use at present is to hold the connection in the 'DISCONNECTING' state while other objects clean up and so on. In the future locking may also be applicable to other states.

void Eris::Connection::unlock (  ) 

Unlock the connection (permit status change).

See Connection::lock for more information about status locking.

void Eris::Connection::refreshServerInfo (  ) 

Update the information stored about the current server.

While the refresh is taking place, the current info is still available, but with it's status set to QUERYING. The signal GotServerInfo will be emitted once the new data is recieved.

void Eris::Connection::getServerInfo ( ServerInfo  )  const

Retrive the current server information.

Check the status field of the returned object before using this data, since it may be out of date or invalid.

void Eris::Connection::setStatus ( Status  sc  )  [protected, virtual]

update the connection status (and emit the appropriate signal)

Parameters:
sc The new status of the connection

Reimplemented from Eris::BaseConnection.


Member Data Documentation

sigc::signal<bool> Eris::Connection::Disconnecting

Emitted when the disconnection process is initiated.

The argument is a flag indicating if the disconnection was clean or not.

sigc::signal<void, const std::string&> Eris::Connection::Failure

Emitted when a non-fatal error occurs.

Tthese are nearly always network related, such as connections being lost, or host names not found. The connection will be placed into the DISCONNECTED state after the signal is emitted; thus the current state (when the failure occured) is still valid during the callback

sigc::signal<void, Status> Eris::Connection::StatusChanged

emitted when the connection status changes; This will often correspond to the emission of a more specific signal (such as Connected), which should be used where available.


The documentation for this class was generated from the following files:
Generated on Sun Dec 16 13:06:23 2007 for Eris by  doxygen 1.5.2