libDwm-0.6.0
Dwm::MacAddress Class Reference

Encapsulates a 6-byte MAC address. More...

#include <DwmMacAddress.hh>

Inheritance diagram for Dwm::MacAddress:
Collaboration diagram for Dwm::MacAddress:

Public Member Functions

 MacAddress ()
 Constructor. Sets the address to 00:00:00:00:00:00.
 
 MacAddress (const std::string &s)
 Construct from a string of the form xx:xx:xx:xx:xx:xx.
 
 MacAddress (const MacAddress &addr)
 Copy constructor.
 
MacAddressoperator= (const MacAddress &addr)
 operator =
 
bool operator== (const MacAddress &addr) const
 operator ==
 
std::istream & Read (std::istream &is)
 Reads the MAC address from an istream. Returns the istream.
 
std::ostream & Write (std::ostream &os) const
 Writes the MAC address to an ostream. Returns the ostream.
 
ssize_t Read (int fd)
 Reads the MAC address from a file descriptor. More...
 
ssize_t Write (int fd) const
 Writes the MAC address to a file descriptor. More...
 
size_t Read (FILE *f)
 Reads the MAC address from a FILE. More...
 
size_t Write (FILE *f) const
 Writes the MAC address to a FILE. More...
 
int Read (gzFile gzf)
 Reads the MAC address from a gzFile. More...
 
int Write (gzFile gzf) const
 Writes the MAC address to a gzFile. More...
 
int BZRead (BZFILE *bzf)
 Reads the MAC address from a BZFILE. More...
 
int BZWrite (BZFILE *bzf) const
 Writes the MAC address to a BZFILE. More...
 
uint32_t StreamedLength () const
 Returns the number of bytes that should be written if we call one of the Write() members. More...
 
- Public Member Functions inherited from Dwm::Readable
virtual ~Readable ()
 destructor
 
- Public Member Functions inherited from Dwm::Writable
virtual ~Writable ()
 Destructor.
 
- Public Member Functions inherited from Dwm::GZReadable
virtual ~GZReadable ()
 destructor
 
- Public Member Functions inherited from Dwm::GZWritable
virtual ~GZWritable ()
 destructor
 

Protected Attributes

uint8_t _addr [6]
 

Friends

std::ostream & operator<< (std::ostream &os, const MacAddress &addr)
 Prints to an ostream in 'xx:xx:xx:xx:xx:xx' format.
 
std::istream & operator>> (std::istream &is, MacAddress &addr)
 Reads from an istream in 'xx:xx:xx:xx:xx:xx' format.
 

Detailed Description

Encapsulates a 6-byte MAC address.

Member Function Documentation

◆ BZRead()

int Dwm::MacAddress::BZRead ( BZFILE *  bzf)
virtual

Reads the MAC address from a BZFILE.

Returns the number of bytes read on success (should be 6), -1 on failure.

Implements Dwm::BZ2Readable.

◆ BZWrite()

int Dwm::MacAddress::BZWrite ( BZFILE *  bzf) const
virtual

Writes the MAC address to a BZFILE.

Returns the number of bytes written on success (should be 6), -1 on failure.

Implements Dwm::BZ2Writable.

◆ Read() [1/3]

ssize_t Dwm::MacAddress::Read ( int  fd)
virtual

Reads the MAC address from a file descriptor.

Returns the number of bytes read on success (should be 6), -1 on failure.

Implements Dwm::Readable.

◆ Read() [2/3]

size_t Dwm::MacAddress::Read ( FILE *  f)
virtual

Reads the MAC address from a FILE.

Returns 1 on success, 0 on failure.

Implements Dwm::Readable.

◆ Read() [3/3]

int Dwm::MacAddress::Read ( gzFile  gzf)
virtual

Reads the MAC address from a gzFile.

Returns the number of bytes read on success (should be 6), -1 on failure.

Implements Dwm::GZReadable.

◆ StreamedLength()

uint32_t Dwm::MacAddress::StreamedLength ( ) const
virtual

Returns the number of bytes that should be written if we call one of the Write() members.

Should always return 6.

Implements Dwm::Writable.

◆ Write() [1/3]

ssize_t Dwm::MacAddress::Write ( int  fd) const
virtual

Writes the MAC address to a file descriptor.

Returns the number of bytes written on success (should be 6), -1 on failure.

Implements Dwm::Writable.

◆ Write() [2/3]

size_t Dwm::MacAddress::Write ( FILE *  f) const
virtual

Writes the MAC address to a FILE.

Returns 1 on success, 0 on failure.

Implements Dwm::Writable.

◆ Write() [3/3]

int Dwm::MacAddress::Write ( gzFile  gzf) const
virtual

Writes the MAC address to a gzFile.

Returns the number of bytes written on success (should be 6), -1 on failure.

Implements Dwm::GZWritable.


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