interface_8h.html 19.8 KB
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>server: include/interface.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.7.3 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">server&#160;<span id="projectnumber">0.0.1</span></div>
   <div id="projectbrief">basicserverinfrastructure</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li id="searchli">
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('interface_8h.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#define-members">Defines</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<h1>include/interface.h File Reference</h1>  </div>
</div>
<div class="contents">
<div class="textblock"><code>#include &lt;sys/types.h&gt;</code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for interface.h:</div>
<div class="dyncontent">
<div class="center"><img src="interface_8h__incl.png" border="0" usemap="#include_2interface_8h" alt=""/></div>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="interface_8h__dep__incl.png" border="0" usemap="#include_2interface_8hdep" alt=""/></div>
<map name="include_2interface_8hdep" id="include_2interface_8hdep">
<area shape="rect" id="node3" href="class_8h.html" title="include/class.h" alt="" coords="83,83,192,111"/><area shape="rect" id="node5" href="logger_8h.html" title="include/logger.h" alt="" coords="80,161,195,189"/><area shape="rect" id="node7" href="socket_8h.html" title="include/socket.h" alt="" coords="5,238,123,266"/><area shape="rect" id="node9" href="server_8h.html" title="include/server.h" alt="" coords="103,315,217,343"/></map>
</div>
</div>
<p><a href="interface_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structinterface.html">interface</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiface__impl.html">iface_impl</a></td></tr>
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_8h.html#ad620a89e939b586d6a025cf342da8e55">MAX_IFACE</a>&#160;&#160;&#160;32</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_8h.html#a02255665665c91d905ec32d00d9a4a85">IFACE</a>(name)&#160;&#160;&#160;((const struct i_##name const*)&amp;i_##name##_impl)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_8h.html#a446cc7d7282f8a0b8e62a371671ea605">INIT_IFACE</a>(name,...)&#160;&#160;&#160;static const struct i_##name i_##name##_impl = {&amp;i_##name,__VA_ARGS__}</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_8h.html#a9dda4d034150e3159927f83d9d15d840">NUMARGS</a>(...)&#160;&#160;&#160;(sizeof((const void*[]){__VA_ARGS__})/sizeof(void*))</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_8h.html#a6e8015282e5aac5747daff5bb71d8601">INIT_IMPL</a>(...)&#160;&#160;&#160;{NUMARGS(__VA_ARGS__), 0, {__VA_ARGS__}}</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_8h.html#a855b98f3119c2d64e7dd4c2c910bd5b5">CREATE_IMPL</a>(...)&#160;&#160;&#160;static struct <a class="el" href="structiface__impl.html">iface_impl</a> <a class="el" href="structiface__impl.html">iface_impl</a> = INIT_IMPL(__VA_ARGS__)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_8h.html#a12243bdd01e5366fecc15f395f09221a">METHOD_GET</a>(iface, method)&#160;&#160;&#160;(iface-&gt;method)</td></tr>
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structinterface.html">interface</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_8h.html#afaa63cd951f41a496111e88acf36dc40">iface_ptr</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structiface__impl.html">iface_impl</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_8h.html#a998b025a5015049fd824424d6983f2df">iface_impl_ptr</a></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structinterface.html">interface</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_8h.html#ae4bb16dde691d2513d444ce772f48718">interfaceGet</a> (<a class="el" href="structiface__impl.html">iface_impl_ptr</a>, const <a class="el" href="structinterface.html">iface_ptr</a>)</td></tr>
</table>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="a855b98f3119c2d64e7dd4c2c910bd5b5"></a><!-- doxytag: member="interface.h::CREATE_IMPL" ref="a855b98f3119c2d64e7dd4c2c910bd5b5" args="(...)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define CREATE_IMPL</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>...</em></td><td>)</td>
          <td>&#160;&#160;&#160;static struct <a class="el" href="structiface__impl.html">iface_impl</a> <a class="el" href="structiface__impl.html">iface_impl</a> = INIT_IMPL(__VA_ARGS__)</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="interface_8h_source.html#l00016">16</a> of file <a class="el" href="interface_8h_source.html">interface.h</a>.</p>

</div>
</div>
<a class="anchor" id="a02255665665c91d905ec32d00d9a4a85"></a><!-- doxytag: member="interface.h::IFACE" ref="a02255665665c91d905ec32d00d9a4a85" args="(name)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define IFACE</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">name</td><td>)</td>
          <td>&#160;&#160;&#160;((const struct i_##name const*)&amp;i_##name##_impl)</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="interface_8h_source.html#l00008">8</a> of file <a class="el" href="interface_8h_source.html">interface.h</a>.</p>

</div>
</div>
<a class="anchor" id="a446cc7d7282f8a0b8e62a371671ea605"></a><!-- doxytag: member="interface.h::INIT_IFACE" ref="a446cc7d7282f8a0b8e62a371671ea605" args="(name,...)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define INIT_IFACE</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">name, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>...</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;static const struct i_##name i_##name##_impl = {&amp;i_##name,__VA_ARGS__}</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="interface_8h_source.html#l00010">10</a> of file <a class="el" href="interface_8h_source.html">interface.h</a>.</p>

</div>
</div>
<a class="anchor" id="a6e8015282e5aac5747daff5bb71d8601"></a><!-- doxytag: member="interface.h::INIT_IMPL" ref="a6e8015282e5aac5747daff5bb71d8601" args="(...)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define INIT_IMPL</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>...</em></td><td>)</td>
          <td>&#160;&#160;&#160;{NUMARGS(__VA_ARGS__), 0, {__VA_ARGS__}}</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="interface_8h_source.html#l00015">15</a> of file <a class="el" href="interface_8h_source.html">interface.h</a>.</p>

