Eris  1.3.19
Public Member Functions | Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | Friends
Eris::Connection Class Reference

Underlying Atlas connection, providing a send interface, and receive (dispatch) system. 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 an unconnected instance.
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
ResponseTrackergetResponder () const
virtual void send (const Atlas::Objects::Root &obj)
 Transmit an Atlas::Objects instance to the server.
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 Member Functions inherited from Eris::BaseConnection
virtual ~BaseConnection ()
 destructor, will perform a hard disconnect if necessary
virtual int connect (const std::string &host, short port)
 
open a connection to the specified host/port; invokes the failure handler if

the connection could not be opened.

Status getStatus () const
 get the current status of the connection
bool isConnected () const
 Ascertain whether or not the connection is usable for transport.
int getFileDescriptor ()
 get the underlyinmg file descriptor (socket).
const std::string & getHost () const
 Gets the host of the connection.
short getPort () const
 Gets the port of the connection.

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
 indicates a status change on the connection
- Public Attributes inherited from Eris::BaseConnection
sigc::signal< void > Connected
 sent on successful negotiation of a game server connection
sigc::signal< void > Disconnected
 final disconnect (or hard disocnnect) notifcation

Protected Types

typedef std::deque
< Atlas::Objects::Operation::RootOperation > 
OpDeque
typedef std::map< std::string,
Router * > 
IdRouterMap

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)
void postForDispatch (const Atlas::Objects::Root &obj)
 Inject a local operation into the dispatch queue.
void cleanupRedispatch (Redispatch *r)
void gotData (PollData &)
void dispatchOp (const Atlas::Objects::Operation::RootOperation &op)
void handleServerInfo (const Atlas::Objects::Operation::RootOperation &op)
void onDisconnectTimeout ()
- Protected Member Functions inherited from Eris::BaseConnection
 BaseConnection (const std::string &cnm, const std::string &id, Atlas::Bridge *br)
 create an unconnected instance
void recv ()
 perform a blocking read from the underlying socket
void onConnectTimeout ()
void onNegotiateTimeout ()
void hardDisconnect (bool emit)
 performs and instant disconnection from the server specified whether the change of state should be signalled
void nonblockingConnect ()
 complete the connection state and start negotiation
void pollNegotiation ()
 track negotation of the Atlas codecs / stream

Protected Attributes

const std::string _host
 the host name we're connected to
const short _port
 port of the server
bool _debug
OpDeque m_opDeque
 store of all the recived ops waiting to be dispatched
std::auto_ptr< TypeServicem_typeService
Routerm_defaultRouter
IdRouterMap m_toRouters
IdRouterMap m_fromRouters
int m_lock
Atlas::Objects::ObjectsEncoder * m_debugRecvEncoder
std::vector< Redispatch * > m_finishedRedispatches
ServerInfo m_info
std::auto_ptr< ResponseTrackerm_responder
- Protected Attributes inherited from Eris::BaseConnection
Atlas::Objects::ObjectsEncoder * _encode
 the objects encoder, bound to _codec
Atlas::Net::StreamConnect * _sc
 negotiation object (NULL after connection!)
Atlas::Codec * m_codec
Status _status
 current status of the connection
const std::string _id
 a unique identifier for this connection
tcp_socket_stream * _stream
 the underlying iostream channel
std::string _clientName
 the client identified used during connection
Atlas::Bridge * _bridge
 
the connection bridge (i.e something implementing objectArrived()) : this can be the derived

class itself, or any other object

Timeout_timeout
 network level timeouts

Friends

class Redispatch
class TestInjector

Additional Inherited Members

- Public Types inherited from Eris::BaseConnection
enum  Status {
  INVALID_STATUS = 0, NEGOTIATE, CONNECTING, CONNECTED,
  DISCONNECTED, DISCONNECTING, QUERY_GET
}
 possible states for the connection More...

Detailed Description

Underlying Atlas connection, providing a send interface, and receive (dispatch) system.

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 an unconnected instance.

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

is sent during Atlas negotiation of the connection.

Parameters:
debugPerform extra (slower) validation on the connection

References Eris::BaseConnection::connect().


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.

References _host, and _port.

void Eris::Connection::getServerInfo ( ServerInfo si) 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::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.

Referenced by Eris::Account::netDisconnecting().

void Eris::Connection::postForDispatch ( const Atlas::Objects::Root &  obj)
protected

Inject a local operation into the dispatch queue.

Used by the redispatch mechansim.

References m_opDeque.

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 received.

References Eris::BaseConnection::_status, Eris::BaseConnection::CONNECTED, and send().

void Eris::Connection::send ( const Atlas::Objects::Root &  obj)
virtual
void Eris::Connection::setStatus ( Status  sc)
protectedvirtual

update the connection status (and emit the appropriate signal)

Parameters:
scThe new status of the connection

Reimplemented from Eris::BaseConnection.

References Eris::BaseConnection::_status, and StatusChanged.

Referenced by disconnect().

void Eris::Connection::unlock ( )

Unlock the connection (permit status change).

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

References Eris::BaseConnection::_status, Eris::BaseConnection::DISCONNECTING, Eris::BaseConnection::hardDisconnect(), and m_opDeque.


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.

Referenced by disconnect().

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

Referenced by Eris::Account::Account(), and handleFailure().

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

indicates a status change on the connection

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.

Referenced by setStatus().


The documentation for this class was generated from the following files: