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

Request. More...

Public Types

enum  accept_format { table =1, text =2, xml =4 }
 Data formats that can be requested. More...
 

Public Member Functions

virtual sixp_result execute (void)=0
 Executes the request.
 
virtual bool get_changes (void) const =0
 Is this a table where only changes are transmitted during initial load.
 
virtual sixp_uint32_t get_conflation_time (void) const =0
 Gets conflation time.
 
virtual bool get_error (void) const =0
 Has an error occured?
 
virtual const
field_set_definition
get_field_set (void) const =0
 Gets the fieldset used the request's table..
 
virtual accept_format get_format (void) const =0
 Gets the format.
 
virtual sixp_uint64_t get_id (void) const =0
 Gets the request identifier.
 
virtual const char * get_last_error_message (void) const =0
 Gets error message text for last error.
 
virtual const char * get_prl (void) const =0
 Gets the prl.
 
virtual bool get_subscribe (void) const =0
 Is this request a subscription?
 
virtual void set_auto_destroy (bool auto_destroy)=0
 
 

Detailed Description

Request.

Member Enumeration Documentation

Data formats that can be requested.

Enumerator
table 

Table.

text 

Text.

xml 

XML.

Member Function Documentation

virtual bool six::sixp::client::irequest::get_changes ( void  ) const
pure virtual

Is this a table where only changes are transmitted during initial load.

Returns
true if changes, false if not.
virtual sixp_uint32_t six::sixp::client::irequest::get_conflation_time ( void  ) const
pure virtual

Gets conflation time.

Returns
The conflation time.
virtual bool six::sixp::client::irequest::get_error ( void  ) const
pure virtual

Has an error occured?

Returns
true if an error occured, false if not.
virtual const field_set_definition* six::sixp::client::irequest::get_field_set ( void  ) const
pure virtual

Gets the fieldset used the request's table..

Returns
The fieldset.
virtual accept_format six::sixp::client::irequest::get_format ( void  ) const
pure virtual

Gets the format.

Returns
The format.
virtual sixp_uint64_t six::sixp::client::irequest::get_id ( void  ) const
pure virtual

Gets the request identifier.

Returns
The identifier.
virtual const char* six::sixp::client::irequest::get_last_error_message ( void  ) const
pure virtual

Gets error message text for last error.

Returns
The message.
virtual const char* six::sixp::client::irequest::get_prl ( void  ) const
pure virtual

Gets the prl.

Returns
The prl.
virtual bool six::sixp::client::irequest::get_subscribe ( void  ) const
pure virtual

Is this request a subscription?

Returns
true if a subscription, false if not.