</div>
</div>
<a class="anchor" id="ad620a89e939b586d6a025cf342da8e55"></a><!-- doxytag: member="interface.h::MAX_IFACE" ref="ad620a89e939b586d6a025cf342da8e55" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define MAX_IFACE&#160;&#160;&#160;32</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="interface_8h_source.html#l00006">6</a> of file <a class="el" href="interface_8h_source.html">interface.h</a>.</p>

</div>
</div>
<a class="anchor" id="a12243bdd01e5366fecc15f395f09221a"></a><!-- doxytag: member="interface.h::METHOD_GET" ref="a12243bdd01e5366fecc15f395f09221a" args="(iface, method)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define METHOD_GET</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">iface, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">method&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;(iface-&gt;method)</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="interface_8h_source.html#l00019">19</a> of file <a class="el" href="interface_8h_source.html">interface.h</a>.</p>

</div>
</div>
<a class="anchor" id="a9dda4d034150e3159927f83d9d15d840"></a><!-- doxytag: member="interface.h::NUMARGS" ref="a9dda4d034150e3159927f83d9d15d840" args="(...)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define NUMARGS</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>...</em></td><td>)</td>
          <td>&#160;&#160;&#160;(sizeof((const void*[]){__VA_ARGS__})/sizeof(void*))</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="interface_8h_source.html#l00013">13</a> of file <a class="el" href="interface_8h_source.html">interface.h</a>.</p>

</div>
</div>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="a998b025a5015049fd824424d6983f2df"></a><!-- doxytag: member="interface.h::iface_impl_ptr" ref="a998b025a5015049fd824424d6983f2df" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef struct <a class="el" href="structiface__impl.html">iface_impl</a>* <a class="el" href="structiface__impl.html">iface_impl_ptr</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="interface_8h_source.html#l00033">33</a> of file <a class="el" href="interface_8h_source.html">interface.h</a>.</p>

</div>
</div>
<a class="anchor" id="afaa63cd951f41a496111e88acf36dc40"></a><!-- doxytag: member="interface.h::iface_ptr" ref="afaa63cd951f41a496111e88acf36dc40" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef struct <a class="el" href="structinterface.html">interface</a>* <a class="el" href="structinterface.html">iface_ptr</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="interface_8h_source.html#l00026">26</a> of file <a class="el" href="interface_8h_source.html">interface.h</a>.</p>

</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ae4bb16dde691d2513d444ce772f48718"></a><!-- doxytag: member="interface.h::interfaceGet" ref="ae4bb16dde691d2513d444ce772f48718" args="(iface_impl_ptr, const iface_ptr)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="structinterface.html">interface</a>* interfaceGet </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiface__impl.html">iface_impl_ptr</a>&#160;</td>
          <td class="paramname"><em>iface_impl</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="structinterface.html">iface_ptr</a>&#160;</td>
          <td class="paramname"><em>_iface</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [read]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>this one is important in selector functions to get the correct interface implementation of a class. </p>

<p>Definition at line <a class="el" href="interface_8c_source.html#l00025">25</a> of file <a class="el" href="interface_8c_source.html">interface.c</a>.</p>
<div class="fragment"><pre class="fragment">{
        <span class="keyword">const</span> <a class="code" href="structinterface.html">iface_ptr</a> * iface = &amp;_iface;
        <span class="keywordtype">void</span> *            dummy;

    <span class="keywordflow">if</span> (! iface_impl-&gt;<a class="code" href="structiface__impl.html#a9ee4589aed892fb213117b692e63e302">simpl</a>) {
        qsort((<span class="keywordtype">void</span>**)(iface_impl-&gt;<a class="code" href="structiface__impl.html#a4f3e0d7f7bbd7e3f98472a140c37c1ea">impl</a>), iface_impl-&gt;<a class="code" href="structiface__impl.html#af2eaa008e863bdef373ed0c6fa26722b">nimpl</a>, <span class="keyword">sizeof</span>(<a class="code" href="structinterface.html">iface_ptr</a>), comp);
        iface_impl-&gt;<a class="code" href="structiface__impl.html#a9ee4589aed892fb213117b692e63e302">simpl</a>=<a class="code" href="interface_8c.html#aa8cecfc5c5c054d2875c03e77b7be15d">TRUE</a>;
    }

    dummy = bsearch(
                        &amp;iface,
                        iface_impl-&gt;<a class="code" href="structiface__impl.html#a4f3e0d7f7bbd7e3f98472a140c37c1ea">impl</a>,
                        iface_impl-&gt;<a class="code" href="structiface__impl.html#af2eaa008e863bdef373ed0c6fa26722b">nimpl</a>,
                        <span class="keyword">sizeof</span>(<a class="code" href="structinterface.html">iface_ptr</a>),
                        comp);

        <span class="keywordflow">return</span> dummy? *(<span class="keyword">struct </span><a class="code" href="structinterface.html">interface</a> **)dummy : dummy;
}
</pre></div>
</div>
</div>
</div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="interface_8h.html">interface.h</a>      </li>
      <li class="footer">Generated on Wed Feb 8 2012 13:09:32 for server by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
    </ul>
  </div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>


</body>
</html>