soup-xmlrpc.h 3.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697
  1. /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
  2. /*
  3. * Copyright 2015 - Collabora Ltd.
  4. */
  5. #ifndef SOUP_XMLRPC_H
  6. #define SOUP_XMLRPC_H 1
  7. #include <libsoup/soup-types.h>
  8. #include <libsoup/soup-xmlrpc-old.h>
  9. G_BEGIN_DECLS
  10. /* XML-RPC client */
  11. SOUP_AVAILABLE_IN_2_52
  12. char *soup_xmlrpc_build_request (const char *method_name,
  13. GVariant *params,
  14. GError **error);
  15. SOUP_AVAILABLE_IN_2_52
  16. SoupMessage *soup_xmlrpc_message_new (const char *uri,
  17. const char *method_name,
  18. GVariant *params,
  19. GError **error);
  20. SOUP_AVAILABLE_IN_2_52
  21. GVariant *soup_xmlrpc_parse_response (const char *method_response,
  22. int length,
  23. const char *signature,
  24. GError **error);
  25. /* XML-RPC server */
  26. typedef struct _SoupXMLRPCParams SoupXMLRPCParams;
  27. SOUP_AVAILABLE_IN_2_52
  28. void soup_xmlrpc_params_free (SoupXMLRPCParams *self);
  29. SOUP_AVAILABLE_IN_2_52
  30. GVariant *soup_xmlrpc_params_parse (SoupXMLRPCParams *self,
  31. const char *signature,
  32. GError **error);
  33. SOUP_AVAILABLE_IN_2_52
  34. char *soup_xmlrpc_parse_request (const char *method_call,
  35. int length,
  36. SoupXMLRPCParams **params,
  37. GError **error);
  38. SOUP_AVAILABLE_IN_2_52
  39. char *soup_xmlrpc_build_response (GVariant *value,
  40. GError **error);
  41. SOUP_AVAILABLE_IN_2_4
  42. char *soup_xmlrpc_build_fault (int fault_code,
  43. const char *fault_format,
  44. ...) G_GNUC_PRINTF (2, 3);
  45. SOUP_AVAILABLE_IN_2_52
  46. gboolean soup_xmlrpc_message_set_response (SoupMessage *msg,
  47. GVariant *value,
  48. GError **error);
  49. SOUP_AVAILABLE_IN_2_52
  50. void soup_xmlrpc_message_set_fault (SoupMessage *msg,
  51. int fault_code,
  52. const char *fault_format,
  53. ...) G_GNUC_PRINTF (3, 4);
  54. /* Utils */
  55. SOUP_AVAILABLE_IN_2_52
  56. GVariant *soup_xmlrpc_variant_new_datetime (SoupDate *date);
  57. SOUP_AVAILABLE_IN_2_52
  58. SoupDate *soup_xmlrpc_variant_get_datetime (GVariant *variant,
  59. GError **error);
  60. /* Errors */
  61. #define SOUP_XMLRPC_ERROR soup_xmlrpc_error_quark()
  62. SOUP_AVAILABLE_IN_2_4
  63. GQuark soup_xmlrpc_error_quark (void);
  64. typedef enum {
  65. SOUP_XMLRPC_ERROR_ARGUMENTS,
  66. SOUP_XMLRPC_ERROR_RETVAL
  67. } SoupXMLRPCError;
  68. #define SOUP_XMLRPC_FAULT soup_xmlrpc_fault_quark()
  69. SOUP_AVAILABLE_IN_2_4
  70. GQuark soup_xmlrpc_fault_quark (void);
  71. typedef enum {
  72. SOUP_XMLRPC_FAULT_PARSE_ERROR_NOT_WELL_FORMED = -32700,
  73. SOUP_XMLRPC_FAULT_PARSE_ERROR_UNSUPPORTED_ENCODING = -32701,
  74. SOUP_XMLRPC_FAULT_PARSE_ERROR_INVALID_CHARACTER_FOR_ENCODING = -32702,
  75. SOUP_XMLRPC_FAULT_SERVER_ERROR_INVALID_XML_RPC = -32600,
  76. SOUP_XMLRPC_FAULT_SERVER_ERROR_REQUESTED_METHOD_NOT_FOUND = -32601,
  77. SOUP_XMLRPC_FAULT_SERVER_ERROR_INVALID_METHOD_PARAMETERS = -32602,
  78. SOUP_XMLRPC_FAULT_SERVER_ERROR_INTERNAL_XML_RPC_ERROR = -32603,
  79. SOUP_XMLRPC_FAULT_APPLICATION_ERROR = -32500,
  80. SOUP_XMLRPC_FAULT_SYSTEM_ERROR = -32400,
  81. SOUP_XMLRPC_FAULT_TRANSPORT_ERROR = -32300
  82. } SoupXMLRPCFault;
  83. G_END_DECLS
  84. #endif /* SOUP_XMLRPC_H */