#include <dc_Types.h>
Data Fields | |
struct soap | soap |
The gSOAP runtime data structure. | |
char * | to |
WSA header To element. | |
struct wsa_endpoint_ref * | 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. | |
char * | action |
WSA header Action element. | |
char * | message_id |
WSA header MessageID element. | |
char * | relates_to |
WSA header RelatesTo element. | |
struct wsa_endpoint_ref | from |
WSA header From element. | |
struct wsa_endpoint_ref | reply_to |
WSA header ReplyTo element. | |
struct 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 | err |
API error code. | |
size_t | 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 | |
struct Namespace * | namespaces |
internal use | |
struct dynamic_array * | proxyHandles |
internal use | |
void(* | fnotification_failure )(struct dpws *, short, struct wsa_endpoint_ref *) |
callback for event notification failures | |
struct reactor * | reactor |
Global reactor used for listening to incoming requests and scheduling global actions. | |
struct reactor_item * | active_item |
Current active reactor items, used to encapsulate the reactor API in existing DPWS API. | |
void * | transport_data |
Pointer to the transport data used for the current request. | |
struct transport_fns * | transport_fns |
Pointer to callback functions used for external Web server integration. | |
soap_mode | user_mode |
Used to restore gSOAP user mode after request handling. | |
struct dpws_protocols * | protocols |
Pointer to the structure holding the constants for the current version of the DPWS protocol. | |
struct wsa_version * | wsa_version |
Pointer to the structure holding the constants for the current version of WS-Adressing. |
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.
char* to |
WSA header To element.
struct wsa_endpoint_ref* source [read] |
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.
struct wsa_endpoint_ref from [read] |
WSA header From element.
struct wsa_endpoint_ref reply_to [read] |
WSA header ReplyTo element.
struct wsa_endpoint_ref fault_to [read] |
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 err |
API error code.
size_t tmp_buf_count |
internal use
int(* backup_send_f)(struct soap *, const char *, size_t) |
internal use
int err_detail_type |
internal use.
Contains the XML type to pass to gSOAP-generated marshalling code so that to produce an error detail in a fault.
void* err_detail_data |
internal use.
Contains the pointer on a serializable C structure to pass to gSOAP-generated marshalling code so that to produce an error detail in a fault.
char* err_detail_data_elt |
internal use.
Contains the name of the tag to pass to gSOAP-generated marshalling code so that to produce an error detail in a fault.
short href_endpoint |
internal use
struct Namespace* namespaces [read] |
internal use
struct dynamic_array* proxyHandles [read] |
internal use
void(* fnotification_failure)(struct dpws *, short, struct wsa_endpoint_ref *) |
callback for event notification failures
Global reactor used for listening to incoming requests and scheduling global actions.
struct reactor_item* active_item [read] |
Current active reactor items, used to encapsulate the reactor API in existing DPWS API.
void* transport_data |
Pointer to the transport data used for the current request.
This is considered as opaque when transport_fns is used.
struct transport_fns* transport_fns [read] |
Pointer to callback functions used for external Web server integration.
NULL when the internal Web server is used.
soap_mode user_mode |
Used to restore gSOAP user mode after request handling.
struct dpws_protocols* protocols [read] |
Pointer to the structure holding the constants for the current version of the DPWS protocol.
struct wsa_version* wsa_version [read] |
Pointer to the structure holding the constants for the current version of WS-Adressing.