AGENT++  4.0.3
Public Member Functions | Protected Attributes | List of all members
MibStaticTable Class Reference

#include <mib_complex_entry.h>

Inheritance diagram for MibStaticTable:
MibComplexEntry MibEntry ThreadManager Synchronized

Public Member Functions

 MibStaticTable (const Oidx &)
 Construct a static table (entry) instance with a given object identifier.
 
 MibStaticTable (MibStaticTable &)
 Copy constructor.
 
virtual ~MibStaticTable ()
 Destructor.
 
virtual MibEntryclone ()
 Return a clone of the receiver.
 
virtual void add (const MibStaticEntry &)
 Add an instance to the table.
 
virtual void remove (const Oidx &)
 Remove an instance from the table.
 
virtual MibStaticEntryget (const Oidx &, bool suffixOnly=FALSE)
 Get the entry instance with the given OID.
 
virtual Oidx find_succ (const Oidx &, Request *req=0)
 Return the successor of a given object identifier within the receiver's scope and the context of a given Request.
 
virtual void get_request (Request *, int)
 Let the receiver process a SNMP GET subrequest.
 
virtual void get_next_request (Request *, int)
 Let the receiver process a SNMP GETNEXT subrequest.
 
- Public Member Functions inherited from MibComplexEntry
 MibComplexEntry (const Oidx &, mib_access)
 Construct a MibComplexEntry instance with a given object identifier and maximum access rights.
 
 MibComplexEntry (const MibComplexEntry &)
 Copy constructor.
 
virtual ~MibComplexEntry ()
 Destructor.
 
virtual mib_type type () const
 Return the type of the receiver MIB node.
 
virtual int commit_set_request (Request *, int)
 Let the receiver commit a SNMP SET subrequest.
 
virtual int prepare_set_request (Request *, int &)
 Let the receiver prepare a SNMP SET subrequest.
 
virtual int undo_set_request (Request *, int &)
 Let the receiver undo a SNMP SET subrequest.
 
virtual void cleanup_set_request (Request *, int &)
 Clean up resources used for performing (or undoing) set requests.
 
virtual bool serialize (char *&, int &)
 Serialize the value of the receiver.
 
virtual bool deserialize (char *, int &)
 Read the value of the receiver from a byte stream.
 
virtual bool is_empty ()
 Check whether the receiver node contains any instance of a managed object.
 
virtual OidxPtr max_key ()
 Return the immediate successor of the greatest object identifier within the receiver's scope.
 
- Public Member Functions inherited from MibEntry
 MibEntry ()
 Default constructor.
 
 MibEntry (const Oidx &, mib_access)
 Construct a MibEntry instance with a given object identifier and maximum access rights.
 
 MibEntry (const MibEntry &)
 Copy constructor.
 
virtual ~MibEntry ()
 Destructor.
 
virtual void load_from_file (const char *)
 Load the value(s) of the receiver node from a file.
 
virtual void save_to_file (const char *)
 Save the value(s) of the receiver node to a file.
 
virtual void notify_change (const Oidx &, mib_change)
 Notify all registered nodes of changes to an object managed by the receiver node.
 
virtual void register_for_notifications (MibEntry *)
 Register an MibEntry object to receive notifications about changes of the receiver node.
 
virtual void add_change_notification (MibEntry *e)
 Wrapper function for register_for_notifications.
 
virtual void change_notification (const Oidx &, mib_change)
 Receive a notification about changes to a managed object.
 
OidxPtr key ()
 Return a pointer to the key (object identifier) of the receiver.
 
virtual mib_access get_access ()
 Return the maximum access rights for the managed object represented by the receiver node.
 
virtual bool is_volatile ()
 Check whether the entry is volatile or not.
 
virtual void reset ()
 Resets (clears) the content of this entry.
 
int operator< (const MibEntry &) const
 
int operator> (const MibEntry &) const
 
int operator== (const MibEntry &) const
 
int operator< (const Oidx &) const
 
int operator> (const Oidx &) const
 
int operator<= (const Oidx &) const
 
int operator>= (const Oidx &) const
 
int operator== (const Oidx &) const
 
- Public Member Functions inherited from ThreadManager
 ThreadManager ()
 Default constructor.
 
virtual ~ThreadManager ()
 Destructor.
 
