Native representation of an IP Address. More...

#include <SocketDescriptor.h>

Public Member Functions
	SocketIPAddress (SocketFlags::AddressFamily addressFamily=SocketFlags::AddressFamilyIPV4)
	Constructs an ip address from a given family (IPV4 or IPV6) More...

SocketFlags::AddressFamily	getAddressFamily ()
	Get Address family of this ip address (IPV4 or IPV6) More...

Result	fromAddressPort (SpanStringView interfaceAddress, uint16_t port)
	Builds this SocketIPAddress parsing given address string and port. More...

uint32_t	sizeOfHandle () const
	Size of the native IP Address representation. More...

Public Attributes
AlignedStorage< 28 >	handle = {}
	Handle to native OS representation of the IP Address. More...

Friends
struct	SocketServer

struct	SocketClient

Detailed Description

Native representation of an IP Address.

Example:

    SocketIPAddress address;
    SC_TEST_EXPECT(not address.fromAddressPort("1223.22.44.1", 6666));
    SC_TEST_EXPECT(address.fromAddressPort("127.0.0.1", 123));
    SC_TEST_EXPECT(address.fromAddressPort("::1", 123));

Constructor & Destructor Documentation

◆ SocketIPAddress()

SC::SocketIPAddress::SocketIPAddress ( SocketFlags::AddressFamily addressFamily = SocketFlags::AddressFamilyIPV4 )

inline

Constructs an ip address from a given family (IPV4 or IPV6)

Parameters

addressFamily The address family

Member Function Documentation

◆ fromAddressPort()

Result SC::SocketIPAddress::fromAddressPort	(	SpanStringView	interfaceAddress,
		uint16_t	port
	)

Builds this SocketIPAddress parsing given address string and port.

Parameters

interfaceAddress	A valid IPV4 or IPV6 address expressed as a string
port	The port to connect to

Returns: A valid Result if the address has been parsed successfully

◆ getAddressFamily()

SocketFlags::AddressFamily SC::SocketIPAddress::getAddressFamily ( )

inline

Get Address family of this ip address (IPV4 or IPV6)

Returns: The Ip Address Family of the given SocketDescriptor

◆ sizeOfHandle()

uint32_t SC::SocketIPAddress::sizeOfHandle ( ) const

Size of the native IP Address representation.

Member Data Documentation

◆ handle

AlignedStorage<28> SC::SocketIPAddress::handle = {}

Handle to native OS representation of the IP Address.

The documentation for this struct was generated from the following file:

SocketDescriptor.h

Public Member Functions

Public Attributes

Friends