SIXP
SIXP API
 All Classes Functions Variables Enumerations Enumerator Pages
six::sixp::client::isession_events Class Referenceabstract

Session event interface. More...

Public Member Functions

virtual void on_connected (isession *session, const server_settings &server, bool reconnected)=0
 Called when connected to server.
 
virtual void on_connecting (isession *session, const server_settings &server, bool reconnecting)=0
 Called when beginning to connect to a server.
 
virtual void on_disconnected (isession *session)=0
 Called when disconnected from a server.
 
virtual void on_error (isession *session, const server_settings &server, sixp_int32_t error_code, const char *error_message)=0
 Called when an error occurs.
 
virtual void on_logged_out (isession *session, sixp_int32_t error_code, const char *error_message)=0
 Called when logged out from a server. Can happed at any time.
 
virtual void on_timing_info (isession *session, sixp_uint64_t ping_turnaround_time, sixp_uint64_t estimated_delay_time, sixp_uint64_t queue_size)=0
 Called when connection timing statistics are available.
 

Detailed Description

Session event interface.

Member Function Documentation

virtual void six::sixp::client::isession_events::on_connected ( isession session,
const server_settings server,
bool  reconnected 
)
pure virtual

Called when connected to server.

Parameters
sessionThe session.
serverThe server.
reconnectingFalse on first connection and true of reconnections.
virtual void six::sixp::client::isession_events::on_connecting ( isession session,
const server_settings server,
bool  reconnecting 
)
pure virtual

Called when beginning to connect to a server.

Parameters
sessionThe session.
serverThe server.
reconnectingFalse on first connection and true of reconnections.
virtual void six::sixp::client::isession_events::on_disconnected ( isession session)
pure virtual

Called when disconnected from a server.

Parameters
sessionThe session.
virtual void six::sixp::client::isession_events::on_error ( isession session,
const server_settings server,
sixp_int32_t  error_code,
const char *  error_message 
)
pure virtual

Called when an error occurs.

Parameters
sessionThe session.
serverThe server.
error_codeThe error code.
error_messageMessage describing the error.
virtual void six::sixp::client::isession_events::on_logged_out ( isession session,
sixp_int32_t  error_code,
const char *  error_message 
)
pure virtual

Called when logged out from a server. Can happed at any time.

Parameters
sessionThe session.
error_codeThe error code.
error_messageReason for logout.
virtual void six::sixp::client::isession_events::on_timing_info ( isession session,
sixp_uint64_t  ping_turnaround_time,
sixp_uint64_t  estimated_delay_time,
sixp_uint64_t  queue_size 
)
pure virtual

Called when connection timing statistics are available.

Parameters
sessionThe session.
ping_turnaround_timePing turnaround time, the time it takes for the server to get a response to a ping message sent to the client.
estimated_delay_timeEstimated delay in ms.
queue_sizeSize of the server's output queue for the current session.