The class SimMibLeaf can be used to create simulation agents. More...

#include <sim_mib.h>

Inheritance diagram for SimMibLeaf:

Public Member Functions
	SimMibLeaf ()
	Default constructor.

	SimMibLeaf (const Oidx &, mib_access, NS_SNMP SmiUINT32)
	Construct a MibLeaf object.

	SimMibLeaf (const Oidx &, mib_access, NS_SNMP SnmpSyntax *)
	Construct a MibLeaf object.

	SimMibLeaf (const Oidx &, mib_access, NS_SNMP SnmpSyntax *, bool)
	Construct a MibLeaf object.

	SimMibLeaf (const SimMibLeaf &)
	Copy Constructor.

virtual	~SimMibLeaf ()
	Destructor.

virtual MibEntryPtr	clone ()
	Clone the receiver object.

virtual mib_access	get_access ()
	Return the maximum access rights for the managed object represented by the receiver node.

Public Member Functions inherited from MibLeaf
	MibLeaf ()
	Default constructor.

	MibLeaf (const Oidx &, mib_access, NS_SNMP SmiUINT32)
	Construct a MibLeaf object.

	MibLeaf (const Oidx &, mib_access, NS_SNMP SnmpSyntax *)
	Construct a MibLeaf object.

	MibLeaf (const Oidx &, mib_access, NS_SNMP SnmpSyntax *, int)
	Construct a MibLeaf object.

	MibLeaf (const MibLeaf &)
	Copy Constructor.

virtual	~MibLeaf ()
	Destructor.

virtual void	init (NS_SNMP SnmpSyntax *, int)
	Initialize a MibLeaf object.

virtual mib_type	type () const
	Return the type of the receiver.

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 NS_SNMP SmiUINT32	get_syntax () const
	Get the syntax of the receiver's value.

virtual Vbx	get_value () const
	Get the value of the receiver.

virtual int	get_value (NS_SNMP SnmpSyntax &s) const
	Get the value of the receiver.

virtual int	get_value (int &i) const
	Get the value of the receiver.

virtual int	get_value (long &i) const
	Get the value of the receiver.

virtual int	get_value (unsigned long &i) const
	Get the value of the receiver.

virtual int	get_value (char *c) const
	Get the value of the receiver.

virtual void	set_value (const NS_SNMP SnmpSyntax &)
	Set the value of the receiver by value.

virtual void	set_value (const unsigned long)
	Set the unsigned integer value of the receiver.

virtual int	set_value (const Vbx &)
	Set the value of the receiver from a variable binding and checks for validity of the variable binding and compatible syntax and oid.

virtual void	replace_value (NS_SNMP SnmpSyntax *s)
	Set the value of the receiver by reference.

virtual OidxPtr	max_key ()
	Return the immediate successor of the greatest object identifier within the receiver's scope.

virtual void	get_request (Request *, int)
	Interface methods dispatch table <-> instrumentation.

virtual void	get_next_request (Request *, int)
	Let the receiver process a SNMP GETNEXT subrequest.

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	value_ok (const Vbx &)
	Check whether the receiver's value may be set to the given new value.

virtual int	set (const Vbx &vb)
	Set the receiver's value and backup its old value for a later undo.

virtual int	unset ()
	Undo a previous set.

MibTable *	get_reference_to_table ()
	Return a pointer to the table the receiver belongs to.

MibTableRow *	get_reference_to_row ()
	Return a pointer to the row the receiver belongs to.

int	valid ()
	Gets the flags (bits) that determine the type/stage of validity of the leaf's value.

bool	has_default ()
	Return whether the receiver has a default value.

bool	is_locked ()
	Return whether the receiver has a default value.

void	set_reference_to_table (MibTable *t)
	Set the receiver's reference to its table.

void	set_reference_to_row (MibTableRow *r)
	Set the receiver's reference to its row.

void	set_access (mib_access a)
	Set the maximum access rights of the receiver.

Oidx	get_oid () const
	Get the instance OID of the MibLeaf object.

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 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	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 bool	is_empty ()
	Check whether the receiver node contains any instance of a managed object.

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 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.

Static Public Member Functions
static void	set_config_mode ()
	Set config mode.

static void	unset_config_mode ()
	Unset config mode.

static bool	get_config_mode ()
	Get the current config mode.

