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.
327 lines
18 KiB
327 lines
18 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/stream/stream.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('stream_2stream_8h.html','');
|
|
</script>
|
|
<div id="doc-content">
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Data Structures</a> |
|
|
<a href="#typedef-members">Typedefs</a> |
|
|
<a href="#enum-members">Enumerations</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<h1>include/stream/stream.h File Reference</h1> </div>
|
|
</div>
|
|
<div class="contents">
|
|
<div class="textblock"><code>#include <sys/types.h></code><br/>
|
|
<code>#include <openssl/ssl.h></code><br/>
|
|
<code>#include "class.h"</code><br/>
|
|
</div><div class="textblock"><div class="dynheader">
|
|
Include dependency graph for stream.h:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="stream_2stream_8h__incl.png" border="0" usemap="#include_2stream_2stream_8h" alt=""/></div>
|
|
<map name="include_2stream_2stream_8h" id="include_2stream_2stream_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="stream_2stream_8h__dep__incl.png" border="0" usemap="#include_2stream_2stream_8hdep" alt=""/></div>
|
|
<map name="include_2stream_2stream_8hdep" id="include_2stream_2stream_8hdep">
|
|
<area shape="rect" id="node3" href="stream_8h.html" title="include/stream.h" alt="" coords="64,83,184,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="133,161,248,189"/></map>
|
|
</div>
|
|
</div>
|
|
<p><a href="stream_2stream_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="structStream.html">Stream</a></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 enum <a class="el" href="stream_2stream_8h.html#afd140730fff620c727747dbf04e76630">e_StreamHandleType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="stream_2stream_8h.html#a3e9983f7e20d1aa1e35662ae1cd538b1">StreamHandleType</a></td></tr>
|
|
<tr><td colspan="2"><h2><a name="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="stream_2stream_8h.html#afd140730fff620c727747dbf04e76630">e_StreamHandleType</a> { <a class="el" href="stream_2stream_8h.html#afd140730fff620c727747dbf04e76630a3cbce5e7e6860cab7950f1d0ca92ba84">STREAM_FD</a> = 0,
|
|
<a class="el" href="stream_2stream_8h.html#afd140730fff620c727747dbf04e76630a191f19b4a171b97e1537b688aead6e4c">STREAM_SSL</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">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="stream_2stream_8h.html#a8201bfbd89d6721bd1e5aac63970e890">streamRead</a> (<a class="el" href="structStream.html">Stream</a>, void *, size_t)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">ssize_t </td><td class="memItemRight" valign="bottom"><a class="el" href="stream_2stream_8h.html#aa06d63428a8a1a7c60680b28e7c51862">streamWrite</a> (<a class="el" href="structStream.html">Stream</a>, void *, size_t)</td></tr>
|
|
</table>
|
|
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
|
<div class="textblock"><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="stream_2stream_8h_source.html">stream.h</a>.</p>
|
|
</div><hr/><h2>Typedef Documentation</h2>
|
|
<a class="anchor" id="a3e9983f7e20d1aa1e35662ae1cd538b1"></a><!-- doxytag: member="stream.h::StreamHandleType" ref="a3e9983f7e20d1aa1e35662ae1cd538b1" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef enum <a class="el" href="stream_2stream_8h.html#afd140730fff620c727747dbf04e76630">e_StreamHandleType</a> <a class="el" href="stream_2stream_8h.html#a3e9983f7e20d1aa1e35662ae1cd538b1">StreamHandleType</a></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<hr/><h2>Enumeration Type Documentation</h2>
|
|
<a class="anchor" id="afd140730fff620c727747dbf04e76630"></a><!-- doxytag: member="stream.h::e_StreamHandleType" ref="afd140730fff620c727747dbf04e76630" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="stream_2stream_8h.html#afd140730fff620c727747dbf04e76630">e_StreamHandleType</a></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"><em><a class="anchor" id="afd140730fff620c727747dbf04e76630a3cbce5e7e6860cab7950f1d0ca92ba84"></a><!-- doxytag: member="STREAM_FD" ref="afd140730fff620c727747dbf04e76630a3cbce5e7e6860cab7950f1d0ca92ba84" args="" -->STREAM_FD</em> </td><td>
|
|
</td></tr>
|
|
<tr><td valign="top"><em><a class="anchor" id="afd140730fff620c727747dbf04e76630a191f19b4a171b97e1537b688aead6e4c"></a><!-- doxytag: member="STREAM_SSL" ref="afd140730fff620c727747dbf04e76630a191f19b4a171b97e1537b688aead6e4c" args="" -->STREAM_SSL</em> </td><td>
|
|
</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>Definition at line <a class="el" href="stream_2stream_8h_source.html#l00031">31</a> of file <a class="el" href="stream_2stream_8h_source.html">stream.h</a>.</p>
|
|
<div class="fragment"><pre class="fragment"> {
|
|
<a class="code" href="stream_2stream_8h.html#afd140730fff620c727747dbf04e76630a3cbce5e7e6860cab7950f1d0ca92ba84">STREAM_FD</a> = 0,
|
|
<a class="code" href="stream_2stream_8h.html#afd140730fff620c727747dbf04e76630a191f19b4a171b97e1537b688aead6e4c">STREAM_SSL</a>
|
|
} <a class="code" href="stream_2stream_8h.html#a3e9983f7e20d1aa1e35662ae1cd538b1">StreamHandleType</a>;
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<hr/><h2>Function Documentation</h2>
|
|
<a class="anchor" id="a8201bfbd89d6721bd1e5aac63970e890"></a><!-- doxytag: member="stream.h::streamRead" ref="a8201bfbd89d6721bd1e5aac63970e890" args="(Stream, void *, size_t)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ssize_t streamRead </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structStream.html">Stream</a> </td>
|
|
<td class="paramname">, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname">, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"> </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="stream_2read_8c_source.html#l00029">29</a> of file <a class="el" href="stream_2read_8c_source.html">read.c</a>.</p>
|
|
<div class="fragment"><pre class="fragment">{
|
|
ssize_t done;
|
|
|
|
<span class="keywordflow">switch</span>(this->type) {
|
|
<span class="keywordflow">case</span> <a class="code" href="stream_2stream_8h.html#afd140730fff620c727747dbf04e76630a3cbce5e7e6860cab7950f1d0ca92ba84">STREAM_FD</a>:
|
|
done = read((this->handle).fd, buf, count);
|
|
<span class="keywordflow">break</span>;
|
|
|
|
<span class="keywordflow">case</span> <a class="code" href="stream_2stream_8h.html#afd140730fff620c727747dbf04e76630a191f19b4a171b97e1537b688aead6e4c">STREAM_SSL</a>:
|
|
done = SSL_read((this->handle).ssl, buf, count);
|
|
<span class="keywordflow">break</span>;
|
|
|
|
<span class="keywordflow">default</span>:
|
|
<span class="keywordflow">break</span>;
|
|
}
|
|
|
|
<span class="keywordflow">return</span> done;
|
|
}
|
|
</pre></div>
|
|
<p><div class="dynheader">
|
|
Here is the caller graph for this function:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="stream_2stream_8h_a8201bfbd89d6721bd1e5aac63970e890_icgraph.png" border="0" usemap="#stream_2stream_8h_a8201bfbd89d6721bd1e5aac63970e890_icgraph" alt=""/></div>
|
|
<map name="stream_2stream_8h_a8201bfbd89d6721bd1e5aac63970e890_icgraph" id="stream_2stream_8h_a8201bfbd89d6721bd1e5aac63970e890_icgraph">
|
|
<area shape="rect" id="node3" href="cbuf_2read_8c.html#a5582ca70b847b9dd308d8234055c1dde" title="cbufRead" alt="" coords="151,30,228,58"/><area shape="rect" id="node5" href="parse_8c.html#a1aa3a9f8959238057fe18ca5bda180db" title="httpParserParse" alt="" coords="279,5,396,33"/><area shape="rect" id="node9" href="http_2writer_2write_8c.html#accd7a3cfe29607d72a35fe3e3d187c48" title="httpWriterWrite" alt="" coords="283,55,392,83"/><area shape="rect" id="node7" href="process_8c.html#a05882322d98d5710a5512c9255e03d71" title="httpWorkerProcess" alt="" coords="447,5,580,33"/><area shape="rect" id="node11" href="answer_8c.html#add3fe105c4e782e5b1387cb596792bbe" title="httpWorkerWrite" alt="" coords="455,55,572,83"/></map>
|
|
</div>
|
|
</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa06d63428a8a1a7c60680b28e7c51862"></a><!-- doxytag: member="stream.h::streamWrite" ref="aa06d63428a8a1a7c60680b28e7c51862" args="(Stream, void *, size_t)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ssize_t streamWrite </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structStream.html">Stream</a> </td>
|
|
<td class="paramname">, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname">, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"> </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="stream_2write_8c_source.html#l00029">29</a> of file <a class="el" href="stream_2write_8c_source.html">write.c</a>.</p>
|
|
<div class="fragment"><pre class="fragment">{
|
|
ssize_t done;
|
|
|
|
<span class="keywordflow">switch</span>(this->type) {
|
|
<span class="keywordflow">case</span> <a class="code" href="stream_2stream_8h.html#afd140730fff620c727747dbf04e76630a3cbce5e7e6860cab7950f1d0ca92ba84">STREAM_FD</a>:
|
|
done = write((this->handle).fd, buf, count);
|
|
<span class="keywordflow">break</span>;
|
|
|
|
<span class="keywordflow">case</span> <a class="code" href="stream_2stream_8h.html#afd140730fff620c727747dbf04e76630a191f19b4a171b97e1537b688aead6e4c">STREAM_SSL</a>:
|
|
done = SSL_write((this->handle).ssl, buf, count);
|
|
<span class="keywordflow">break</span>;
|
|
|
|
<span class="keywordflow">default</span>:
|
|
<span class="keywordflow">break</span>;
|
|
}
|
|
|
|
<span class="keywordflow">return</span> done;
|
|
}
|
|
</pre></div>
|
|
<p><div class="dynheader">
|
|
Here is the caller graph for this function:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="stream_2stream_8h_aa06d63428a8a1a7c60680b28e7c51862_icgraph.png" border="0" usemap="#stream_2stream_8h_aa06d63428a8a1a7c60680b28e7c51862_icgraph" alt=""/></div>
|
|
<map name="stream_2stream_8h_aa06d63428a8a1a7c60680b28e7c51862_icgraph" id="stream_2stream_8h_aa06d63428a8a1a7c60680b28e7c51862_icgraph">
|
|
<area shape="rect" id="node3" href="cbuf_2write_8c.html#a3872748b7d2c563a6e73eb3f2e1e7130" title="cbufWrite" alt="" coords="147,5,224,33"/><area shape="rect" id="node5" href="http_2writer_2write_8c.html#accd7a3cfe29607d72a35fe3e3d187c48" title="httpWriterWrite" alt="" coords="272,5,381,33"/><area shape="rect" id="node7" href="answer_8c.html#add3fe105c4e782e5b1387cb596792bbe" title="httpWorkerWrite" alt="" coords="429,5,547,33"/></map>
|
|
</div>
|
|
</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="stream_2stream_8h.html">stream.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>
|