#include "soapH.h"

Include dependency graph for wsaapi.h:

This graph shows which files directly or indirectly include this file:

Classes
struct	soap_wsa_data
	plugin data to override callbacks More...

Macros
#define	SOAP_WSA_ID "SOAP-WSA/1.5"

#define	SOAP_WSA_INHERIT_TRANSFER NULL

#define	SOAP_WSA_NEW_TRANSFER ((void*)"")

#define	SOAP_WSA(member) wsa__##member

#define	SOAP_WSA_(prefix, member) prefix##_wsa__##member

#define	SOAP_WSA__(prefix, member) prefix##wsa__##member

Functions
SOAP_FMAC1 int SOAP_FMAC2	soap_wsa (struct soap soap, struct soap_plugin p, void *arg)
	Plugin registry function, used with soap_register_plugin and soap_register_plugin_arg. More...

SOAP_FMAC1 const char *SOAP_FMAC2	soap_wsa_rand_uuid (struct soap *soap)
	Generates a random UUID (UUID algorithm version 4). Compile all source codes with -DWITH_OPENSSL for better randomness. More...

SOAP_FMAC1 int SOAP_FMAC2	soap_wsa_request (struct soap soap, const char id, const char to, const char action)
	Sets the WS-Addressing information header for the next request message with MessageID (optional), To (optional), and Action (required). More...

SOAP_FMAC1 int SOAP_FMAC2	soap_wsa_add_From (struct soap soap, const char endpoint)
	Sets WS-Addressing From header for request message. More...

SOAP_FMAC1 int SOAP_FMAC2	soap_wsa_add_NoReply (struct soap *soap)
	Sets WS-Addressing ReplyTo header to 'none' (no reply) More...

SOAP_FMAC1 int SOAP_FMAC2	soap_wsa_add_ReplyTo (struct soap soap, const char endpoint)
	Sets WS-Addressing ReplyTo header for request message. More...

SOAP_FMAC1 int SOAP_FMAC2	soap_wsa_add_FaultTo (struct soap soap, const char endpoint)
	Sets WS-Addressing FaultTo header for request message. More...

SOAP_FMAC1 int SOAP_FMAC2	soap_wsa_add_RelatesTo (struct soap soap, const char endpoint)
	Sets WS-Addressing RelatesTo header. More...

SOAP_FMAC1 const char *SOAP_FMAC2	soap_wsa_From (struct soap *soap)
	Returns WS-Addressing From header. More...

SOAP_FMAC1 const char *SOAP_FMAC2	soap_wsa_ReplyTo (struct soap *soap)
	Returns WS-Addressing ReplyTo header. More...

SOAP_FMAC1 const char *SOAP_FMAC2	soap_wsa_FaultTo (struct soap *soap)
	Returns WS-Addressing FaultTo header. More...

SOAP_FMAC1 const char *SOAP_FMAC2	soap_wsa_RelatesTo (struct soap *soap)
	Returns WS-Addressing RelatesTo header. More...

SOAP_FMAC1 int SOAP_FMAC2	soap_wsa_check (struct soap *soap)
	Checks the presence and validity of WS-Addressing information headers. More...

SOAP_FMAC1 int SOAP_FMAC2	soap_wsa_reply (struct soap soap, const char id, const char *action)
	Sets WS-Addressing header fields for server response. Automatically relays the response to the ReplyTo address (when ReplyTo != to From and ReplyTo != 'none') and returns HTTP 202 Accept to sender when relay was successful. More...

SOAP_FMAC1 int SOAP_FMAC2	soap_wsa_fault_subcode (struct soap soap, int flag, const char faultsubcode, const char faultstring, const char faultdetail)
	Sets sender/receiver SOAP Fault (sub)code for server fault response. More...

SOAP_FMAC1 int SOAP_FMAC2	soap_wsa_fault_subcode_action (struct soap soap, int flag, const char faultsubcode, const char faultstring, const char faultdetail, const char *action)
	Sets sender/receiver SOAP Fault (sub)code and action for server fault response. More...

SOAP_FMAC1 int SOAP_FMAC2	soap_wsa_sender_fault_subcode (struct soap soap, const char faultsubcode, const char faultstring, const char faultdetail)
	Sets sender SOAP Fault (sub)code for server fault response. More...

SOAP_FMAC1 int SOAP_FMAC2	soap_wsa_sender_fault_subcode_action (struct soap soap, const char faultsubcode, const char faultstring, const char faultdetail, const char *action)
	Sets sender SOAP Fault (sub)code for server fault response. More...

SOAP_FMAC1 int SOAP_FMAC2	soap_wsa_receiver_fault_subcode (struct soap soap, const char faultsubcode, const char faultstring, const char faultdetail)
	Sets receiver SOAP Fault (sub)code for server fault response. More...

SOAP_FMAC1 int SOAP_FMAC2	soap_wsa_receiver_fault_subcode_action (struct soap soap, const char faultsubcode, const char faultstring, const char faultdetail, const char *action)
	Sets receiver SOAP Fault (sub)code for server fault response. More...

