4#include "../Foundation/AlignedStorage.h"
5#include "../Foundation/Result.h"
6#include "../Foundation/StringSpan.h"
7#include "../Foundation/UniqueHandle.h"
18#if SC_PLATFORM_WINDOWS
20struct SocketDescriptorDefinition
23 static Result releaseHandle(Handle& handle);
25 static constexpr Handle Invalid = ~static_cast<Handle>(0);
30struct SocketDescriptorDefinition
33 static Result releaseHandle(Handle& handle);
35 static constexpr Handle Invalid = -1;
89 friend struct SocketIPAddressInternal;
90 [[nodiscard]]
static AddressFamily AddressFamilyFromInt(
int value);
91 [[nodiscard]]
static unsigned char toNative(
AddressFamily family);
92 [[nodiscard]]
static SocketType SocketTypeFromInt(
int value);
93 [[nodiscard]]
static int toNative(
SocketType family);
95 [[nodiscard]]
static ProtocolType ProtocolTypeFromInt(
int value);
143 return formatAddress(buffer);
unsigned short uint16_t
Platform independent (2) bytes unsigned int.
Definition PrimitiveTypes.h:37
unsigned long size_t
Platform independent unsigned size type.
Definition PrimitiveTypes.h:56
unsigned int uint32_t
Platform independent (4) bytes unsigned int.
Definition PrimitiveTypes.h:38
long long int64_t
Platform independent (8) bytes signed int.
Definition PrimitiveTypes.h:50
A buffer of bytes with given alignment.
Definition AlignedStorage.h:29
An ascii string used as boolean result. SC_TRY macro forwards errors to caller.
Definition Result.h:12
Use a SocketDescriptor as a client (example a TCP or UDP socket client).
Definition Socket.h:249
Result read(Span< char > data, Span< char > &readData)
Read bytes from this socket blocking until they're actually received.
SocketClient(const SocketDescriptor &socket)
Constructs this SocketClient from a SocketDescriptor (already created with SocketDescriptor::create)
Definition Socket.h:252
Result connect(StringSpan address, uint16_t port)
Connect to a given address and port combination.
Result connect(SocketIPAddress ipAddress)
Connect to a given address and port combination.
Result readWithTimeout(Span< char > data, Span< char > &readData, int64_t timeout)
Read bytes from this socket blocking until they're actually received or timeout occurs.
Result write(Span< const char > data)
Writes bytes to this socket.
Synchronous DNS Resolution.
Definition Socket.h:293
static Result resolveDNS(StringSpan host, Span< char > &ipAddress)
Resolve an host string to an ip address (blocking until DNS response arrives)
Low-level OS socket handle.
Definition Socket.h:163
Result shutdown(SocketFlags::ShutdownType shutdownType)
Shuts down the socket for reading, writing, or both.
Result isInheritable(bool &value) const
Check if socket is inheritable by child processes.
Result setBlocking(bool value)
Changes the blocking flag for this socket (if IO reads / writes should be blocking or not)
Result setInheritable(bool value)
Changes the inheritable flag for this socket.
Result create(SocketFlags::AddressFamily addressFamily, SocketFlags::SocketType socketType=SocketFlags::SocketStream, SocketFlags::ProtocolType protocol=SocketFlags::ProtocolTcp, SocketFlags::BlockingType blocking=SocketFlags::Blocking, SocketFlags::InheritableType inheritable=SocketFlags::NonInheritable)
Creates a new SocketDescriptor Descriptor of given family, type, protocol.
Result getAddressFamily(SocketFlags::AddressFamily &addressFamily) const
Get address family (IPV4 / IPV6) of this socket.
Flags for SocketDescriptor (Blocking / Inheritable, IPVx, SocketType)
Definition Socket.h:43
SocketType
Sets the socket type, if it's a Datagram (for UDP) or Streaming (for TCP and others)
Definition Socket.h:67
@ SocketStream
Sets the socket type as Streaming type (for TCP and others)
Definition Socket.h:68
@ SocketDgram
Sets the socket type as Streaming type (for UDP)
Definition Socket.h:69
AddressFamily
Sets the address family of an IP Address (IPv4 or IPV6)
Definition Socket.h:60
@ AddressFamilyIPV6
IP Address is IPV6.
Definition Socket.h:62
@ AddressFamilyIPV4
IP Address is IPV4.
Definition Socket.h:61
InheritableType
Sets the socket inheritable behaviour for child processes.
Definition Socket.h:53
@ NonInheritable
SocketDescriptor will not be inherited by child processes.
Definition Socket.h:54
@ Inheritable
SocketDescriptor will be inherited by child processes.
Definition Socket.h:55
ShutdownType
Sets the type of shutdown to perform.
Definition Socket.h:81
@ ShutdownBoth
Shuts down the socket for both reading and writing.
Definition Socket.h:84
@ ShutdownWrite
Shuts down the socket for writing.
Definition Socket.h:83
@ ShutdownRead
Shuts down the socket for reading.
Definition Socket.h:82
BlockingType
Sets the socket as blocking / nonblocking mode.
Definition Socket.h:46
@ NonBlocking
SocketDescriptor is in non-blocking mode.
Definition Socket.h:47
@ Blocking
SocketDescriptor is in blocking mode.
Definition Socket.h:48
ProtocolType
Sets the socket protocol type.
Definition Socket.h:74
@ ProtocolUdp
The protocol is UDP.
Definition Socket.h:76
@ ProtocolTcp
The protocol is TCP.
Definition Socket.h:75
Native representation of an IP Address.
Definition Socket.h:104
uint16_t getPort() const
Get port of this ip address.
char[MAX_ASCII_STRING_LENGTH] AsciiBuffer
Buffer for storing the ASCII representation of an IP Address.
Definition Socket.h:109
AlignedStorage< 28 > handle
Handle to native OS representation of the IP Address.
Definition Socket.h:147
static constexpr int MAX_ASCII_STRING_LENGTH
Maximum length of the ASCII representation of an IP Address.
Definition Socket.h:106
Result fromAddressPort(StringSpan interfaceAddress, uint16_t port)
Builds this SocketIPAddress parsing given address string and port.
StringSpan toString(char(&buffer)[N]) const
Returns the text representation of this SocketIPAddress.
Definition Socket.h:140
SocketFlags::AddressFamily getAddressFamily() const
Get Address family of this ip address (IPV4 or IPV6)
uint32_t sizeOfHandle() const
Size of the native IP Address representation.
SocketIPAddress(SocketFlags::AddressFamily addressFamily=SocketFlags::AddressFamilyIPV4)
Constructs an ip address from a given family (IPV4 or IPV6)
bool isValid() const
Checks if this is a valid IPV4 or IPV6 address.
Networking globals initialization (Winsock2 WSAStartup)
Definition Socket.h:306
static Result shutdownNetworking()
Shutdowns Winsock2 on Windows (WSAStartup)
static bool isNetworkingInited()
Check if initNetworking has been previously called.
static Result initNetworking()
Initializes Winsock2 on Windows (WSAStartup)
Use a SocketDescriptor as a Server (example TCP or UDP Socket Server).
Definition Socket.h:208
Result listen(uint32_t numberOfWaitingConnections)
Start listening for incoming connections at a specific address / port combination (after bind)
SocketServer(SocketDescriptor &socket)
Build a SocketServer from a SocketDescriptor (already created with SocketDescriptor::create)
Definition Socket.h:211
Result close()
Calls SocketDescriptor::close.
Result bind(SocketIPAddress nativeAddress)
Binds this socket to a given address / port combination.
Result accept(SocketFlags::AddressFamily addressFamily, SocketDescriptor &newClient)
Accepts a new client, blocking while waiting for it.
View over a contiguous sequence of items (pointer + size in elements).
Definition Span.h:29
An read-only view over a string (to avoid including Strings library when parsing is not needed).
Definition StringSpan.h:37
Move only handle that has a special tag value flagging its invalid state.
Definition UniqueHandle.h:27