Request event interface. More...

Public Member Functions
virtual void	on_clear_table (const irequest *req)=0
	Called when the table is cleared, ie all records are deleted.

virtual void	on_destroyed (const irequest *req)=0
	Called when the request is being destroyed.

virtual void	on_error (const irequest req, sixp_int32_t error_code, const char error_message)=0
	Called when an error occured.

virtual void	on_fieldset_received (const irequest req, const field_set_definition field_set)=0
	Called when the table's fieldset is received.

virtual void	on_init_table (const irequest *req, sixp_uint64_t num_records, bool changes)=0
	Called when the table is being initialized.

virtual void	on_record_update (const irequest req, sixp_uint64_t record_id, const char key, const field_update *fields, size_t num_fields, record_update_type update_type)=0
	Called when a record is updated.

virtual void	on_table_filled (const irequest *req)=0
	Called when the initial load is finished and streaming mode is entered.

virtual void	on_text (const irequest req, const char text)=0
	Called when a news text is received.

Detailed Description

Request event interface.

Member Function Documentation

virtual void six::sixp::client::irequest_events::on_clear_table ( const irequest * req )

pure virtual

Called when the table is cleared, ie all records are deleted.

Parameters

req	The request.

virtual void six::sixp::client::irequest_events::on_destroyed ( const irequest * req )

pure virtual

Called when the request is being destroyed.

Parameters

req	The request.

virtual void six::sixp::client::irequest_events::on_error	(	const irequest *	req,
		sixp_int32_t	error_code,
		const char *	error_message
	)

pure virtual

Called when an error occured.

Parameters

req	The request.
error_code	The error code.
error_message	Message describing the error.

virtual void six::sixp::client::irequest_events::on_fieldset_received	(	const irequest *	req,
		const field_set_definition *	field_set
	)

pure virtual

Called when the table's fieldset is received.

Parameters

req	The request.
field_set	The fieldset.

virtual void six::sixp::client::irequest_events::on_init_table	(	const irequest *	req,
		sixp_uint64_t	num_records,
		bool	changes
	)

pure virtual

Called when the table is being initialized.

Parameters

req	The request.
num_records	Number of records in the table. 0 if unknown.
changes	True if only changed fields will be received during the initial load, ie the first record will contain all fields and the following only fields that differ from the previousd record (ony used for day logs).

virtual void six::sixp::client::irequest_events::on_record_update	(	const irequest *	req,
		sixp_uint64_t	record_id,
		const char *	key,
		const field_update *	fields,
		size_t	num_fields,
		record_update_type	update_type
	)

pure virtual

Called when a record is updated.

Parameters

req	The request.
record_id	Unique id that identifies the record within the request table.
key	Record's key. Note that not all tables have keys.
fields	Array of fields updates.
num_fields	Number of fields.
update_type	Type of update.

virtual void six::sixp::client::irequest_events::on_table_filled ( const irequest * req )

pure virtual

Called when the initial load is finished and streaming mode is entered.

Parameters

req	The request.

virtual void six::sixp::client::irequest_events::on_text	(	const irequest *	req,
		const char *	text
	)

pure virtual

Called when a news text is received.

Parameters

req	The request.
text	The text in text or xml format depending on what was requested.