StorageTable Class Reference

The StorageTable class represents tables that have a StorageType row. More...

#include <snmp_textual_conventions.h>

Inheritance diagram for StorageTable:

MibTable MibEntry MibTableVoter ThreadManager Synchronized snmpNotifyEntry snmpNotifyFilterEntry snmpNotifyFilterProfileEntry snmpProxyEntry snmpTargetAddrEntry snmpTargetParamsEntry VacmAccessTable VacmSecurityToGroupTable VacmViewTreeFamilyTable

List of all members.

Public Member Functions

 StorageTable (const StorageTable &)
 Copy constructor.
 StorageTable (const Oidx &)
 Constructor with object identifier with single index object like string or oid with implied length.
 StorageTable (const Oidx &, unsigned int)
 Constructor with object identifier and single index object's index length (meassured in subidentifiers).
 StorageTable (const Oidx &, unsigned int, boolean)
 Constructor with object identifier and given fixed index length.
 StorageTable (const Oidx &, const index_info *, unsigned int)
 Constructor with object identifier and given index structure.
virtual ~StorageTable ()
 Destructor.
virtual void add_storage_col (StorageType *)
 Add the StorageType column to the table.
void set_storage_type (MibTableRow *, int)
 Set storage type of the specified row.
virtual void reset ()
 Removes all rows that are not permanent and not read-only.

Protected Member Functions

virtual boolean is_persistent (MibTableRow *)
 Check whether the given row should be serialized or not.

Friends

class Mib
class snmpRowStatus


Detailed Description

The StorageTable class represents tables that have a StorageType row.

It provides the functionality to store the table's content permanently (on disk) and retrieve it again when the table is instanciated again.

Author:
Frank Fock
Version:
3.5.22

Constructor & Destructor Documentation

StorageTable::StorageTable ( const StorageTable  ) 

Copy constructor.

StorageTable::StorageTable ( const Oidx  ) 

Constructor with object identifier with single index object like string or oid with implied length.

Parameters:
o the object identifier of the table, which has to be the oid of the the SMI table entry object (table.1).

StorageTable::StorageTable ( const Oidx ,
unsigned  int 
)

Constructor with object identifier and single index object's index length (meassured in subidentifiers).

Parameters:
o the object identifier of the table, which has to be the oid of the the SMI table entry object (table.1).
ilen the length of the index meassured in subidentifiers. 0 represents a variable length string or oid index object. -1 represents a variable length string or oid index object with implied length.

StorageTable::StorageTable ( const Oidx ,
unsigned  int,
boolean   
)

Constructor with object identifier and given fixed index length.

Additionally the automatic index object initialization can be activated.

Parameters:
o - The object identifier of the table, which has to be the oid of the the SMI table entry object (table.1).
ilen - The length of the index meassured in subidentifiers.
a - If TRUE the automatic index object initialization is activated.

StorageTable::StorageTable ( const Oidx ,
const index_info ,
unsigned  int 
)

Constructor with object identifier and given index structure.

In AGENT++ the structure of a table's index is given by an array of integer values. Each element represents an object of the index. A value of -1 represents a implied variable length string or oid. A value of 0 a variable length string or oid index object. A value greater than 0 determines the length of the index object meassured in subidentifiers.

Parameters:
o the object identifier of the table, which has to be the oid of the the SMI table entry object (table.1).
index an integer array. The length of the array corresponds to the number of objects in the INDEX clause.
indexLength number of elements in the index array.

virtual StorageTable::~StorageTable (  )  [virtual]

Destructor.


Member Function Documentation

virtual void StorageTable::add_storage_col ( StorageType  )  [virtual]

Add the StorageType column to the table.

Parameters:
col - A pointer to a storageType object which should be added to the columnar objects of the receiver.
Note:
A table can only have one storageType columnar object.

void StorageTable::set_storage_type ( MibTableRow ,
int   
)

Set storage type of the specified row.

Parameters:
row a pointer to a MibTableRow instance of this table.
storageType a storage type value (1-5).

virtual void StorageTable::reset (  )  [virtual]

Removes all rows that are not permanent and not read-only.

Reimplemented from MibTable.

Reimplemented in VacmViewTreeFamilyTable.

virtual boolean StorageTable::is_persistent ( MibTableRow  )  [protected, virtual]

Check whether the given row should be serialized or not.

Return TRUE if the given row has a volatile class StorageType.

Parameters:
row a MibTableRow instance.
Returns:
TRUE if the row should be stored persistently, FALSE otherwise

Reimplemented from MibTable.


Friends And Related Function Documentation

friend class Mib [friend]

Reimplemented from MibTable.

friend class snmpRowStatus [friend]

Reimplemented from MibTable.


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

Generated on Fri May 29 22:36:55 2009 for AGENT++ by  doxygen 1.5.6