agentxcpp::UnregisterPDU Class Reference

This class represents an Unregister-PDU. More...

#include <UnregisterPDU.hpp>

Inheritance diagram for agentxcpp::UnregisterPDU:

Collaboration diagram for agentxcpp::UnregisterPDU:

List of all members.

Public Member Functions
void	set_upper_bound (uint32_t upper_bound)
	Set the upper_bound.
uint32_t	get_upper_bound ()
	Get the upper_bound.
void	set_subtree (oid subtree)
	Set the subtree.
oid	get_subtree ()
	Get the subtree.
void	set_range_subid (byte_t range_subid)
	Set the range_subid.
byte_t	get_range_subid ()
	Get the range_subid.
void	set_priority (byte_t priority)
	Set the priority.
byte_t	get_priority ()
	Get the priority.
	UnregisterPDU (data_t::const_iterator &pos, const data_t::const_iterator &end, bool big_endian)
	Parse constructor.
data_t	serialize () const
	Serialize the PDU.
	UnregisterPDU ()
	Default Constructor.
Private Attributes
byte_t	priority
byte_t	range_subid
oid	subtree
uint32_t	upper_bound

---

Detailed Description

This class represents an Unregister-PDU.

Definition at line 32 of file UnregisterPDU.hpp.

---

Constructor & Destructor Documentation

UnregisterPDU::UnregisterPDU	(	data_t::const_iterator &	pos,
		const data_t::const_iterator &	end,
		bool	big_endian
	)

Parse constructor.

Construct the object by parsing a stream. See Parsing incoming PDUs for details about PDU parsing.

Parameters:

pos	Iterator pointing to the current stream position. The iterator is advanced while reading the header.
end	Iterator pointing one element past the end of the current stream. This is needed to mark the end of the buffer.
big_endian	Whether the serialized form of the PDU is in big_endian format.

Exceptions:

parse_error

If parsing fails, for example because reading the stream fails or the PDU is malformed.

Definition at line 24 of file UnregisterPDU.cpp.

References priority, range_subid, read32(), subtree, and upper_bound.

UnregisterPDU::UnregisterPDU

(

)

Default Constructor.

Sets the state of the object to the defaults as set by the PDU::PDU() constructor, plus the following:

• priority = 127 (The default when registering an object according to RFC 2741, section '6.2.3. The agentx-Register-PDU')
• subtree = null Object Identifier
• range_subid = 0
• upper_bound = null Object Identifier

Definition at line 76 of file UnregisterPDU.cpp.

---

Member Function Documentation

byte_t agentxcpp::UnregisterPDU::get_priority

(

)

[inline]

Get the priority.

Definition at line 96 of file UnregisterPDU.hpp.

References priority.

byte_t agentxcpp::UnregisterPDU::get_range_subid

(

)

[inline]

Get the range_subid.

Definition at line 81 of file UnregisterPDU.hpp.

References range_subid.

oid agentxcpp::UnregisterPDU::get_subtree

(

)

[inline]

Get the subtree.

Definition at line 66 of file UnregisterPDU.hpp.

References subtree.

uint32_t agentxcpp::UnregisterPDU::get_upper_bound

(

)

[inline]

Get the upper_bound.

Definition at line 51 of file UnregisterPDU.hpp.

References upper_bound.

data_t UnregisterPDU::serialize

(

)

const [virtual]

Serialize the PDU.

Implements agentxcpp::PDU.

Definition at line 52 of file UnregisterPDU.cpp.

References agentxcpp::PDUwithContext::add_header(), agentxcpp::PDU::agentxUnregisterPDU, priority, range_subid, agentxcpp::oid::serialize(), subtree, upper_bound, and write32().

void agentxcpp::UnregisterPDU::set_priority

(

byte_t

priority

)

[inline]

Set the priority.

Definition at line 89 of file UnregisterPDU.hpp.

References priority.

void agentxcpp::UnregisterPDU::set_range_subid

(

byte_t

range_subid

)

[inline]

Set the range_subid.

Definition at line 74 of file UnregisterPDU.hpp.

References range_subid.

void agentxcpp::UnregisterPDU::set_subtree

(

oid

subtree

)

[inline]

Set the subtree.

Definition at line 59 of file UnregisterPDU.hpp.

References subtree.

void agentxcpp::UnregisterPDU::set_upper_bound

(

uint32_t

upper_bound

)

[inline]

Set the upper_bound.

Definition at line 44 of file UnregisterPDU.hpp.

References upper_bound.

---

Member Data Documentation

byte_t agentxcpp::UnregisterPDU::priority [private]

Definition at line 35 of file UnregisterPDU.hpp.

Referenced by get_priority(), serialize(), set_priority(), and UnregisterPDU().

byte_t agentxcpp::UnregisterPDU::range_subid [private]

Definition at line 36 of file UnregisterPDU.hpp.

Referenced by get_range_subid(), serialize(), set_range_subid(), and UnregisterPDU().

oid agentxcpp::UnregisterPDU::subtree [private]

Definition at line 37 of file UnregisterPDU.hpp.

Referenced by get_subtree(), serialize(), set_subtree(), and UnregisterPDU().

uint32_t agentxcpp::UnregisterPDU::upper_bound [private]

Definition at line 38 of file UnregisterPDU.hpp.

Referenced by get_upper_bound(), serialize(), set_upper_bound(), and UnregisterPDU().

---

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

• /home/tanjeff/projekte/agentxcpp/src/UnregisterPDU.hpp
• /home/tanjeff/projekte/agentxcpp/src/UnregisterPDU.cpp