Dwm::Ipv4IcmpMessage Class Reference

Base class for ICMP messages. More...

#include <DwmIpv4IcmpMessage.hh>

Inheritance diagram for Dwm::Ipv4IcmpMessage:

Collaboration diagram for Dwm::Ipv4IcmpMessage:

Public Member Functions
	Ipv4IcmpMessage ()
	Default constructor.
	~Ipv4IcmpMessage ()
	Destructor.
uint8_t	Type () const
	Returns the ICMP message type.
uint8_t	Type (uint8_t type)
	Sets and returns the ICMP message type.
uint8_t	Code () const
	Returns the ICMP message code.
uint8_t	Code (uint8_t code)
	Sets and returns the ICMP message code.
uint16_t	Checksum ()
	Returns the ICMP checksum.
void	SetChecksum ()
	Computes and sets the checksum.
std::istream &	Read (std::istream &is, uint16_t len)
	Reads the message of length len from an istream. More...
std::ostream &	Write (std::ostream &os) const
	Writes the message to an ostream. Returns the ostream.
ssize_t	Read (int fd, uint16_t len)
	Reads the message of length len from a file descriptor. More...
ssize_t	Write (int fd) const
	Writes the message to a file descriptor. More...
size_t	Read (FILE *f, uint16_t len)
	Reads the message of length len from a FILE. More...
size_t	Write (FILE *f) const
	Writes the message to a FILE. Returns 1 on success, 0 on failure.
int	Read (gzFile gzf, uint16_t len)
	Reads the message of length len from a gzFile. More...
int	Write (gzFile gzf) const
	Writes the message to a gzFile. More...
int	BZRead (BZFILE *bzf, uint16_t len)
	Reads the message of length len from a BZFILE. More...
int	BZWrite (BZFILE *bzf) const
	Writes the message to a BZFILE. More...
uint32_t	StreamedLength () const
	Returns the number of bytes that would be written if we called one of the Write() members. More...
bool	operator== (const Ipv4IcmpMessage &msg) const
	operator ==
Public Member Functions inherited from Dwm::Writable
virtual	~Writable ()
	Destructor.
Public Member Functions inherited from Dwm::GZWritable
virtual	~GZWritable ()
	destructor

Protected Member Functions
void	Free ()
void	Allocate (uint16_t len)
void	Reallocate (uint16_t len)

Protected Attributes
std::pair< uint16_t, uint8_t * >	_data
bool	_ownData

Detailed Description

Base class for ICMP messages.

Member Function Documentation

BZRead()

int Dwm::Ipv4IcmpMessage::BZRead	(	BZFILE *	bzf,
		uint16_t	len
	)

Reads the message of length len from a BZFILE.

Returns the number of bytes read on success, -1 on failure.

BZWrite()

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

virtual

Writes the message to a BZFILE.

Returns the number of bytes written on success, -1 on failure.

Implements Dwm::BZ2Writable.

Read() [1/4]

std::istream& Dwm::Ipv4IcmpMessage::Read	(	std::istream &	is,
		uint16_t	len
	)

Reads the message of length len from an istream.

Returns the istream.

Read() [2/4]

ssize_t Dwm::Ipv4IcmpMessage::Read	(	int	fd,
		uint16_t	len
	)

Reads the message of length len from a file descriptor.

Returns the number of bytes read on success, -1 on failure.

Read() [3/4]

size_t Dwm::Ipv4IcmpMessage::Read	(	FILE *	f,
		uint16_t	len
	)

Reads the message of length len from a FILE.

Returns 1 on success, 0 on failure.

Read() [4/4]

int Dwm::Ipv4IcmpMessage::Read	(	gzFile	gzf,
		uint16_t	len
	)

Reads the message of length len from a gzFile.

Returns the number of bytes read on success, -1 on failure.

StreamedLength()

uint32_t Dwm::Ipv4IcmpMessage::StreamedLength ( ) const

virtual

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

Implements Dwm::Writable.

Write() [1/2]

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

virtual

Writes the message to a file descriptor.

Returns the number of bytes written on success, -1 on failure.

Implements Dwm::Writable.

Write() [2/2]

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

virtual

Writes the message to a gzFile.

Returns the number of bytes written on success, -1 on failure.

Implements Dwm::GZWritable.

---

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

• DwmIpv4IcmpMessage.hh