MibBrowser Class

Properties   Methods   Events   Configuration Settings   Errors  

The MIBBrowser class is used to parse SNMP MIB Module definitions.

Class Name

IPWorksSNMP_MibBrowser

Procedural Interface

 ipworkssnmp_mibbrowser_open();
 ipworkssnmp_mibbrowser_close($res);
 ipworkssnmp_mibbrowser_register_callback($res, $id, $function);
 ipworkssnmp_mibbrowser_get_last_error($res);
 ipworkssnmp_mibbrowser_get_last_error_code($res);
 ipworkssnmp_mibbrowser_set($res, $id, $index, $value);
 ipworkssnmp_mibbrowser_get($res, $id, $index);
 ipworkssnmp_mibbrowser_do_config($res, $configurationstring);
 ipworkssnmp_mibbrowser_do_listchildren($res);
 ipworkssnmp_mibbrowser_do_listsuccessors($res);
 ipworkssnmp_mibbrowser_do_listtraps($res);
 ipworkssnmp_mibbrowser_do_loadmib($res, $filename);
 ipworkssnmp_mibbrowser_do_reset($res);
 ipworkssnmp_mibbrowser_do_selectnode($res, $selector);

Remarks

The MIBBrowser class allows easy loading and querying of definitions in the SNMP Management Information Base (MIB) specifications.

The LoadMib method allows loading of MIB modules, which get stored in an internal tree structure for further queries.

If modules reference (import) other modules, recursive loading of modules is performed automatically and/or controlled by the ImportSymbols event.

The MIB tree is navigated through the SelectNode method, which enables pointing to a node in the tree specified by NodeOid and NodeLabel. Other node information is provided through the NodeModuleName, NodeFileName, NodeSyntax, NodeType, and NodeAccess properties.

The node selector parameter in SelectNode can be a label such as "internet", an OID such as "1.3.6.4", a combination of the two: "iso.3.dod.internet", or a label in a particular module such as "RFC1213-MIB!interfaces".

Node children and successors are provided by the ListChildren and ListSuccessors methods. The individual node information is provided via the MibNode event.

Module traps are listed via the ListTraps method. The individual trap information is provided through the TrapNode event.

Property List


The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

ExactMatchControls the way the OID matching is done (complete or partial).
NodeAccessThe access permissions for the selected node.
NodeDescriptionTextual description of the selected node.
NodeFileNameThe absolute path of the file where the selected node is declared.
NodeFullLabelThe full label of the selected node.
NodeIndexThe index of the node in a table.
NodeLabelThe label of the selected node.
NodeModuleNameThe name of the module where the selected node is declared.
NodeOidThe Object ID of the selected node.
NodeSubIdThe SubId of the currently selected node.
NodeSyntaxThe syntax of the selected node.
NodeSyntaxStringThe node syntax of the selected node in text format.
NodeTypeThe type of the selected node.
NodeTypeStringThe node type of the selected node in text format.

Method List


The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

ConfigSets or retrieves a configuration setting.
ListChildrenLists the immediate children of the selected node.
ListSuccessorsLists all successors of the selected node.
ListTrapsLists all the traps defined in the loaded modules.
LoadMibParses the file FileName and adds the parsed nodes to the collection of existing nodes.
ResetReset all properties of the class.
SelectNodeUsed to select individual nodes in the loaded MIB module(s).

Event List


The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

ErrorErrors that occur while loading/parsing MIB modules are fired through this event.
ImportSymbolsList of imported symbols and the respective modules where they are declared.
MibNodeThis event fires once for every child or successor of the currently selected node when invoking ListChildren or ListSuccessors .
TrapNodeLists module trap information.

Configuration Settings


The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.

AutoLoadMibsDetermines whether imported MIB modules are loaded automatically.
CacheDescriptionsControls caching of Node descriptions.
CacheMibsControls MIB module caching.
CheckNoKnownRootsControls whether or not the class fails when a file with no known root is loaded.
DisplayHintThe DISPLAY-HINT property for the current node.
MibExtensionsControls the file extensions that the class will search for.
NodeIsColumnarWhether the current node is columnar.
NodeIsScalarWhether the current node is scalar.
ReleaseTempNodesWill release any temporary nodes stored by the class.
ReturnEnumValuesComma-separated list of the current node's enumeration textual-conventions.
UndefinedSymbolsComma-separated list of nodes that have not been resolved.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks SNMP 2020 PHP Edition - Version 20.0 [Build 7941]