Socket IP address instance handle. More...

#include <socket.hpp>

Public Member Functions
	SocketAddress (const SocketAddress &)=delete
	SocketAddress (SocketAddress &&r) noexcept
SocketAddress &	operator= (SocketAddress &)=delete
SocketAddress &	operator= (SocketAddress &&r) noexcept
	SocketAddress (SocketFamily family=IP_V6_SOCKET_FAMILY)
	Creates a new any socket IP address instance.
	SocketAddress (const char host, const char service)
	Creates a new socket IP address instance.
	~SocketAddress ()
	Destroys socket IP address instance.
SocketAddress	createCopy () const noexcept
	Creates a new socket IP address copy instance.
void	destroy () noexcept
	Destroys socket IP address instance.
SocketAddress_T *	getInstance () const noexcept
	Returns socket IP address view instance.
SocketFamily	getFamily () const noexcept
	Returns socket IP address family type.
size_t	getIpSize () const noexcept
	Returns socket IP address byte array size.
bool	isAny () const noexcept
	Returns true if socket IP address is any address.
bool	isLoopback () const noexcept
	Returns true if socket IP address is loopback address.
bool	isMappedV4 () const noexcept
	Returns true if socket IP address is IPv4 mapped IPv6.
const uint8_t *	getIP () const noexcept
	Returns socket IP address byte array.
void	setIP (const uint8_t *ip) noexcept
	Sets socket IP address byte array.
uint16_t	getPort () const noexcept
	Returns socket IP address port number.
void	setPort (uint16_t port) noexcept
	Sets socket IP address port number.
void	getHost (char *host, size_t length) const noexcept
	Returns socket IP address numeric host name.
void	getHost (std::string &host) const
	Returns socket IP address numeric host name.
void	getService (char *service, size_t length) const noexcept
	Returns socket IP address numeric service name.
void	getService (std::string &service) const
	Returns socket IP address numeric service name.
void	getHostService (char host, size_t hostLength, char service, size_t serviceLength) const noexcept
	Returns socket IP address numeric host and service name.
void	getHostService (std::string &host, std::string &service) const
	Returns socket IP address numeric host and service name.
	operator bool () const noexcept
	Returns true if socket IP address view is not null.

Static Public Member Functions
static void	destroy (SocketAddressView *socketAddresses, size_t addressCount) noexcept
	Destroys resolved socket IP address array.
static NetsResult	resolve (const char host, const char service, SocketFamily family, SocketType type, SocketAddressView *&socketAddresses, size_t &addressCount) noexcept
	Resolves a new socket IP address array. (Blocking call).
static void	copy (SocketAddressView sourceAddress, SocketAddressView destinationAddress) noexcept
	Copies source socket IP address to the destination.
static int	compare (SocketAddressView a, SocketAddressView b) noexcept
	Compares two socket IP addresses.

Protected Attributes
SocketAddress_T *	instance = nullptr

Detailed Description

Socket IP address instance handle.

See the socket.h

Constructor & Destructor Documentation

◆ SocketAddress() [1/2]

SocketAddress ( SocketFamily family = IP_V6_SOCKET_FAMILY )

inline

Creates a new any socket IP address instance.

See the createAnySocketAddress().

Parameters

family socket IP address family type

Exceptions

Error with a NetsResult string on failure.

◆ SocketAddress() [2/2]

SocketAddress	(	const char *	host,
		const char *	service )

inline

Creates a new socket IP address instance.

See the createSocketAddress().

Parameters

[in]	host	socket IP address host name string
[in]	service	socket IP address service name string (port)

Exceptions

Error with a NetsResult string on failure.

◆ ~SocketAddress()

~SocketAddress ( )

inline

Destroys socket IP address instance.

See the destroySocketAddress().

Member Function Documentation

◆ createCopy()

SocketAddress createCopy ( ) const

inlinenoexcept

Creates a new socket IP address copy instance.

See the createSocketAddressCopy().

◆ destroy() [1/2]

void destroy ( )

inlinenoexceptinherited

Destroys socket IP address instance.

See the destroySocketAddress().

◆ destroy() [2/2]

void destroy	(	SocketAddressView *	socketAddresses,
		size_t	addressCount )

inlinestaticnoexceptinherited

Destroys resolved socket IP address array.

See the destroySocketAddresses().

Parameters

[in]	socketAddresses	socket IP address array
	addressCount	socket address count

◆ getFamily()

SocketFamily getFamily ( ) const

inlinenoexceptinherited

Returns socket IP address family type.

See the getSocketAddressFamily().

◆ getIpSize()

size_t getIpSize ( ) const

inlinenoexceptinherited

Returns socket IP address byte array size.

See the getSocketAddressIpSize().

◆ isAny()

