#include <address.h>

Inheritance diagram for GenAddress:

Collaboration diagram for GenAddress:

[legend]

Public Member Functions
	GenAddress ()
	Construct an empty invalid generic address object. More...

	GenAddress (const char *addr, const Address::addr_type use_type=Address::type_invalid)
	Construct a generic address from a string. More...

	GenAddress (const Address &addr)
	Construct a generic address from an Address object. More...

	GenAddress (const GenAddress &addr)
	Construct a generic address from another generic address object. More...

	~GenAddress ()
	Destructor, free memory. More...

SmiUINT32	get_syntax () const
	Return the syntax. More...

virtual int	get_asn1_length () const
	Return the space needed for serialization. More...

SnmpSyntax *	clone () const
	Clone this object. More...

virtual GenAddress &	operator= (const GenAddress &addr)
	Overloaded assignment operator for a GenAddress. More...

virtual Address &	operator= (const Address &addr)
	Overloaded assignment operator for a Address. More...

virtual SnmpSyntax &	operator= (const SnmpSyntax &val)
	Map other SnmpSyntax objects to GenAddress. More...

virtual const char *	get_printable () const
	Get a printable ASCII value of the address. More...

virtual	operator const char * () const
	Overloaded operator for streaming output. More...

virtual int	get_length () const
	Get the length of the binary address (accessible through operator[]). More...

void	clear ()
	Reset the object. More...

virtual addr_type	get_type () const
	Return the type of the address. More...

const IpAddress &	cast_ipaddress () const
	Access the protected address. More...

const UdpAddress &	cast_udpaddress () const
	Access the protected address. More...

virtual Address &	operator= (const Address &val)=0
	Overloaded assignment operator. More...

virtual Address &	operator= (const char *str)

virtual SnmpSyntax &	operator= (const SnmpSyntax &val)=0
	Overloaded assignment operator. More...

Public Member Functions inherited from Address
	Address ()
	Default constructor, clears the buffer and sets valid flag to false. More...

virtual	~Address ()
	Allow destruction of derived classes. More...

virtual bool	valid () const
	Return if the object contains a valid address. More...

unsigned char &	operator[] (const int position)
	Access as an array (read and write). More...

unsigned char	operator[] (const int position) const
	Access as an array (read only). More...

virtual Address &	operator= (const char *str)

virtual unsigned int	hashFunction () const

virtual SnmpSyntax &	operator= (const SnmpSyntax &val)=0
	Overloaded assignment operator. More...

Public Member Functions inherited from SnmpSyntax
virtual	~SnmpSyntax ()
	Virtual destructor to ensure deletion of derived classes... More...

Protected Member Functions
virtual bool	parse_address (const char *addr)

virtual bool	parse_address (const char *addr, const Address::addr_type use_type)

virtual void	format_output () const

virtual bool	is_gen_address () const
	Is this a GenAddress object. More...

Protected Member Functions inherited from Address
void	trim_white_space (char *ptr)
	Trim of whitespaces at the start and the end of the string. More...

Protected Member Functions inherited from SnmpSyntax
	SnmpSyntax ()

Protected Attributes
Address *	address

char	output_buffer [1]

Protected Attributes inherited from Address
SNMP_PP_MUTABLE bool	addr_changed

bool	valid_flag

unsigned char	address_buffer [ADDRBUF]

Protected Attributes inherited from SnmpSyntax
SmiVALUE	smival

Additional Inherited Members
Public Types inherited from Address
enum	addr_type { type_ip, type_ipx, type_udp, type_ipxsock, type_mac, type_invalid }
	Type returned by Address::get_type(). More...

enum	version_type { version_ipv4, version_ipv6 }
	Type returned by IpAddress::get_ip_version() and UdpAddress::get_ip_version(). More...

enum	InetAddressType { e_unknown = 0, e_ipv4 = 1, e_ipv6 = 2, e_ipv4z = 3, e_ipv6z = 4, e_dns = 16 }
	Type returned by Address::get_inet_address_type() More...

Detailed Description

Definition at line 1021 of file address.h.

Constructor & Destructor Documentation

◆ GenAddress() [1/4]

GenAddress::GenAddress ( )

Construct an empty invalid generic address object.

◆ GenAddress() [2/4]

GenAddress::GenAddress	(	const char *	addr,
		const Address::addr_type	use_type = `Address::type_invalid`
	)

Construct a generic address from a string.

To optimize the speed of the parsing method, use_type can be used to indicate that the address string is of the specified type.

Parameters

addr	- address string
use_type	- if this value is set, the input string is only parsed for the given type

◆ GenAddress() [3/4]

GenAddress::GenAddress ( const Address & addr )

Construct a generic address from an Address object.

Parameters

addr	- Any address object

◆ GenAddress() [4/4]

GenAddress::GenAddress ( const GenAddress & addr )

Construct a generic address from another generic address object.

Parameters

addr	- Generic address object to copy

◆ ~GenAddress()

GenAddress::~GenAddress ( )

inline

Destructor, free memory.

Definition at line 1059 of file address.h.

Member Function Documentation

◆ cast_ipaddress()

