Vortex XML-RPC types: XML-RPC data abstraction layer, supporting types used.


Defines

#define CREATE_FAULT_REPLY(fault_code, fault_string)   vortex_xml_rpc_method_response_new (XML_RPC_FAIL, fault_code, fault_string, NULL);
 Creates a negative XmlRpcMethodResponse containing the provided fault code and fault string.
#define CREATE_OK_REPLY(type, value)   vortex_xml_rpc_method_response_create (type, value);
 Helper function to create positive XmlRpcMethodResponse objects by providing a reference to the XmlRpcMethodValue.
#define method_call_add_value   vortex_xml_rpc_method_call_add_value
 Alias definition for vortex_xml_rpc_method_call_add_value.
#define method_call_create_value   vortex_xml_rpc_method_call_create_value
 Alias definition for vortex_xml_rpc_method_call_create_value.
#define method_call_create_value_from_string   vortex_xml_rpc_method_call_create_value_from_string
 Alias definition for vortex_xml_rpc_method_call_create_value_from_string.
#define method_call_free   vortex_xml_rpc_method_call_free
 Alias definition for vortex_xml_rpc_method_call_free.
#define method_call_get_current_num_params   vortex_xml_rpc_method_call_get_current_num_params
 Alias definition for vortex_xml_rpc_method_call_get_current_num_params.
#define method_call_get_name   vortex_xml_rpc_method_call_get_name
 Alias definition for vortex_xml_rpc_method_call_get_name.
#define method_call_get_num_params   vortex_xml_rpc_method_call_get_num_params
 Alias definition for vortex_xml_rpc_method_call_get_num_params.
#define method_call_get_param_value   vortex_xml_rpc_method_call_get_param_value
 Alias definition for vortex_xml_rpc_method_call_get_param_value.
#define method_call_get_param_value_as_int   vortex_xml_rpc_method_call_get_param_value_as_int
 Alias definition for vortex_xml_rpc_method_call_get_param_value_as_int.
#define method_call_get_parma_value_as_double   vortex_xml_rpc_method_call_get_param_value_as_double
 Alias definition for vortex_xml_rpc_method_call_get_param_value_as_double.
#define method_call_get_parma_value_as_string   vortex_xml_rpc_method_call_get_param_value_as_string
 Alias definition for vortex_xml_rpc_method_call_get_param_value_as_string.
#define method_call_is   vortex_xml_rpc_method_call_is
 Alias definition for vortex_xml_rpc_method_call_is.
#define method_call_marshall   vortex_xml_rpc_method_call_marshall
 Alias definition for vortex_xml_rpc_method_call_marshall.
#define method_call_new   vortex_xml_rpc_method_call_new
 Alias definition for vortex_xml_rpc_method_call_new.
#define method_call_set_value   vortex_xml_rpc_method_call_set_value
 Alias definition for vortex_xml_rpc_method_call_set_value.
#define method_response_free   vortex_xml_rpc_method_response_free
 Alias definition for vortex_xml_rpc_method_response_free.
#define method_response_get_fault_code   vortex_xml_rpc_method_response_get_fault_code
 Alias definition for vortex_xml_rpc_method_response_get_fault_code.
#define method_response_get_fault_string   vortex_xml_rpc_method_response_get_fault_string
 Alias definition for vortex_xml_rpc_method_response_get_fault_string.
#define method_response_get_status   vortex_xml_rpc_method_response_get_status
 Alias definition for vortex_xml_rpc_method_response_get_status.
#define method_response_new   vortex_xml_rpc_method_response_new
 Alias definition for vortex_xml_rpc_method_response_new.
#define method_response_stringify   vortex_xml_rpc_method_response_stringify
 Alias definition for vortex_xml_rpc_method_response_stringify.
#define method_value_free   vortex_xml_rpc_method_value_free
 Alias definition for vortex_xml_rpc_method_value_free.
#define method_value_get_as_int   vortex_xml_rpc_method_value_get_as_int
 Alias definition for vortex_xml_rpc_method_value_get_as_int.
#define method_value_get_type   vortex_xml_rpc_method_value_get_type
 Alias definition for vortex_xml_rpc_method_value_get_type.