bool isAny ( ) const

inlinenoexceptinherited

Returns true if socket IP address is any address.

See the isSocketAddressAny().

◆ isLoopback()

bool isLoopback ( ) const

inlinenoexceptinherited

Returns true if socket IP address is loopback address.

See the isSocketAddressLoopback().

◆ isMappedV4()

bool isMappedV4 ( ) const

inlinenoexceptinherited

Returns true if socket IP address is IPv4 mapped IPv6.

See the isSocketAddressMappedV4().

◆ getIP()

const uint8_t * getIP ( ) const

inlinenoexceptinherited

Returns socket IP address byte array.

See the getSocketAddressIP().

◆ setIP()

void setIP ( const uint8_t * ip )

inlinenoexceptinherited

Sets socket IP address byte array.

See the setSocketAddressIP().

Parameters

[in] ip target IP address byte array

◆ getPort()

uint16_t getPort ( ) const

inlinenoexceptinherited

Returns socket IP address port number.

See the getSocketAddressPort().

◆ setPort()

void setPort ( uint16_t port )

inlinenoexceptinherited

Sets socket IP address port number.

See the setSocketAddressPort().

Parameters

port	target IP address port number

◆ getHost() [1/2]

void getHost	(	char *	host,
		size_t	length ) const

inlinenoexceptinherited

Returns socket IP address numeric host name.

See the getSocketAddressHost().

Parameters

[out]	host	pointer to the host name string
	length	host name string length (including null terminator)

◆ getHost() [2/2]

void getHost ( std::string & host ) const

inlineinherited

Returns socket IP address numeric host name.

See the getSocketAddressHost().

Parameters

[out] host target host name string

◆ getService() [1/2]

void getService	(	char *	service,
		size_t	length ) const

inlinenoexceptinherited

Returns socket IP address numeric service name.

See the getSocketAddressService().

Parameters

[out]	service	pointer to the service name string
	length	service name string length (including null terminator)

◆ getService() [2/2]

void getService ( std::string & service ) const

inlineinherited

Returns socket IP address numeric service name.

See the getSocketAddressService().

Parameters

[out] service target service name string

◆ getHostService() [1/2]

void getHostService	(	char *	host,
		size_t	hostLength,
		char *	service,
		size_t	serviceLength ) const

inlinenoexceptinherited

Returns socket IP address numeric host and service name.

See the getSocketAddressHostService().

Parameters

[out]	host	pointer to the host name string
	hostLength	host name string length (including null terminator)
[out]	service	pointer to the service name string
	serviceLength	service name string length (including null terminator)

◆ getHostService() [2/2]

void getHostService	(	std::string &	host,
		std::string &	service ) const

inlineinherited

Returns socket IP address numeric host and service name.

See the getSocketAddressHostService().

Parameters

[out]	host	target host name string
[out]	service	target service name string

◆ resolve()

NetsResult resolve	(	const char *	host,
		const char *	service,
		SocketFamily	family,
		SocketType	type,
		SocketAddressView *&	socketAddresses,
		size_t &	addressCount )

inlinestaticnoexceptinherited

Resolves a new socket IP address array. (Blocking call).

See the resolveSocketAddresses().

Warning: This may be a slow running operation!

Returns: The operation NetsResult code.

Parameters

[in]	host	socket IP address host name string
[in]	service	socket IP address service name string (port)
	family	socket IP address family type
	type	socket communication protocol type
[out]	socketAddresses	reference to the socket address array
[out]	addressCount	reference to the socket address count

◆ copy()

void copy	(	SocketAddressView	sourceAddress,
		SocketAddressView	destinationAddress )

inlinestaticnoexceptinherited

Copies source socket IP address to the destination.

See the copySocketAddress().

Parameters

sourceAddress	source socket address instance
destinationAddress	destination socket address instance

◆ compare()

int compare	(	SocketAddressView	a,
		SocketAddressView	b )

inlinestaticnoexceptinherited

Compares two socket IP addresses.

See the compareSocketAddress().

Parameters

[in]	a	first socket address instance
[in]	b	second socket address instance

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SocketAddress() [1/2]

◆ SocketAddress() [2/2]

◆ ~SocketAddress()

Member Function Documentation

◆ createCopy()

◆ destroy() [1/2]

◆ destroy() [2/2]

◆ getFamily()

◆ getIpSize()

◆ isAny()

◆ isLoopback()

◆ isMappedV4()

◆ getIP()

◆ setIP()

◆ getPort()

◆ setPort()

◆ getHost() [1/2]

◆ getHost() [2/2]

◆ getService() [1/2]

◆ getService() [2/2]

◆ getHostService() [1/2]

◆ getHostService() [2/2]

◆ resolve()

◆ copy()

◆ compare()