A task management system. At least this was the initial idea. Basically this it the base code for the taskrambler framework.
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.
 
 
 
 
 
 

402 lines
22 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/class.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">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&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="annotated.html"><span>Data&#160;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&#160;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('class_2interface_2class_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</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/class/interface/class.h File Reference</h1> </div>
</div>
<div class="contents">
<div class="textblock"><code>#include &lt;stdarg.h&gt;</code><br/>
<code>#include &quot;class/class.h&quot;</code><br/>
<code>#include &quot;class/interface.h&quot;</code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for class.h:</div>
<div class="dyncontent">
<div class="center"><img src="class_2interface_2class_8h__incl.png" border="0" usemap="#include_2class_2interface_2class_8h" alt=""/></div>
<map name="include_2class_2interface_2class_8h" id="include_2class_2interface_2class_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="class_2interface_2class_8h__dep__incl.png" border="0" usemap="#include_2class_2interface_2class_8hdep" alt=""/></div>
<map name="include_2class_2interface_2class_8hdep" id="include_2class_2interface_2class_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="class_2interface_2class_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 &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structi__Class.html">i_Class</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="class_2interface_2class_8h.html#a323cb9a9088662b03bc37a47403e4212">new</a>(<a class="el" href="structclass.html">class</a>,...)&#160;&#160;&#160;classNew(_##<a class="el" href="structclass.html">class</a>, ##__VA_ARGS__)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_2interface_2class_8h.html#adb9a02719a59dd833c56e1a33ded59db">delete</a>(object)&#160;&#160;&#160;classDelete((void **)&amp;(object))</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_2interface_2class_8h.html#a864061d3c9c7f123efb63649bb0fade7">clone</a>(object)&#160;&#160;&#160;classClone((void *)(object))</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 int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_2interface_2class_8h.html#add4d9666bf962ab7b4f7850653ed1be9">fptr_ctor</a> )(void *, va_list *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_2interface_2class_8h.html#a59366634eecbace7ae9c8c5e65199c91">fptr_dtor</a> )(void *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_2interface_2class_8h.html#a6d852b3640eeb6ef8a3d776b87736392">fptr_clone</a> )(void *, void *const)</td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_2interface_2class_8h.html#adebe9bba79f753f5c44409a2ff664299">classNew</a> (<a class="el" href="structclass.html">class_ptr</a>,...)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_2interface_2class_8h.html#ac064b1caf75bc6c8b1a4371748d55878">classDelete</a> (void **)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_2interface_2class_8h.html#a51116659174ec46c5a04721d31631053">classClone</a> (void *)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Interface for class handling. Defines new, delete and clone selectors which in turn use the ctor, dtor and clone implementation from the class implementation.</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 &lt;<a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>&gt;. </p>
<p>Definition in file <a class="el" href="class_2interface_2class_8h_source.html">class.h</a>.</p>
</div><hr/><h2>Define Documentation</h2>
<a class="anchor" id="a864061d3c9c7f123efb63649bb0fade7"></a><!-- doxytag: member="class.h::clone" ref="a864061d3c9c7f123efb63649bb0fade7" args="(object)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define clone</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">object</td><td>)</td>
<td>&#160;&#160;&#160;classClone((void *)(object))</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="class_2interface_2class_8h_source.html#l00053">53</a> of file <a class="el" href="class_2interface_2class_8h_source.html">class.h</a>.</p>
</div>
</div>
<a class="anchor" id="adb9a02719a59dd833c56e1a33ded59db"></a><!-- doxytag: member="class.h::delete" ref="adb9a02719a59dd833c56e1a33ded59db" args="(object)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define delete</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">object</td><td>)</td>
<td>&#160;&#160;&#160;classDelete((void **)&amp;(object))</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="class_2interface_2class_8h_source.html#l00052">52</a> of file <a class="el" href="class_2interface_2class_8h_source.html">class.h</a>.</p>
</div>
</div>
<a class="anchor" id="a323cb9a9088662b03bc37a47403e4212"></a><!-- doxytag: member="class.h::new" ref="a323cb9a9088662b03bc37a47403e4212" args="(class,...)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define new</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><a class="el" href="structclass.html">class</a>, </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;classNew(_##<a class="el" href="structclass.html">class</a>, ##__VA_ARGS__)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="class_2interface_2class_8h_source.html#l00051">51</a> of file <a class="el" href="class_2interface_2class_8h_source.html">class.h</a>.</p>
</div>
</div>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="a6d852b3640eeb6ef8a3d776b87736392"></a><!-- doxytag: member="class.h::fptr_clone" ref="a6d852b3640eeb6ef8a3d776b87736392" args=")(void *, void *const)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* <a class="el" href="class_2interface_2class_8h.html#a6d852b3640eeb6ef8a3d776b87736392">fptr_clone</a>)(void *, void *const)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="class_2interface_2class_8h_source.html#l00036">36</a> of file <a class="el" href="class_2interface_2class_8h_source.html">class.h</a>.</p>
</div>
</div>
<a class="anchor" id="add4d9666bf962ab7b4f7850653ed1be9"></a><!-- doxytag: member="class.h::fptr_ctor" ref="add4d9666bf962ab7b4f7850653ed1be9" args=")(void *, va_list *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int(* <a class="el" href="class_2interface_2class_8h.html#add4d9666bf962ab7b4f7850653ed1be9">fptr_ctor</a>)(void *, va_list *)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="class_2interface_2class_8h_source.html#l00034">34</a> of file <a class="el" href="class_2interface_2class_8h_source.html">class.h</a>.</p>
</div>
</div>
<a class="anchor" id="a59366634eecbace7ae9c8c5e65199c91"></a><!-- doxytag: member="class.h::fptr_dtor" ref="a59366634eecbace7ae9c8c5e65199c91" args=")(void *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* <a class="el" href="class_2interface_2class_8h.html#a59366634eecbace7ae9c8c5e65199c91">fptr_dtor</a>)(void *)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="class_2interface_2class_8h_source.html#l00035">35</a> of file <a class="el" href="class_2interface_2class_8h_source.html">class.h</a>.</p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a51116659174ec46c5a04721d31631053"></a><!-- doxytag: member="class.h::classClone" ref="a51116659174ec46c5a04721d31631053" args="(void *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* classClone </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="i__class_8c_source.html#l00069">69</a> of file <a class="el" href="i__class_8c_source.html">i_class.c</a>.</p>
<div class="fragment"><pre class="fragment">{
<a class="code" href="structclass.html">class_ptr</a> <span class="keyword">class </span>= <a class="code" href="class_2class_8h.html#a97a9cde15dbb06287accf0a392b0c2ed">GET_CLASS</a>(_object);
<span class="keywordtype">void</span> * <span class="keywordtype">object</span> = calloc(1, <a class="code" href="structclass.html">class</a>-&gt;<a class="code" href="structclass.html#a31f0b35f94229885e948d55bac214c0d">object_size</a> + <span class="keyword">sizeof</span>(<span class="keywordtype">void</span>*));
* (<a class="code" href="structclass.html">class_ptr</a> *)<span class="keywordtype">object</span> = <span class="keyword">class</span>;
<span class="keywordtype">object</span> += <span class="keyword">sizeof</span>(<span class="keywordtype">void</span>*);
<span class="preprocessor">#undef clone</span>
<span class="preprocessor"></span> <a class="code" href="class_2class_8h.html#ada752d9d1fdbf84e978606e8999c762d">CALL</a>(<span class="keywordtype">object</span>, Class, <a class="code" href="class_2interface_2class_8h.html#a864061d3c9c7f123efb63649bb0fade7">clone</a>, _object);
<span class="keywordflow">return</span> object;
}
</pre></div>
</div>
</div>
<a class="anchor" id="ac064b1caf75bc6c8b1a4371748d55878"></a><!-- doxytag: member="class.h::classDelete" ref="ac064b1caf75bc6c8b1a4371748d55878" args="(void **)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void classDelete </td>
<td>(</td>
<td class="paramtype">void **&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="i__class_8c_source.html#l00058">58</a> of file <a class="el" href="i__class_8c_source.html">i_class.c</a>.</p>
<div class="fragment"><pre class="fragment">{
<span class="keywordflow">if</span> (NULL != *<span class="keywordtype">object</span>) {
<a class="code" href="class_2class_8h.html#ada752d9d1fdbf84e978606e8999c762d">CALL</a>(*<span class="keywordtype">object</span>, Class, dtor);
free(*<span class="keywordtype">object</span> - <span class="keyword">sizeof</span>(<span class="keywordtype">void</span>*));
*<span class="keywordtype">object</span> = NULL;
}
}
</pre></div>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_2interface_2class_8h_ac064b1caf75bc6c8b1a4371748d55878_icgraph.png" border="0" usemap="#class_2interface_2class_8h_ac064b1caf75bc6c8b1a4371748d55878_icgraph" alt=""/></div>
<map name="class_2interface_2class_8h_ac064b1caf75bc6c8b1a4371748d55878_icgraph" id="class_2interface_2class_8h_ac064b1caf75bc6c8b1a4371748d55878_icgraph">
<area shape="rect" id="node3" href="i__class_8c.html#a841e4a0f9bceb16fda262302d038bfa0" title="classNew" alt="" coords="145,5,223,33"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="adebe9bba79f753f5c44409a2ff664299"></a><!-- doxytag: member="class.h::classNew" ref="adebe9bba79f753f5c44409a2ff664299" args="(class_ptr,...)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* classNew </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structclass.html">class_ptr</a>&#160;</td>
<td class="paramname">, </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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="i__class_8c_source.html#l00037">37</a> of file <a class="el" href="i__class_8c_source.html">i_class.c</a>.</p>
<div class="fragment"><pre class="fragment">{
<span class="keywordtype">void</span> * <span class="keywordtype">object</span> = calloc(1, <a class="code" href="structclass.html">class</a>-&gt;<a class="code" href="structclass.html#a31f0b35f94229885e948d55bac214c0d">object_size</a> + <span class="keyword">sizeof</span>(<span class="keywordtype">void</span>*));
va_list params;
<span class="keywordtype">int</span> ret;
* (<a class="code" href="structclass.html">class_ptr</a> *)<span class="keywordtype">object</span> = <span class="keyword">class</span>;
<span class="keywordtype">object</span> += <span class="keyword">sizeof</span>(<span class="keywordtype">void</span>*);
va_start(params, <span class="keyword">class</span>);
<a class="code" href="class_2class_8h.html#a06fb0f2e08d1cbacbed6784319e7c3fc">RETCALL</a>(<span class="keywordtype">object</span>, Class, ctor, ret, &amp;params);
va_end(params);
<span class="keywordflow">if</span> (-1 == ret) {
<a class="code" href="class_2interface_2class_8h.html#ac064b1caf75bc6c8b1a4371748d55878">classDelete</a>(&amp;<span class="keywordtype">object</span>);
}
<span class="keywordflow">return</span> object;
}
</pre></div>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="class_2interface_2class_8h_adebe9bba79f753f5c44409a2ff664299_cgraph.png" border="0" usemap="#class_2interface_2class_8h_adebe9bba79f753f5c44409a2ff664299_cgraph" alt=""/></div>
<map name="class_2interface_2class_8h_adebe9bba79f753f5c44409a2ff664299_cgraph" id="class_2interface_2class_8h_adebe9bba79f753f5c44409a2ff664299_cgraph">
<area shape="rect" id="node3" href="class_2interface_2class_8h.html#ac064b1caf75bc6c8b1a4371748d55878" title="classDelete" alt="" coords="133,5,224,33"/></map>
</div>
</p>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="class_2interface_2class_8h.html">class.h</a> </li>
<li class="footer">Generated on Wed Mar 28 2012 10:39:44 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>Data Structures</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>