SOAP_FMAC1 int SOAP_FMAC2	soap_wsa_sender_fault (struct soap soap, const char faultstring, const char *faultdetail)
	Sets sender SOAP Fault for server fault response. More...

SOAP_FMAC1 int SOAP_FMAC2	soap_wsa_receiver_fault (struct soap soap, const char faultstring, const char *faultdetail)
	Sets receiver SOAP Fault for server fault response. More...

SOAP_FMAC1 int SOAP_FMAC2	soap_wsa_check_fault (struct soap soap, SOAP_WSA(FaultSubcodeValues)fault)
	Checks the presence of a WS-Addressing fault. More...

SOAP_FMAC1 int SOAP_FMAC2	soap_wsa_error (struct soap *soap, SOAP_WSA(FaultSubcodeValues) fault)
	Sets SOAP Fault (sub)code for server WS-Addressing fault response. More...

Variables
const char	soap_wsa_id []

const char *	soap_wsa_noneURI

const char *	soap_wsa_anonymousURI

const char *	soap_wsa_faultAction

Macro Definition Documentation

#define SOAP_WSA ( member ) wsa__##member

#define SOAP_WSA_	(	prefix,
		member
	)	prefix##_wsa__##member

#define SOAP_WSA__	(	prefix,
		member
	)	prefix##wsa__##member

#define SOAP_WSA_ID "SOAP-WSA/1.5"

Plugin identification for plugin registry

#define SOAP_WSA_INHERIT_TRANSFER NULL

Plugin registry argument parameter to inherit soap context to connect and send responses to other servers (default)

#define SOAP_WSA_NEW_TRANSFER ((void*)"")

Plugin registry argument parameter to reset soap context transfer callbacks to connect and send responses to other servers

Function Documentation

int soap_wsa	(	struct soap *	soap,
		struct soap_plugin *	p,
		void *	arg
	)

Plugin registry function, used with soap_register_plugin and soap_register_plugin_arg.

Parameters

	soap	context
[in,out]	p	plugin created in registry
[in]	arg	passed from soap_register_plugin_arg

Returns: SOAP_OK

int soap_wsa_add_FaultTo	(	struct soap *	soap,
		const char *	faultTo
	)

Sets WS-Addressing FaultTo header for request message.

Parameters

	soap	context
[in]	faultTo	endpoint URI or NULL for remove faultTo

Returns: SOAP_OK or SOAP_ERR

Use soap_wsa_request to populate the WS-Addressing header first.

int soap_wsa_add_From	(	struct soap *	soap,
		const char *	from
	)

Sets WS-Addressing From header for request message.

Parameters

	soap	context
[in]	from	endpoint URI

Returns: SOAP_OK or SOAP_ERR

Use soap_wsa_request to populate the WS-Addressing header first.

int soap_wsa_add_NoReply ( struct soap * soap )

Sets WS-Addressing ReplyTo header to 'none' (no reply)

Parameters

soap context

Returns: SOAP_OK or SOAP_ERR

Note: WS-Addressing 2005/08 standard.

Use soap_wsa_request to populate the WS-Addressing header.

int soap_wsa_add_RelatesTo	(	struct soap *	soap,
		const char *	relatesTo
	)

Sets WS-Addressing RelatesTo header.

Parameters

	soap	context
[in]	relatesTo	endpoint URI

Returns: SOAP_OK or SOAP_ERR

Use soap_wsa_request to populate the WS-Addressing header.

int soap_wsa_add_ReplyTo	(	struct soap *	soap,
		const char *	replyTo
	)

Sets WS-Addressing ReplyTo header for request message.

Parameters

	soap	context
[in]	replyTo	endpoint URI or NULL for anonymous

Returns: SOAP_OK or SOAP_ERR

Use soap_wsa_request to populate the WS-Addressing header.

int soap_wsa_check ( struct soap * soap )

Checks the presence and validity of WS-Addressing information headers.

Parameters

soap context

Returns: SOAP_OK or fault

int soap_wsa_check_fault	(	struct soap *	soap,
		SOAP_WSA(FaultSubcodeValues)*	fault
	)

Checks the presence of a WS-Addressing fault.

Parameters

	soap	context
[out]	fault	code

Returns: SOAP_OK (no fault) or fault code

int soap_wsa_error	(	struct soap *	soap,
		SOAP_WSA(FaultSubcodeValues)	fault
	)

Sets SOAP Fault (sub)code for server WS-Addressing fault response.

Parameters

	soap	context
[in]	fault	is one of wsa:FaultSubcodeValues

Returns: SOAP_FAULT

int soap_wsa_fault_subcode	(	struct soap *	soap,
		int	flag,
		const char *	faultsubcode,
		const char *	faultstring,
		const char *	faultdetail
	)

Sets sender/receiver SOAP Fault (sub)code for server fault response.

Parameters

	soap	context
[in]	flag	0=receiver, 1=sender
[in]	faultsubcode	sub code string
[in]	faultstring	fault string
[in]	faultdetail	detail string

Returns: SOAP_FAULT

int soap_wsa_fault_subcode_action	(	struct soap *	soap,
		int	flag,
		const char *	faultsubcode,
		const char *	faultstring,
		const char *	faultdetail,
		const char *	action
	)

