netbuflib.html

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

    if (netPoolInit (pNetPool, &mClBlkConfig, &clDescTbl [0], clDescTblNumEnt,
        NULL) != OK)
        return (ERROR);
</pre>

</blockquote><h4>VXWORKS AE PROTECTION DOMAINS</h4><blockquote><p>
Under VxWorks AE, access to the contents of a memory pool is limited to 
the protection domain within which you made the <b><a href="./netBufLib.html#netPoolInit">netPoolInit</a>(&nbsp;)</b> call that 
created the pool.  In addition, all parameters to a <b><a href="./netBufLib.html#netPoolInit">netPoolInit</a>(&nbsp;)</b> call 
must be valid within the protection domain from which you make the call. 
This restriction does not apply under non-AE versions of VxWorks.  
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
OK or ERROR.
<p>
</blockquote><h4>ERRNO</h4><blockquote><p>
<p>
&nbsp;<b>S_netBufLib_MEMSIZE_INVALID</b><br>
&nbsp;<b>S_netBufLib_CLSIZE_INVALID</b><br>
&nbsp;<b>S_netBufLib_NO_SYSTEM_MEMORY</b><br>
&nbsp;<b>S_netBufLib_MEM_UNALIGNED</b><br>
&nbsp;<b>S_netBufLib_MEMSIZE_UNALIGNED</b><br>
&nbsp;<b>S_netBufLib_MEMAREA_INVALID</b>
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./netBufLib.html#top">netBufLib</a></b>, <b><a href="./netBufLib.html#netPoolDelete">netPoolDelete</a>(&nbsp;)</b>

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

