<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>ZenLib: Http_Handler.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">ZenLib
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<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="namespaces.html"><span>Namespaces</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>
</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>File Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_2f6a66f21b21faa3b2ca762adad4ca87.html">ZenLib</a></li><li class="navelem"><a class="el" href="dir_20708eb8d1dfdef1e8093d214af3f21c.html">Format</a></li><li class="navelem"><a class="el" href="dir_7683e1bbc4e1aa50463dee9395ab8048.html">Http</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Http_Handler.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="Http__Handler_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* Copyright (c) MediaArea.net SARL. All Rights Reserved.</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Use of this source code is governed by a zlib-style license that can</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * be found in the License.txt file in the root of the source tree.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">//+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">//</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">// A HTTP Request</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">//</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">//+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">//---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#ifndef ZenLib_Format_Http_RequestH</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor"></span><span class="preprocessor">#define ZenLib_Format_Http_RequestH</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor"></span><span class="comment">//---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">//---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include "<a class="code" href="Http__Cookies_8h.html">ZenLib/Format/Http/Http_Cookies.h</a>"</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <string></span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <ctime></span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <map></span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <vector></span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">//---------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">namespace </span>ZenLib</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> {</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">namespace </span>Format</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> {</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">namespace </span>Http</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> {</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">//***************************************************************************</span><span class="comment"></span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">/// @brief</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"></span><span class="comment">//***************************************************************************</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classZenLib_1_1Format_1_1Http_1_1Handler.html"> 39</a></span> <span class="keyword">class </span><a class="code" href="classZenLib_1_1Format_1_1Http_1_1Handler.html">Handler</a></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> {</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="comment">//Constructor/Destructor</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <a class="code" href="classZenLib_1_1Format_1_1Http_1_1Handler.html#a64d8b48045489b46abd8bbfdea4079d0">Handler</a>();</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="comment">//In</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="classZenLib_1_1Format_1_1Http_1_1Handler.html#ac2a8538f0e435504ba0701f47499afe4"> 46</a></span>  std::string <a class="code" href="classZenLib_1_1Format_1_1Http_1_1Handler.html#ac2a8538f0e435504ba0701f47499afe4">Path</a>; <span class="comment">//The path being requested by this request</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classZenLib_1_1Format_1_1Http_1_1Handler.html#a33f9d5f111f9d754f781329b5563efda"> 47</a></span>  std::map<std::string, std::string> <a class="code" href="classZenLib_1_1Format_1_1Http_1_1Handler.html#a33f9d5f111f9d754f781329b5563efda">Request_Headers</a>; <span class="comment">//All the incoming HTTP headers from the client web browser.</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="classZenLib_1_1Format_1_1Http_1_1Handler.html#aaa71404f77d021bbeaabea3496bd0716"> 48</a></span>  std::map<std::string, std::string> <a class="code" href="classZenLib_1_1Format_1_1Http_1_1Handler.html#aaa71404f77d021bbeaabea3496bd0716">Request_Cookies</a>; <span class="comment">//The set of cookies that came from the client along with this request</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="classZenLib_1_1Format_1_1Http_1_1Handler.html#a1c9b447d769c6afc4301aa229cfccb81"> 49</a></span>  std::map<std::string, std::string> <a class="code" href="classZenLib_1_1Format_1_1Http_1_1Handler.html#a1c9b447d769c6afc4301aa229cfccb81">Request_Queries</a>; <span class="comment">//All the key/value pairs in the query string of this request</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classZenLib_1_1Format_1_1Http_1_1Handler.html#a021dc9e21e706caaeb38592b9265fbec"> 50</a></span>  std::string <a class="code" href="classZenLib_1_1Format_1_1Http_1_1Handler.html#a021dc9e21e706caaeb38592b9265fbec">Foreign_IP</a>; <span class="comment">//The foreign ip address for this request</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="classZenLib_1_1Format_1_1Http_1_1Handler.html#a333fffcdcfbd0cc61fb268f683baf6f7"> 51</a></span>  std::string <a class="code" href="classZenLib_1_1Format_1_1Http_1_1Handler.html#a333fffcdcfbd0cc61fb268f683baf6f7">Local_IP</a>; <span class="comment">//The foreign port number for this request</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="classZenLib_1_1Format_1_1Http_1_1Handler.html#ad9a49dc8c418d58077dc7cc3c304a72d"> 52</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> <a class="code" href="classZenLib_1_1Format_1_1Http_1_1Handler.html#ad9a49dc8c418d58077dc7cc3c304a72d">Foreign_Port</a>; <span class="comment">//The IP of the local interface this request is coming in on</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="classZenLib_1_1Format_1_1Http_1_1Handler.html#ac2a3de7574005957d0999ef5a2c871ad"> 53</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> <a class="code" href="classZenLib_1_1Format_1_1Http_1_1Handler.html#ac2a3de7574005957d0999ef5a2c871ad">Local_Port</a>; <span class="comment">//The local port number this request is coming in on</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classZenLib_1_1Format_1_1Http_1_1Handler.html#a88c130cbb6d60ac7cf66649c12031da7"> 54</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classZenLib_1_1Format_1_1Http_1_1Handler.html#a88c130cbb6d60ac7cf66649c12031da7">HeadersOnly</a>; <span class="comment">//The request requests only the header</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="comment">//Out</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="classZenLib_1_1Format_1_1Http_1_1Handler.html#a5c53af4dc2d0bc1fe42a7ea8ee696103"> 57</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="classZenLib_1_1Format_1_1Http_1_1Handler.html#a5c53af4dc2d0bc1fe42a7ea8ee696103">Response_HTTP_Code</a>; <span class="comment">//HTTP code to be sent</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="classZenLib_1_1Format_1_1Http_1_1Handler.html#ad56fe52ad9e8a23182473a6df5393808"> 58</a></span>  std::map<std::string, std::string> <a class="code" href="classZenLib_1_1Format_1_1Http_1_1Handler.html#ad56fe52ad9e8a23182473a6df5393808">Response_Headers</a>; <span class="comment">//Additional headers you wish to appear in the HTTP response to this request</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="classZenLib_1_1Format_1_1Http_1_1Handler.html#a4c465b788bd3eab3c5c46fcd0da72563"> 59</a></span>  <a class="code" href="classZenLib_1_1Format_1_1Http_1_1Cookies.html">Cookies</a> <a class="code" href="classZenLib_1_1Format_1_1Http_1_1Handler.html#a4c465b788bd3eab3c5c46fcd0da72563">Response_Cookies</a>; <span class="comment">//New cookies to pass back to the client along with the result of this request</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="classZenLib_1_1Format_1_1Http_1_1Handler.html#a2cb023ce178bd5582329b515e53f62c5"> 60</a></span>  std::string <a class="code" href="classZenLib_1_1Format_1_1Http_1_1Handler.html#a2cb023ce178bd5582329b515e53f62c5">Response_Body</a>; <span class="comment">//To be displayed as the response to this request</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> };</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> } <span class="comment">//Namespace</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> } <span class="comment">//Namespace</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> } <span class="comment">//Namespace</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor">#endif</span></div>
<div class="ttc" id="classZenLib_1_1Format_1_1Http_1_1Handler_html_a64d8b48045489b46abd8bbfdea4079d0"><div class="ttname"><a href="classZenLib_1_1Format_1_1Http_1_1Handler.html#a64d8b48045489b46abd8bbfdea4079d0">ZenLib::Format::Http::Handler::Handler</a></div><div class="ttdeci">Handler()</div></div>
<div class="ttc" id="classZenLib_1_1Format_1_1Http_1_1Cookies_html"><div class="ttname"><a href="classZenLib_1_1Format_1_1Http_1_1Cookies.html">ZenLib::Format::Http::Cookies</a></div><div class="ttdef"><b>Definition:</b> Http_Cookies.h:55</div></div>
<div class="ttc" id="classZenLib_1_1Format_1_1Http_1_1Handler_html_a2cb023ce178bd5582329b515e53f62c5"><div class="ttname"><a href="classZenLib_1_1Format_1_1Http_1_1Handler.html#a2cb023ce178bd5582329b515e53f62c5">ZenLib::Format::Http::Handler::Response_Body</a></div><div class="ttdeci">std::string Response_Body</div><div class="ttdef"><b>Definition:</b> Http_Handler.h:60</div></div>
<div class="ttc" id="classZenLib_1_1Format_1_1Http_1_1Handler_html_a4c465b788bd3eab3c5c46fcd0da72563"><div class="ttname"><a href="classZenLib_1_1Format_1_1Http_1_1Handler.html#a4c465b788bd3eab3c5c46fcd0da72563">ZenLib::Format::Http::Handler::Response_Cookies</a></div><div class="ttdeci">Cookies Response_Cookies</div><div class="ttdef"><b>Definition:</b> Http_Handler.h:59</div></div>
<div class="ttc" id="classZenLib_1_1Format_1_1Http_1_1Handler_html_a1c9b447d769c6afc4301aa229cfccb81"><div class="ttname"><a href="classZenLib_1_1Format_1_1Http_1_1Handler.html#a1c9b447d769c6afc4301aa229cfccb81">ZenLib::Format::Http::Handler::Request_Queries</a></div><div class="ttdeci">std::map< std::string, std::string > Request_Queries</div><div class="ttdef"><b>Definition:</b> Http_Handler.h:49</div></div>
<div class="ttc" id="classZenLib_1_1Format_1_1Http_1_1Handler_html_a333fffcdcfbd0cc61fb268f683baf6f7"><div class="ttname"><a href="classZenLib_1_1Format_1_1Http_1_1Handler.html#a333fffcdcfbd0cc61fb268f683baf6f7">ZenLib::Format::Http::Handler::Local_IP</a></div><div class="ttdeci">std::string Local_IP</div><div class="ttdef"><b>Definition:</b> Http_Handler.h:51</div></div>
<div class="ttc" id="classZenLib_1_1Format_1_1Http_1_1Handler_html_a021dc9e21e706caaeb38592b9265fbec"><div class="ttname"><a href="classZenLib_1_1Format_1_1Http_1_1Handler.html#a021dc9e21e706caaeb38592b9265fbec">ZenLib::Format::Http::Handler::Foreign_IP</a></div><div class="ttdeci">std::string Foreign_IP</div><div class="ttdef"><b>Definition:</b> Http_Handler.h:50</div></div>
<div class="ttc" id="classZenLib_1_1Format_1_1Http_1_1Handler_html_ad9a49dc8c418d58077dc7cc3c304a72d"><div class="ttname"><a href="classZenLib_1_1Format_1_1Http_1_1Handler.html#ad9a49dc8c418d58077dc7cc3c304a72d">ZenLib::Format::Http::Handler::Foreign_Port</a></div><div class="ttdeci">unsigned short Foreign_Port</div><div class="ttdef"><b>Definition:</b> Http_Handler.h:52</div></div>
<div class="ttc" id="classZenLib_1_1Format_1_1Http_1_1Handler_html_a33f9d5f111f9d754f781329b5563efda"><div class="ttname"><a href="classZenLib_1_1Format_1_1Http_1_1Handler.html#a33f9d5f111f9d754f781329b5563efda">ZenLib::Format::Http::Handler::Request_Headers</a></div><div class="ttdeci">std::map< std::string, std::string > Request_Headers</div><div class="ttdef"><b>Definition:</b> Http_Handler.h:47</div></div>
<div class="ttc" id="classZenLib_1_1Format_1_1Http_1_1Handler_html_ac2a3de7574005957d0999ef5a2c871ad"><div class="ttname"><a href="classZenLib_1_1Format_1_1Http_1_1Handler.html#ac2a3de7574005957d0999ef5a2c871ad">ZenLib::Format::Http::Handler::Local_Port</a></div><div class="ttdeci">unsigned short Local_Port</div><div class="ttdef"><b>Definition:</b> Http_Handler.h:53</div></div>
<div class="ttc" id="classZenLib_1_1Format_1_1Http_1_1Handler_html_aaa71404f77d021bbeaabea3496bd0716"><div class="ttname"><a href="classZenLib_1_1Format_1_1Http_1_1Handler.html#aaa71404f77d021bbeaabea3496bd0716">ZenLib::Format::Http::Handler::Request_Cookies</a></div><div class="ttdeci">std::map< std::string, std::string > Request_Cookies</div><div class="ttdef"><b>Definition:</b> Http_Handler.h:48</div></div>
<div class="ttc" id="classZenLib_1_1Format_1_1Http_1_1Handler_html_ad56fe52ad9e8a23182473a6df5393808"><div class="ttname"><a href="classZenLib_1_1Format_1_1Http_1_1Handler.html#ad56fe52ad9e8a23182473a6df5393808">ZenLib::Format::Http::Handler::Response_Headers</a></div><div class="ttdeci">std::map< std::string, std::string > Response_Headers</div><div class="ttdef"><b>Definition:</b> Http_Handler.h:58</div></div>
<div class="ttc" id="classZenLib_1_1Format_1_1Http_1_1Handler_html"><div class="ttname"><a href="classZenLib_1_1Format_1_1Http_1_1Handler.html">ZenLib::Format::Http::Handler</a></div><div class="ttdef"><b>Definition:</b> Http_Handler.h:39</div></div>
<div class="ttc" id="classZenLib_1_1Format_1_1Http_1_1Handler_html_a88c130cbb6d60ac7cf66649c12031da7"><div class="ttname"><a href="classZenLib_1_1Format_1_1Http_1_1Handler.html#a88c130cbb6d60ac7cf66649c12031da7">ZenLib::Format::Http::Handler::HeadersOnly</a></div><div class="ttdeci">bool HeadersOnly</div><div class="ttdef"><b>Definition:</b> Http_Handler.h:54</div></div>
<div class="ttc" id="classZenLib_1_1Format_1_1Http_1_1Handler_html_a5c53af4dc2d0bc1fe42a7ea8ee696103"><div class="ttname"><a href="classZenLib_1_1Format_1_1Http_1_1Handler.html#a5c53af4dc2d0bc1fe42a7ea8ee696103">ZenLib::Format::Http::Handler::Response_HTTP_Code</a></div><div class="ttdeci">size_t Response_HTTP_Code</div><div class="ttdef"><b>Definition:</b> Http_Handler.h:57</div></div>
<div class="ttc" id="classZenLib_1_1Format_1_1Http_1_1Handler_html_ac2a8538f0e435504ba0701f47499afe4"><div class="ttname"><a href="classZenLib_1_1Format_1_1Http_1_1Handler.html#ac2a8538f0e435504ba0701f47499afe4">ZenLib::Format::Http::Handler::Path</a></div><div class="ttdeci">std::string Path</div><div class="ttdef"><b>Definition:</b> Http_Handler.h:46</div></div>
<div class="ttc" id="Http__Cookies_8h_html"><div class="ttname"><a href="Http__Cookies_8h.html">Http_Cookies.h</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Oct 19 2013 00:11:17 for ZenLib by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
