1/**************************************************************************/
2/* net_socket.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 NET_SOCKET_H
32#define NET_SOCKET_H
33
34#include "core/io/ip.h"
35#include "core/object/ref_counted.h"
36
37class NetSocket : public RefCounted {
38protected:
39 static NetSocket *(*_create)();
40
41public:
42 static NetSocket *create();
43
44 enum PollType {
45 POLL_TYPE_IN,
46 POLL_TYPE_OUT,
47 POLL_TYPE_IN_OUT
48 };
49
50 enum Type {
51 TYPE_NONE,
52 TYPE_TCP,
53 TYPE_UDP,
54 };
55
56 virtual Error open(Type p_type, IP::Type &ip_type) = 0;
57 virtual void close() = 0;
58 virtual Error bind(IPAddress p_addr, uint16_t p_port) = 0;
59 virtual Error listen(int p_max_pending) = 0;
60 virtual Error connect_to_host(IPAddress p_addr, uint16_t p_port) = 0;
61 virtual Error poll(PollType p_type, int timeout) const = 0;
62 virtual Error recv(uint8_t *p_buffer, int p_len, int &r_read) = 0;
63 virtual Error recvfrom(uint8_t *p_buffer, int p_len, int &r_read, IPAddress &r_ip, uint16_t &r_port, bool p_peek = false) = 0;
64 virtual Error send(const uint8_t *p_buffer, int p_len, int &r_sent) = 0;
65 virtual Error sendto(const uint8_t *p_buffer, int p_len, int &r_sent, IPAddress p_ip, uint16_t p_port) = 0;
66 virtual Ref<NetSocket> accept(IPAddress &r_ip, uint16_t &r_port) = 0;
67
68 virtual bool is_open() const = 0;
69 virtual int get_available_bytes() const = 0;
70 virtual Error get_socket_address(IPAddress *r_ip, uint16_t *r_port) const = 0;
71
72 virtual Error set_broadcasting_enabled(bool p_enabled) = 0; // Returns OK if the socket option has been set successfully.
73 virtual void set_blocking_enabled(bool p_enabled) = 0;
74 virtual void set_ipv6_only_enabled(bool p_enabled) = 0;
75 virtual void set_tcp_no_delay_enabled(bool p_enabled) = 0;
76 virtual void set_reuse_address_enabled(bool p_enabled) = 0;
77 virtual Error join_multicast_group(const IPAddress &p_multi_address, String p_if_name) = 0;
78 virtual Error leave_multicast_group(const IPAddress &p_multi_address, String p_if_name) = 0;
79};
80
81#endif // NET_SOCKET_H
82