Static Protected Attributes
static bool	configMode

Additional Inherited Members
Public Types inherited from Synchronized
enum	TryLockResult { LOCKED = 1, BUSY = 0, OWNED = -1 }

Protected Member Functions inherited from MibLeaf
int	get_value_mode ()
	Return the value handle mode.

void	set_validity (int flags)
	Sets the flags (bits) that determine the type/stage of validity of the leaf's value.

void	set_syntax (NS_SNMP SmiUINT32)
	Set the syntax of the receiver's value and delete the old value.

void	free_value ()
	Frees the receiver's value and sets it to NULL.

Protected Attributes inherited from MibLeaf
NS_SNMP SnmpSyntax *	value

NS_SNMP SnmpSyntax *	undo

int	value_mode

int	validity
	Set of flags (bits) that determine the type/stage of validity of the leaf's value.

MibTable *	my_table

MibTableRow *	my_row

Detailed Description

The class SimMibLeaf can be used to create simulation agents.

Author: Frank Fock

Version: 3.1c

Constructor & Destructor Documentation

SimMibLeaf::SimMibLeaf ( )

Default constructor.

SimMibLeaf::SimMibLeaf	(	const Oidx &	,
		mib_access	,
		NS_SNMP	SmiUINT32
	)

Construct a MibLeaf object.

Parameters

o	- The object identifier of the managed object. If it is part of a table, only the column subidentifier is given. If it is a scalar object the object identifier given includes the full registration oid including the suffix ".0".
a	- The maximum access rights for the managed object.
s	- The syntax of the managed object.

See Also: Oidx, mib_access

SimMibLeaf::SimMibLeaf	(	const Oidx &	,
		mib_access	,
		NS_SNMP SnmpSyntax *
	)

Construct a MibLeaf object.

Parameters

o	- The object identifier of the managed object. If it is part of a table, only the column subidentifier is given. If it is a scalar object the object identifier given includes the full registration oid including the suffix ".0".
a	- The maximum access rights for the managed object.
s	- A pointer to the SnmpSyntax object to be used for storing the value of the managed object. NOTE: Do not delete this pointer from outside MibLeaf. It will be deleted by ~MibLeaf

See Also: Oidx, mib_access

SimMibLeaf::SimMibLeaf	(	const Oidx &	,
		mib_access	,
		NS_SNMP SnmpSyntax *	,
		bool
	)

Construct a MibLeaf object.

Parameters

o	- The object identifier of the managed object. If it is part of a table, only the column subidentifier is given. If it is a scalar object the object identifier given includes the full registration oid including the suffix ".0".
a	- The maximum access rights for the managed object.
s	- A pointer to the SnmpSyntax object to be used for storing the value of the managed object. NOTE: Do not delete this pointer from outside MibLeaf. It will be deleted by ~MibLeaf
d	- If TRUE the value of the object pointed by s will be used as default value, otherwise the managed object has no default value.

See Also: Oidx, mib_access

SimMibLeaf::SimMibLeaf ( const SimMibLeaf & )

Copy Constructor.

virtual SimMibLeaf::~SimMibLeaf ( )

virtual

Destructor.

Member Function Documentation

virtual MibEntryPtr SimMibLeaf::clone ( )

virtual

Clone the receiver object.

Returns: A pointer to the clone.

Reimplemented from MibLeaf.

virtual mib_access SimMibLeaf::get_access ( )

virtual

Return the maximum access rights for the managed object represented by the receiver node.

Returns: The maximum access (one of the following values: NOACCESS, READONLY, READWRITE, or READCREATE)

Reimplemented from MibEntry.

static bool SimMibLeaf::get_config_mode ( )

static

Get the current config mode.

Returns: true if the config mode is set, false otherwise.

static void SimMibLeaf::set_config_mode ( )

static

Set config mode.

All SimMibLeaf objects acting as a leaf object get access rights of read-write and all SimMibLeaf objects acting as a columnar object get read-create access rights.

static void SimMibLeaf::unset_config_mode ( )

static

Unset config mode.

All SimMibLeaf objects get their original access rights (i.e., those rights they got when they have been constructed).

Member Data Documentation

bool SimMibLeaf::configMode

staticprotected

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

sim_mib.h

Public Member Functions

Static Public Member Functions

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation