Package org.snmp4j.util
package org.snmp4j.util
Contains table retrieval utilities and multi-threading support classes as
well as miscellaneous utility classes.

The org.snmp4j.util contains the following groups of classes:
- 
  Classes for SNMP table retrieval. The class 
TableUtilscan be used to asynchronously retrieve table data efficiently row by row. - 
  Classes for support of multi-threaded message dispatching. The class
  
MultiThreadedMessageDispatcherimplements theMessageDispatcherinterface and uses theMessageDispatcherImplclass to dispatch incoming message using the threads of aThreadPool. 
  The following UML class diagram shows the classes of the
  org.snmp4j.util package and their relationships
  (relationships to other packages are not shown):

- 
ClassDescriptionThe
AbstractSnmpUtilityis an abstract base class for convenience utility classes to retrieve SNMP data.TheArgumentParserparsers a command line array into Java objects and associates each object with the corresponding command line option according to predefined schemes for options and parameters.ThisCommonTimerdefines the subset interface used fromTimerby SNMP4J.TheDefaultPDUFactoryis a default implementation of thePDUFactoryinterface.TheDefaultThreadFactorycreatesWorkerTaskinstances that allow concurrent execution of tasks.ThisDefaultTimerFactorycreates a newTimerwhich is configured to run as daemon.TheEnumerationIteratorprovides an iterator from anEnumeration.TheMultiThreadedMessageDispatcherclass is a decorator for anyMessageDispatcherinstances that processes incoming message with a suppliedThreadPool.TheOIDTextFormatprovides a textual representation of a raw object ID.PDUFactorydefines the interface for PDU factories.TheRetrievalEventis an abstract class representing the result of one or more GET/GETNEXT/GETBULK requests.TheSchedulerTaskextends theRunnableinterface by methods that are needed for recurrent execution of a task.TheSimpleOIDTextFormatimplements a simple textual representation for object IDs as dotted string.TheSimpleVariableTextFormatimplements a simple textual representation for SNMP variables based on their type only.TheSnmpConfiguratorclass configures aSnmpinstance with settings taken from aMapconforming to the format returned byArgumentParser.parse(String[] args).TheTableEventclass reports events in a table retrieval operation.TheTableListenerinterface is implemented by objects listening for table events.TheTableUtilsclass provides utility functions to retrieve SNMP tabular data.TheTaskScheduleruses aThreadPoolto recurrent executeSchedulerTasks.TheThreadFactorydescribes a factory for threads of execution modeled asWorkerTasks.TheThreadPoolprovides a pool of a fixed number of threads that are capable to execute tasks that implement theRunnableinterface concurrently.TheTimerFactorydescribes a factory forCommonTimerinstances.TheTreeEventclass reports events in a tree retrieval operation.TheTreeListenerinterface is implemented by objects listening for tree events.TheVariableTextFormatprovides a textual representation of SNMPVariables, in dependence of their associated (instance) OID.TheWorkerPoolinterface models an abstract pool of workers (threads) which can executeWorkerTasks concurrently.This models aWorkerTaskinstance that would be executed by aWorkerPoolupon submission.