saiolib.html

vxworks相关论文

it, and transmit it to the master agent.  The message is built up from
the information provided in the input parameters:
<p>
<dl>
<dt>
<i>vblist</i>
<dd>

Expects a pointer to the <b>VBL_T</b> structure containing the varbind list you
want to include in the message.
<p>
<dt>
<i>hdr_blk</i>
<dd>

Expects a pointer to the header for this message.
<p>
<dt>
<i>demuxer</i>
<dd>

Expects a pointer to the demuxer information for this message.
The demuxer information consists of a string and an object ID.
In a message dealing with a version 1 request, the string is
the community string and the object ID is unused.  In a message
dealing with a version 2 request, the string is the local entity
string from the context and the object ID is the local time object
ID from the context.
<p>
<dt>
<i>said</i>
<dd>
 Expects a pointer to the IPC mechanism (a message queue ID) that the
master agent can use to respond to this message. 
</dl>

<p>
To encode the message, this routine calls <b><i><a href="./subagentLib.html#snmpSubEncode">snmpSubEncode</a></i>(&nbsp;)</b>.
To send the message to the master agent, this routine calls <b><i><a href="./saIoLib.html#saIoWrite">saIoWrite</a></i>(&nbsp;)</b>.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
N/A
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./saIoLib.html#top">saIoLib</a></b>

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

</blockquote><h1><i>hdrBlkBuild</i>(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong><i>hdrBlkBuild</i>(&nbsp;)</strong> - create the header block and the demuxer information</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>void hdrBlkBuild
    (
    SA_HEADER_T * hdr,    /* header block */
    VBL_T *       vblist, /* vblist that was built */
    int           opt,    /* reg_option suggesting reg/dereg */
    int           group,  /* group ID */
    PTR_T         saId    /* ipchandle */
    )</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine is called to start a process that encodes a message and
transmits it to the master agent.  Internally, this routine first
prepares a header block and demuxer information.  These are then
passed in to a <b><i><a href="./saIoLib.html#saMsgBuild">saMsgBuild</a></i>(&nbsp;)</b> call, along with a varbind list, and a
pointer to the IPC mechanism that the master agent can use to
respond to this message.  As input, <b><i><a href="./saIoLib.html#hdrBlkBuild">hdrBlkBuild</a></i>(&nbsp;)</b> expects:
<p>
<dl>
<dt>
<i>hdr</i>
<dd>

Expects a pointer to a previously allocated <b>SA_HEADER_T</b> structure.  The
<b><i><a href="./saIoLib.html#hdrBlkBuild">hdrBlkBuild</a></i>(&nbsp;)</b> routine uses this structure as a storage place within
which to build the header block for the message to the master agent.
<p>

<dt>
<i>vblist</i>
<dd>

Expects a pointer to the <b>VBL_T</b> structure containing the varbind list
that you want to include in the message.
<p>

<dt>
<i>opt</i>
<dd>

Expects an operation code that indicates the type of this message.  Valid
operation codes are as follows:
<p>
<b>SA_REG_OBJ_REQUEST</b> registers an object with the master agent's MIB tree.
The response from the master agent will contain an <b>SA_REG_OBJ_REPLY</b> code.
<p>
<b>SA_REM_OBJ_REQUEST</b> removes (deregisters) an object from the master
agent's MIB tree. The response from the master agent will contain
an <b>SA_REM_OBJ_REPLY</b> code.
<p>
<b>SA_REG_INST_REQUEST</b> registers an instance with the master agent's MIB
tree.  The response from the master agent will contain an <b>SA_REG_INST_REPLY</b>
code.
<p>
<b>SA_REM_INST_REQUEST</b> removes (deregisters) an instance from the master
agent's MIB tree.  The response from the master agent will contain
an <b>SA_REG_OBJ_REPLY</b> code.
<p>
<b>SA_QUERY_REQUEST</b> requests SNMP operations.  The response from the master
agent will contain an <b>SA_QUERY_REPLY</b> code.
<p>
<b>SA_TRAP_REQUEST</b> tells the master agent that this message should be
handled as a trap.  The response from the master agent (if any) will contain
an <b>SA_TRAP_REPLY</b> code. 
<p>

<dt>
<i>group</i>
<dd>

Expects the group ID that the master agent has assigned to the objects
or instances referenced in <i>vblist</i>.  This group ID was returned in an
If <b>SA_REG_OBJ_REPLY</b> or an <b>SA_REG_INST_REPLY</b> from the master agent.
this is an object registration request, you can supply a NULL pointer here.
<p>

<dt>
<i>said</i>
<dd>
 Expects a pointer to the IPC mechanism that the master agent can use to
respond to the message.
<p>
</dl>

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

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

</blockquote><h1><i>envoy_now</i>(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong><i>envoy_now</i>(&nbsp;)</strong> - return the number of clock ticks elapsed since the timer was set</p>

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

bits32_t envoy_now (void)</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
Call this function to find out the number of clock ticks elapsed since
the timer was set.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
Elapsed time, in ticks.
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./saIoLib.html#top">saIoLib</a></b>

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

</blockquote><h1><i>envoy_call_timer</i>(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong><i>envoy_call_timer</i>(&nbsp;)</strong> - execute the specified function when the timer expires</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>void envoy_call_timer
    (
    bits32_t when,
    void (*  what)(void)
    )</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine executes the <i>what</i> function after <i>when</i> ticks have elapsed.
This function is used internally to respond when the interval between the
test and set of a "test and set" exceeds the timeout specified by <i>when</i>.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
N/A
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./saIoLib.html#top">saIoLib</a></b>

</body>
</html>