agentxcpp::PingPDU Class Reference

Represents a Ping-PDU. More...

#include <PingPDU.hpp>

Inheritance diagram for agentxcpp::PingPDU:

Collaboration diagram for agentxcpp::PingPDU:

Public Member Functions
	PingPDU (binary::const_iterator &pos, const binary::const_iterator &end, bool big_endian)
	Parse constructor. More...
	PingPDU ()
	Default Constructor. More...
binary	serialize ()
	Serialize the PDU. More...
Public Member Functions inherited from agentxcpp::PDUwithContext
bool	has_context ()
	Whether the PDU has a context. More...
OctetStringVariable	get_context ()
	Get context. More...
void	set_context (OctetStringVariable value)
	Set the PDU's context. More...
void	remove_context ()
	Removes the context from the PDU. More...
Public Member Functions inherited from agentxcpp::PDU
virtual	~PDU ()
	Destructor. More...
bool	get_new_index ()
	Get new_index flag. More...
void	set_new_index (bool new_index)
	Set new_index flag. More...
bool	get_any_index ()
	Get any_index flag. More...
void	set_any_index (bool any_index)
	Set any_index flag. More...
quint32	get_sessionID ()
	Get sessionID. More...
void	set_sessionID (quint32 id)
	Set sessionID. More...
quint32	get_transactionID ()
	Get transactionID. More...
void	set_transactionID (quint32 id)
	Set transactionID. More...
quint32	get_packetID ()
	Get packetID. More...
void	set_packetID (quint32 packetID)
	Set packetID. More...
virtual binary	serialize () const =0
	Serialize function for concrete PDUs. More...

Additional Inherited Members
Static Public Member Functions inherited from agentxcpp::PDU
static QSharedPointer< PDU >	parse_pdu (binary buf)
	Parse a PDU from a buffer. More...
Protected Types inherited from agentxcpp::PDU
enum	type_t {   agentxOpenPDU = 1, agentxClosePDU = 2, agentxRegisterPDU = 3, agentxUnregisterPDU = 4,   agentxGetPDU = 5, agentxGetNextPDU = 6, agentxGetBulkPDU = 7, agentxTestSetPDU = 8,   agentxCommitSetPDU = 9, agentxUndoSetPDU = 10, agentxCleanupSetPDU = 11, agentxNotifyPDU = 12,   agentxPingPDU = 13, agentxIndexAllocatePDU = 14, agentxIndexDeallocatePDU = 15, agentxAddAgentCapsPDU = 16,   agentxRemoveAgentCapsPDU = 17, agentxResponsePDU = 18 }
	The PDU types. More...
Protected Member Functions inherited from agentxcpp::PDUwithContext
	PDUwithContext (binary::const_iterator &pos, const binary::const_iterator &end, bool big_endian)
	Parse constructor. More...
void	add_header (type_t type, binary &payload) const
	Add PDU header and context field to the payload. More...
	PDUwithContext ()
	Default Constructor. More...
Protected Member Functions inherited from agentxcpp::PDU
	PDU (binary::const_iterator &pos, const binary::const_iterator &end, bool big_endian)
	Parse constructor. More...
void	add_header (type_t type, binary &payload) const
	Construct the PDU header and add it to the payload. More...
	PDU ()
	Default constructor. More...
Protected Attributes inherited from agentxcpp::PDU
bool	instance_registration
	the instance_registration flag More...
bool	non_default_context
	Whether the PDU has a non-default context. More...
quint32	packetID
	h.packetID field according to RFC 2741, 6.1. "AgentX PDU Header". More...

Detailed Description

Represents a Ping-PDU.

Definition at line 31 of file PingPDU.hpp.

Constructor & Destructor Documentation

PingPDU::PingPDU	(	binary::const_iterator &	pos,
		const binary::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 25 of file PingPDU.cpp.

agentxcpp::PingPDU::PingPDU ( )

inline

Default Constructor.

Sets the state of the object to the defaults as set by the PDU::PDUwithContext() constructor.

Definition at line 64 of file PingPDU.hpp.

Member Function Documentation

binary PingPDU::serialize

(

)

Serialize the PDU.

Definition at line 36 of file PingPDU.cpp.

References agentxcpp::PDUwithContext::add_header(), and agentxcpp::PDU::agentxPingPDU.

---

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

• /home/tanjeff/projekte/agentxcpp/deliv/agentxcpp-0.3/src/PingPDU.hpp
• /home/tanjeff/projekte/agentxcpp/deliv/agentxcpp-0.3/src/PingPDU.cpp