Sets sender/receiver SOAP Fault (sub)code and action for server fault response.

Parameters

	soap	context
[in]	flag	0=receiver, 1=sender
[in]	faultsubcode	sub code string
[in]	faultstring	fault string
[in]	faultdetail	detail string
[in]	action	WS-Addressing action string

Returns: SOAP_FAULT

const char * soap_wsa_FaultTo ( struct soap * soap )

Returns WS-Addressing FaultTo header.

Parameters

soap context

Returns: From string or NULL

const char * soap_wsa_From ( struct soap * soap )

Returns WS-Addressing From header.

Parameters

soap context

Returns: From string or NULL

const char * soap_wsa_rand_uuid ( struct soap * soap )

Generates a random UUID (UUID algorithm version 4). Compile all source codes with -DWITH_OPENSSL for better randomness.

Parameters

soap context

Returns: UUID "urn:uuid:xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx" or NULL if out of memory

int soap_wsa_receiver_fault	(	struct soap *	soap,
		const char *	faultstring,
		const char *	faultdetail
	)

Sets receiver SOAP Fault for server fault response.

Parameters

	soap	context
[in]	faultstring	fault string
[in]	faultdetail	detail string

Returns: SOAP_FAULT

int soap_wsa_receiver_fault_subcode	(	struct soap *	soap,
		const char *	faultsubcode,
		const char *	faultstring,
		const char *	faultdetail
	)

Sets receiver SOAP Fault (sub)code for server fault response.

Parameters

	soap	context
[in]	faultsubcode	sub code string
[in]	faultstring	fault string
[in]	faultdetail	detail string

Returns: SOAP_FAULT

int soap_wsa_receiver_fault_subcode_action	(	struct soap *	soap,
		const char *	faultsubcode,
		const char *	faultstring,
		const char *	faultdetail,
		const char *	action
	)

Sets receiver SOAP Fault (sub)code for server fault response.

Parameters

	soap	context
[in]	faultsubcode	sub code string
[in]	faultstring	fault string
[in]	faultdetail	detail string
[in]	action	WS-Addressing action string

Returns: SOAP_FAULT

const char * soap_wsa_RelatesTo ( struct soap * soap )

Returns WS-Addressing RelatesTo header.

Parameters

soap context

Returns: From string or NULL

int soap_wsa_reply	(	struct soap *	soap,
		const char *	id,
		const char *	action
	)

Sets WS-Addressing header fields for server response. Automatically relays the response to the ReplyTo address (when ReplyTo != to From and ReplyTo != 'none') and returns HTTP 202 Accept to sender when relay was successful.

Parameters

	soap	context
[in]	id	is the messageID (optional)
[in]	action	is the target action (required)

Returns: SOAP_OK or fault

const char * soap_wsa_ReplyTo ( struct soap * soap )

Returns WS-Addressing ReplyTo header.

Parameters

soap context

Returns: From string or NULL

int soap_wsa_request	(	struct soap *	soap,
		const char *	id,
		const char *	to,
		const char *	action
	)

Sets the WS-Addressing information header for the next request message with MessageID (optional), To (optional), and Action (required).

Parameters

	soap	context
[in]	id	is the message ID (optional)
[in]	to	is the target endpoint (optional, set to anonymous when NULL)
[in]	action	is the target action (required)

Returns: SOAP_OK or error

Note: use soap_wsa_add_From, soap_wsa_add_ReplyTo, soap_wsa_add_FaultTo to add other addressing fields following this function call.

int soap_wsa_sender_fault	(	struct soap *	soap,
		const char *	faultstring,
		const char *	faultdetail
	)

Sets sender SOAP Fault for server fault response.

Parameters

	soap	context
[in]	faultstring	fault string
[in]	faultdetail	detail string

Returns: SOAP_FAULT

int soap_wsa_sender_fault_subcode	(	struct soap *	soap,
		const char *	faultsubcode,
		const char *	faultstring,
		const char *	faultdetail
	)

Sets sender SOAP Fault (sub)code for server fault response.

Parameters

	soap	context
[in]	faultsubcode	sub code string
[in]	faultstring	fault string
[in]	faultdetail	detail string

Returns: SOAP_FAULT

int soap_wsa_sender_fault_subcode_action	(	struct soap *	soap,
		const char *	faultsubcode,
		const char *	faultstring,
		const char *	faultdetail,
		const char *	action
	)

Sets sender SOAP Fault (sub)code for server fault response.

Parameters

	soap	context
[in]	faultsubcode	sub code string
[in]	faultstring	fault string
[in]	faultdetail	detail string
[in]	action	WS-Addressing action string

Returns: SOAP_FAULT

Variable Documentation

const char* soap_wsa_anonymousURI

Anonymous Reply/To endpoint address

const char* soap_wsa_faultAction

const char soap_wsa_id[]

Plugin identification for plugin registry

const char* soap_wsa_noneURI

Specifies no Reply endpoint address (no reply)

Classes

Macros

Functions

Variables

Macro Definition Documentation

Function Documentation

Variable Documentation