![]() |
![]() |
![]() |
libsoup Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy |
SoupSoapMessage; SoupSoapMessage * soup_soap_message_new (const char *method
,const char *uri_string
,gboolean standalone
,const char *xml_encoding
,const char *env_prefix
,const char *env_uri
); SoupSoapMessage * soup_soap_message_new_from_uri (const char *method
,const SoupUri *uri
,gboolean standalone
,const char *xml_encoding
,const char *env_prefix
,const char *env_uri
); void soup_soap_message_start_envelope (SoupSoapMessage *msg
); void soup_soap_message_end_envelope (SoupSoapMessage *msg
); void soup_soap_message_start_body (SoupSoapMessage *msg
); void soup_soap_message_end_body (SoupSoapMessage *msg
); void soup_soap_message_start_element (SoupSoapMessage *msg
,const char *name
,const char *prefix
,const char *ns_uri
); void soup_soap_message_end_element (SoupSoapMessage *msg
); void soup_soap_message_start_fault (SoupSoapMessage *msg
,const char *faultcode
,const char *faultstring
,const char *faultfactor
); void soup_soap_message_end_fault (SoupSoapMessage *msg
); void soup_soap_message_start_fault_detail (SoupSoapMessage *msg
); void soup_soap_message_end_fault_detail (SoupSoapMessage *msg
); void soup_soap_message_start_header (SoupSoapMessage *msg
); void soup_soap_message_end_header (SoupSoapMessage *msg
); void soup_soap_message_start_header_element (SoupSoapMessage *msg
,const char *name
,gboolean must_understand
,const char *actor_uri
,const char *prefix
,const char *ns_uri
); void soup_soap_message_end_header_element (SoupSoapMessage *msg
); void soup_soap_message_write_int (SoupSoapMessage *msg
,glong i
); void soup_soap_message_write_double (SoupSoapMessage *msg
,double d
); void soup_soap_message_write_base64 (SoupSoapMessage *msg
,const char *string
,int len
); void soup_soap_message_write_time (SoupSoapMessage *msg
,const time_t *timeval
); void soup_soap_message_write_string (SoupSoapMessage *msg
,const char *string
); void soup_soap_message_write_buffer (SoupSoapMessage *msg
,const char *buffer
,int len
); void soup_soap_message_set_element_type (SoupSoapMessage *msg
,const char *xsi_type
); void soup_soap_message_set_null (SoupSoapMessage *msg
); void soup_soap_message_add_attribute (SoupSoapMessage *msg
,const char *name
,const char *value
,const char *prefix
,const char *ns_uri
); void soup_soap_message_add_namespace (SoupSoapMessage *msg
,const char *prefix
,const char *ns_uri
); void soup_soap_message_set_default_namespace (SoupSoapMessage *msg
,const char *ns_uri
); void soup_soap_message_set_encoding_style (SoupSoapMessage *msg
,const char *enc_style
); void soup_soap_message_reset (SoupSoapMessage *msg
); void soup_soap_message_persist (SoupSoapMessage *msg
); const char * soup_soap_message_get_namespace_prefix (SoupSoapMessage *msg
,const char *ns_uri
); xmlDocPtr soup_soap_message_get_xml_doc (SoupSoapMessage *msg
); SoupSoapResponse * soup_soap_message_parse_response (SoupSoapMessage *msg
);
SoupSoapMessage * soup_soap_message_new (const char *method
,const char *uri_string
,gboolean standalone
,const char *xml_encoding
,const char *env_prefix
,const char *env_uri
);
Creates a new empty SoupSoapMessage, which will connect to uri_string
.
|
the HTTP method for the created request. |
|
the destination endpoint (as a string). |
|
??? FIXME |
|
??? FIXME |
|
??? FIXME |
|
??? FIXME |
Returns : |
the new SoupSoapMessage (or NULL if uri_string could not be
parsed). |
SoupSoapMessage * soup_soap_message_new_from_uri (const char *method
,const SoupUri *uri
,gboolean standalone
,const char *xml_encoding
,const char *env_prefix
,const char *env_uri
);
Creates a new empty SoupSoapMessage, which will connect to uri
|
the HTTP method for the created request. |
|
the destination endpoint (as a SoupUri). |
|
??? FIXME |
|
??? FIXME |
|
??? FIXME |
|
??? FIXME |
Returns : |
the new SoupSoapMessage |
void soup_soap_message_start_envelope (SoupSoapMessage *msg
);
Starts the top level SOAP Envelope element.
|
the SoupSoapMessage . |
void soup_soap_message_end_envelope (SoupSoapMessage *msg
);
Closes the top level SOAP Envelope element.
|
the SoupSoapMessage . |
void soup_soap_message_start_body (SoupSoapMessage *msg
);
Starts the SOAP Body element.
|
the SoupSoapMessage . |
void soup_soap_message_end_body (SoupSoapMessage *msg
);
Closes the SOAP Body element.
|
the SoupSoapMessage . |
void soup_soap_message_start_element (SoupSoapMessage *msg
,const char *name
,const char *prefix
,const char *ns_uri
);
Starts a new arbitrary message element, with name
as the element
name, prefix
as the XML Namespace prefix, and ns_uri
as the XML
Namespace uri for * the created element.
Passing prefix
with no ns_uri
will cause a recursive search for
an existing namespace with the same prefix. Failing that a new ns
will be created with an empty uri.
Passing both prefix
and ns_uri
always causes new namespace
attribute creation.
Passing NULL for both prefix
and ns_uri
causes no prefix to be
used, and the element will be in the default namespace.
|
the SoupSoapMessage. |
|
the element name. |
|
the namespace prefix |
|
the namespace URI |
void soup_soap_message_end_element (SoupSoapMessage *msg
);
Closes the current message element.
|
the SoupSoapMessage. |
void soup_soap_message_start_fault (SoupSoapMessage *msg
,const char *faultcode
,const char *faultstring
,const char *faultfactor
);
Starts a new SOAP Fault element, creating faultcode, faultstring, and faultfactor child elements.
If you wish to add the faultdetail element, use
soup_soap_message_start_fault_detail()
, and then
soup_soap_message_start_element()
to add arbitrary sub-elements.
|
the SoupSoapMessage. |
|
faultcode element value |
|
faultstring element value |
|
faultfactor element value |
void soup_soap_message_end_fault (SoupSoapMessage *msg
);
Closes the current SOAP Fault element.
|
the SoupSoapMessage. |
void soup_soap_message_start_fault_detail
(SoupSoapMessage *msg
);
Start the faultdetail child element of the current SOAP Fault element. The faultdetail element allows arbitrary data to be sent in a returned fault.
|
the SoupSoapMessage. |
void soup_soap_message_end_fault_detail (SoupSoapMessage *msg
);
Closes the current SOAP faultdetail element.
|
the SoupSoapMessage. |
void soup_soap_message_start_header (SoupSoapMessage *msg
);
Creates a new SOAP Header element. You can call
soup_soap_message_start_header_element()
after this to add a new
header child element. SOAP Header elements allow out-of-band data
to be transferred while not interfering with the message body.
This should be called after soup_soap_message_start_envelope()
and
before soup_soap_message_start_body()
.
|
the SoupSoapMessage. |
void soup_soap_message_end_header (SoupSoapMessage *msg
);
Closes the current SOAP Header element.
|
the SoupSoapMessage. |
void soup_soap_message_start_header_element (SoupSoapMessage *msg
,const char *name
,gboolean must_understand
,const char *actor_uri
,const char *prefix
,const char *ns_uri
);
Starts a new SOAP arbitrary header element.
|
the SoupSoapMessage. |
|
name of the header element |
|
whether the recipient must understand the header in order to proceed with processing the message |
|
the URI which represents the destination actor for this header. |
|
the namespace prefix |
|
the namespace URI |
void soup_soap_message_end_header_element
(SoupSoapMessage *msg
);
Closes the current SOAP header element.
|
the SoupSoapMessage. |
void soup_soap_message_write_int (SoupSoapMessage *msg
,glong i
);
Writes the stringified value of i
as the current element's content.
|
the SoupSoapMessage. |
|
the integer value to write. |
void soup_soap_message_write_double (SoupSoapMessage *msg
,double d
);
Writes the stringified value of d
as the current element's content.
|
the SoupSoapMessage. |
|
the double value to write. |
void soup_soap_message_write_base64 (SoupSoapMessage *msg
,const char *string
,int len
);
Writes the Base-64 encoded value of string
as the current
element's content.
|
the SoupSoapMessage |
|
the binary data buffer to encode |
|
the length of data to encode |
void soup_soap_message_write_time (SoupSoapMessage *msg
,const time_t *timeval
);
Writes the stringified value of timeval
as the current element's
content.
|
the SoupSoapMessage. |
|
pointer to a time_t to encode |
void soup_soap_message_write_string (SoupSoapMessage *msg
,const char *string
);
Writes the string
as the current element's content.
|
the SoupSoapMessage. |
|
string to write. |
void soup_soap_message_write_buffer (SoupSoapMessage *msg
,const char *buffer
,int len
);
Writes the string buffer pointed to by buffer
as the current
element's content.
|
the SoupSoapMessage. |
|
the string data buffer to write. |
|
length of buffer . |
void soup_soap_message_set_element_type (SoupSoapMessage *msg
,const char *xsi_type
);
Sets the current element's XML schema xsi:type attribute, which specifies the element's type name.
|
the SoupSoapMessage. |
|
the type name for the element. |
void soup_soap_message_set_null (SoupSoapMessage *msg
);
Sets the current element's XML Schema xsi:null attribute.
|
the SoupSoapMessage. |
void soup_soap_message_add_attribute (SoupSoapMessage *msg
,const char *name
,const char *value
,const char *prefix
,const char *ns_uri
);
Adds an XML attribute to the current element.
|
the SoupSoapMessage. |
|
name of the attribute |
|
value of the attribute |
|
the namespace prefix |
|
the namespace URI |
void soup_soap_message_add_namespace (SoupSoapMessage *msg
,const char *prefix
,const char *ns_uri
);
Adds a new XML namespace to the current element.
|
the SoupSoapMessage. |
|
the namespace prefix |
|
the namespace URI, or NULL for empty namespace |
void soup_soap_message_set_default_namespace (SoupSoapMessage *msg
,const char *ns_uri
);
Sets the default namespace to the URI specified in ns_uri
. The
default namespace becomes the namespace all non-explicitly
namespaced child elements fall into.
|
the SoupSoapMessage. |
|
the namespace URI. |
void soup_soap_message_set_encoding_style (SoupSoapMessage *msg
,const char *enc_style
);
Sets the encodingStyle attribute on the current element to the
value of enc_style
.
|
the SoupSoapMessage. |
|
the new encodingStyle value |
void soup_soap_message_reset (SoupSoapMessage *msg
);
Resets the internal XML representation of the SOAP message.
|
the SoupSoapMessage. |
void soup_soap_message_persist (SoupSoapMessage *msg
);
Writes the serialized XML tree to the SoupMessage's buffer.
|
the SoupSoapMessage. |
const char * soup_soap_message_get_namespace_prefix (SoupSoapMessage *msg
,const char *ns_uri
);
Returns the namespace prefix for ns_uri
(or an empty string if
ns_uri
is set to the default namespace)
|
the SoupSoapMessage. |
|
the namespace URI. |
Returns : |
The namespace prefix, or NULL if no namespace exists
for the URI given. |
xmlDocPtr soup_soap_message_get_xml_doc (SoupSoapMessage *msg
);
Returns the internal XML representation tree of the
SoupSoapMessage pointed to by msg
.
|
the SoupSoapMessage. |
Returns : |
the xmlDocPtr representing the SOAP message. |
SoupSoapResponse * soup_soap_message_parse_response (SoupSoapMessage *msg
);
Parses the response returned by the server.
|
the SoupSoapMessage. |
Returns : |
a SoupSoapResponse representing the response from
the server, or NULL if there was an error. |