beautypg.com

Esnmp_register – Compaq AAR04BCTE User Manual

Page 61

background image

eSNMP API Routines

esnmp_register

esnmp_register

Requests local registration of a single MIB subtree. This indicates to the master
agent that the subagent instantiates MIB variables within the registered MIB
subtree.

Format

int esnmp_register ( subtree *subtree,

int timeout,
int priority ) ;

Arguments

subtree

A pointer to a subtree structure corresponding to the subtree to be handled.
The code emitted by the MIB compiler files (subtree_TBL.C and subtree_TBL.H)
externally declare and initialize the subtree structures. Refer to Chapter 3 for
more information about these files.

Note

All memory pointed to by the subtree fields must have permanent storage
since it is referenced by

libesnmp

for the duration of the program. You

should use the data declarations emitted by the MIBCOMP program.

timeout

The number of seconds the master agent should wait for responses when
requesting data in this subtree. This value must be between 0 (zero) and
300. If the value is 0, the default timeout is 3 seconds. Compaq recommends
that you use the default. For information about modifying the default subagent
timeout value, refer to Section 6.2.

priority

The registration priority. The priority argument allows you to coordinate
cooperating subagents to handle different configurations. The range is 1 to
255.

The entry with the largest number has the highest priority. The subagent that
registers a subtree with the highest priority over a range of object identifiers gets
all requests for that range of

OIDs

.

Subtrees registered with the same priority are considered duplicate, and the
registration is rejected by the master agent.

Description

Call the initialization routine

esnmp_init

prior to calling the

esnmp_register

.

Call the

esnmp_register

function for each subtree structure corresponding to

each subtree to be handled. At any time, subtrees can be unregistered by calling

esnmp_unregister

and then be reregistered by calling the

esnmp_register

.

When restarting the eSNMP protocol by calling

esnmp_init

, all registrations are

cleared. All subtrees must be reregistered.

eSNMP API Routines 5–3