const IpAddress& GenAddress::cast_ipaddress ( ) const

inline

Access the protected address.

The caller must make sure that this GenAddress object ist valid() and is of the right type (get_type()).

Definition at line 1141 of file address.h.

◆ cast_udpaddress()

const UdpAddress& GenAddress::cast_udpaddress ( ) const

inline

Access the protected address.

The caller must make sure that this GenAddress object ist valid() and is of the right type (get_type()).

Definition at line 1148 of file address.h.

◆ clear()

void GenAddress::clear ( )

inlinevirtual

Reset the object.

Reimplemented from Address.

Definition at line 1125 of file address.h.

◆ clone()

SnmpSyntax* GenAddress::clone ( ) const

inlinevirtual

Clone this object.

Returns: Pointer to the newly created object (allocated through new).

Implements SnmpSyntax.

Definition at line 1082 of file address.h.

◆ format_output()

virtual void GenAddress::format_output ( ) const

inlineprotectedvirtual

Implements Address.

Definition at line 1189 of file address.h.

◆ get_asn1_length()

virtual int GenAddress::get_asn1_length ( ) const

inlinevirtual

Return the space needed for serialization.

Implements Address.

Definition at line 1074 of file address.h.

◆ get_length()

virtual int GenAddress::get_length ( ) const

inlinevirtual

Get the length of the binary address (accessible through operator[]).

Implements Address.

Definition at line 1119 of file address.h.

◆ get_printable()

virtual const char* GenAddress::get_printable ( ) const

inlinevirtual

Get a printable ASCII value of the address.

Returns: String containing the numerical address

Implements SnmpSyntax.

Definition at line 1105 of file address.h.

◆ get_syntax()

SmiUINT32 GenAddress::get_syntax ( ) const

inlinevirtual

Return the syntax.

Returns: This method returns sNMP_SYNTAX_IPADDR, sNMP_SYNTAX_OCTETS or sNMP_SYNTAX_NULL if the generic address does not have an address object.

Implements SnmpSyntax.

Definition at line 1068 of file address.h.

References sNMP_SYNTAX_NULL.

◆ get_type()

virtual addr_type GenAddress::get_type ( ) const

inlinevirtual

Return the type of the address.

See also: Address::addr_type

Returns: Type of the contained address object or Address::type_invalid if it is not valid().

Implements Address.

Definition at line 1133 of file address.h.

◆ is_gen_address()

virtual bool GenAddress::is_gen_address ( ) const

inlineprotectedvirtual

Is this a GenAddress object.

Reimplemented from Address.

Definition at line 1194 of file address.h.

◆ operator const char *()

virtual GenAddress::operator const char * ( ) const

inlinevirtual

Overloaded operator for streaming output.

Returns: String containing the numerical address

Implements Address.

Definition at line 1113 of file address.h.

◆ operator=() [1/6]

virtual Address& Address::operator=

Overloaded assignment operator.

◆ operator=() [2/6]

virtual SnmpSyntax& SnmpSyntax::operator=

Overloaded assignment operator.

◆ operator=() [3/6]

virtual Address& Address::operator=

inline

Definition at line 275 of file address.h.

◆ operator=() [4/6]

virtual GenAddress& GenAddress::operator= ( const GenAddress & addr )

virtual

Overloaded assignment operator for a GenAddress.

◆ operator=() [5/6]

virtual Address& GenAddress::operator= ( const Address & addr )

virtual

Overloaded assignment operator for a Address.

Implements Address.

◆ operator=() [6/6]

virtual SnmpSyntax& GenAddress::operator= ( const SnmpSyntax & val )

virtual

Map other SnmpSyntax objects to GenAddress.

Implements SnmpSyntax.

◆ parse_address() [1/2]

virtual bool GenAddress::parse_address ( const char * addr )

inlineprotectedvirtual

Implements Address.

Definition at line 1182 of file address.h.

References Address::type_invalid.

Referenced by Address::operator=().

◆ parse_address() [2/2]

virtual bool GenAddress::parse_address	(	const char *	addr,
		const Address::addr_type	use_type
	)

protectedvirtual

Member Data Documentation

◆ address

Address* GenAddress::address

protected

Definition at line 1178 of file address.h.

◆ output_buffer

char GenAddress::output_buffer[1]

protected

Definition at line 1179 of file address.h.

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

address.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GenAddress() [1/4]

◆ GenAddress() [2/4]

◆ GenAddress() [3/4]

◆ GenAddress() [4/4]

◆ ~GenAddress()

Member Function Documentation

◆ cast_ipaddress()

◆ cast_udpaddress()

◆ clear()

◆ clone()

◆ format_output()

◆ get_asn1_length()

◆ get_length()

◆ get_printable()

◆ get_syntax()

◆ get_type()

◆ is_gen_address()

◆ operator const char *()

◆ operator=() [1/6]

◆ operator=() [2/6]

◆ operator=() [3/6]

◆ operator=() [4/6]

◆ operator=() [5/6]

◆ operator=() [6/6]

◆ parse_address() [1/2]

◆ parse_address() [2/2]

Member Data Documentation

◆ address

◆ output_buffer