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.
 
 
 
 
 
 

352 lines
21 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/socket.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('socket_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>include/socket.h File Reference</h1> </div>
</div>
<div class="contents">
<div class="textblock"><code>#include &lt;arpa/inet.h&gt;</code><br/>
<code>#include &quot;<a class="el" href="class_8h_source.html">class.h</a>&quot;</code><br/>
<code>#include &quot;<a class="el" href="logger_8h_source.html">logger.h</a>&quot;</code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for socket.h:</div>
<div class="dyncontent">
<div class="center"><img src="socket_8h__incl.png" border="0" usemap="#include_2socket_8h" alt=""/></div>
<map name="include_2socket_8h" id="include_2socket_8h">
<area shape="rect" id="node5" href="class_8h.html" title="class.h" alt="" coords="269,83,333,111"/><area shape="rect" id="node28" href="logger_8h.html" title="logger.h" alt="" coords="524,83,593,111"/><area shape="rect" id="node7" href="class_2class_8h.html" title="class/class.h" alt="" coords="177,161,276,189"/><area shape="rect" id="node19" href="interface_8h.html" title="class/interface.h" alt="" coords="21,161,139,189"/><area shape="rect" id="node22" href="class_2interface_2class_8h.html" title="class/interface/class.h" alt="" coords="300,161,452,189"/><area shape="rect" id="node30" href="logger_2logger_8h.html" title="logger/logger.h" alt="" coords="689,161,799,189"/><area shape="rect" id="node34" href="logger_2interface_2logger_8h.html" title="logger/interface/logger.h" alt="" coords="476,161,641,189"/></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="socket_8h__dep__incl.png" border="0" usemap="#include_2socket_8hdep" alt=""/></div>
<map name="include_2socket_8hdep" id="include_2socket_8hdep">
<area shape="rect" id="node3" href="server_8h.html" title="include/server.h" alt="" coords="7,83,121,111"/></map>
</div>
</div>
<p><a href="socket_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="structSock.html">Sock</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">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="socket_8h.html#a6481f4bbdd2abaf6327f4e5dee9db1b2">socketConnect</a> (<a class="el" href="structSock.html">Sock</a> this, const char *addr, char(*)[16])</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="socket_8h.html#a757c220e9371523ef55b1137a1efed57">socketListen</a> (<a class="el" href="structSock.html">Sock</a> this, int backlog)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structSock.html">Sock</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="socket_8h.html#a45ec8fbdb035314da3d390fdcd6dc304">socketAccept</a> (<a class="el" href="structSock.html">Sock</a> this, char(*remoteAddr)[16])</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Abstraction layer above BSD sockets. Capsules and simplifies connect accept and listen.</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="socket_8h_source.html">socket.h</a>.</p>
</div><hr/><h2>Function Documentation</h2>
<a class="anchor" id="a45ec8fbdb035314da3d390fdcd6dc304"></a><!-- doxytag: member="socket.h::socketAccept" ref="a45ec8fbdb035314da3d390fdcd6dc304" args="(Sock this, char(*remoteAddr)[16])" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structSock.html">Sock</a> socketAccept </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structSock.html">Sock</a>&#160;</td>
<td class="paramname"><em>this</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char(*)&#160;</td>
<td class="paramname"><em>remoteAddr</em>[16]&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><dl class="todo"><dt><b><a class="el" href="todo.html#_todo000011">Todo:</a></b></dt><dd>Uhh, this is bad. we open a new socket additionally to the one we get from the accept call. i have to change the socket constructor to be able to create the data structure without creation of a socket at all. For now i simply close the socket here.... :D </dd></dl>
</p>
<p>Definition at line <a class="el" href="accept_8c_source.html#l00031">31</a> of file <a class="el" href="accept_8c_source.html">accept.c</a>.</p>
<div class="fragment"><pre class="fragment">{
<a class="code" href="structSock.html">Sock</a> sock; <span class="comment">// Socket for client</span>
<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> len; <span class="comment">// Length of client address data structure</span>
<span class="comment">// Set the size of the in-out parameter</span>
len = <span class="keyword">sizeof</span>(this-&gt;addr);
sock = <span class="keyword">new</span>(<a class="code" href="structSock.html">Sock</a>, this-&gt;log, -1);
<span class="comment">// Wait for a client to connect</span>
sock-&gt;<a class="code" href="structSock.html#a1b5945aef923a906501d7abac82449c3">handle</a> = accept(this-&gt;handle, (<span class="keyword">struct</span> sockaddr *) &amp;(sock-&gt;addr), &amp;len);
<span class="keywordflow">if</span> (-1 == sock-&gt;<a class="code" href="structSock.html#a1b5945aef923a906501d7abac82449c3">handle</a>) {
<a class="code" href="logger_2interface_2logger_8h.html#ae9f8662ec8b300dcfb5064906937553e">loggerLog</a>(this-&gt;log, <a class="code" href="logger_2logger_8h.html#a63296c69f4b9bf51d6756a5d2c482d1ea236a2401a6ed3e96611f3a14352082ad">LOGGER_WARNING</a>,
<span class="stringliteral">&quot;error accepting connection: %s&quot;</span>, strerror(errno));
} <span class="keywordflow">else</span> {
strcpy(*remoteAddr, inet_ntoa((sock-&gt;addr).sin_addr));
<a class="code" href="logger_2interface_2logger_8h.html#ae9f8662ec8b300dcfb5064906937553e">loggerLog</a>(this-&gt;log, <a class="code" href="logger_2logger_8h.html#a63296c69f4b9bf51d6756a5d2c482d1ea3a56c2c000665930df74a9ebf9047316">LOGGER_INFO</a>,
<span class="stringliteral">&quot;handling client %s\n&quot;</span>, inet_ntoa((sock-&gt;addr).sin_addr));
}
<span class="keywordflow">return</span> sock;
}
</pre></div>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="socket_8h_a45ec8fbdb035314da3d390fdcd6dc304_cgraph.png" border="0" usemap="#socket_8h_a45ec8fbdb035314da3d390fdcd6dc304_cgraph" alt=""/></div>
<map name="socket_8h_a45ec8fbdb035314da3d390fdcd6dc304_cgraph" id="socket_8h_a45ec8fbdb035314da3d390fdcd6dc304_cgraph">
<area shape="rect" id="node3" href="logger_2interface_2logger_8h.html#ae9f8662ec8b300dcfb5064906937553e" title="loggerLog" alt="" coords="156,5,236,33"/></map>
</div>
</p>
<p><div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="socket_8h_a45ec8fbdb035314da3d390fdcd6dc304_icgraph.png" border="0" usemap="#socket_8h_a45ec8fbdb035314da3d390fdcd6dc304_icgraph" alt=""/></div>
<map name="socket_8h_a45ec8fbdb035314da3d390fdcd6dc304_icgraph" id="socket_8h_a45ec8fbdb035314da3d390fdcd6dc304_icgraph">
<area shape="rect" id="node3" href="run_8c.html#ac80f57676062b94ad17a46646ba15e73" title="serverHandleAccept" alt="" coords="156,5,297,33"/><area shape="rect" id="node5" href="run_8c.html#a67a4d9073b80d8ae1459fb11ddd23675" title="serverRun" alt="" coords="348,5,431,33"/><area shape="rect" id="node7" href="webgameserver_8c.html#ae66f6b31b5ad750f1fe042a706a4e3d4" title="main" alt="" coords="480,5,531,33"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a6481f4bbdd2abaf6327f4e5dee9db1b2"></a><!-- doxytag: member="socket.h::socketConnect" ref="a6481f4bbdd2abaf6327f4e5dee9db1b2" args="(Sock this, const char *addr, char(*)[16])" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void socketConnect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structSock.html">Sock</a>&#160;</td>
<td class="paramname"><em>this</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char(*)&#160;</td>
<td class="paramname">[16]&#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="connect_8c_source.html#l00032">32</a> of file <a class="el" href="connect_8c_source.html">connect.c</a>.</p>
<div class="fragment"><pre class="fragment">{
inet_pton(AF_INET, addr, &amp;((this-&gt;addr).sin_addr));
(this-&gt;addr).sin_family = AF_INET; <span class="comment">// Internet address family</span>
(this-&gt;addr).sin_port = htons(this-&gt;port); <span class="comment">// Local port</span>
<span class="keywordflow">if</span> (-1 == connect(
this-&gt;handle,
(<span class="keyword">struct</span> sockaddr*) &amp;(this-&gt;addr),
<span class="keyword">sizeof</span>(this-&gt;addr)))
{
<a class="code" href="logger_2interface_2logger_8h.html#ae9f8662ec8b300dcfb5064906937553e">loggerLog</a>(this-&gt;log, <a class="code" href="logger_2logger_8h.html#a63296c69f4b9bf51d6756a5d2c482d1eaa7d55c7b377d82da77e532aa299eeeb0">LOGGER_CRIT</a>,
<span class="stringliteral">&quot;error connection socket: %s - service terminated&quot;</span>,
strerror(errno));
exit(EXIT_FAILURE);
} <span class="keywordflow">else</span> {
strcpy(*remoteAddr, inet_ntoa((this-&gt;addr).sin_addr));
<a class="code" href="logger_2interface_2logger_8h.html#ae9f8662ec8b300dcfb5064906937553e">loggerLog</a>(this-&gt;log, <a class="code" href="logger_2logger_8h.html#a63296c69f4b9bf51d6756a5d2c482d1ea3a56c2c000665930df74a9ebf9047316">LOGGER_INFO</a>,
<span class="stringliteral">&quot;handling connection %s\n&quot;</span>, inet_ntoa((this-&gt;addr).sin_addr));
}
}
</pre></div>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="socket_8h_a6481f4bbdd2abaf6327f4e5dee9db1b2_cgraph.png" border="0" usemap="#socket_8h_a6481f4bbdd2abaf6327f4e5dee9db1b2_cgraph" alt=""/></div>
<map name="socket_8h_a6481f4bbdd2abaf6327f4e5dee9db1b2_cgraph" id="socket_8h_a6481f4bbdd2abaf6327f4e5dee9db1b2_cgraph">
<area shape="rect" id="node3" href="logger_2interface_2logger_8h.html#ae9f8662ec8b300dcfb5064906937553e" title="loggerLog" alt="" coords="167,5,247,33"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="a757c220e9371523ef55b1137a1efed57"></a><!-- doxytag: member="socket.h::socketListen" ref="a757c220e9371523ef55b1137a1efed57" args="(Sock this, int backlog)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void socketListen </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structSock.html">Sock</a>&#160;</td>
<td class="paramname"><em>this</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>backlog</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><p>Bind to the local address</p>
<p>Mark the socket so it will listen for incoming connections</p>
</p>
<p>Definition at line <a class="el" href="listen_8c_source.html#l00032">32</a> of file <a class="el" href="listen_8c_source.html">listen.c</a>.</p>
<div class="fragment"><pre class="fragment">{
(this-&gt;addr).sin_family = AF_INET; <span class="comment">// Internet address family</span>
(this-&gt;addr).sin_addr.s_addr = htonl(INADDR_ANY); <span class="comment">// Any incoming interface</span>
(this-&gt;addr).sin_port = htons(this-&gt;port); <span class="comment">// Local port</span>
<span class="keywordflow">if</span> (-1 == bind(this-&gt;handle, (<span class="keyword">struct</span> sockaddr *) &amp;(this-&gt;addr), <span class="keyword">sizeof</span>(this-&gt;addr))) {
<a class="code" href="logger_2interface_2logger_8h.html#ae9f8662ec8b300dcfb5064906937553e">loggerLog</a>(this-&gt;log, <a class="code" href="logger_2logger_8h.html#a63296c69f4b9bf51d6756a5d2c482d1eaa7d55c7b377d82da77e532aa299eeeb0">LOGGER_CRIT</a>,
<span class="stringliteral">&quot;error binding socket: %s - service terminated&quot;</span>,
strerror(errno));
exit(EXIT_FAILURE);
}
<span class="keywordflow">if</span> (-1 == listen(this-&gt;handle, backlog)) {
<a class="code" href="logger_2interface_2logger_8h.html#ae9f8662ec8b300dcfb5064906937553e">loggerLog</a>(this-&gt;log, <a class="code" href="logger_2logger_8h.html#a63296c69f4b9bf51d6756a5d2c482d1eaa7d55c7b377d82da77e532aa299eeeb0">LOGGER_CRIT</a>,
<span class="stringliteral">&quot;error binding socket: %s - service terminated&quot;</span>,
strerror(errno));
exit(EXIT_FAILURE);
}
}
</pre></div>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="socket_8h_a757c220e9371523ef55b1137a1efed57_cgraph.png" border="0" usemap="#socket_8h_a757c220e9371523ef55b1137a1efed57_cgraph" alt=""/></div>
<map name="socket_8h_a757c220e9371523ef55b1137a1efed57_cgraph" id="socket_8h_a757c220e9371523ef55b1137a1efed57_cgraph">
<area shape="rect" id="node3" href="logger_2interface_2logger_8h.html#ae9f8662ec8b300dcfb5064906937553e" title="loggerLog" alt="" coords="151,5,231,33"/></map>
</div>
</p>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="socket_8h.html">socket.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>