AgentXRequest Class Reference

The AgentXRequest class represents requests made to an AgentX++ subagent. More...

#include <agentx_request.h>

List of all members.

Public Member Functions

 AgentXRequest (const AgentXPdu &)
 Construct a Request.
virtual ~AgentXRequest ()
 Destructor.
virtual Oidx get_oid (int)
 Return the object identifier of the specified sub-request.
virtual void set_oid (const Oidx &, int)
virtual unsigned short get_agentx_type ()
 Return the AgentX request type.
AgentXPduget_agentx_pdu ()
 Return a pointer to the AgentXPdu.
virtual boolean add_rep_row ()
 Add a repetition row to the GETBULK request PDU.
virtual void trim_request (int)
 Trim the request's variable bindings to a given number of elements.
void lock ()
 Lock the request for exclusive usage.
void unlock ()
 Unlock the request.

Friends

class AgentXRequestList
class SubAgentXMib


Detailed Description

The AgentXRequest class represents requests made to an AgentX++ subagent.

It is derived from the Request class from AGENT++. Instead of holding a Pdux instance this class holds an AgentXPdu instance.

Author:
Frank Fock
Version:
1.5

Constructor & Destructor Documentation

AgentXRequest::AgentXRequest ( const AgentXPdu  ) 

Construct a Request.

Parameters:
pdu a AgentXPdu instance.

virtual AgentXRequest::~AgentXRequest (  )  [virtual]

Destructor.


Member Function Documentation

virtual Oidx AgentXRequest::get_oid ( int   )  [virtual]

Return the object identifier of the specified sub-request.

Parameters:
index the index of the sub-request (starting from 0).
Returns:
An object identifier.

virtual void AgentXRequest::set_oid ( const Oidx &  ,
int   
) [virtual]

virtual unsigned short AgentXRequest::get_agentx_type (  )  [inline, virtual]

Return the AgentX request type.

Returns:
an AgentX PDU type.

AgentXPdu* AgentXRequest::get_agentx_pdu (  )  [inline]

Return a pointer to the AgentXPdu.

Returns:
a pointer to an AgentXPdu instance.

virtual boolean AgentXRequest::add_rep_row (  )  [virtual]

Add a repetition row to the GETBULK request PDU.

Returns:
TRUE if there was enough room in the response PDU for another repetition, FALSE otherwise.

virtual void AgentXRequest::trim_request ( int   )  [virtual]

Trim the request's variable bindings to a given number of elements.

Elements are removed starting from the end.

Parameters:
count the count of variable bindings that should remain.

void AgentXRequest::lock (  ) 

Lock the request for exclusive usage.

This is used for processing SET requests.

void AgentXRequest::unlock (  ) 

Unlock the request.


Friends And Related Function Documentation

friend class AgentXRequestList [friend]

friend class SubAgentXMib [friend]


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

Generated on Tue May 26 23:32:15 2009 for AgentX++ by  doxygen 1.5.6