You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
344 lines
19 KiB
344 lines
19 KiB
<!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/class/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 <span id="projectnumber">0.0.1</span></div>
|
|
<div id="projectbrief">HTTP/REST server implementation</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="annotated.html"><span>Data Structures</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 List</span></a></li>
|
|
<li><a href="globals.html"><span>Globals</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">Data Structures</a> |
|
|
<a href="#define-members">Defines</a> |
|
|
<a href="#typedef-members">Typedefs</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<h1>include/class/interface.h File Reference</h1> </div>
|
|
</div>
|
|
<div class="contents">
|
|
<div class="textblock"><code>#include <sys/types.h></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_2class_2interface_8h" alt=""/></div>
|
|
<map name="include_2class_2interface_8h" id="include_2class_2interface_8h">
|
|
</map>
|
|
</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_2class_2interface_8hdep" alt=""/></div>
|
|
<map name="include_2class_2interface_8hdep" id="include_2class_2interface_8hdep">
|
|
<area shape="rect" id="node3" href="class_8h.html" title="include/class.h" alt="" coords="140,83,249,111"/><area shape="rect" id="node5" href="cbuf_8h.html" title="include/cbuf.h" alt="" coords="5,161,109,189"/><area shape="rect" id="node7" href="server_8h.html" title="include/server.h" alt="" coords="137,238,252,266"/><area shape="rect" id="node9" href="socket_8h.html" title="include/socket.h" alt="" coords="184,161,301,189"/><area shape="rect" id="node12" href="session_8h.html" title="include/session.h" alt="" coords="325,161,448,189"/></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>
|
|
Data Structures</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">struct  </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  </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 </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_8h.html#ad620a89e939b586d6a025cf342da8e55">MAX_IFACE</a>   32</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_8h.html#a02255665665c91d905ec32d00d9a4a85">IFACE</a>(name)   ((const struct i_##name const*)&i_##name##_impl)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_8h.html#a446cc7d7282f8a0b8e62a371671ea605">INIT_IFACE</a>(name,...)   static const struct i_##name i_##name##_impl = {&i_##name,__VA_ARGS__}</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_8h.html#a9dda4d034150e3159927f83d9d15d840">NUMARGS</a>(...)   (sizeof((const void*[]){__VA_ARGS__})/sizeof(void*))</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_8h.html#a23a3c2be665a85b7e5f0844c9826a5b9">INIT_IFACE_IMPL</a>(...)   {NUMARGS(__VA_ARGS__), 0, {__VA_ARGS__}}</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> * </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> * </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"><a class="el" href="structinterface.html">iface_ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_8h.html#a9b302f65f460114fb13ad74b4411ac08">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/><a name="_details"></a><h2>Detailed Description</h2>
|
|
<div class="textblock"><p>Interface definition code. Each interface is a set of selector functions as well as a data structure where the concrete implementation will be stored. This structure is the intergrated in the class that implements the interface.</p>
|
|
<dl class="author"><dt><b>Author:</b></dt><dd>Georg Hopp</dd></dl>
|
|
<p>Copyright © 2012 Georg Hopp</p>
|
|
<p>This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</p>
|
|
<p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
|
|
<p>You should have received a copy of the GNU General Public License along with this program. If not, see <<a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>>. </p>
|
|
|
|
<p>Definition in file <a class="el" href="interface_8h_source.html">interface.h</a>.</p>
|
|
</div><hr/><h2>Define Documentation</h2>
|
|
<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"> </td>
|
|
<td class="paramname">name</td><td>)</td>
|
|
<td>   ((const struct i_##name const*)&i_##name##_impl)</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="interface_8h_source.html#l00034">34</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"> </td>
|
|
<td class="paramname">name, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>...</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td>   static const struct i_##name i_##name##_impl = {&i_##name,__VA_ARGS__}</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="interface_8h_source.html#l00035">35</a> of file <a class="el" href="interface_8h_source.html">interface.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a23a3c2be665a85b7e5f0844c9826a5b9"></a><!-- doxytag: member="interface.h::INIT_IFACE_IMPL" ref="a23a3c2be665a85b7e5f0844c9826a5b9" args="(...)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">#define INIT_IFACE_IMPL</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>...</em></td><td>)</td>
|
|
<td>   {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#l00039">39</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   32</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="interface_8h_source.html#l00032">32</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"> </td>
|
|
<td class="paramname"><em>...</em></td><td>)</td>
|
|
<td>   (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#l00038">38</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#l00053">53</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#l00046">46</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="a9b302f65f460114fb13ad74b4411ac08"></a><!-- doxytag: member="interface.h::interfaceGet" ref="a9b302f65f460114fb13ad74b4411ac08" args="(iface_impl_ptr, const iface_ptr)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structinterface.html">iface_ptr</a> interfaceGet </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structiface__impl.html">iface_impl_ptr</a> </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> </td>
|
|
<td class="paramname"><em>_iface</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></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#l00044">44</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 = &_iface;
|
|
<a class="code" href="structinterface.html">iface_ptr</a> * found;
|
|
|
|
<span class="keywordflow">if</span> (! iface_impl-><a class="code" href="structiface__impl.html#a9ee4589aed892fb213117b692e63e302">simpl</a>) {
|
|
qsort((<span class="keywordtype">void</span>**)(iface_impl-><a class="code" href="structiface__impl.html#a4f3e0d7f7bbd7e3f98472a140c37c1ea">impl</a>), iface_impl-><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-><a class="code" href="structiface__impl.html#a9ee4589aed892fb213117b692e63e302">simpl</a>=<a class="code" href="commons_8h.html#aa8cecfc5c5c054d2875c03e77b7be15d">TRUE</a>;
|
|
}
|
|
|
|
found = bsearch(
|
|
&iface,
|
|
iface_impl-><a class="code" href="structiface__impl.html#a4f3e0d7f7bbd7e3f98472a140c37c1ea">impl</a>,
|
|
iface_impl-><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> found? *found : (<a class="code" href="interface_8h.html#afaa63cd951f41a496111e88acf36dc40">iface_ptr</a>)NULL;
|
|
}
|
|
</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 Mar 28 2012 10:39:44 for Server by 
|
|
<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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </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>
|