0be6d925dc
Which means that reduz' beloved style which we all became used to will now be changed automatically to remove the first empty line. This makes us lean closer to 1TBS (the one true brace style) instead of hybridating it with some Allman-inspired spacing. There's still the case of braces around single-statement blocks that needs to be addressed (but clang-format can't help with that, but clang-tidy may if we agree about it). Part of #33027.
80 lines
3.9 KiB
C++
80 lines
3.9 KiB
C++
/*************************************************************************/
|
|
/* net_socket.h */
|
|
/*************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/*************************************************************************/
|
|
/* Copyright (c) 2007-2020 Juan Linietsky, Ariel Manzur. */
|
|
/* Copyright (c) 2014-2020 Godot Engine contributors (cf. AUTHORS.md). */
|
|
/* */
|
|
/* Permission is hereby granted, free of charge, to any person obtaining */
|
|
/* a copy of this software and associated documentation files (the */
|
|
/* "Software"), to deal in the Software without restriction, including */
|
|
/* without limitation the rights to use, copy, modify, merge, publish, */
|
|
/* distribute, sublicense, and/or sell copies of the Software, and to */
|
|
/* permit persons to whom the Software is furnished to do so, subject to */
|
|
/* the following conditions: */
|
|
/* */
|
|
/* The above copyright notice and this permission notice shall be */
|
|
/* included in all copies or substantial portions of the Software. */
|
|
/* */
|
|
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
|
|
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
|
|
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
|
|
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
|
|
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
|
|
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
|
|
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
|
|
/*************************************************************************/
|
|
|
|
#ifndef NET_SOCKET_H
|
|
#define NET_SOCKET_H
|
|
|
|
#include "core/io/ip.h"
|
|
#include "core/reference.h"
|
|
|
|
class NetSocket : public Reference {
|
|
protected:
|
|
static NetSocket *(*_create)();
|
|
|
|
public:
|
|
static NetSocket *create();
|
|
|
|
enum PollType {
|
|
POLL_TYPE_IN,
|
|
POLL_TYPE_OUT,
|
|
POLL_TYPE_IN_OUT
|
|
};
|
|
|
|
enum Type {
|
|
TYPE_NONE,
|
|
TYPE_TCP,
|
|
TYPE_UDP,
|
|
};
|
|
|
|
virtual Error open(Type p_type, IP::Type &ip_type) = 0;
|
|
virtual void close() = 0;
|
|
virtual Error bind(IP_Address p_addr, uint16_t p_port) = 0;
|
|
virtual Error listen(int p_max_pending) = 0;
|
|
virtual Error connect_to_host(IP_Address p_addr, uint16_t p_port) = 0;
|
|
virtual Error poll(PollType p_type, int timeout) const = 0;
|
|
virtual Error recv(uint8_t *p_buffer, int p_len, int &r_read) = 0;
|
|
virtual Error recvfrom(uint8_t *p_buffer, int p_len, int &r_read, IP_Address &r_ip, uint16_t &r_port, bool p_peek = false) = 0;
|
|
virtual Error send(const uint8_t *p_buffer, int p_len, int &r_sent) = 0;
|
|
virtual Error sendto(const uint8_t *p_buffer, int p_len, int &r_sent, IP_Address p_ip, uint16_t p_port) = 0;
|
|
virtual Ref<NetSocket> accept(IP_Address &r_ip, uint16_t &r_port) = 0;
|
|
|
|
virtual bool is_open() const = 0;
|
|
virtual int get_available_bytes() const = 0;
|
|
|
|
virtual Error set_broadcasting_enabled(bool p_enabled) = 0; // Returns OK if the socket option has been set successfully.
|
|
virtual void set_blocking_enabled(bool p_enabled) = 0;
|
|
virtual void set_ipv6_only_enabled(bool p_enabled) = 0;
|
|
virtual void set_tcp_no_delay_enabled(bool p_enabled) = 0;
|
|
virtual void set_reuse_address_enabled(bool p_enabled) = 0;
|
|
virtual Error join_multicast_group(const IP_Address &p_multi_address, String p_if_name) = 0;
|
|
virtual Error leave_multicast_group(const IP_Address &p_multi_address, String p_if_name) = 0;
|
|
};
|
|
|
|
#endif // NET_SOCKET_H
|