soup-websocket-extension.h 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100
  1. /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
  2. /*
  3. * soup-websocket-extension.h
  4. *
  5. * Copyright (C) 2019 Igalia S.L.
  6. *
  7. * This library is free software; you can redistribute it and/or
  8. * modify it under the terms of the GNU Library General Public
  9. * License as published by the Free Software Foundation; either
  10. * version 2 of the License, or (at your option) any later version.
  11. *
  12. * This library is distributed in the hope that it will be useful,
  13. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  15. * Library General Public License for more details.
  16. *
  17. * You should have received a copy of the GNU Library General Public License
  18. * along with this library; see the file COPYING.LIB. If not, write to
  19. * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  20. * Boston, MA 02110-1301, USA.
  21. */
  22. #ifndef __SOUP_WEBSOCKET_EXTENSION_H__
  23. #define __SOUP_WEBSOCKET_EXTENSION_H__ 1
  24. #include <libsoup/soup-types.h>
  25. #include <libsoup/soup-websocket.h>
  26. G_BEGIN_DECLS
  27. #define SOUP_TYPE_WEBSOCKET_EXTENSION (soup_websocket_extension_get_type ())
  28. #define SOUP_WEBSOCKET_EXTENSION(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), SOUP_TYPE_WEBSOCKET_EXTENSION, SoupWebsocketExtension))
  29. #define SOUP_IS_WEBSOCKET_EXTENSION(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), SOUP_TYPE_WEBSOCKET_EXTENSION))
  30. #define SOUP_WEBSOCKET_EXTENSION_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), SOUP_TYPE_WEBSOCKET_EXTENSION, SoupWebsocketExtensionClass))
  31. #define SOUP_IS_WEBSOCKET_EXTENSION_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((obj), SOUP_TYPE_WEBSOCKET_EXTENSION))
  32. #define SOUP_WEBSOCKET_EXTENSION_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), SOUP_TYPE_WEBSOCKET_EXTENSION, SoupWebsocketExtensionClass))
  33. struct _SoupWebsocketExtension {
  34. GObject parent;
  35. };
  36. typedef struct {
  37. GObjectClass parent_class;
  38. const char *name;
  39. gboolean (* configure) (SoupWebsocketExtension *extension,
  40. SoupWebsocketConnectionType connection_type,
  41. GHashTable *params,
  42. GError **error);
  43. char *(* get_request_params) (SoupWebsocketExtension *extension);
  44. char *(* get_response_params) (SoupWebsocketExtension *extension);
  45. GBytes *(* process_outgoing_message) (SoupWebsocketExtension *extension,
  46. guint8 *header,
  47. GBytes *payload,
  48. GError **error);
  49. GBytes *(* process_incoming_message) (SoupWebsocketExtension *extension,
  50. guint8 *header,
  51. GBytes *payload,
  52. GError **error);
  53. /* Padding for future expansion */
  54. void (*_libsoup_reserved1) (void);
  55. void (*_libsoup_reserved2) (void);
  56. void (*_libsoup_reserved3) (void);
  57. void (*_libsoup_reserved4) (void);
  58. } SoupWebsocketExtensionClass;
  59. SOUP_AVAILABLE_IN_2_68
  60. GType soup_websocket_extension_get_type (void);
  61. SOUP_AVAILABLE_IN_2_68
  62. gboolean soup_websocket_extension_configure (SoupWebsocketExtension *extension,
  63. SoupWebsocketConnectionType connection_type,
  64. GHashTable *params,
  65. GError **error);
  66. SOUP_AVAILABLE_IN_2_68
  67. char *soup_websocket_extension_get_request_params (SoupWebsocketExtension *extension);
  68. SOUP_AVAILABLE_IN_2_68
  69. char *soup_websocket_extension_get_response_params (SoupWebsocketExtension *extension);
  70. SOUP_AVAILABLE_IN_2_68
  71. GBytes *soup_websocket_extension_process_outgoing_message (SoupWebsocketExtension *extension,
  72. guint8 *header,
  73. GBytes *payload,
  74. GError **error);
  75. SOUP_AVAILABLE_IN_2_68
  76. GBytes *soup_websocket_extension_process_incoming_message (SoupWebsocketExtension *extension,
  77. guint8 *header,
  78. GBytes *payload,
  79. GError **error);
  80. G_END_DECLS
  81. #endif /* __SOUP_WEBSOCKET_EXTENSION_H__ */