six::sixp::client::isession Class Reference

Session. More...

Public Member Functions
virtual void	connect (void)=0
	Connect to the server.
virtual sixp_result	create_request (irequest *&req, const char *prl, irequest::accept_format format, bool subscribe, irequest_events *events)=0
	Create a request.
virtual sixp_result	create_snapshot_requester (isnapshot_requester *&req)=0
	Creates snapshot requester.
virtual sixp_result	destroy_request (irequest *req)=0
	Destroys a request.
virtual sixp_result	destroy_snapshot_requester (isnapshot_requester *requester)=0
	Destroys a snapshot requester.
virtual const char *	get_last_error_message (void) const =0
	Gets error message text for last error.
virtual void	set_connect_timeout (sixp_int32_t timeout)=0
	Sets connect timeout.
virtual void	set_request_timeout (sixp_int32_t timeout)=0
	Sets request timeout.

Detailed Description

Session.

Member Function Documentation

virtual void six::sixp::client::isession::connect ( void  )

pure virtual

Connect to the server.

Returns

Result code.

virtual sixp_result six::sixp::client::isession::create_request ( irequest *&  req, const char *  prl, irequest::accept_format  format, bool  subscribe, irequest_events *  events  )

pure virtual

Create a request.

Parameters

req	Out: The new request.
prl	PRL.
format	Format.
subscribe	True if subscription with streaming updates and false if just snapshot.
events	irequest_event to get callbacks.

Returns

Result code.

virtual sixp_result six::sixp::client::isession::create_snapshot_requester ( isnapshot_requester *&  req )

pure virtual

Creates snapshot requester.

Parameters

req	Out: The new snapshot request.

Returns

Result code.

virtual sixp_result six::sixp::client::isession::destroy_request ( irequest *  req )

pure virtual

Destroys a request.

Parameters

A

request.

Returns

Result code.

virtual sixp_result six::sixp::client::isession::destroy_snapshot_requester ( isnapshot_requester *  requester )

pure virtual

Destroys a snapshot requester.

Parameters

A	requester.

Returns

Result code.

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

pure virtual

Gets error message text for last error.

Returns

The message.

virtual void six::sixp::client::isession::set_connect_timeout ( sixp_int32_t  timeout )

pure virtual

Sets connect timeout.

Parameters

timeout

The timeout in seconds.

virtual void six::sixp::client::isession::set_request_timeout ( sixp_int32_t  timeout )

pure virtual

Sets request timeout.

Parameters

timeout

The timeout in seconds.