Internet host address. More...

#include <InetHostAddress.h>

Inheritance diagram for utl::InetHostAddress:

Public Member Functions
	InetHostAddress (const InetHostname &hostName)
	Constructor. More...

	InetHostAddress (const void *hostAddr)
	Constructor. More...

	InetHostAddress (uint32_t hostAddr)
	Constructor. More...

	InetHostAddress (uint_t b3, uint_t b2, uint_t b1, uint_t b0)
	Constructor. More...

virtual int	compare (const Object &rhs) const
	Compare with another object. More...

virtual void	copy (const Object &rhs)
	Copy another instance. More...

virtual size_t	hash (size_t size) const
	Get the hash code for the object. More...

virtual void	serialize (Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize to or from a stream. More...

virtual String	toString () const
	Return a String representation (ie "127.0.0.1"). More...

void	clear ()
	Clear the address (zero it out). More...

uint32_t	get () const
	Get the address. More...

InetHostname	getName () const
	Return the name of the host with self's address. More...

bool	isNil () const
	Determine whether the address is defined. More...

InetHostname	name () const
	Return the name of the host with self's address. More...

void	set (const InetHostname &hostName)
	Set to the address of the given host. More...

void	set (const void *hostAddr)
	Set the address. More...

void	set (uint32_t hostAddr)
	Set the address. More...

void	set (uint_t b3, uint_t b2, uint_t b1, uint_t b0)
	Set the address. More...

void	setNil ()
	Clear the address (zero it out). More...

Public Member Functions inherited from utl::Object
void	clear ()
	Revert to initial state. More...

virtual void	vclone (const Object &rhs)
	Make an exact copy of another instance. More...

virtual void	steal (Object &rhs)
	"Steal" the internal representation from another instance. More...

virtual void	dump (Stream &os, uint_t level=uint_t_max) const
	Dump a human-readable representation of self to the given output stream. More...

void	dumpWithClassName (Stream &os, uint_t indent=4, uint_t level=uint_t_max) const
	Front-end for dump() that prints the object's class name. More...

virtual const Object &	getKey () const
	Get the key for this object. More...

bool	hasKey () const
	Determine whether or not the object has a key. More...

virtual const Object &	getProxiedObject () const
	Get the proxied object (= self if none). More...

virtual Object &	getProxiedObject ()
	Get the proxied object (= self if none). More...

bool	_isA (const RunTimeClass *runTimeClass) const
	Determine whether self's class is a descendent of the given class. More...

	operator String () const
	Conversion to String. More...

size_t	allocatedSize () const
	Get the total allocated size of this object. More...

virtual size_t	innerAllocatedSize () const
	Get the "inner" allocated size. More...

virtual void	addOwnedIt (const class FwdIt *it) const
	Notify self that it owns the given iterator. More...

virtual void	removeOwnedIt (const class FwdIt *it) const
	Notify self that the given owned iterator has been destroyed. More...

bool	operator< (const Object &rhs) const
	Less-than operator. More...

bool	operator<= (const Object &rhs) const
	Less-than-or-equal-to operator. More...

bool	operator> (const Object &rhs) const
	Greater-than operator. More...

bool	operator>= (const Object &rhs) const
	Greater-than-or-equal-to operator. More...

bool	operator== (const Object &rhs) const
	Equal-to operator. More...

bool	operator!= (const Object &rhs) const
	Unequal-to operator. More...

void	serializeIn (Stream &is, uint_t mode=ser_default)
	Serialize from an input stream. More...

void	serializeOut (Stream &os, uint_t mode=ser_default) const
	Serialize to an output stream. More...

void	serializeOutBoxed (Stream &os, uint_t mode=ser_default) const
	Serialize a boxed object to an output stream. More...

Additional Inherited Members
Static Public Member Functions inherited from utl::Object
static Object *	serializeInNullable (Stream &is, uint_t mode=ser_default)
	Serialize a nullptr-able object from an input stream. More...

static void	serializeOutNullable (const Object *object, Stream &os, uint_t mode=ser_default)
	Serialize a nullptr-able object to an output stream. More...

static void	serializeNullable (Object *&object, Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize a nullptr-able object to or from a stream. More...

static Object *	serializeInBoxed (Stream &is, uint_t mode=ser_default)
	Serialize a boxed object from an input stream. More...

static void	serializeBoxed (Object *&object, Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize a boxed object to or from a stream. More...

Detailed Description

Internet host address.

Author: Adam McKee

Definition at line 26 of file InetHostAddress.h.

Constructor & Destructor Documentation

◆ InetHostAddress() [1/4]

utl::InetHostAddress::InetHostAddress ( const InetHostname & hostName )

Constructor.

Parameters

hostName to get address for

◆ InetHostAddress() [2/4]

utl::InetHostAddress::InetHostAddress ( const void * hostAddr )

Constructor.

Parameters

hostAddr host address (big-endian)

◆ InetHostAddress() [3/4]

utl::InetHostAddress::InetHostAddress ( uint32_t hostAddr )

Constructor.

Parameters

hostAddr 32-bit host address

◆ InetHostAddress() [4/4]

utl::InetHostAddress::InetHostAddress	(	uint_t	b3,
		uint_t	b2,
		uint_t	b1,
		uint_t	b0
	)

Constructor.

Parameters

b3	byte 3 of host address (MSB)
b2	byte 2 of host address
b1	byte 1 of host address
b0	byte 0 of host address (LSB)

Member Function Documentation

◆ compare()

virtual int utl::InetHostAddress::compare ( const Object & rhs ) const

virtual

Compare with another object.

If no overridden version succeeds in doing the comparison, then an attempt will be made to re-start the comparison process using one or both of the objects' keys. Usually, an override of compare() should call the superclass's compare() if it doesn't know how to compare itself with the rhs object.

See also: getKey

Returns: < 0 if self < rhs, 0 if self = rhs, > 0 if self > rhs

Parameters

rhs	object to compare with

Reimplemented from utl::Object.

◆ copy()

virtual void utl::InetHostAddress::copy ( const Object & rhs )

virtual

Copy another instance.

When you override copy(), you should usually call the superclass's copy().

Parameters

rhs	object to copy

Reimplemented from utl::Object.

◆ hash()

virtual size_t utl::InetHostAddress::hash ( size_t size ) const

virtual

Get the hash code for the object.

The default implementation will return the hash code of the object's key, or abort if the object has none.

Returns: the hash code

Parameters

size	hash table size

Reimplemented from utl::Object.

◆ serialize()

virtual void utl::InetHostAddress::serialize	(	Stream &	stream,
		uint_t	io,
		uint_t	mode = `ser_default`
	)

virtual

Serialize to or from a stream.

This is the only virtual method for serialization. You must override this in any class that has data to be serialized, and ensure that the superclass's serialize() gets called.

Parameters

stream	stream to serialize from/to
io	see utl::io_t
mode	see utl::serialize_t

Reimplemented from utl::Object.

◆ toString()

virtual String utl::InetHostAddress::toString ( ) const

virtual

Return a String representation (ie "127.0.0.1").

Reimplemented from utl::Object.

◆ clear()

void utl::InetHostAddress::clear ( )

Clear the address (zero it out).

◆ get()

uint32_t utl::InetHostAddress::get ( ) const

Get the address.

◆ getName()

InetHostname utl::InetHostAddress::getName ( ) const

Return the name of the host with self's address.

◆ isNil()

bool utl::InetHostAddress::isNil ( ) const

Determine whether the address is defined.

◆ name()

InetHostname utl::InetHostAddress::name ( ) const

Return the name of the host with self's address.

◆ set() [1/4]

void utl::InetHostAddress::set ( const InetHostname & hostName )

Set to the address of the given host.

◆ set() [2/4]

void utl::InetHostAddress::set ( const void * hostAddr )

Set the address.

Parameters

hostAddr host address (big-endian)

◆ set() [3/4]

void utl::InetHostAddress::set ( uint32_t hostAddr )

Set the address.

Parameters

hostAddr 32-bit host address

◆ set() [4/4]

void utl::InetHostAddress::set	(	uint_t	b3,
		uint_t	b2,
		uint_t	b1,
		uint_t	b0
	)

Set the address.

Parameters

b3	byte 3 of host address (MSB)
b2	byte 2 of host address
b1	byte 1 of host address
b0	byte 0 of host address (LSB)

◆ setNil()

void utl::InetHostAddress::setNil ( )

inline

Clear the address (zero it out).

Definition at line 110 of file InetHostAddress.h.

References utl::deInit(), and utl::init().

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

InetHostAddress.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ InetHostAddress() [1/4]

◆ InetHostAddress() [2/4]

◆ InetHostAddress() [3/4]

◆ InetHostAddress() [4/4]

Member Function Documentation

◆ compare()

◆ copy()

◆ hash()

◆ serialize()

◆ toString()

◆ clear()

◆ get()

◆ getName()

◆ isNil()

◆ name()

◆ set() [1/4]

◆ set() [2/4]

◆ set() [3/4]

◆ set() [4/4]

◆ setNil()