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
|
/*
* QEMU I/O channels driver websockets
*
* Copyright (c) 2015 Red Hat, Inc.
*
* This library 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.
*
* 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
* 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/>.
*
*/
#ifndef QIO_CHANNEL_WEBSOCK_H
#define QIO_CHANNEL_WEBSOCK_H
#include "io/channel.h"
#include "qemu/buffer.h"
#include "io/task.h"
#include "qom/object.h"
#define TYPE_QIO_CHANNEL_WEBSOCK "qio-channel-websock"
OBJECT_DECLARE_SIMPLE_TYPE(QIOChannelWebsock, QIO_CHANNEL_WEBSOCK)
typedef union QIOChannelWebsockMask QIOChannelWebsockMask;
union QIOChannelWebsockMask {
char c[4];
uint32_t u;
};
/**
* QIOChannelWebsock
*
* The QIOChannelWebsock class provides a channel wrapper which
* can transparently run the HTTP websockets protocol. This is
* usually used over a TCP socket, but there is actually no
* technical restriction on which type of master channel is
* used as the transport.
*
* This channel object is currently only capable of running as
* a websocket server and is a pretty crude implementation
* of it, not supporting the full websockets protocol feature
* set. It is sufficient to use with a simple websockets
* client for encapsulating VNC for noVNC in-browser client.
*/
struct QIOChannelWebsock {
QIOChannel parent;
QIOChannel *master;
Buffer encinput;
Buffer encoutput;
Buffer rawinput;
size_t payload_remain;
size_t pong_remain;
QIOChannelWebsockMask mask;
guint io_tag;
Error *io_err;
gboolean io_eof;
uint8_t opcode;
};
/**
* qio_channel_websock_new_server:
* @master: the underlying channel object
*
* Create a new websockets channel that runs the server
* side of the protocol.
*
* After creating the channel, it is mandatory to call
* the qio_channel_websock_handshake() method before attempting
* todo any I/O on the channel.
*
* Once the handshake has completed, all I/O should be done
* via the new websocket channel object and not the original
* master channel
*
* Returns: the new websockets channel object
*/
QIOChannelWebsock *
qio_channel_websock_new_server(QIOChannel *master);
/**
* qio_channel_websock_handshake:
* @ioc: the websocket channel object
* @func: the callback to invoke when completed
* @opaque: opaque data to pass to @func
* @destroy: optional callback to free @opaque
*
* Perform the websocket handshake. This method
* will return immediately and the handshake will
* continue in the background, provided the main
* loop is running. When the handshake is complete,
* or fails, the @func callback will be invoked.
*/
void qio_channel_websock_handshake(QIOChannelWebsock *ioc,
QIOTaskFunc func,
gpointer opaque,
GDestroyNotify destroy);
#endif /* QIO_CHANNEL_WEBSOCK_H */
|
