six::sixp::client::iclient Class Reference

Client. More...

Public Types
enum	reconnect_strategy { reconnect_resubscribe, reconnect_no_resubscribe }
	Values that represent reconnect_strategy. More...

Public Member Functions
virtual sixp_result	create_session (isession *&session, isession_events *events, const char *address, const char *username, const char *password, const proxy_settings *proxy=NULL)=0
	Creates a new session to a server.
virtual sixp_result	create_session (isession *&session, isession_events *events, const char *address, const char *username, const char *password, reconnect_strategy reconnect_type, sixp_int32_t reconnect_interval, const proxy_settings *proxy=NULL)=0
	Creates a session with automatic reconnection on unexpected disconnects.
virtual sixp_result	destroy_session (isession *sess)=0
	Destroys a session.
virtual sixp_uint64_t	get_avg_message_size (void) const =0
	Gets average message size since connect.
virtual const char *	get_last_error_message (void) const =0
	Gets error message text for last error.
virtual sixp_uint64_t	get_num_field_updates (void) const =0
	Gets the total number of fields updates received since connect.
virtual sixp_uint64_t	get_num_login (void) const =0
	Gets the total number logins done since connect.
virtual sixp_uint64_t	get_num_record_updates (void) const =0
	Gets the total number of record updates received since connect.
virtual sixp_uint64_t	get_num_subscribe (void) const =0
	Gets the total number of subscribe request sent to the server since connect.
virtual sixp_uint64_t	get_num_updates (void) const =0
	Gets the total number of update messages received since connect.
virtual void	set_logging (iclient_logging *logger)=0
	Sets logging handler to receive log messages.

Detailed Description

Client.

Member Enumeration Documentation

enum six::sixp::client::iclient::reconnect_strategy

Values that represent reconnect_strategy.

Enumerator
reconnect_resubscribe	Automatic resubscription on reconnect.
reconnect_no_resubscribe	No resubscription on reconnect; all requests will be destroyed.

Member Function Documentation

virtual sixp_result six::sixp::client::iclient::create_session ( isession *&  session, isession_events *  events, const char *  address, const char *  username, const char *  password, const proxy_settings *  proxy = NULL  )

pure virtual

Creates a new session to a server.

Parameters

session	Out: The new session.
events	isession_events to get callbacks.
address	Address to server in format ip:port. Ip can be IP address or DNS name. Multiple servers can be given as a comma separated list. The servers will be used in a round-robin fashion.
username	Username.
password	Password.
proxy	Proxy settings or NULL if no proxy is used.

Returns

Result code.

virtual sixp_result six::sixp::client::iclient::create_session ( isession *&  session, isession_events *  events, const char *  address, const char *  username, const char *  password, reconnect_strategy  reconnect_type, sixp_int32_t  reconnect_interval, const proxy_settings *  proxy = NULL  )

pure virtual

Creates a session with automatic reconnection on unexpected disconnects.

Parameters

session	Out: The new session.
events	isession_events to get callbacks.
address	Address to server in format ip:port. Ip can be IP address ro DNS name. Multiple servers can be given as a comma separated list. The servers will be used in a round-robin fashion.
username	Username.
password	Password.
reconnect_type	Reconnect strategy.
reconnect_interval	Reconnect interval, in s.
proxy	Proxy settings or NULL if no proxy is used.

Returns

Result code.

virtual sixp_result six::sixp::client::iclient::destroy_session ( isession *  sess )

pure virtual

Destroys a session.

Parameters

A

session.

Returns

Result code.

virtual sixp_uint64_t six::sixp::client::iclient::get_avg_message_size ( void  ) const

pure virtual

Gets average message size since connect.

Returns

The average message size.

virtual const char* six::sixp::client::iclient::get_last_error_message ( void  ) const

pure virtual

Gets error message text for last error.

Returns

The message.

virtual sixp_uint64_t six::sixp::client::iclient::get_num_field_updates ( void  ) const

pure virtual

Gets the total number of fields updates received since connect.

Returns

The number field updates.

virtual sixp_uint64_t six::sixp::client::iclient::get_num_login ( void  ) const

pure virtual

Gets the total number logins done since connect.

Returns

The number logins.

virtual sixp_uint64_t six::sixp::client::iclient::get_num_record_updates ( void  ) const

pure virtual

Gets the total number of record updates received since connect.

Returns

The number record updates.

virtual sixp_uint64_t six::sixp::client::iclient::get_num_subscribe ( void  ) const

pure virtual

Gets the total number of subscribe request sent to the server since connect.

Returns

The number subscribe requests.

virtual sixp_uint64_t six::sixp::client::iclient::get_num_updates ( void  ) const

pure virtual

Gets the total number of update messages received since connect.

Returns

The number updates.

virtual void six::sixp::client::iclient::set_logging ( iclient_logging *  logger )

pure virtual

Sets logging handler to receive log messages.

Parameters

logger

iclient_logging to receive callbacks.