Represents an IP address as described in RFC 2741, section 5.4. More...

#include <IpAddressVariable.hpp>

Inheritance diagram for agentxcpp::IpAddressVariable:

Public Member Functions
	IpAddressVariable (quint8 a, quint8 b, quint8 c, quint8 d)
	Construct an IpAddressValue object. More...

void	set_value (quint8 a, quint8 b, quint8 c, quint8 d)
	Set the value. More...

quint8 &	operator[] (unsigned index)
	Access a component of the stored IpAddress. More...

virtual Oid	toOid () const
	Convert the value to an OID. More...

virtual void	perform_get ()
	Perform a Get request. More...

virtual testset_result_t	perform_testset (const quint8 _v[4])
	Handle a TestSet request. More...

virtual void	perform_cleanupset (const quint8 _v[4])
	Perform an SNMP CleanupSet request. More...

virtual bool	perform_commitset (const quint8 _v[4])
	Perform an SNMP CommitSet request. More...

virtual bool	perform_undoset (const quint8 _v[4])
	Perform an SNMP UndoSet request. More...

Public Member Functions inherited from agentxcpp::AbstractVariable
virtual	~AbstractVariable ()
	Virtual destructor. More...

Protected Attributes
quint8	v [4]
	The IP address. More...

Additional Inherited Members
Public Types inherited from agentxcpp::AbstractVariable
enum	testset_result_t { noError = 0, genErr = 5, noAccess = 6, wrongType = 7, wrongLength = 8, wrongValue = 10, noCreation = 11, inconsistentValue = 12, resourceUnavailable = 13, notWritable = 17, inconsistentName = 18 }
	Result type for the TestSet validation. More...

Detailed Description

Represents an IP address as described in RFC 2741, section 5.4.

Constructor & Destructor Documentation

agentxcpp::IpAddressVariable::IpAddressVariable	(	quint8	a,
		quint8	b,
		quint8	c,
		quint8	d
	)

inline

Construct an IpAddressValue object.

The stored IpAddress is initialized to "a.b.c.d".

Exceptions

None.

Member Function Documentation

quint8& agentxcpp::IpAddressVariable::operator[] ( unsigned index )

inline

Access a component of the stored IpAddress.

This function returns the component with the given index. Note that exactly 4 components are stored. The return value is a reference to the component, so that it can be read/written, in other words, the IpAddressValue object can be accessed like an ordinary array.

Parameters

index The index (value in the range 0...3).

Returns: A reference to the component.

Exceptions

inval_param If the index is out of bound.

virtual void agentxcpp::IpAddressVariable::perform_cleanupset ( const quint8 _v[4] )

inlinevirtual

Perform an SNMP CleanupSet request.

This method is invoked when an SNMP CleanupSet request is received. It shall release any resources allocated by perform_testset().

The default implementation does nothing. If no action is required to perform the CleanupSet operation, this method need not be overridden.

Parameters

_v	The value to which the variable was (possibly) set.

virtual bool agentxcpp::IpAddressVariable::perform_commitset ( const quint8 _v[4] )

inlinevirtual

Perform an SNMP CommitSet request.

This method is invoked when an SNMP CommitSet request is received. It shall perform the actual write operation.

The default implementation returns false to indicate that the operation failed. To implement a writeable SNMP variable this method must be overridden.

Parameters

_v	The value which shall be written.

Returns: True if the operation succeeded, false otherwise.

virtual void agentxcpp::IpAddressVariable::perform_get ( )

inlinevirtual

Perform a Get request.

This method is invoked when an SNMP Get request is received. It should update the internal value v.

virtual testset_result_t agentxcpp::IpAddressVariable::perform_testset ( const quint8 _v[4] )

inlinevirtual

Handle a TestSet request.

Perform an SNMP TestSet request. This method is invoked when an SNMP TestSet request is received. It shall check whether a Set operation is possible for the variable. It shall acquire the resources needed to perform the Set operation (but the Set operation shall not yet be performed).

The default implementation returns AbstractVariable::noAccess to indicate that this is a read-only variable. Thus, for read-only variables this method need not be overridden.

Parameters

_v	The new value provided by the master agent.

Returns: The result of the check (this is reported to the master agent).

virtual bool agentxcpp::IpAddressVariable::perform_undoset ( const quint8 _v[4] )

inlinevirtual

Perform an SNMP UndoSet request.

This method is invoked when an SNMP UndoSet request is received. It shall undo whatever perform_commitset() performed. It shall also release all resources allocated by perform_testset(), because perform_cleanupset() will not be called afterwards.

The default implementation returns false to indicate that the operation failed. It is strongly recommended that writeable variables override this method.

Parameters

_v	The value just set by perform_commitset().

Returns: True on success, false otherwise.

void agentxcpp::IpAddressVariable::set_value	(	quint8	a,
		quint8	b,
		quint8	c,
		quint8	d
	)

inline

Set the value.

The stored IpAddress is updated to "a.b.c.d".

Exceptions

None.

virtual Oid agentxcpp::IpAddressVariable::toOid ( ) const

inlinevirtual

Convert the value to an OID.

The conversion is done according to RFC 2578, 7.7. "Mapping of the INDEX clause". The created OID has exactly 4 subids which corresponds to the 4 integers of the IP address.

Implements agentxcpp::AbstractVariable.

Member Data Documentation

quint8 agentxcpp::IpAddressVariable::v[4]

protected

The IP address.

According to RFC 2578, IpAddress is a 32-bit number.

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation