snmpdlib.html

vxworks相关论文

in that position. The function <b><i><a href="./snmpIoLib.html#snmpIoTrapSend">snmpIoTrapSend</a></i>(&nbsp;)</b> is invoked by this
routine, so any configuration required by that routine should be
done prior to calling <b><i><a href="./snmpdLib.html#snmpdInitFinish">snmpdInitFinish</a></i>(&nbsp;)</b>.
<p>
The hook routines are as follows:
<p>
<dl>
<dt>
<i>pPrivRlse</i>
<dd>

This routine is used by the agent to free any memory attached to the
private field of the <b>SNMP_PKT_T</b> structure. 
<p>
<dt>
<i>pSetPduVldt</i>
<dd>

This routine is called before any processing of a <b>set</b> request has
taken place.  It can be used to perform global validation of the
request, if needed. The return values for this routine must meet the
following requirements:
<p>
0 - indicates that the <b>set</b> PDU is valid, and processing should continue.
<p>
1 - indicates that the <b>set</b> PDU is valid, and that this routine has
already completed all the required <b>set</b> operations.
<p>
-1 - indicates that the <b>set</b> PDU is invalid and should be rejected.
<p>
<dt>
<i>pPreSet</i>
<dd>

This routine is called after all <b>testproc</b> operations have
completed successfully, but before any <b>setproc</b> operation is begun.
Return value requirements are as follows
<p>
0 - indicates that the <b>set</b> PDU is valid, and processing should continue.
<p>
1 - indicates that the <b>set</b> PDU is valid, and that this routine has
already completed all the required <b>set</b> operations.
<p>
-1 - indicates that the <b>set</b> PDU is invalid and should be rejected.
<p>
<dt>
<i>pPostSet</i>
<dd>

This routine is called after all <b>setproc</b> have completed
successfully. This routine can be used to free resources allocated
during <b>set</b> processing. 
<p>
<dt>
<i>pSetFailed</i>
<dd>
 This routine is possibly called under two sets of circumstances:
after all <b>testproc</b> operations have returned and some of them have
failed, and/or after all <b>undoproc</b> operations have returned and
some <b>setproc</b> operations have failed.  It can be used to do any
required cleanup.   
</dl>

<p>

</blockquote><h4>RETURNS</h4><blockquote><p>
N/A
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./snmpdLib.html#top">snmpdLib</a></b>

<hr>
<a name="snmpdExit"></a>
<p align=right>
<a href="rtnIndex.html"><i>Libraries :  Routines</i></a></p>

</blockquote><h1><i>snmpdExit</i>(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong><i>snmpdExit</i>(&nbsp;)</strong> - exit the SNMP agent</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>

void snmpdExit (void)</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine causes the SNMP agent to exit.  It is available in case
the user encounters some problem after a successful startup. 
<p>
This routine must be called from the main thread. Any other tasks
spawned by the user (for asynchronous method routines) should be
deleted prior to calling this function.
<p>

</blockquote><h4>RETURNS</h4><blockquote><p>
N/A
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./snmpdLib.html#top">snmpdLib</a></b>

<hr>
<a name="snmpdContinue"></a>
<p align=right>
<a href="rtnIndex.html"><i>Libraries :  Routines</i></a></p>

</blockquote><h1><i>snmpdContinue</i>(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong><i>snmpdContinue</i>(&nbsp;)</strong> - continue processing of an SNMP packet</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>void snmpdContinue
    (
    SNMP_PKT_T * pktp /* snmp packet */
    )</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine continues processing a packet. <b><i><a href="./snmpdLib.html#snmpdPktProcess">snmpdPktProcess</a></i>(&nbsp;)</b> begins
the method routines needed to fulfill the request, while this
routine determines whether the current set of method routines have
finished; it then either starts more method routines or sends a
response packet.
<p>
If a method routine returns before completing its task, it must
arrange for <b><i><a href="./snmpdLib.html#snmpdContinue">snmpdContinue</a></i>(&nbsp;)</b> to be called when the task is completed.
You must obtain the write-lock on this packet by calling
<b><i><a href="./snmpdLib.html#snmpdPktLockGet">snmpdPktLockGet</a></i>(&nbsp;)</b> prior to calling <b><i><a href="./snmpdLib.html#snmpdContinue">snmpdContinue</a></i>(&nbsp;)</b>. <b><i><a href="./snmpdLib.html#snmpdContinue">snmpdContinue</a></i>(&nbsp;)</b> 
releases the write-lock when it completes.
<p>
<i>pktp</i> is a pointer to the structure that contains the packet.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
N/A
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./snmpdLib.html#top">snmpdLib</a></b>

<hr>
<a name="snmpdGroupByGetprocAndInstance"></a>
<p align=right>
<a href="rtnIndex.html"><i>Libraries :  Routines</i></a></p>

</blockquote><h1><i>snmpdGroupByGetprocAndInstance</i>(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong><i>snmpdGroupByGetprocAndInstance</i>(&nbsp;)</strong> - gather set of similar variable bindings</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>void snmpdGroupByGetprocAndInstance
    (
    SNMP_PKT_T * pktp,     /* snmp packet */
    VB_T *       firstVbp, /* first var bind */
    int          compc,    /* component count */
    OIDC_T *     compl     /* component length */
    )</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine gathers a set of similar variable bindings together by
searching the variable bindings in <i>pktp</i>, starting at <i>firstVbp</i>
for a match of the <b>getproc</b> pointer of <i>firstVbp</i> and with an
instance specified by <i>compc</i> and <i>compl</i>.  This routine then links
the variable bindings found which match <i>firsVbp</i>.
<p>
This routine does not set any flags in the variable bindings. It is
left to the calling routine to decide whether the <i>tested</i> or <i>set</i> flags
should be set.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
N/A
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./snmpdLib.html#top">snmpdLib</a></b>

<hr>
<a name="snmpdVbRowExtract"></a>
<p align=right>
<a href="rtnIndex.html"><i>Libraries :  Routines</i></a></p>

</blockquote><h1><i>snmpdVbRowExtract</i>(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong><i>snmpdVbRowExtract</i>(&nbsp;)</strong> - extract required pieces of a row for a <b>set</b> operation</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>VB_T * snmpdVbRowExtract
    (
    SNMP_PKT_T *        pktp,                 /* snmp packet */
    int                 start_index,          /* starting index */
    int                 compc,                /* component count */
    OIDC_T *            compl,                /* component length */
    int                 row_structure_length, /* length of row structure */
    struct create_row * row                   /* row structure */
    )</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine assists in implementing row-creation <b>set</b> operations.
It is typically used by the <b>testproc</b> routine for a table. It scans
the SNMP packet looking for all the pieces that go together for the
purposes of creating a new row in an SNMP table.
<p>
The parameter <i>row</i> describes what this routine is looking for.
<i>row</i> is a list of MIB leaf pointers referring to variables in the
table in question, and a flag indicating if this variable (<i>column</i>)
in the table is required.  This routine searches the variable
bindings in <i>pktp</i> for a match of the MIB leaf pointer specified in
the row array and the instance specified by <i>compc</i> and <i>compl</i>. It
links the variable bindings found from the first MIB leaf node in
the row array.  This first variable binding must be in the packet 
whether it is marked as needed or not, and is the return value of
<b><i><a href="./snmpdLib.html#snmpdVbRowExtract">snmpdVbRowExtract</a></i>(&nbsp;)</b>.
<p>
If <b><i><a href="./snmpdLib.html#snmpdVbRowExtract">snmpdVbRowExtract</a></i>(&nbsp;)</b> does not find a matching variable binding and
that leaf is flagged <b>ROW_FLAG_NEEDED</b> in the row array, the routine
returns NULL to indicate an error.
<p>
This routine marks the variable bindings in the resulting list as
already tested except for the first entry, which is marked as
already set.  As a result, the agent only calls the <b>set</b> routine
associated with the first MIB leaf in the row array.  This <b>set</b>
routine should handle creation of the necessary data structures and
reading the variable binding list to execute the required <b>set</b>
operations.  You can force other entries set routines to be called
by flagging entries with <b>ROW_FLAG_CALL_SET</b>.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
a pointer to the first variable binding if successful,
otherwise NULL.
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./snmpdLib.html#top">snmpdLib</a></b>

<hr>
<a name="snmpdVbExtractRowLoose"></a>
<p align=right>
<a href="rtnIndex.html"><i>Libraries :  Routines</i></a></p>

</blockquote><h1><i>snmpdVbExtractRowLoose</i>(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong><i>snmpdVbExtractRowLoose</i>(&nbsp;)</strong> - incrementally extract pieces of a row for a set </p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>VB_T * snmpdVbExtractRowLoose
    (
    SNMP_PKT_T *  pktp,   /* snmp packet */
    int           indx,   /* index */
    MIBLEAF_T * * leaves, /* mib leaves */
    int           compc,  /* component count */
    OIDC_T *      compl   /* component length */
    )</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine assists in implementing row-creation <b>set</b> operations,
especially in the case of <b>`dribble</b><b> creation.  In <b>`dribble</b>
creation, the network management station may choose to break the
creation of a new entry in some table into multiple packets.  Using
multiple packets does not work with <b><i><a href="./snmpdLib.html#snmpdVbRowExtract">snmpdVbRowExtract</a></i>(&nbsp;)</b>, which
requires at least one specified item to be in the packet.
<p>
In dribble creation, there is no single item that is guaranteed to
be in every packet.  As its name implies, this routine is similar to
<b><i><a href="./snmpdLib.html#snmpdVbRowExtract">snmpdVbRowExtract</a></i>(&nbsp;)</b>.  It searches the variable bindings in <i>pktp</i>
starting at <i>indx</i> for a match of the MIB leaf pointer specified in
the <i>leaves</i> array and with an instance specified by <i>compc</i> and
<i>compl</i>.  The routine then links the variable bindings found from
the last variable binding found.
<p>
If no variable bindings are found, this routine returns a NULL
pointer.  This routine does not set any of the flags in the variable
bindings.  It is left to the calling routine to decide if the <i>tested</i>
or <i>set</i> flags should be set.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
a pointer to the last variable binding if successful,
otherwise NULL.
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./snmpdLib.html#top">snmpdLib</a></b>

<hr>
<a name="snmpdPktLockGet"></a>
<p align=right>
<a href="rtnIndex.html"><i>Libraries :  Routines</i></a></p>

</blockquote><h1><i>snmpdPktLockGet</i>(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong><i>snmpdPktLockGet</i>(&nbsp;)</strong> - lock an SNMP packet </p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS snmpdPktLockGet
    (
    SNMP_PKT_T * pktp /* snmp packet */
    )</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine obtains a lock on the SNMP packet being processed,
which must be obtained by any asynchronous method routine prior to
calling any of the routines <b>getproc_*</b>, <b>nextproc_*</b>, <b>testproc_*</b>,
or <b>setproc_*</b>, or also <b><i><a href="./snmpdLib.html#snmpdContinue">snmpdContinue</a></i>(&nbsp;)</b>. <b><i><a href="./snmpdLib.html#snmpdContinue">snmpdContinue</a></i>(&nbsp;)</b> releases
the lock before returning. No other routine can release this lock.
<p>
This routine blocks until the lock is obtained.
<p>
Returns: OK, or ERROR on failure.
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./snmpdLib.html#top">snmpdLib</a></b>, <b><a href="./snmpProcLib.html#top">snmpProcLib</a></b>, <b><i><a href="./snmpdLib.html#snmpdContinue">snmpdContinue</a></i>(&nbsp;)</b>

</body>
</html>