1/**************************************************************************/
2/* net_socket_posix.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_POSIX_H
32#define NET_SOCKET_POSIX_H
33
34#include "core/io/net_socket.h"
35
36#if defined(WINDOWS_ENABLED)
37#include <winsock2.h>
38#include <ws2tcpip.h>
39#define SOCKET_TYPE SOCKET
40
41#else
42#include <sys/socket.h>
43#define SOCKET_TYPE int
44
45#endif
46
47class NetSocketPosix : public NetSocket {
48private:
49 SOCKET_TYPE _sock; // NOLINT - the default value is defined in the .cpp
50 IP::Type _ip_type = IP::TYPE_NONE;
51 bool _is_stream = false;
52
53 enum NetError {
54 ERR_NET_WOULD_BLOCK,
55 ERR_NET_IS_CONNECTED,
56 ERR_NET_IN_PROGRESS,
57 ERR_NET_ADDRESS_INVALID_OR_UNAVAILABLE,
58 ERR_NET_UNAUTHORIZED,
59 ERR_NET_BUFFER_TOO_SMALL,
60 ERR_NET_OTHER,
61 };
62
63 NetError _get_socket_error() const;
64 void _set_socket(SOCKET_TYPE p_sock, IP::Type p_ip_type, bool p_is_stream);
65 _FORCE_INLINE_ Error _change_multicast_group(IPAddress p_ip, String p_if_name, bool p_add);
66 _FORCE_INLINE_ void _set_close_exec_enabled(bool p_enabled);
67
68protected:
69 static NetSocket *_create_func();
70
71 bool _can_use_ip(const IPAddress &p_ip, const bool p_for_bind) const;
72
73public:
74 static void make_default();
75 static void cleanup();
76 static void _set_ip_port(struct sockaddr_storage *p_addr, IPAddress *r_ip, uint16_t *r_port);
77 static size_t _set_addr_storage(struct sockaddr_storage *p_addr, const IPAddress &p_ip, uint16_t p_port, IP::Type p_ip_type);
78
79 virtual Error open(Type p_sock_type, IP::Type &ip_type);
80 virtual void close();
81 virtual Error bind(IPAddress p_addr, uint16_t p_port);
82 virtual Error listen(int p_max_pending);
83 virtual Error connect_to_host(IPAddress p_host, uint16_t p_port);
84 virtual Error poll(PollType p_type, int timeout) const;
85 virtual Error recv(uint8_t *p_buffer, int p_len, int &r_read);
86 virtual Error recvfrom(uint8_t *p_buffer, int p_len, int &r_read, IPAddress &r_ip, uint16_t &r_port, bool p_peek = false);
87 virtual Error send(const uint8_t *p_buffer, int p_len, int &r_sent);
88 virtual Error sendto(const uint8_t *p_buffer, int p_len, int &r_sent, IPAddress p_ip, uint16_t p_port);
89 virtual Ref<NetSocket> accept(IPAddress &r_ip, uint16_t &r_port);
90
91 virtual bool is_open() const;
92 virtual int get_available_bytes() const;
93 virtual Error get_socket_address(IPAddress *r_ip, uint16_t *r_port) const;
94
95 virtual Error set_broadcasting_enabled(bool p_enabled);
96 virtual void set_blocking_enabled(bool p_enabled);
97 virtual void set_ipv6_only_enabled(bool p_enabled);
98 virtual void set_tcp_no_delay_enabled(bool p_enabled);
99 virtual void set_reuse_address_enabled(bool p_enabled);
100 virtual void set_reuse_port_enabled(bool p_enabled);
101 virtual Error join_multicast_group(const IPAddress &p_multi_address, String p_if_name);
102 virtual Error leave_multicast_group(const IPAddress &p_multi_address, String p_if_name);
103
104 NetSocketPosix();
105 ~NetSocketPosix();
106};
107
108#endif // NET_SOCKET_POSIX_H
109