1/**************************************************************************/
2/* websocket_peer.cpp */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#include "websocket_peer.h"
32
33WebSocketPeer *(*WebSocketPeer::_create)() = nullptr;
34
35WebSocketPeer::WebSocketPeer() {
36}
37
38WebSocketPeer::~WebSocketPeer() {
39}
40
41void WebSocketPeer::_bind_methods() {
42 ClassDB::bind_method(D_METHOD("connect_to_url", "url", "tls_client_options"), &WebSocketPeer::connect_to_url, DEFVAL(Ref<TLSOptions>()));
43 ClassDB::bind_method(D_METHOD("accept_stream", "stream"), &WebSocketPeer::accept_stream);
44 ClassDB::bind_method(D_METHOD("send", "message", "write_mode"), &WebSocketPeer::_send_bind, DEFVAL(WRITE_MODE_BINARY));
45 ClassDB::bind_method(D_METHOD("send_text", "message"), &WebSocketPeer::send_text);
46 ClassDB::bind_method(D_METHOD("was_string_packet"), &WebSocketPeer::was_string_packet);
47 ClassDB::bind_method(D_METHOD("poll"), &WebSocketPeer::poll);
48 ClassDB::bind_method(D_METHOD("close", "code", "reason"), &WebSocketPeer::close, DEFVAL(1000), DEFVAL(""));
49 ClassDB::bind_method(D_METHOD("get_connected_host"), &WebSocketPeer::get_connected_host);
50 ClassDB::bind_method(D_METHOD("get_connected_port"), &WebSocketPeer::get_connected_port);
51 ClassDB::bind_method(D_METHOD("get_selected_protocol"), &WebSocketPeer::get_selected_protocol);
52 ClassDB::bind_method(D_METHOD("get_requested_url"), &WebSocketPeer::get_requested_url);
53 ClassDB::bind_method(D_METHOD("set_no_delay", "enabled"), &WebSocketPeer::set_no_delay);
54 ClassDB::bind_method(D_METHOD("get_current_outbound_buffered_amount"), &WebSocketPeer::get_current_outbound_buffered_amount);
55
56 ClassDB::bind_method(D_METHOD("get_ready_state"), &WebSocketPeer::get_ready_state);
57 ClassDB::bind_method(D_METHOD("get_close_code"), &WebSocketPeer::get_close_code);
58 ClassDB::bind_method(D_METHOD("get_close_reason"), &WebSocketPeer::get_close_reason);
59
60 ClassDB::bind_method(D_METHOD("get_supported_protocols"), &WebSocketPeer::_get_supported_protocols);
61 ClassDB::bind_method(D_METHOD("set_supported_protocols", "protocols"), &WebSocketPeer::set_supported_protocols);
62 ClassDB::bind_method(D_METHOD("get_handshake_headers"), &WebSocketPeer::_get_handshake_headers);
63 ClassDB::bind_method(D_METHOD("set_handshake_headers", "protocols"), &WebSocketPeer::set_handshake_headers);
64
65 ClassDB::bind_method(D_METHOD("get_inbound_buffer_size"), &WebSocketPeer::get_inbound_buffer_size);
66 ClassDB::bind_method(D_METHOD("set_inbound_buffer_size", "buffer_size"), &WebSocketPeer::set_inbound_buffer_size);
67 ClassDB::bind_method(D_METHOD("get_outbound_buffer_size"), &WebSocketPeer::get_outbound_buffer_size);
68 ClassDB::bind_method(D_METHOD("set_outbound_buffer_size", "buffer_size"), &WebSocketPeer::set_outbound_buffer_size);
69
70 ClassDB::bind_method(D_METHOD("set_max_queued_packets", "buffer_size"), &WebSocketPeer::set_max_queued_packets);
71 ClassDB::bind_method(D_METHOD("get_max_queued_packets"), &WebSocketPeer::get_max_queued_packets);
72
73 ADD_PROPERTY(PropertyInfo(Variant::PACKED_STRING_ARRAY, "supported_protocols"), "set_supported_protocols", "get_supported_protocols");
74 ADD_PROPERTY(PropertyInfo(Variant::PACKED_STRING_ARRAY, "handshake_headers"), "set_handshake_headers", "get_handshake_headers");
75
76 ADD_PROPERTY(PropertyInfo(Variant::INT, "inbound_buffer_size"), "set_inbound_buffer_size", "get_inbound_buffer_size");
77 ADD_PROPERTY(PropertyInfo(Variant::INT, "outbound_buffer_size"), "set_outbound_buffer_size", "get_outbound_buffer_size");
78
79 ADD_PROPERTY(PropertyInfo(Variant::INT, "max_queued_packets"), "set_max_queued_packets", "get_max_queued_packets");
80
81 BIND_ENUM_CONSTANT(WRITE_MODE_TEXT);
82 BIND_ENUM_CONSTANT(WRITE_MODE_BINARY);
83
84 BIND_ENUM_CONSTANT(STATE_CONNECTING);
85 BIND_ENUM_CONSTANT(STATE_OPEN);
86 BIND_ENUM_CONSTANT(STATE_CLOSING);
87 BIND_ENUM_CONSTANT(STATE_CLOSED);
88}
89
90Error WebSocketPeer::_send_bind(const PackedByteArray &p_message, WriteMode p_mode) {
91 return send(p_message.ptr(), p_message.size(), p_mode);
92}
93
94Error WebSocketPeer::send_text(const String &p_text) {
95 const CharString cs = p_text.utf8();
96 return send((const uint8_t *)cs.ptr(), cs.length(), WRITE_MODE_TEXT);
97}
98
99void WebSocketPeer::set_supported_protocols(const Vector<String> &p_protocols) {
100 // Strip edges from protocols.
101 supported_protocols.resize(p_protocols.size());
102 for (int i = 0; i < p_protocols.size(); i++) {
103 supported_protocols.write[i] = p_protocols[i].strip_edges();
104 }
105}
106
107const Vector<String> WebSocketPeer::get_supported_protocols() const {
108 return supported_protocols;
109}
110
111Vector<String> WebSocketPeer::_get_supported_protocols() const {
112 Vector<String> out;
113 out.append_array(supported_protocols);
114 return out;
115}
116
117void WebSocketPeer::set_handshake_headers(const Vector<String> &p_headers) {
118 handshake_headers = p_headers;
119}
120
121const Vector<String> WebSocketPeer::get_handshake_headers() const {
122 return handshake_headers;
123}
124
125Vector<String> WebSocketPeer::_get_handshake_headers() const {
126 Vector<String> out;
127 out.append_array(handshake_headers);
128 return out;
129}
130
131void WebSocketPeer::set_outbound_buffer_size(int p_buffer_size) {
132 outbound_buffer_size = p_buffer_size;
133}
134
135int WebSocketPeer::get_outbound_buffer_size() const {
136 return outbound_buffer_size;
137}
138
139void WebSocketPeer::set_inbound_buffer_size(int p_buffer_size) {
140 inbound_buffer_size = p_buffer_size;
141}
142
143int WebSocketPeer::get_inbound_buffer_size() const {
144 return inbound_buffer_size;
145}
146
147void WebSocketPeer::set_max_queued_packets(int p_max_queued_packets) {
148 max_queued_packets = p_max_queued_packets;
149}
150
151int WebSocketPeer::get_max_queued_packets() const {
152 return max_queued_packets;
153}
154