1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
|
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/*
* soup-websocket-extension.c
*
* Copyright (C) 2019 Igalia S.L.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include "soup-websocket-extension.h"
/**
* SECTION:soup-websocket-extension
* @short_description: a WebSocket extension
* @see_also: #SoupSession, #SoupWebsocketExtensionManager
*
* SoupWebsocketExtension is the base class for WebSocket extension objects.
*
* Since: 2.68
*/
/**
* SoupWebsocketExtensionClass:
* @parent_class: the parent class
* @configure: called to configure the extension with the given parameters
* @get_request_params: called by the client to build the request header.
* It should include the parameters string starting with ';'
* @get_response_params: called by the server to build the response header.
* It should include the parameters string starting with ';'
* @process_outgoing_message: called to process the payload data of a message
* before it's sent. Reserved bits of the header should be changed.
* @process_incoming_message: called to process the payload data of a message
* after it's received. Reserved bits of the header should be cleared.
*
* The class structure for the SoupWebsocketExtension.
*
* Since: 2.68
*/
G_DEFINE_ABSTRACT_TYPE (SoupWebsocketExtension, soup_websocket_extension, G_TYPE_OBJECT)
static void
soup_websocket_extension_init (SoupWebsocketExtension *extension)
{
}
static void
soup_websocket_extension_class_init (SoupWebsocketExtensionClass *auth_class)
{
}
/**
* soup_websocket_extension_configure:
* @extension: a #SoupWebsocketExtension
* @connection_type: either %SOUP_WEBSOCKET_CONNECTION_CLIENT or %SOUP_WEBSOCKET_CONNECTION_SERVER
* @params: (nullable): the parameters, or %NULL
* @error: return location for a #GError
*
* Configures @extension with the given @params
*
* Return value: %TRUE if extension could be configured with the given parameters, or %FALSE otherwise
*/
gboolean
soup_websocket_extension_configure (SoupWebsocketExtension *extension,
SoupWebsocketConnectionType connection_type,
GHashTable *params,
GError **error)
{
SoupWebsocketExtensionClass *klass;
g_return_val_if_fail (SOUP_IS_WEBSOCKET_EXTENSION (extension), FALSE);
g_return_val_if_fail (connection_type != SOUP_WEBSOCKET_CONNECTION_UNKNOWN, FALSE);
g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
klass = SOUP_WEBSOCKET_EXTENSION_GET_CLASS (extension);
if (!klass->configure)
return TRUE;
return klass->configure (extension, connection_type, params, error);
}
/**
* soup_websocket_extension_get_request_params:
* @extension: a #SoupWebsocketExtension
*
* Get the parameters strings to be included in the request header. If the extension
* doesn't include any parameter in the request, this function returns %NULL.
*
* Returns: (nullable) (transfer full): a new allocated string with the parameters
*
* Since: 2.68
*/
char *
soup_websocket_extension_get_request_params (SoupWebsocketExtension *extension)
{
SoupWebsocketExtensionClass *klass;
g_return_val_if_fail (SOUP_IS_WEBSOCKET_EXTENSION (extension), NULL);
klass = SOUP_WEBSOCKET_EXTENSION_GET_CLASS (extension);
if (!klass->get_request_params)
return NULL;
return klass->get_request_params (extension);
}
/**
* soup_websocket_extension_get_response_params:
* @extension: a #SoupWebsocketExtension
*
* Get the parameters strings to be included in the response header. If the extension
* doesn't include any parameter in the response, this function returns %NULL.
*
* Returns: (nullable) (transfer full): a new allocated string with the parameters
*
* Since: 2.68
*/
char *
soup_websocket_extension_get_response_params (SoupWebsocketExtension *extension)
{
SoupWebsocketExtensionClass *klass;
g_return_val_if_fail (SOUP_IS_WEBSOCKET_EXTENSION (extension), NULL);
klass = SOUP_WEBSOCKET_EXTENSION_GET_CLASS (extension);
if (!klass->get_response_params)
return NULL;
return klass->get_response_params (extension);
}
/**
* soup_websocket_extension_process_outgoing_message:
* @extension: a #SoupWebsocketExtension
* @header: (inout): the message header
* @payload: (transfer full): the payload data
* @error: return location for a #GError
*
* Process a message before it's sent. If the payload isn't changed the given
* @payload is just returned, otherwise g_bytes_unref() is called on the given
* @payload and a new #GBytes is returned with the new data.
*
* Extensions using reserved bits of the header will change them in @header.
*
* Returns: (transfer full): the message payload data, or %NULL in case of error
*
* Since: 2.68
*/
GBytes *
soup_websocket_extension_process_outgoing_message (SoupWebsocketExtension *extension,
guint8 *header,
GBytes *payload,
GError **error)
{
SoupWebsocketExtensionClass *klass;
g_return_val_if_fail (SOUP_IS_WEBSOCKET_EXTENSION (extension), NULL);
g_return_val_if_fail (header != NULL, NULL);
g_return_val_if_fail (payload != NULL, NULL);
g_return_val_if_fail (error == NULL || *error == NULL, NULL);
klass = SOUP_WEBSOCKET_EXTENSION_GET_CLASS (extension);
if (!klass->process_outgoing_message)
return payload;
return klass->process_outgoing_message (extension, header, payload, error);
}
/**
* soup_websocket_extension_process_incoming_message:
* @extension: a #SoupWebsocketExtension
* @header: (inout): the message header
* @payload: (transfer full): the payload data
* @error: return location for a #GError
*
* Process a message after it's received. If the payload isn't changed the given
* @payload is just returned, otherwise g_bytes_unref() is called on the given
* @payload and a new #GBytes is returned with the new data.
*
* Extensions using reserved bits of the header will reset them in @header.
*
* Returns: (transfer full): the message payload data, or %NULL in case of error
*
* Since: 2.68
*/
GBytes *
soup_websocket_extension_process_incoming_message (SoupWebsocketExtension *extension,
guint8 *header,
GBytes *payload,
GError **error)
{
SoupWebsocketExtensionClass *klass;
g_return_val_if_fail (SOUP_IS_WEBSOCKET_EXTENSION (extension), NULL);
g_return_val_if_fail (header != NULL, NULL);
g_return_val_if_fail (payload != NULL, NULL);
g_return_val_if_fail (error == NULL || *error == NULL, NULL);
klass = SOUP_WEBSOCKET_EXTENSION_GET_CLASS (extension);
if (!klass->process_incoming_message)
return payload;
return klass->process_incoming_message (extension, header, payload, error);
}
|
