soup_xmlrpc_build_request ()

char *
soup_xmlrpc_build_request (const char *method_name,
                           GVariant *params,
                           GError **error);

This creates an XML-RPC methodCall and returns it as a string. This is the low-level method that soup_xmlrpc_message_new() is built on.

params is a GVariant tuple representing the method parameters.

Serialization details:

If params is floating, it is consumed.

Since 2.52

soup_xmlrpc_message_new ()

SoupMessage *
soup_xmlrpc_message_new (const char *uri,
                         const char *method_name,
                         GVariant *params,
                         GError **error);

Creates an XML-RPC methodCall and returns a SoupMessage, ready to send, for that method call.

See soup_xmlrpc_build_request() for serialization details.

If params is floating, it is consumed.

Since 2.52

soup_xmlrpc_parse_response ()

GVariant *
soup_xmlrpc_parse_response (const char *method_response,
                            int length,
                            const char *signature,
                            GError **error);

Parses method_response and returns the return value. If method_response is a fault, NULL is returned, and error will be set to an error in the SOUP_XMLRPC_FAULT domain, with the error code containing the fault code, and the error message containing the fault string. If method_response cannot be parsed, NULL is returned, and error will be set to an error in the SOUP_XMLRPC_ERROR domain.

See soup_xmlrpc_params_parse() for deserialization details.

Since 2.52

soup_xmlrpc_variant_new_datetime ()

GVariant *
soup_xmlrpc_variant_new_datetime (SoupDate *date);

Construct a special GVariant used to serialize a <dateTime.iso8601> node. See soup_xmlrpc_build_request().

The actual type of the returned GVariant is unspecified and "v" or "*" should be used in variant format strings. For example:

1

args = g_variant_new ("(v)", soup_xmlrpc_variant_new_datetime (date));

Since 2.52

soup_xmlrpc_variant_get_datetime ()

SoupDate *
soup_xmlrpc_variant_get_datetime (GVariant *variant,
                                  GError **error);

Get the SoupDate from special GVariant created by soup_xmlrpc_variant_new_datetime() or by parsing a <dateTime.iso8601> node. See soup_xmlrpc_params_parse().

If variant does not contain a datetime it will return an error but it is not considered a programmer error because it generally means parameters received are not in the expected type.

Since 2.52

soup_xmlrpc_params_free ()

void
soup_xmlrpc_params_free (SoupXMLRPCParams *self);

Free a SoupXMLRPCParams returned by soup_xmlrpc_parse_request().

Since 2.52

soup_xmlrpc_params_parse ()

GVariant *
soup_xmlrpc_params_parse (SoupXMLRPCParams *self,
                          const char *signature,
                          GError **error);

Parse method parameters returned by soup_xmlrpc_parse_request().

Deserialization details:

Since 2.52

soup_xmlrpc_parse_request ()

char *
soup_xmlrpc_parse_request (const char *method_call,
                           int length,
                           SoupXMLRPCParams **params,
                           GError **error);

Parses method_call and return the method name. Method parameters can be parsed later using soup_xmlrpc_params_parse().

Since 2.52

soup_xmlrpc_build_response ()

char *
soup_xmlrpc_build_response (GVariant *value,
                            GError **error);

This creates a (successful) XML-RPC methodResponse and returns it as a string. To create a fault response, use soup_xmlrpc_build_fault(). This is the low-level method that soup_xmlrpc_message_set_response() is built on.

See soup_xmlrpc_build_request() for serialization details, but note that since a method can only have a single return value, value should not be a tuple here (unless the return value is an array).

If value is floating, it is consumed.

Since 2.52

soup_xmlrpc_build_fault ()

char *
soup_xmlrpc_build_fault (int fault_code,
                         const char *fault_format,
                         ...);

This creates an XML-RPC fault response and returns it as a string. (To create a successful response, use soup_xmlrpc_build_method_response().)

soup_xmlrpc_message_set_response ()

gboolean
soup_xmlrpc_message_set_response (SoupMessage *msg,
                                  GVariant *value,
                                  GError **error);

Sets the status code and response body of msg to indicate a successful XML-RPC call, with a return value given by value . To set a fault response, use soup_xmlrpc_message_set_fault().

See soup_xmlrpc_build_request() for serialization details.

If value is floating, it is consumed.

Since 2.52

soup_xmlrpc_message_set_fault ()

void
soup_xmlrpc_message_set_fault (SoupMessage *msg,
                               int fault_code,
                               const char *fault_format,
                               ...);

Sets the status code and response body of msg to indicate an unsuccessful XML-RPC call, with the error described by fault_code and fault_format .

Since 2.52

SOUP_XMLRPC_ERROR

#define SOUP_XMLRPC_ERROR soup_xmlrpc_error_quark()

enum SoupXMLRPCError

SOUP_XMLRPC_FAULT

#define SOUP_XMLRPC_FAULT soup_xmlrpc_fault_quark()

A GError domain representing an XML-RPC fault code. Used with SoupXMLRPCFault (although servers may also return fault codes not in that enumeration).

enum SoupXMLRPCFault

Pre-defined XML-RPC fault codes from http://xmlrpc-epi.sourceforge.net/specs/rfc.fault_codes.php. These are an extension, not part of the XML-RPC spec; you can't assume servers will use them.

SoupXMLRPCParams

typedef struct _SoupXMLRPCParams SoupXMLRPCParams;

Opaque structure containing XML-RPC methodCall parameter values. Can be parsed using soup_xmlrpc_params_parse() and freed with soup_xmlrpc_params_free().

Since 2.52