</blockquote><h1>netPoolKheapInit(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>netPoolKheapInit(&nbsp;)</strong> - kernel heap version of <b><a href="./netBufLib.html#netPoolInit">netPoolInit</a>(&nbsp;)</b></p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS netPoolKheapInit
    (
    NET_POOL_ID   pNetPool,        /* pointer to a net pool */
    M_CL_CONFIG * pMclBlkConfig,   /* pointer to a mBlk configuration */
    CL_DESC *     pClDescTbl,      /* pointer to cluster desc table */
    int           clDescTblNumEnt, /* number of cluster desc entries */
    POOL_FUNC *   pFuncTbl         /* pointer to pool function table */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This initializes a <b><a href="./netBufLib.html#top">netBufLib</a></b>-managed memory pool from Kernel heap.
See <b><a href="./netBufLib.html#netPoolInit">netPoolInit</a>(&nbsp;)</b> for more detail.
<p>
</blockquote><h4>VXWORKS AE PROTECTION DOMAINS</h4><blockquote><p>
Under VxWorks AE, you can call this function from within the kernel 
protection domain only.  In addition, all arguments to this function can  
reference only that data which is valid in the kernel protection domain. 
This restriction does not apply under non-AE versions of VxWorks.  
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
OK or ERROR.
<p>
</blockquote><h4>ERRNO</h4><blockquote><p>
<p>
&nbsp;N/A
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./netBufLib.html#top">netBufLib</a></b>, <b><a href="./netBufLib.html#netPoolInit">netPoolInit</a>(&nbsp;)</b>, <b><a href="./netBufLib.html#netPoolDelete">netPoolDelete</a>(&nbsp;)</b>

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

</blockquote><h1>netPoolDelete(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>netPoolDelete(&nbsp;)</strong> - delete a memory pool</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS netPoolDelete
    (
    NET_POOL_ID pNetPool      /* pointer to a net pool */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine deletes the specified <b><a href="./netBufLib.html#top">netBufLib</a></b>-managed memory pool.
<p>
</blockquote><h4>VXWORKS AE PROTECTION DOMAINS</h4><blockquote><p>
Under VxWorks AE, you can call this function from within the kernel 
protection domain only.  In addition, all arguments to this function can  
reference only that data which is valid in the kernel protection domain. 
This restriction does not apply under non-AE versions of VxWorks.  
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
OK or ERROR.
<p>
</blockquote><h4>ERRNO</h4><blockquote><p>
<p>
&nbsp;<b>S_netBufLib_NETPOOL_INVALID</b>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./netBufLib.html#top">netBufLib</a></b>

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

</blockquote><h1>netMblkFree(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>netMblkFree(&nbsp;)</strong> - free an <b>mBlk</b> back to its memory pool</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>void netMblkFree
    (
    NET_POOL_ID pNetPool,     /* pointer to the net pool */
    M_BLK_ID    pMblk         /* mBlk to free */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine frees the specified <b>mBlk</b> back to the specified memory pool.
<p>
</blockquote><h4>VXWORKS AE PROTECTION DOMAINS</h4><blockquote><p>
Under VxWorks AE, you can call this function from within the kernel 
protection domain only.  In addition, all arguments to this function can  
reference only that data which is valid in the kernel protection domain. 
This restriction does not apply under non-AE versions of VxWorks.  
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
N/A
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./netBufLib.html#top">netBufLib</a></b>

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

</blockquote><h1>netClBlkFree(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>netClBlkFree(&nbsp;)</strong> - free a <b>clBlk</b>-cluster construct back to the memory pool</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>void netClBlkFree
    (
    NET_POOL_ID pNetPool,     /* pointer to the net pool */
    CL_BLK_ID   pClBlk        /* pointer to the clBlk to free */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine decrements the reference counter in the specified <b>clBlk</b>. 
If the reference count falls to zero, this routine frees both the <b>clBlk</b>
and its associated cluster back to the specified memory pool.
<p>
</blockquote><h4>VXWORKS AE PROTECTION DOMAINS</h4><blockquote><p>
Under VxWorks AE, you can call this function from within the kernel 
protection domain only.  In addition, all arguments to this function can  
reference only that data which is valid in the kernel protection domain. 
This restriction does not apply under non-AE versions of VxWorks.  
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
N/A
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./netBufLib.html#top">netBufLib</a></b>

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

</blockquote><h1>netClFree(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>netClFree(&nbsp;)</strong> - free a cluster back to the memory pool</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>void netClFree
    (
    NET_POOL_ID pNetPool,     /* pointer to the net pool */
    UCHAR *     pClBuf        /* pointer to the cluster buffer */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine returns the specified cluster buffer back to the specified
memory pool.  
<p>
</blockquote><h4>VXWORKS AE PROTECTION DOMAINS</h4><blockquote><p>
Under VxWorks AE, you can call this function from within the kernel 
protection domain only.  In addition, all arguments to this function can  
reference only that data which is valid in the kernel protection domain. 
This restriction does not apply under non-AE versions of VxWorks.  
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
N/A
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./netBufLib.html#top">netBufLib</a></b>

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

</blockquote><h1>netMblkClFree(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>netMblkClFree(&nbsp;)</strong> - free an <b>mBlk</b>-<b>clBlk</b>-cluster construct</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>M_BLK_ID netMblkClFree
    (
    M_BLK_ID pMblk            /* pointer to the mBlk */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
For the specified <b>mBlk</b>-<b>clBlk</b>-cluster construct, this routine
frees the <b>mBlk</b> back to the specified memory pool.  It also decrements 
the reference count in the <b>clBlk</b> structure.  If the reference count 
falls to zero, no other <b>mBlk</b> structure reference this <b>clBlk</b>.  In that 
case, this routine also frees the <b>clBlk</b> structure and its associated 
cluster back to the specified memory pool.  
<p>
</blockquote><h4>VXWORKS AE PROTECTION DOMAINS</h4><blockquote><p>
Under VxWorks AE, you can call this function from within the kernel 
protection domain only.  In addition, all arguments to this function can  
reference only that data which is valid in the kernel protection domain. 
Likewise, the returned ID is valid in the kernel protection domain only.
This restriction does not apply under non-AE versions of VxWorks.  
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
If the specified <b>mBlk</b> was part of an <b>mBlk</b> chain, this routine returns 
a pointer to the next <b>mBlk</b>.  Otherwise, it returns a NULL.
<p>
</blockquote><h4>ERRNO</h4><blockquote><p>
<p>
&nbsp;<b>S_netBufLib_MBLK_INVALID</b>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./netBufLib.html#top">netBufLib</a></b>

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

</blockquote><h1>netMblkClChainFree(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>netMblkClChainFree(&nbsp;)</strong> - free a chain of <b>mBlk</b>-<b>clBlk</b>-cluster constructs</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>void netMblkClChainFree
    (
    M_BLK_ID pMblk            /* pointer to the mBlk */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
For the specified chain of <b>mBlk</b>-<b>clBlk</b>-cluster constructs, this 
routine frees all the <b>mBlk</b> structures back to the specified memory pool.  
It also decrements the reference count in all the <b>clBlk</b> structures.  If 
the reference count in a <b>clBlk</b> falls to zero, this routine also frees 
that <b>clBlk</b> and its associated cluster back to the specified memory pool. 
<p>
</blockquote><h4>VXWORKS AE PROTECTION DOMAINS</h4><blockquote><p>
Under VxWorks AE, you can call this function from within the kernel 
protection domain only.  In addition, all arguments to this function can  
reference only that data which is valid in the kernel protection domain. 
This restriction does not apply under non-AE versions of VxWorks.  
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
N/A
<p>
</blockquote><h4>ERRNO</h4><blockquote><p>
<p>
&nbsp;<b>S_netBufLib_MBLK_INVALID</b>
</blockquote><h4>SEE ALSO</h4><blockquote><p>