Defines | |
| #define | BOOT_CHANNEL(connection, res) (vortex_xml_rpc_boot_channel_sync(connection, NULL, res, NULL, NULL)) |
| Allows to boot an XML-RPC channel, in a synchronous way, calling to vortex_xml_rpc_boot_channel_sync. | |
| #define | VORTEX_XML_RPC_PROFILE "http://iana.org/beep/xmlrpc" |
| Unique uri profile identificador for the XML-RPC. | |
| #define | XML_RPC_BOOT_STATE "vortex-xml-rpc:state" |
| String used to flag xml-rpc channel status. | |
| #define | XML_RPC_RESOURCE "vortex-xml-rpc:resource" |
| String used to flag xml-rpc channel resource used to boot. | |
Typedefs | |
| typedef void(* | VortexXmlRpcBootNotify )(VortexChannel *booted_channel, VortexStatus status, char *message, axlPointer user_data) |
| Async notification handler for the XML-RPC channel boot. | |
| typedef XmlRpcMethodResponse *(* | VortexXmlRpcServiceDispatch )(VortexChannel *channel, XmlRpcMethodCall *method_call, axlPointer user_data) |
| Async handler to process all incoming service invocation through XML-RPC. | |
| typedef axl_bool(* | VortexXmlRpcValidateResource )(VortexConnection *connection, int channel_number, const char *serverName, const char *resource_path, axlPointer user_data) |
| This async handler allows to control how is accepted XML-RPC initial boot channel based on a particular resource. | |
| typedef void(* | XmlRpcInvokeNotify )(VortexChannel *channel, XmlRpcMethodResponse *response, axlPointer user_data) |
| Async method response notifier. | |
Enumerations | |
| enum | VortexXmlRpcState { XmlRpcStateUnknown, XmlRpcStateBoot, XmlRpcStateReady } |
Enum value to represent XML-RPC channel initialization status. More... | |
Functions | |
| axl_bool | vortex_xml_rpc_accept_negotiation (VortexCtx *ctx, VortexXmlRpcValidateResource validate_resource, axlPointer validate_user_data, VortexXmlRpcServiceDispatch service_dispatch, axlPointer dispatch_user_data) |
| Allow to start receiving incoming XML-RPC request, setting two handlers to validate and process them. | |
| void | vortex_xml_rpc_boot_channel (VortexConnection *connection, const char *serverName, const char *resourceName, VortexXmlRpcBootNotify process_status, axlPointer user_data) |
| Perform initial boot step to get confirmation from remote server to accept incoming XML-RPC under the given resource. | |
| VortexChannel * | vortex_xml_rpc_boot_channel_sync (VortexConnection *connection, const char *serverName, const char *resourceName, VortexStatus *status, char **status_message) |
| Perform a synchronous (blocking) XML-RPC channel boot. | |
| const char * | vortex_xml_rpc_channel_get_resource (VortexChannel *channel) |
| Allows to get the channel resource used to boot the provided channel. | |
| VortexChannel * | vortex_xml_rpc_channel_pool_get_next (VortexConnection *connection, axl_bool auto_inc, int pool_id) |
| Allows to get next channel ready on the channel pool created on the connection provided. | |
| VortexXmlRpcState | vortex_xml_rpc_channel_status (VortexChannel *channel) |
| Allows to get current XML-RPC channel boot status for the given channel. | |
| void | vortex_xml_rpc_cleanup (VortexCtx *ctx) |
| Terminates the xml-rpc module state from the provided context. | |
| VortexChannelPool * | vortex_xml_rpc_create_channel_pool (VortexConnection *connection, const char *serverName, const char *resourceName, VortexOnChannelPoolCreated on_pool_created, axlPointer user_data) |
| Allows to create and attach a channel pool containing XML-RPC channels that are created using the provided serverName and resourceName value. | |
| axl_bool | vortex_xml_rpc_init (VortexCtx *ctx) |
| Inits the vortex xml-rpc module state. | |
| axl_bool | vortex_xml_rpc_invoke (VortexChannel *channel, XmlRpcMethodCall *method_call, XmlRpcInvokeNotify reply_notify, axlPointer user_data) |
| Perform an asynchronous invocation using the XML-RPC profile. | |
| XmlRpcMethodResponse * | vortex_xml_rpc_invoke_sync (VortexChannel *channel, XmlRpcMethodCall *method_call) |
| Perform a synchronous XML-RPC invocation using a method call already built over an already booted XML-RPC channel. | |
| axl_bool | vortex_xml_rpc_listener_parse_conf_and_start_listeners (VortexCtx *ctx) |
| Support function for xml-rpc listeners created by the xml-rpc-gen tool, that reads a xml file that contains listener information and starts the listener. | |
| axl_bool | vortex_xml_rpc_notify_reply (XmlRpcMethodCall *method_call, XmlRpcMethodResponse *method_response) |
| Allows to notify a reply that has been generated from the given XmlRpcMethodCall object. | |
| void | vortex_xml_rpc_unmarshall_array (VortexChannel *channel, XmlRpcMethodResponse *response, axlPointer user_data) |
| (Un)Marshaller function used by the xml-rpc-gen tool, at the client C stub generated used as XmlRpcInvokeNotify function. | |
| axlPointer | vortex_xml_rpc_unmarshall_array_sync (XmlRpcMethodResponse *response, XmlRpcArrayUnMarshaller unmarshaller, XmlRpcResponseStatus *status, VortexChannel *channel, int *fault_code, char **fault_string) |
| Gets the array value from the XmlRpcMethodResponse, setting the fault code and the fault string, releasing the XmlRpcMethodResponse passed in. | |
| void | vortex_xml_rpc_unmarshall_double (VortexChannel *channel, XmlRpcMethodResponse *response, axlPointer user_data) |
| (Un)Marshaller function used by the xml-rpc-gen tool, at the client C stub generated used as XmlRpcInvokeNotify function. | |
| double | vortex_xml_rpc_unmarshall_double_sync (XmlRpcMethodResponse *response, XmlRpcResponseStatus *status, VortexChannel *channel, int *fault_code, char **fault_string) |
| Gets the double value from the XmlRpcMethodResponse, setting the fault code and the fault string, releasing the XmlRpcMethodResponse passed in. | |
| void | vortex_xml_rpc_unmarshall_int (VortexChannel *channel, XmlRpcMethodResponse *response, axlPointer user_data) |
| (Un)Marshaller function used by the xml-rpc-gen tool, at the client C stub generated used as XmlRpcInvokeNotify function. | |
| int | vortex_xml_rpc_unmarshall_int_sync (XmlRpcMethodResponse *response, XmlRpcResponseStatus *status, VortexChannel *channel, int *fault_code, char **fault_string) |
| Gets the integer value from the XmlRpcMethodResponse, setting the fault code and the fault string, releasing the XmlRpcMethodResponse passed in. | |
| void | vortex_xml_rpc_unmarshall_string (VortexChannel *channel, XmlRpcMethodResponse *response, axlPointer user_data) |
| (Un)Marshaller function used by the xml-rpc-gen tool, at the client C stub generated used as XmlRpcInvokeNotify function. | |
| char * | vortex_xml_rpc_unmarshall_string_sync (XmlRpcMethodResponse *response, XmlRpcResponseStatus *status, VortexChannel *channel, int *fault_code, char **fault_string) |
| Gets the string value from the XmlRpcMethodResponse, setting the fault code and the fault string, releasing the XmlRpcMethodResponse passed in. | |
| void | vortex_xml_rpc_unmarshall_struct (VortexChannel *channel, XmlRpcMethodResponse *response, axlPointer user_data) |
| (Un)Marshaller function used by the xml-rpc-gen tool, at the client C stub generated used as XmlRpcInvokeNotify function. | |
| axlPointer | vortex_xml_rpc_unmarshall_struct_sync (XmlRpcMethodResponse *response, XmlRpcStructUnMarshaller unmarshaller, XmlRpcResponseStatus *status, VortexChannel *channel, int *fault_code, char **fault_string) |
| Gets the struct value from the XmlRpcMethodResponse, setting the fault code and the fault string, releasing the XmlRpcMethodResponse passed in. | |