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
|
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/*
* soup-websocket.h: This file was originally part of Cockpit.
*
* Copyright 2013, 2014 Red Hat, Inc.
*
* Cockpit is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 2.1 of the License, or
* (at your option) any later version.
*
* Cockpit 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library; If not, see <http://www.gnu.org/licenses/>.
*/
#pragma once
#include "soup-types.h"
G_BEGIN_DECLS
#define SOUP_WEBSOCKET_ERROR (soup_websocket_error_get_quark ())
SOUP_AVAILABLE_IN_2_50
GQuark soup_websocket_error_get_quark (void) G_GNUC_CONST;
typedef enum {
SOUP_WEBSOCKET_ERROR_FAILED,
SOUP_WEBSOCKET_ERROR_NOT_WEBSOCKET,
SOUP_WEBSOCKET_ERROR_BAD_HANDSHAKE,
SOUP_WEBSOCKET_ERROR_BAD_ORIGIN,
} SoupWebsocketError;
typedef enum {
SOUP_WEBSOCKET_CONNECTION_UNKNOWN,
SOUP_WEBSOCKET_CONNECTION_CLIENT,
SOUP_WEBSOCKET_CONNECTION_SERVER
} SoupWebsocketConnectionType;
typedef enum {
SOUP_WEBSOCKET_DATA_TEXT = 0x01,
SOUP_WEBSOCKET_DATA_BINARY = 0x02,
} SoupWebsocketDataType;
typedef enum {
SOUP_WEBSOCKET_CLOSE_NORMAL = 1000,
SOUP_WEBSOCKET_CLOSE_GOING_AWAY = 1001,
SOUP_WEBSOCKET_CLOSE_PROTOCOL_ERROR = 1002,
SOUP_WEBSOCKET_CLOSE_UNSUPPORTED_DATA = 1003,
SOUP_WEBSOCKET_CLOSE_NO_STATUS = 1005,
SOUP_WEBSOCKET_CLOSE_ABNORMAL = 1006,
SOUP_WEBSOCKET_CLOSE_BAD_DATA = 1007,
SOUP_WEBSOCKET_CLOSE_POLICY_VIOLATION = 1008,
SOUP_WEBSOCKET_CLOSE_TOO_BIG = 1009,
SOUP_WEBSOCKET_CLOSE_NO_EXTENSION = 1010,
SOUP_WEBSOCKET_CLOSE_SERVER_ERROR = 1011,
SOUP_WEBSOCKET_CLOSE_TLS_HANDSHAKE = 1015,
} SoupWebsocketCloseCode;
typedef enum {
SOUP_WEBSOCKET_STATE_OPEN = 1,
SOUP_WEBSOCKET_STATE_CLOSING = 2,
SOUP_WEBSOCKET_STATE_CLOSED = 3,
} SoupWebsocketState;
SOUP_AVAILABLE_IN_2_50
void soup_websocket_client_prepare_handshake (SoupMessage *msg,
const char *origin,
char **protocols);
SOUP_AVAILABLE_IN_2_68
void soup_websocket_client_prepare_handshake_with_extensions (SoupMessage *msg,
const char *origin,
char **protocols,
GPtrArray *supported_extensions);
SOUP_AVAILABLE_IN_2_50
gboolean soup_websocket_client_verify_handshake (SoupMessage *msg,
GError **error);
SOUP_AVAILABLE_IN_2_68
gboolean soup_websocket_client_verify_handshake_with_extensions (SoupMessage *msg,
GPtrArray *supported_extensions,
GList **accepted_extensions,
GError **error);
SOUP_AVAILABLE_IN_2_50
gboolean soup_websocket_server_check_handshake (SoupMessage *msg,
const char *origin,
char **protocols,
GError **error);
SOUP_AVAILABLE_IN_2_68
gboolean
soup_websocket_server_check_handshake_with_extensions (SoupMessage *msg,
const char *origin,
char **protocols,
GPtrArray *supported_extensions,
GError **error);
SOUP_AVAILABLE_IN_2_50
gboolean soup_websocket_server_process_handshake (SoupMessage *msg,
const char *expected_origin,
char **protocols);
SOUP_AVAILABLE_IN_2_68
gboolean
soup_websocket_server_process_handshake_with_extensions (SoupMessage *msg,
const char *expected_origin,
char **protocols,
GPtrArray *supported_extensions,
GList **accepted_extensions);
G_END_DECLS
|
