diff options
Diffstat (limited to 'docs/class_tg_bot_1_1_http_server.html')
| -rw-r--r-- | docs/class_tg_bot_1_1_http_server.html | 354 |
1 files changed, 354 insertions, 0 deletions
diff --git a/docs/class_tg_bot_1_1_http_server.html b/docs/class_tg_bot_1_1_http_server.html new file mode 100644 index 0000000..60a744d --- /dev/null +++ b/docs/class_tg_bot_1_1_http_server.html @@ -0,0 +1,354 @@ +<!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.13"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>tgbot-cpp: TgBot::HttpServer< Protocol > Class Template Reference</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="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); +</script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.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 id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">tgbot-cpp + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.13 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</script> +<div id="main-nav"></div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('class_tg_bot_1_1_http_server.html','');}); +</script> +<div id="doc-content"> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div class="header"> + <div class="summary"> +<a href="#nested-classes">Classes</a> | +<a href="#pub-types">Public Types</a> | +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pro-attribs">Protected Attributes</a> | +<a href="class_tg_bot_1_1_http_server-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">TgBot::HttpServer< Protocol > Class Template Reference<div class="ingroups"><a class="el" href="group__net.html">Net</a></div></div> </div> +</div><!--header--> +<div class="contents"> + +<p><code>#include <<a class="el" href="_http_server_8h_source.html">HttpServer.h</a>></code></p> +<div class="dynheader"> +Inheritance diagram for TgBot::HttpServer< Protocol >:</div> +<div class="dyncontent"> + <div class="center"> + <img src="class_tg_bot_1_1_http_server.png" usemap="#TgBot::HttpServer_3C_20Protocol_20_3E_map" alt=""/> + <map id="TgBot::HttpServer_3C_20Protocol_20_3E_map" name="TgBot::HttpServer_3C_20Protocol_20_3E_map"> +<area href="class_tg_bot_1_1_tg_webhook_server.html" alt="TgBot::TgWebhookServer< Protocol >" shape="rect" coords="0,56,226,80"/> +</map> + </div></div> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> +Classes</h2></td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_http_server_1_1_connection.html">Connection</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> +Public Types</h2></td></tr> +<tr class="memitem:ae3b5d008d0ec0c9dd14b4a8bccdf8c0b"><td class="memItemLeft" align="right" valign="top">typedef std::function< std::string(const std::string &, const std::map< std::string, std::string >)> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_http_server.html#ae3b5d008d0ec0c9dd14b4a8bccdf8c0b">ServerHandler</a></td></tr> +<tr class="separator:ae3b5d008d0ec0c9dd14b4a8bccdf8c0b"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:a8edad0dd91ffffa6cacce4d49cb60abe"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_http_server.html#a8edad0dd91ffffa6cacce4d49cb60abe">HttpServer</a> (std::shared_ptr< boost::asio::basic_socket_acceptor< Protocol >> acceptor, const <a class="el" href="class_tg_bot_1_1_http_server.html#ae3b5d008d0ec0c9dd14b4a8bccdf8c0b">ServerHandler</a> &handler)</td></tr> +<tr class="separator:a8edad0dd91ffffa6cacce4d49cb60abe"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aa237b199d8a0712b983e4913970ad7f7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_http_server.html#aa237b199d8a0712b983e4913970ad7f7">start</a> ()</td></tr> +<tr class="separator:aa237b199d8a0712b983e4913970ad7f7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aeed8b9200cc2932126b9c27946751377"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_http_server.html#aeed8b9200cc2932126b9c27946751377">stop</a> ()</td></tr> +<tr class="separator:aeed8b9200cc2932126b9c27946751377"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a> +Protected Attributes</h2></td></tr> +<tr class="memitem:a68812914f5c398331ee3ef8e77fe39b7"><td class="memItemLeft" align="right" valign="top">boost::asio::io_service </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_http_server.html#a68812914f5c398331ee3ef8e77fe39b7">_ioService</a></td></tr> +<tr class="separator:a68812914f5c398331ee3ef8e77fe39b7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a020e76d58f70ad41686081be41a8c108"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< boost::asio::basic_socket_acceptor< Protocol > > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_http_server.html#a020e76d58f70ad41686081be41a8c108">_acceptor</a></td></tr> +<tr class="separator:a020e76d58f70ad41686081be41a8c108"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9af2cf386463a1f40d0d3e9d92d88eec"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="class_tg_bot_1_1_http_server.html#ae3b5d008d0ec0c9dd14b4a8bccdf8c0b">ServerHandler</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_tg_bot_1_1_http_server.html#a9af2cf386463a1f40d0d3e9d92d88eec">_handler</a></td></tr> +<tr class="separator:a9af2cf386463a1f40d0d3e9d92d88eec"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><h3>template<typename Protocol><br /> +class TgBot::HttpServer< Protocol ></h3> + +<p>This class handles HTTP requests from the Internet. </p> + +<p class="definition">Definition at line <a class="el" href="_http_server_8h_source.html#l00039">39</a> of file <a class="el" href="_http_server_8h_source.html">HttpServer.h</a>.</p> +</div><h2 class="groupheader">Member Typedef Documentation</h2> +<a id="ae3b5d008d0ec0c9dd14b4a8bccdf8c0b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ae3b5d008d0ec0c9dd14b4a8bccdf8c0b">◆ </a></span>ServerHandler</h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<typename Protocol> </div> + <table class="memname"> + <tr> + <td class="memname">typedef std::function<std::string (const std::string&, const std::map<std::string, std::string>)> <a class="el" href="class_tg_bot_1_1_http_server.html">TgBot::HttpServer</a>< Protocol >::<a class="el" href="class_tg_bot_1_1_http_server.html#ae3b5d008d0ec0c9dd14b4a8bccdf8c0b">ServerHandler</a></td> + </tr> + </table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_http_server_8h_source.html#l00042">42</a> of file <a class="el" href="_http_server_8h_source.html">HttpServer.h</a>.</p> + +</div> +</div> +<h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="a8edad0dd91ffffa6cacce4d49cb60abe"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a8edad0dd91ffffa6cacce4d49cb60abe">◆ </a></span>HttpServer()</h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<typename Protocol> </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_tg_bot_1_1_http_server.html">TgBot::HttpServer</a>< Protocol >::<a class="el" href="class_tg_bot_1_1_http_server.html">HttpServer</a> </td> + <td>(</td> + <td class="paramtype">std::shared_ptr< boost::asio::basic_socket_acceptor< Protocol >> </td> + <td class="paramname"><em>acceptor</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="class_tg_bot_1_1_http_server.html#ae3b5d008d0ec0c9dd14b4a8bccdf8c0b">ServerHandler</a> & </td> + <td class="paramname"><em>handler</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_http_server_8h_source.html#l00047">47</a> of file <a class="el" href="_http_server_8h_source.html">HttpServer.h</a>.</p> + +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="aa237b199d8a0712b983e4913970ad7f7"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aa237b199d8a0712b983e4913970ad7f7">◆ </a></span>start()</h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<typename Protocol> </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">void <a class="el" href="class_tg_bot_1_1_http_server.html">TgBot::HttpServer</a>< Protocol >::start </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>Starts receiving new connections. </p> + +<p class="definition">Definition at line <a class="el" href="_http_server_8h_source.html#l00053">53</a> of file <a class="el" href="_http_server_8h_source.html">HttpServer.h</a>.</p> + +</div> +</div> +<a id="aeed8b9200cc2932126b9c27946751377"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aeed8b9200cc2932126b9c27946751377">◆ </a></span>stop()</h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<typename Protocol> </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">void <a class="el" href="class_tg_bot_1_1_http_server.html">TgBot::HttpServer</a>< Protocol >::stop </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>Stops receiving new connections. </p> + +<p class="definition">Definition at line <a class="el" href="_http_server_8h_source.html#l00066">66</a> of file <a class="el" href="_http_server_8h_source.html">HttpServer.h</a>.</p> + +</div> +</div> +<h2 class="groupheader">Member Data Documentation</h2> +<a id="a020e76d58f70ad41686081be41a8c108"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a020e76d58f70ad41686081be41a8c108">◆ </a></span>_acceptor</h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<typename Protocol> </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">std::shared_ptr<boost::asio::basic_socket_acceptor<Protocol> > <a class="el" href="class_tg_bot_1_1_http_server.html">TgBot::HttpServer</a>< Protocol >::_acceptor</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_http_server_8h_source.html#l00096">96</a> of file <a class="el" href="_http_server_8h_source.html">HttpServer.h</a>.</p> + +</div> +</div> +<a id="a9af2cf386463a1f40d0d3e9d92d88eec"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a9af2cf386463a1f40d0d3e9d92d88eec">◆ </a></span>_handler</h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<typename Protocol> </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">const <a class="el" href="class_tg_bot_1_1_http_server.html#ae3b5d008d0ec0c9dd14b4a8bccdf8c0b">ServerHandler</a> <a class="el" href="class_tg_bot_1_1_http_server.html">TgBot::HttpServer</a>< Protocol >::_handler</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_http_server_8h_source.html#l00097">97</a> of file <a class="el" href="_http_server_8h_source.html">HttpServer.h</a>.</p> + +</div> +</div> +<a id="a68812914f5c398331ee3ef8e77fe39b7"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a68812914f5c398331ee3ef8e77fe39b7">◆ </a></span>_ioService</h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<typename Protocol> </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">boost::asio::io_service <a class="el" href="class_tg_bot_1_1_http_server.html">TgBot::HttpServer</a>< Protocol >::_ioService</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p class="definition">Definition at line <a class="el" href="_http_server_8h_source.html#l00095">95</a> of file <a class="el" href="_http_server_8h_source.html">HttpServer.h</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>include/tgbot/net/<a class="el" href="_http_server_8h_source.html">HttpServer.h</a></li> +</ul> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><a class="el" href="namespace_tg_bot.html">TgBot</a></li><li class="navelem"><a class="el" href="class_tg_bot_1_1_http_server.html">HttpServer</a></li> + <li class="footer">Generated on Sun Jan 15 2017 02:46:16 for tgbot-cpp by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> + </ul> +</div> +</body> +</html> |