libDwm-0.9.45
Dwm::Ipv6Address Class Reference

This class encapsulates an IPv6 address. More...

#include <DwmIpv6Address.hh>

Public Member Functions

 Ipv6Address ()
 Constructor. Sets address to 0::
 
 Ipv6Address (const std::string &addr)
 Construct from a string.
 
 Ipv6Address (const struct in6_addr &addr)
 Construct from an in6_addr.
 
 operator std::string () const
 Returns a string representation.
 
 operator struct in6_addr () const
 Returns an in6_addr representation.
 
bool operator< (const Ipv6Address &addr) const
 Less-than operator.
 
bool operator> (const Ipv6Address &addr) const
 Greater-than operator.
 
bool operator== (const Ipv6Address &addr) const
 Equal-to operator.
 
bool operator!= (const Ipv6Address &addr) const
 Not-equal-to operator.
 
Ipv6Addressoperator&= (const Ipv6Address &netmask)
 Mask operator.
 
Ipv6Address operator& (const Ipv6Address &netmask) const
 Mask operator.
 
bool IsLinkLocal () const
 Returns true if the address is link-local.
 
bool IsSiteLocal () const
 Returns true if the address is site-local.
 
const uint8_t * RawPointer () const
 Returns a pointer to the memory containing the address.
 
const in6_addr & In6Addr () const
 
uint64_t StreamedLength () const
 Returns the number of bytes that would be written if we called one of the Write() members.
 
std::istream & Read (std::istream &is)
 Reads from an istream. Returns the istream.
 
std::ostream & Write (std::ostream &os) const
 Writes to an ostream. Returns the ostream.
 
ssize_t Read (int fd)
 Reads from a file descriptor.
 
ssize_t Write (int fd) const
 Writes to a file descriptor.
 
size_t Read (FILE *f)
 Reads from a FILE pointer. Returns 1 on success, 0 on failure.
 
size_t Write (FILE *f) const
 Writes to a FILE pointer. Returns 1 on success, 0 on failure.
 
int Read (gzFile gzf)
 Reads from a gzFile.
 
int Write (gzFile gzf) const
 Writes to a gzFile.
 
int BZRead (BZFILE *bzf)
 Reads from a BZFILE pointer.
 
int BZWrite (BZFILE *bzf) const
 Writes to a BZFILE pointer.
 
template<typename ST >
requires IsSupportedASIOSocket<ST>
bool ASIO_Read (ST &s, boost::system::error_code &ec)
 Function template intended for boost::asio stream sockets.
 
template<typename ST >
requires IsSupportedASIOSocket<ST>
bool ASIO_Write (ST &s, boost::system::error_code &ec) const
 Function template intended for boost::asio stream sockets.
 
bool Read (boost::asio::ip::tcp::socket &s, boost::system::error_code &ec)
 Reads the Ipv6Address from s.
 
bool Write (boost::asio::ip::tcp::socket &s, boost::system::error_code &ec) const
 Writes the Ipv6Address to s.
 
bool Read (boost::asio::local::stream_protocol::socket &s, boost::system::error_code &ec)
 Reads the Ipv6Address from s.
 
bool Write (boost::asio::local::stream_protocol::socket &s, boost::system::error_code &ec) const
 Writes the Ipv6Address to s.
 
bool Read (boost::asio::generic::stream_protocol::socket &s, boost::system::error_code &ec)
 Reads the Ipv6Address from s.
 
bool Write (boost::asio::generic::stream_protocol::socket &s, boost::system::error_code &ec) const
 Writes the Ipv6Address to s.
 
uint64_t Hash () const
 Returns a 64-bit hash value for the Ipv6Address.
 

Friends

std::ostream & operator<< (std::ostream &os, const Ipv6Address &addr)
 Prints an Ipv6Address to an ostream in human-readable form.
 

Detailed Description

This class encapsulates an IPv6 address.

Member Function Documentation

◆ BZRead()

int Dwm::Ipv6Address::BZRead ( BZFILE * bzf)

Reads from a BZFILE pointer.

Returns the number of bytes read (16 on success).

◆ BZWrite()

int Dwm::Ipv6Address::BZWrite ( BZFILE * bzf) const

Writes to a BZFILE pointer.

Returns the number of bytes written (16 on success).

◆ Read() [1/5]

bool Dwm::Ipv6Address::Read ( boost::asio::generic::stream_protocol::socket & s,
boost::system::error_code & ec )
inline

Reads the Ipv6Address from s.

Returns true on success, false on failure.

Here is the call graph for this function:

◆ Read() [2/5]

bool Dwm::Ipv6Address::Read ( boost::asio::ip::tcp::socket & s,
boost::system::error_code & ec )
inline

Reads the Ipv6Address from s.

Returns true on success, false on failure.

Here is the call graph for this function:

◆ Read() [3/5]

bool Dwm::Ipv6Address::Read ( boost::asio::local::stream_protocol::socket & s,
boost::system::error_code & ec )
inline

Reads the Ipv6Address from s.

Returns true on success, false on failure.

Here is the call graph for this function:

◆ Read() [4/5]

int Dwm::Ipv6Address::Read ( gzFile gzf)

Reads from a gzFile.

Returns the number of bytes read (16 on success).

◆ Read() [5/5]

ssize_t Dwm::Ipv6Address::Read ( int fd)

Reads from a file descriptor.

Returns the number of bytes read (16 on success).

◆ Write() [1/5]

bool Dwm::Ipv6Address::Write ( boost::asio::generic::stream_protocol::socket & s,
boost::system::error_code & ec ) const
inline

Writes the Ipv6Address to s.

Returns true on success, false on failure.

Here is the call graph for this function:

◆ Write() [2/5]

bool Dwm::Ipv6Address::Write ( boost::asio::ip::tcp::socket & s,
boost::system::error_code & ec ) const
inline

Writes the Ipv6Address to s.

Returns true on success, false on failure.

Here is the call graph for this function:

◆ Write() [3/5]

bool Dwm::Ipv6Address::Write ( boost::asio::local::stream_protocol::socket & s,
boost::system::error_code & ec ) const
inline

Writes the Ipv6Address to s.

Returns true on success, false on failure.

Here is the call graph for this function:

◆ Write() [4/5]

int Dwm::Ipv6Address::Write ( gzFile gzf) const

Writes to a gzFile.

Returns the number of bytes written (16 on success).

◆ Write() [5/5]

ssize_t Dwm::Ipv6Address::Write ( int fd) const

Writes to a file descriptor.

Returns the number of bytes written (16 on success).


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