#define method_value_new   vortex_xml_rpc_method_value_new
 Alias definition for vortex_xml_rpc_method_value_new.
#define method_value_new_from_string   vortex_xml_rpc_method_value_new_from_string
 Alias definition for vortex_xml_rpc_method_value_new_from_string.
#define REPLY_FAULT(string, code, error)
 Perform an error reply inside a XML-RPC server stub implementation.

Typedefs

typedef _XmlRpcArray XmlRpcArray
 Abstraction of an array of values.
typedef _XmlRpcMethodCall XmlRpcMethodCall
 Represents an abstraction of a remote procedure invocation.
typedef _XmlRpcMethodResponse XmlRpcMethodResponse
 Abstraction to represent a method response object.
typedef _XmlRpcMethodValue XmlRpcMethodValue
 Abstraction of a value stored inside a method call or a method response.
typedef _XmlRpcStruct XmlRpcStruct
 Abstraction of a special value representing an struct.
typedef _XmlRpcStructMember XmlRpcStructMember
 Abstraction of a single member inside a struct.

Enumerations

enum  XmlRpcParamType {
  XML_RPC_UNKNOWN_VALUE = 1, XML_RPC_INT_VALUE = 2, XML_RPC_BOOLEAN_VALUE = 3, XML_RPC_DOUBLE_VALUE = 4,
  XML_RPC_STRING_VALUE = 5, XML_RPC_DATE_VALUE = 6, XML_RPC_BASE64_VALUE = 7, XML_RPC_STRUCT_VALUE = 8,
  XML_RPC_ARRAY_VALUE = 9
}
 Values supported to send as parameters for a method invocation and a method response. More...
enum  XmlRpcResponseStatus {
  XML_RPC_UNKNOWN_ERROR = -1, XML_RPC_OK = 1, XML_RPC_FAIL = -2, XML_RPC_CHANNEL_NOT_READY = -3,
  XML_RPC_NOT_XML_RPC_CHANNEL = -4, XML_RPC_WAITING_PREVIOUS = -5, XML_RPC_INVOCATION_FAILURE = -6, XML_RPC_TIMEOUT_ERROR = -7,
  XML_RPC_BAD_REPLY_RECEIVED = -8
}
 Represents current XmlRpc status operation. More...

Functions

void vortex_xml_rpc_method_call_add_value (XmlRpcMethodCall *method_call, XmlRpcMethodValue *value)
 Allows to add the given XmlRpcMethodValue in the next parameter position available.
void vortex_xml_rpc_method_call_create_value (XmlRpcMethodCall *method_call, XmlRpcParamType type, gpointer value)
 Convenience function to avoid XML-RPC API consumers to write to much code.
void vortex_xml_rpc_method_call_create_value_from_string (XmlRpcMethodCall *method_call, XmlRpcParamType type, gchar *string_value)
 Convenience function to avoid XML-RPC API consumers to write to much code.
void vortex_xml_rpc_method_call_free (XmlRpcMethodCall *method_call)
 Unref all memory allocated by the method call object and its childs, including method call values.
gint vortex_xml_rpc_method_call_get_current_num_params (XmlRpcMethodCall *method_call)
 Allows to get current number of parameters already added to the given XmlRpcMethodCall object.
gchar * vortex_xml_rpc_method_call_get_name (XmlRpcMethodCall *method_call)
 Allows to get current method name for the given XmlRpcMethodCall object.
gint vortex_xml_rpc_method_call_get_num_params (XmlRpcMethodCall *method_call)
 Allows to get which is the number of parameters that the given XmlRpcMethodCall object has.
XmlRpcMethodValuevortex_xml_rpc_method_call_get_param_value (XmlRpcMethodCall *method_call, gint position)
 Allows to get the param value (XmlRpcMethodValue) from the given XmlRpcMethodCall at the selected position.
gdouble vortex_xml_rpc_method_call_get_param_value_as_double (XmlRpcMethodCall *method_call, gint position)
 Allow to get current double value associated to the giveh XmlRpcMethodCall, at the given position for the parameter value.
