1/**************************************************************************/
2/* webrtc_data_channel.h */
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#ifndef WEBRTC_DATA_CHANNEL_H
32#define WEBRTC_DATA_CHANNEL_H
33
34#include "core/io/packet_peer.h"
35
36class WebRTCDataChannel : public PacketPeer {
37 GDCLASS(WebRTCDataChannel, PacketPeer);
38
39public:
40 enum WriteMode {
41 WRITE_MODE_TEXT,
42 WRITE_MODE_BINARY,
43 };
44
45 enum ChannelState {
46 STATE_CONNECTING,
47 STATE_OPEN,
48 STATE_CLOSING,
49 STATE_CLOSED
50 };
51
52protected:
53 unsigned int _in_buffer_shift;
54
55 static void _bind_methods();
56
57public:
58 virtual void set_write_mode(WriteMode mode) = 0;
59 virtual WriteMode get_write_mode() const = 0;
60 virtual bool was_string_packet() const = 0;
61
62 virtual ChannelState get_ready_state() const = 0;
63 virtual String get_label() const = 0;
64 virtual bool is_ordered() const = 0;
65 virtual int get_id() const = 0;
66 virtual int get_max_packet_life_time() const = 0;
67 virtual int get_max_retransmits() const = 0;
68 virtual String get_protocol() const = 0;
69 virtual bool is_negotiated() const = 0;
70
71 virtual int get_buffered_amount() const = 0;
72
73 virtual Error poll() = 0;
74 virtual void close() = 0;
75
76 WebRTCDataChannel();
77 ~WebRTCDataChannel();
78};
79
80VARIANT_ENUM_CAST(WebRTCDataChannel::WriteMode);
81VARIANT_ENUM_CAST(WebRTCDataChannel::ChannelState);
82
83#endif // WEBRTC_DATA_CHANNEL_H
84