void start_synch ()
 Start synchronized execution.
 
void end_synch ()
 End synchronized execution.
 
- Public Member Functions inherited from Synchronized
 Synchronized ()
 
 ~Synchronized ()
 
void wait ()
 Causes current thread to wait until another thread invokes the notify() method or the notifyAll() method for this object.
 
bool wait (unsigned long timeout)
 Causes current thread to wait until either another thread invokes the notify() method or the notifyAll() method for this object, or a specified amount of time has elapsed.
 
void notify ()
 Wakes up a single thread that is waiting on this object's monitor.
 
void notify_all ()
 Wakes up all threads that are waiting on this object's monitor.
 
bool lock ()
 Enter a critical section.
 
TryLockResult trylock ()
 Try to enter a critical section.
 
bool unlock ()
 Leave a critical section.
 

Protected Attributes

OidList< MibStaticEntrycontents
 
- Protected Attributes inherited from MibComplexEntry
Oidx upperBound
 
- Protected Attributes inherited from MibEntry
Oidx oid
 
mib_access access
 
List< MibEntrynotifies
 

Additional Inherited Members

- Public Types inherited from Synchronized
enum  TryLockResult { LOCKED = 1, BUSY = 0, OWNED = -1 }
 
- Static Public Member Functions inherited from ThreadManager
static void start_global_synch ()
 Start global synchronized execution.
 
static void end_global_synch ()
 End global synchronized execution.
 
- Protected Member Functions inherited from MibEntry
void set_oid (const Oidx &)
 Set the object identifier of the receiver node.
 

Constructor & Destructor Documentation

MibStaticTable::MibStaticTable ( const Oidx )

Construct a static table (entry) instance with a given object identifier.

Parameters
oidan object identifier.
MibStaticTable::MibStaticTable ( MibStaticTable )

Copy constructor.

Parameters
otheranother MibComplexEntry instance.
virtual MibStaticTable::~MibStaticTable ( )
virtual

Destructor.

Member Function Documentation

virtual void MibStaticTable::add ( const MibStaticEntry )
virtual

Add an instance to the table.

If such an instance already exists, it will be removed. (SYNCHRONIZED)

Parameters
instancea MibStaticEntry instance.
virtual MibEntry* MibStaticTable::clone ( )
inlinevirtual

Return a clone of the receiver.

Returns
a pointer to a clone of the MibStaticTable object.

Implements MibComplexEntry.

virtual Oidx MibStaticTable::find_succ ( const Oidx ,
Request req = 0 
)
virtual

Return the successor of a given object identifier within the receiver's scope and the context of a given Request.

Parameters
oidan object identifier
requesta pointer to a Request instance.
Returns
an object identifier if a successor could be found, otherwise (if no successor exists or is out of scope) a zero length oid is returned

Implements MibComplexEntry.

virtual MibStaticEntry* MibStaticTable::get ( const Oidx ,
bool  suffixOnly = FALSE 
)
virtual

Get the entry instance with the given OID.

If suffixOnly is FALSE (the default), the specified OID must be the full OID of the entry, including the OID prefix from the MibStaticTable. (NOT SYBCHRONIZED)

Parameters
oidthe OID (or OID suffix) of the requested entry.
suffixOnlydetermines whether the given OID should be interpreted as suffix appended to the table's OID or whether the given OID fully specifies the requested entry.
Returns
the entry with the given OID or 0 if such an object does not exist.
virtual void MibStaticTable::get_next_request ( Request ,
int   
)
virtual

Let the receiver process a SNMP GETNEXT subrequest.

Parameters
req- A pointer to the whole SNMP GETNEXT request.
ind- The index of the subrequest to be processed.

Implements MibComplexEntry.

virtual void MibStaticTable::get_request ( Request ,
int   
)
virtual

Let the receiver process a SNMP GET subrequest.

Parameters
req- A pointer to the whole SNMP GET request.
ind- The index of the subrequest to be processed.

Implements MibComplexEntry.

virtual void MibStaticTable::remove ( const Oidx )
virtual

Remove an instance from the table.

(SYNCHRONIZED)

Parameters
oidthe object ID of the entry to be removed.

Member Data Documentation

OidList<MibStaticEntry> MibStaticTable::contents
protected

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