wvlib.html

Vxworks API操作系统和驱动程序设计API。压缩的HTML文件

<a name="wvLibInit"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>wvLibInit(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>wvLibInit(&nbsp;)</strong> - initialize <b><a href="./wvLib.html#top">wvLib</a></b> - first step (WindView)</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>void wvLibInit (void)</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine starts initializing <b><a href="./wvLib.html#top">wvLib</a></b>.  Its actions should be performed 
before object creation, so it is called from <b>usrKernelInit(&nbsp;)</b> in <b>usrKernel.c</b>.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
N/A
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./wvLib.html#top">wvLib</a></b>

<hr>
<a name="wvLibInit2"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>wvLibInit2(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>wvLibInit2(&nbsp;)</strong> - initialize <b><a href="./wvLib.html#top">wvLib</a></b> - final step (WindView)</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>void wvLibInit2 (void)</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine is called after <b><a href="./wvLib.html#wvLibInit">wvLibInit</a>(&nbsp;)</b> to complete the initialization of
<b><a href="./wvLib.html#top">wvLib</a></b>.  It should be called before starting any event logging.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
N/A
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./wvLib.html#top">wvLib</a></b>

<hr>
<a name="wvEvtLogInit"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>wvEvtLogInit(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>wvEvtLogInit(&nbsp;)</strong> - initialize an event log (WindView)</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>void wvEvtLogInit
    (
    BUFFER_ID evtBufId        /* event-buffer id */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine initializes event logging by associating a particular event
buffer with the logging functions.  It must be called before event logging
is turned on.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
N/A
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./wvLib.html#top">wvLib</a></b>

<hr>
<a name="wvEvtLogStart"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>wvEvtLogStart(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>wvEvtLogStart(&nbsp;)</strong> - start logging events to the buffer (WindView)</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>void wvEvtLogStart (void)</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine starts event logging.  It also resets the timestamp
mechanism so that it can be called more than once without stopping event
logging.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
N/A
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./wvLib.html#top">wvLib</a></b>

<hr>
<a name="wvEvtLogStop"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>wvEvtLogStop(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>wvEvtLogStop(&nbsp;)</strong> - stop logging events to the buffer (WindView)</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>void wvEvtLogStop (void)</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine turns off all event logging, including event-logging of
objects and signals specifically requested by the user.  In addition,
it disables the timestamp facility.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
N/A
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./wvLib.html#top">wvLib</a></b>

<hr>
<a name="wvEvtClassSet"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>wvEvtClassSet(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>wvEvtClassSet(&nbsp;)</strong> - set the class of events to log (WindView)</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>void wvEvtClassSet
    (
    UINT32 classDescription   /* description of evt classes to set */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine sets the class of events which are logged when event
logging is started.  <i>classDescription</i> can take the following values:
<p>
<pre>     WV_CLASS_1      /* Events causing context switches */
     WV_CLASS_2      /* Events causing task-state transitions */
     WV_CLASS_3      /* Events from object and system libraries */
</pre>

See <b><a href="./wvLib.html#top">wvLib</a></b> for more information about these classes, particularly Class 3.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
N/A
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./wvLib.html#top">wvLib</a></b>, <b><a href="./wvLib.html#wvObjInst">wvObjInst</a>(&nbsp;)</b>, <b><a href="./wvLib.html#wvObjInstModeSet">wvObjInstModeSet</a>(&nbsp;)</b>, <b><a href="./wvLib.html#wvSigInst">wvSigInst</a>(&nbsp;)</b>, <b><a href="./wvLib.html#wvEventInst">wvEventInst</a>(&nbsp;)</b>

<hr>
<a name="wvEvtClassGet"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>wvEvtClassGet(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>wvEvtClassGet(&nbsp;)</strong> - get the current set of classes being logged (WindView)</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>UINT32 wvEvtClassGet (void)</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine returns the set of classes currently being logged.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
The class description.
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./wvLib.html#top">wvLib</a></b>

<hr>
<a name="wvEvtClassClear"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>wvEvtClassClear(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>wvEvtClassClear(&nbsp;)</strong> - clear the specified class of events from those being logged (WindView)</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>void wvEvtClassClear
    (
    UINT32 classDescription   /* description of evt classes to clear */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine clears the class or classes described by <i>classDescription</i>
from the set of classes currently being logged.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
N/A
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./wvLib.html#top">wvLib</a></b>

<hr>
<a name="wvEvtClassClearAll"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>wvEvtClassClearAll(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>wvEvtClassClearAll(&nbsp;)</strong> - clear all classes of events from those logged (WindView)</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>void wvEvtClassClearAll (void)</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine clears all classes of events so that no classes are logged
if event logging is started.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
N/A
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./wvLib.html#top">wvLib</a></b>

<hr>
<a name="wvObjInstModeSet"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>wvObjInstModeSet(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>wvObjInstModeSet(&nbsp;)</strong> - set object instrumentation on/off  (WindView)</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS wvObjInstModeSet
    (
    int mode                  /* object instrumentation on/off */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine causes objects to be created either instrumented or not
depending on the value of <i>mode</i>, which can be <b>INSTRUMENT_ON</b> or 
<b>INSTRUMENT_OFF</b>.  All objects created after <b><a href="./wvLib.html#wvObjInstModeSet">wvObjInstModeSet</a>(&nbsp;)</b> is called
with <b>INSTRUMENT_ON</b> and before it is called with <b>INSTRUMENT_OFF</b> are
created as instrumented objects.
<p>
Use <b><a href="./wvLib.html#wvObjInst">wvObjInst</a>(&nbsp;)</b> if you want to enable instrumentation for a specific
object or set of objects.  Use <b><a href="./wvLib.html#wvSigInst">wvSigInst</a>(&nbsp;)</b> if you want to enable 
instrumentation for all signal activity, and <b><a href="./wvLib.html#wvEventInst">wvEventInst</a>(&nbsp;)</b> to 
enable instrumentation for VxWorks Event activity.
<p>
This routine has effect only if <b>INCLUDE_WINDVIEW</b> is defined in
<b>configAll.h</b>.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
The previous value of <i>mode</i> or ERROR.
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./wvLib.html#top">wvLib</a></b>, <b><a href="./wvLib.html#wvObjInst">wvObjInst</a>(&nbsp;)</b>, <b><a href="./wvLib.html#wvSigInst">wvSigInst</a>(&nbsp;)</b>, <b><a href="./wvLib.html#wvEventInst">wvEventInst</a>(&nbsp;)</b>

<hr>
<a name="wvObjInst"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>wvObjInst(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>wvObjInst(&nbsp;)</strong> - instrument objects (WindView)</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS wvObjInst
    (
    int    objType,           /* object type */
    void * objId,             /* object ID or NULL for all objects */
    int    mode               /* instrumentation mode */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine instruments a specified object or set of objects and has
effect when system objects have been enabled for event logging.
<p>
<i>objType</i> can be set to one of the following: <b>OBJ_TASK</b> (tasks), <b>OBJ_SEM</b> 
(semaphores), <b>OBJ_MSG</b> (message queues), or <b>OBJ_WD</b> (watchdogs).
<i>objId</i> specifies the identifier of the particular object to be instrumented.
If <i>objId</i> is NULL, then all objects of <i>objType</i> have instrumentation
turned on or off depending on the value of <i>mode</i>. 
<p>
If <i>mode</i> is <b>INSTRUMENT_ON</b>, instrumentation is turned on; if it is any 
other value (including <b>INSTRUMENT_OFF</b>) then instrumentation is turned off
for <i>objId</i>.
<p>
Call <b><a href="./wvLib.html#wvObjInstModeSet">wvObjInstModeSet</a>(&nbsp;)</b> with <b>INSTRUMENT_ON</b> if you want to enable
instrumentation for all objects created after a certain place in your code.
Use <b><a href="./wvLib.html#wvSigInst">wvSigInst</a>(&nbsp;)</b> if you want to enable instrumentation for all signal activity.
<p>
This routine has effect only if <b>INCLUDE_WINDVIEW</b> is defined in
<b>configAll.h</b>.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
OK or ERROR.
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./wvLib.html#top">wvLib</a></b>, <b><a href="./wvLib.html#wvSigInst">wvSigInst</a>(&nbsp;)</b>, <b><a href="./wvLib.html#wvEventInst">wvEventInst</a>(&nbsp;)</b>, <b><a href="./wvLib.html#wvObjInstModeSet">wvObjInstModeSet</a>(&nbsp;)</b>

<hr>
<a name="wvSigInst"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>wvSigInst(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>wvSigInst(&nbsp;)</strong> - instrument signals (WindView)</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS wvSigInst
    (
    int mode                  /* instrumentation mode */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine instruments all signal activity.
<p>
If <i>mode</i> is <b>INSTRUMENT_ON</b>, instrumentation for signals is turned on;
if it is any other value (including <b>INSTRUMENT_OFF</b>), instrumentation for
signals is turned off.
<p>
This routine has effect only if <b>INCLUDE_WINDVIEW</b> is defined in
<b>configAll.h</b> and event logging has been enabled for system objects.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
OK or ERROR.
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./wvLib.html#top">wvLib</a></b>

<hr>
<a name="wvEventInst"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>wvEventInst(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>wvEventInst(&nbsp;)</strong> - instrument VxWorks Events (WindView)</p>