📄 group__osip__fifo.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>libosip: oSIP fifo Handling</title><link href="doxygen.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.3.8 --><div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="pages.html">Related Pages</a></div><h1>oSIP fifo Handling<br><small>[<a class="el" href="group__osip2__port.html">The OS port modules</a>]</small></h1><table border=0 cellpadding=0 cellspacing=0><tr><td></td></tr><tr><td colspan=2><br><h2>Classes</h2></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>struct </td><td class="memItemRight" valign=bottom><a class="el" href="structosip__fifo.html">osip_fifo</a></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>struct </td><td class="memItemRight" valign=bottom><a class="el" href="structosip__fifo.html">osip_fifo</a></td></tr><tr><td colspan=2><br><h2>Typedefs</h2></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>typedef <a class="el" href="structosip__fifo.html">osip_fifo</a> </td><td class="memItemRight" valign=bottom><a class="el" href="group__oSIP__FIFO.html#ga0">osip_fifo_t</a></td></tr><tr><td colspan=2><br><h2>Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="group__oSIP__FIFO.html#ga1">osip_fifo_init</a> (<a class="el" href="structosip__fifo.html">osip_fifo_t</a> *ff)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="group__oSIP__FIFO.html#ga2">osip_fifo_free</a> (<a class="el" href="structosip__fifo.html">osip_fifo_t</a> *ff)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="group__oSIP__FIFO.html#ga3">osip_fifo_insert</a> (<a class="el" href="structosip__fifo.html">osip_fifo_t</a> *ff, void *element)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="group__oSIP__FIFO.html#ga4">osip_fifo_add</a> (<a class="el" href="structosip__fifo.html">osip_fifo_t</a> *ff, void *element)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="group__oSIP__FIFO.html#ga5">osip_fifo_size</a> (<a class="el" href="structosip__fifo.html">osip_fifo_t</a> *ff)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>void * </td><td class="memItemRight" valign=bottom><a class="el" href="group__oSIP__FIFO.html#ga6">osip_fifo_get</a> (<a class="el" href="structosip__fifo.html">osip_fifo_t</a> *ff)</td></tr><tr><td class="memItemLeft" nowrap align=right valign=top>void * </td><td class="memItemRight" valign=bottom><a class="el" href="group__oSIP__FIFO.html#ga7">osip_fifo_tryget</a> (<a class="el" href="structosip__fifo.html">osip_fifo_t</a> *ff)</td></tr></table><hr><h2>Typedef Documentation</h2><a class="anchor" name="ga0" doxytag="osip_fifo.h::osip_fifo_t" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="structosip__fifo.html">osip_fifo_t</a> </td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Structure for referencing a fifo. </td> </tr></table><hr><h2>Function Documentation</h2><a class="anchor" name="ga4" doxytag="osip_fifo.h::osip_fifo_add" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> int osip_fifo_add </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="structosip__fifo.html">osip_fifo_t</a> * </td> <td class="mdname" nowrap> <em>ff</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td></td> <td class="md" nowrap>void * </td> <td class="mdname" nowrap> <em>element</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Add an element in a fifo. <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign=top><em>ff</em> </td><td>The element to work on. </td></tr> <tr><td></td><td valign=top><em>element</em> </td><td>The pointer on the element to add. </td></tr> </table></dl> </td> </tr></table><a class="anchor" name="ga2" doxytag="osip_fifo.h::osip_fifo_free" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void osip_fifo_free </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="structosip__fifo.html">osip_fifo_t</a> * </td> <td class="mdname1" valign="top" nowrap> <em>ff</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Free a fifo element. <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign=top><em>ff</em> </td><td>The element to work on. </td></tr> </table></dl> </td> </tr></table><a class="anchor" name="ga6" doxytag="osip_fifo.h::osip_fifo_get" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void* osip_fifo_get </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="structosip__fifo.html">osip_fifo_t</a> * </td> <td class="mdname1" valign="top" nowrap> <em>ff</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Get an element from a fifo or block until one is added. <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign=top><em>ff</em> </td><td>The element to work on. </td></tr> </table></dl> </td> </tr></table><a class="anchor" name="ga1" doxytag="osip_fifo.h::osip_fifo_init" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void osip_fifo_init </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="structosip__fifo.html">osip_fifo_t</a> * </td> <td class="mdname1" valign="top" nowrap> <em>ff</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Initialise a osip_fifo_t element. NOTE: this element MUST be previously allocated. <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign=top><em>ff</em> </td><td>The element to initialise. </td></tr> </table></dl> </td> </tr></table><a class="anchor" name="ga3" doxytag="osip_fifo.h::osip_fifo_insert" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> int osip_fifo_insert </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="structosip__fifo.html">osip_fifo_t</a> * </td> <td class="mdname" nowrap> <em>ff</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td></td> <td class="md" nowrap>void * </td> <td class="mdname" nowrap> <em>element</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Insert an element in a fifo (at the beginning). <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign=top><em>ff</em> </td><td>The element to work on. </td></tr> <tr><td></td><td valign=top><em>element</em> </td><td>The pointer on the element to insert. </td></tr> </table></dl> </td> </tr></table><a class="anchor" name="ga5" doxytag="osip_fifo.h::osip_fifo_size" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> int osip_fifo_size </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="structosip__fifo.html">osip_fifo_t</a> * </td> <td class="mdname1" valign="top" nowrap> <em>ff</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Get the number of element in a fifo. <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign=top><em>ff</em> </td><td>The element to work on. </td></tr> </table></dl> </td> </tr></table><a class="anchor" name="ga7" doxytag="osip_fifo.h::osip_fifo_tryget" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void* osip_fifo_tryget </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="structosip__fifo.html">osip_fifo_t</a> * </td> <td class="mdname1" valign="top" nowrap> <em>ff</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Try to get an element from a fifo, but do not block if there is no element. <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign=top><em>ff</em> </td><td>The element to work on. </td></tr> </table></dl> </td> </tr></table><hr size="1"><address style="align: right;"><small>Generated on Tue Sep 7 15:07:58 2004 for libosip by<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.8 </small></address></body></html>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -