dht::SockAddr Class Reference

#include <sockaddr.h>

Classes
struct	ipCmp

Public Member Functions
	SockAddr (const SockAddr &o)
	SockAddr (SockAddr &&o) noexcept
	SockAddr (const sockaddr *sa, socklen_t length)
	SockAddr (const sockaddr *sa)
	SockAddr (const sockaddr_storage &ss, socklen_t len)
bool	operator< (const SockAddr &o) const
bool	equals (const SockAddr &o) const
SockAddr &	operator= (const SockAddr &o)
SockAddr &	operator= (SockAddr &&o)
std::string	toString () const
sa_family_t	getFamily () const
void	setFamily (sa_family_t af)
void	setAny ()
in_port_t	getPort () const
void	setPort (in_port_t p)
void	setAddress (const char *address)
socklen_t	getLength () const
	operator bool () const noexcept
const sockaddr *	get () const
sockaddr *	get ()
const sockaddr_in &	getIPv4 () const
const sockaddr_in6 &	getIPv6 () const
sockaddr_in &	getIPv4 ()
sockaddr_in6 &	getIPv6 ()
bool	isLoopback () const
bool	isPrivate () const
bool	isUnspecified () const
bool	isMappedIPv4 () const
SockAddr	getMappedIPv4 ()
SockAddr	getMappedIPv6 ()

Static Public Member Functions
static std::vector< SockAddr >	resolve (const std::string &host, const std::string &service={})

Detailed Description

A Socket Address (sockaddr*), with abstraction for IPv4, IPv6 address families.

Definition at line 57 of file sockaddr.h.

Constructor & Destructor Documentation

SockAddr() [1/2]

dht::SockAddr::SockAddr ( const sockaddr *  sa, socklen_t  length  )

inline

Build from existing address.

Definition at line 70 of file sockaddr.h.

SockAddr() [2/2]

dht::SockAddr::SockAddr ( const sockaddr_storage &  ss, socklen_t  len  )

inline

Build from an existing sockaddr_storage structure.

Definition at line 91 of file sockaddr.h.

Member Function Documentation

get() [1/2]

const sockaddr* dht::SockAddr::get ( ) const

inline

Returns the address to the managed sockaddr structure. The accessible length is returned by getLength().

Definition at line 218 of file sockaddr.h.

get() [2/2]

sockaddr* dht::SockAddr::get ( )

inline

Returns the address to the managed sockaddr structure. The accessible length is returned by getLength().

Definition at line 224 of file sockaddr.h.

getFamily()

sa_family_t dht::SockAddr::getFamily ( ) const

inline

Returns the address family or AF_UNSPEC if the address is not set.

Definition at line 123 of file sockaddr.h.

getLength()

socklen_t dht::SockAddr::getLength ( ) const

inline

Returns the accessible byte length at the pointer returned by get(). If zero, get() returns null.

Definition at line 205 of file sockaddr.h.

getPort()

in_port_t dht::SockAddr::getPort ( ) const

inline

Retreive the port (in host byte order) or 0 if the address is not of a supported family.

Definition at line 170 of file sockaddr.h.

isLoopback()

bool dht::SockAddr::isLoopback

(

)

const

Return true if address is a loopback IP address.

isPrivate()

bool dht::SockAddr::isPrivate

(

)

const

Return true if address is not a public IP address.

operator bool()

dht::SockAddr::operator bool ( ) const

inlineexplicitnoexcept

An address is defined to be true if its length is not zero.

Definition at line 210 of file sockaddr.h.

setAddress()

void dht::SockAddr::setAddress

(

const char *

address

)

Set the address part of the socket address from a numeric IP address (string representation). Family must be already set. Throws in case of parse failue.

setAny()

void dht::SockAddr::setAny ( )

inline

Set Network Interface to any

Definition at line 154 of file sockaddr.h.

setFamily()

void dht::SockAddr::setFamily ( sa_family_t  af )

inline

Resize the managed structure to the appropriate size (if needed), in which case the sockaddr structure is cleared to zero, and set the address family field (sa_family).

Definition at line 130 of file sockaddr.h.

setPort()

void dht::SockAddr::setPort ( in_port_t  p )

inline

Set the port. The address must be of a supported family.

Parameters

p	The port in host byte order.

Definition at line 184 of file sockaddr.h.

---

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

• /home/abuild/rpmbuild/BUILD/opendht-2.4.4/include/opendht/sockaddr.h