gint vortex_xml_rpc_method_call_get_param_value_as_int (XmlRpcMethodCall *method_call, gint position)
 Helper function that allows to get the <integer> value from the given position for the arguments received inside the given XmlRpcMethodCall object.
gchar * vortex_xml_rpc_method_call_get_param_value_as_string (XmlRpcMethodCall *method_call, gint position)
 Convenience function to the the string associated to the given parameter, indentified by the position, inside the given XmlRpcMethodCall object.
gboolean vortex_xml_rpc_method_call_is (XmlRpcMethodCall *method_call, gchar *method_name, gint param_num,...)
 Allows to check if the given method call meets the requirements provided.
gchar * vortex_xml_rpc_method_call_marshall (XmlRpcMethodCall *method_call, gint *size)
 Perform a marshalling from the invocator provided (method_call) into the appropiate XML-RPC representation.
gboolean vortex_xml_rpc_method_call_must_release (XmlRpcMethodCall *method_call)
 Returns current status for releasing the given object after performing an invoke.
XmlRpcMethodCallvortex_xml_rpc_method_call_new (gchar *methodName, gint parameters)
 Creates a new method call object, representing a remote procedure invocation.
void vortex_xml_rpc_method_call_release_after_invoke (XmlRpcMethodCall *method_call, gboolean release)
 Allows to configure how the XML-RPC invocation mechanism manages invocator objects that have performed its invocation.
void vortex_xml_rpc_method_call_set_value (XmlRpcMethodCall *method_call, gint position, XmlRpcMethodValue *value)
 Allows to set a particular value at a particular position into the parameter invocation order.
XmlRpcMethodResponsevortex_xml_rpc_method_response_create (XmlRpcParamType type, gpointer value)
 Creates a new positive XmlRpcMethodResponse object, inserting a XmlRpcMethodValue instance created by providing the type and value this function receives.
void vortex_xml_rpc_method_response_free (XmlRpcMethodResponse *response)
 Deallocates the given XmlRpcMethodResponse object.
gint vortex_xml_rpc_method_response_get_fault_code (XmlRpcMethodResponse *response)
 Get current fault code from the given XmlRpcMethodResponse object.
gchar * vortex_xml_rpc_method_response_get_fault_string (XmlRpcMethodResponse *response)
 Get current fault string from the given XmlRpcMethodResponse object.
XmlRpcResponseStatus vortex_xml_rpc_method_response_get_status (XmlRpcMethodResponse *response)
 Returns current status for the invocation performed which has return the given XmlRpcMethodResponse.
gchar * vortex_xml_rpc_method_response_marshall (XmlRpcMethodResponse *response, gint *size)
 Allows to perform a marshalling operation into the XML representation for the given XmlRpcMethodResponse object.
XmlRpcMethodResponsevortex_xml_rpc_method_response_new (XmlRpcResponseStatus status, gint fault_code, gchar *fault_string, XmlRpcMethodValue *value)
 Allows to create a new XmlRpcMethodResponse object, representing a request reply having either a XmlRpcMethodValue or a error code with a fault string.
gchar * vortex_xml_rpc_method_response_stringify (XmlRpcMethodResponse *response)
 Allows to get a string representation for the XmlRpcMethodValue inside the given XmlRpcMethodResponse.
void vortex_xml_rpc_method_value_free (XmlRpcMethodValue *value)
 Perform a memory deallocation operation over the given value.
gint vortex_xml_rpc_method_value_get_as_int (XmlRpcMethodValue *value)
 Allows to get current integer value from the given method value object (XmlRpcMethodValue).
XmlRpcParamType vortex_xml_rpc_method_value_get_type (XmlRpcMethodValue *value)
 Allows to get current type for the given method value.
XmlRpcMethodValuevortex_xml_rpc_method_value_new (XmlRpcParamType type, gpointer value)
 Allows to create a new XmlRpcMethodValue object from the given type and the given value.
XmlRpcMethodValuevortex_xml_rpc_method_value_new_from_string (XmlRpcParamType type, gchar *string_value)
 Creates a new XmlRpcMethodValue object from the given type, using as value the string provided.