SocketAddress class. More...

#include <SocketAddress.h>

Public Member Functions
template<typename S >
	SocketAddress (S stack, const char host, uint16_t port=0)
	Create a SocketAddress from a hostname and port. More...

	SocketAddress (nsapi_addr_t addr=nsapi_addr_t(), uint16_t port=0)
	Create a SocketAddress from a raw IP address and port. More...

	SocketAddress (const char *addr, uint16_t port=0)
	Create a SocketAddress from an IP address and port. More...

	SocketAddress (const void *bytes, nsapi_version_t version, uint16_t port=0)
	Create a SocketAddress from raw IP bytes, IP version, and port. More...

	SocketAddress (const SocketAddress &addr)
	Create a SocketAddress from another SocketAddress. More...

	~SocketAddress ()
	Destructor. More...

bool	set_ip_address (const char *addr)
	Set the IP address. More...

void	set_ip_bytes (const void *bytes, nsapi_version_t version)
	Set the raw IP bytes and IP version. More...

void	set_addr (nsapi_addr_t addr)
	Set the raw IP address. More...

void	set_port (uint16_t port)
	Set the port. More...

const char *	get_ip_address () const
	Get the human-readable IP address. More...

const void *	get_ip_bytes () const
	Get the raw IP bytes. More...

nsapi_version_t	get_ip_version () const
	Get the IP address version. More...

nsapi_addr_t	get_addr () const
	Get the raw IP address. More...

uint16_t	get_port () const
	Get the port. More...

	operator bool () const
	Test if address is zero. More...

SocketAddress &	operator= (const SocketAddress &addr)
	Copy address from another SocketAddress. More...

Friends
bool	operator== (const SocketAddress &a, const SocketAddress &b)
	Compare two addresses for equality. More...

bool	operator!= (const SocketAddress &a, const SocketAddress &b)
	Compare two addresses for equality. More...

Detailed Description

SocketAddress class.

Representation of an IP address and port pair.

Definition at line 35 of file SocketAddress.h.

Constructor & Destructor Documentation

SocketAddress	(	S *	stack,
		const char *	host,
		uint16_t	port = `0`
	)

Create a SocketAddress from a hostname and port.

The hostname may be either a domain name or an IP address. If the hostname is an IP address, no network transactions will be performed.

On failure, the IP address and port will be set to zero

Template Parameters

S	Type of the Network stack

Parameters

stack	Network stack to use for DNS resolution
host	Hostname to resolve
port	Optional 16-bit port, defaults to 0

Deprecated:: Constructors hide possible errors. Replaced by NetworkInterface::gethostbyname.

Definition at line 56 of file SocketAddress.h.

SocketAddress	(	nsapi_addr_t	addr = `nsapi_addr_t()`,
		uint16_t	port = `0`
	)

Create a SocketAddress from a raw IP address and port.

Note: To construct from a host name, use NetworkInterface::gethostbyname

Parameters

addr	Raw IP address
port	Optional 16-bit port, defaults to 0

SocketAddress	(	const char *	addr,
		uint16_t	port = `0`
	)

Create a SocketAddress from an IP address and port.

Parameters

addr	Null-terminated representation of the IP address
port	Optional 16-bit port, defaults to 0

SocketAddress	(	const void *	bytes,
		nsapi_version_t	version,
		uint16_t	port = `0`
	)

Create a SocketAddress from raw IP bytes, IP version, and port.

Parameters

bytes	Raw IP address in big-endian order
version	IP address version, NSAPI_IPv4 or NSAPI_IPv6
port	Optional 16-bit port, defaults to 0

SocketAddress ( const SocketAddress & addr )

Create a SocketAddress from another SocketAddress.

Parameters

addr	SocketAddress to copy

~SocketAddress ( )

Destructor.

Member Function Documentation

nsapi_addr_t get_addr ( ) const

Get the raw IP address.

Returns: Raw IP address

const char* get_ip_address ( ) const

Get the human-readable IP address.

Allocates memory for a string and converts binary address to human-readable format. String is freed in the destructor.

Returns: Null-terminated representation of the IP Address

const void* get_ip_bytes ( ) const

Get the raw IP bytes.

Returns: Raw IP address in big-endian order

nsapi_version_t get_ip_version ( ) const

Get the IP address version.

Returns: IP address version, NSAPI_IPv4 or NSAPI_IPv6

uint16_t get_port ( ) const

Get the port.

Returns: The 16-bit port

operator bool ( ) const

Test if address is zero.

Returns: True if address is not zero

SocketAddress& operator= ( const SocketAddress & addr )

Copy address from another SocketAddress.

Parameters

addr	SocketAddress to copy

void set_addr ( nsapi_addr_t addr )

Set the raw IP address.

Parameters

addr	Raw IP address

bool set_ip_address ( const char * addr )

Set the IP address.

Parameters

addr	Null-terminated represention of the IP address

Returns: True if address is a valid representation of an IP address, otherwise False and SocketAddress is set to null

void set_ip_bytes	(	const void *	bytes,
		nsapi_version_t	version
	)

Set the raw IP bytes and IP version.

Parameters

bytes	Raw IP address in big-endian order
version	IP address version, NSAPI_IPv4 or NSAPI_IPv6

void set_port ( uint16_t port )

Set the port.

Parameters

port	16-bit port

Friends And Related Function Documentation

bool operator!=	(	const SocketAddress &	a,
		const SocketAddress &	b
	)

friend

Compare two addresses for equality.

Returns: True if both addresses are not equal

bool operator==	(	const SocketAddress &	a,
		const SocketAddress &	b
	)

friend

Compare two addresses for equality.

Returns: True if both addresses are equal

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Important Information for this Arm website