dpws Struct Reference

DPWS toolkit runtime structure Main DPWS API runtime data structure. More...

#include <dpws.h>


Data Fields

soap soap
 The gSOAP runtime data structure.
char * to
 WSA header To element.
wsa_endpoint_refsource
 This fields stores the source endpoint reference information set through the API and that is used to fill the WSA header source tag (from field) before every sending.
char * action
 WSA header Action element.
char * message_id
 WSA header MessageID element.
char * relates_to
 WSA header RelatesTo element.
wsa_endpoint_ref from
 WSA header From element.
wsa_endpoint_ref reply_to
 WSA header ReplyTo element.
wsa_endpoint_ref fault_to
 WSA header FaultTo element.
unsigned long instance_id
 WS-Discovery application sequence instance id.
unsigned short msg_nb
 WS-Discovery application sequence message number.
char * subscription_id
 WS-Eventing subscription identifier.
unsigned short status
 internal DPWS processing status
int wsd_ls
 WS-Discovery listening socket (receiving hello, bye, probe, resolve).
int err
 API error code.
void * discovery_msg
 Stores the parsed discovery message.
int tmp_buf_count
 internal use
int(* backup_send_f )(struct soap *, const char *, size_t)
 internal use
int err_detail_type
 internal use
void * err_detail_data
 internal use
char * err_detail_data_elt
 internal use
short href_endpoint
 internal use
schedule_item * schedule
 internal use
Namespace * namespaces
 internal use


Detailed Description

DPWS toolkit runtime structure Main DPWS API runtime data structure.

The fields in the dpws structure provide support for the WS-Addressing specification. Most of those fields are set automatically or through API calls by the DPWS toolkit, and should therefore be accessed only for reading in user-defined client or server code. The notable exception is the fault_to field, which should be set by the user before calling a proxy function, if required. A future version of the toolkit may add parameters to the proxy function signatures to pass this optional information to the toolkit runtime. As mentioned previously, it is always possible to retrieve the soap structure embedded within the dpws structure, and use it to call gSOAP runtime functions. It is also possible to retrieve the dpws structure corresponding to a soap structure. The dpws_dpws2soap(dpws) and dpws_soap2dpws(soap) macros are available to cast from one structure to the other.


Field Documentation

struct wsa_endpoint_ref* dpws::source

This fields stores the source endpoint reference information set through the API and that is used to fill the WSA header source tag (from field) before every sending.


The documentation for this struct was generated from the following file:
Generated on Mon May 7 19:15:42 2007 for DPWS Toolkit API Reference by  doxygen 1.5.1-p1