📄 classpion_1_1_pion_engine.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"><title>libpion: pion::PionEngine Class Reference</title><link href="doxygen.css" rel="stylesheet" type="text/css"><link href="tabs.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.5.2 --><div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul></div><div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul></div><div class="nav"><a class="el" href="namespacepion.html">pion</a>::<a class="el" href="classpion_1_1_pion_engine.html">PionEngine</a></div><h1>pion::PionEngine Class Reference</h1><!-- doxytag: class="pion::PionEngine" --><code>#include <<a class="el" href="_pion_engine_8hpp-source.html">PionEngine.hpp</a>></code><p><a href="classpion_1_1_pion_engine-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2><a class="el" href="classpion_1_1_pion_engine.html">PionEngine</a>: singleton class that manages TCP servers and threads <p><p>Definition at line <a class="el" href="_pion_engine_8hpp-source.html#l00033">33</a> of file <a class="el" href="_pion_engine_8hpp-source.html">PionEngine.hpp</a>.<table border="0" cellpadding="0" cellspacing="0"><tr><td></td></tr><tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="00286dc19fc8f743b6a9d1ab2898d6ae"></a><!-- doxytag: member="pion::PionEngine::~PionEngine" ref="00286dc19fc8f743b6a9d1ab2898d6ae" args="()" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_pion_engine.html#00286dc19fc8f743b6a9d1ab2898d6ae">~PionEngine</a> ()</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">public destructor: not virtual, should not be extended <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_pion_engine.html#39c7e8b0eeca284001cf7a9455cbb5ae">addServer</a> (<a class="el" href="namespacepion.html#a54ac170d28fb8b88d560775581a9b8f">TCPServerPtr</a> tcp_server)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespacepion.html#7ed8c1f0fbb318801a8a19dda04f7001">HTTPServerPtr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_pion_engine.html#caa79f07e5eb562eb4b3ba99230ee941">addHTTPServer</a> (const unsigned int tcp_port)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="namespacepion.html#a54ac170d28fb8b88d560775581a9b8f">TCPServerPtr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_pion_engine.html#d2a1e4fc8c01020702b067508c027d6d">getServer</a> (const unsigned int tcp_port)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_pion_engine.html#2c6d002ad46191a4c4c4046537db329e">stop</a> (const bool reset_servers=false)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="82d766568a1629f92f36ff6930ba0751"></a><!-- doxytag: member="pion::PionEngine::start" ref="82d766568a1629f92f36ff6930ba0751" args="(void)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_pion_engine.html#82d766568a1629f92f36ff6930ba0751">start</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">starts <a class="el" href="namespacepion.html">pion</a> <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e9ae5bdbf1ef328a83e9a1a12037d08e"></a><!-- doxytag: member="pion::PionEngine::join" ref="e9ae5bdbf1ef328a83e9a1a12037d08e" args="(void)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_pion_engine.html#e9ae5bdbf1ef328a83e9a1a12037d08e">join</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">the calling thread will sleep until the engine has stopped <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5d04f83ff12550d8a645cd92dbd3a753"></a><!-- doxytag: member="pion::PionEngine::setNumThreads" ref="5d04f83ff12550d8a645cd92dbd3a753" args="(const unsigned int n)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_pion_engine.html#5d04f83ff12550d8a645cd92dbd3a753">setNumThreads</a> (const unsigned int n)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">sets the number of threads to be used (these are shared by all servers) <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="18533750090c18bedee61564d9769140"></a><!-- doxytag: member="pion::PionEngine::getNumThreads" ref="18533750090c18bedee61564d9769140" args="(void) const " -->unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_pion_engine.html#18533750090c18bedee61564d9769140">getNumThreads</a> (void) const </td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns the number of threads currently in use <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="74aa1df1308e3a02e2eb0b3bee141706"></a><!-- doxytag: member="pion::PionEngine::setLogger" ref="74aa1df1308e3a02e2eb0b3bee141706" args="(PionLogger log_ptr)" -->void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_pion_engine.html#74aa1df1308e3a02e2eb0b3bee141706">setLogger</a> (<a class="el" href="namespacepion.html#917bc483e4f692504156efb93c11b322">PionLogger</a> log_ptr)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">sets the logger to be used <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1d656ab4125167ce1e17e684d7c80b93"></a><!-- doxytag: member="pion::PionEngine::getLogger" ref="1d656ab4125167ce1e17e684d7c80b93" args="(void)" --><a class="el" href="namespacepion.html#917bc483e4f692504156efb93c11b322">PionLogger</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_pion_engine.html#1d656ab4125167ce1e17e684d7c80b93">getLogger</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns the logger currently in use <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8ad96703f8a19cf2aac3c774003f163"></a><!-- doxytag: member="pion::PionEngine::getIOService" ref="d8ad96703f8a19cf2aac3c774003f163" args="(void)" -->boost::asio::io_service & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_pion_engine.html#d8ad96703f8a19cf2aac3c774003f163">getIOService</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">returns the async I/O service used by the engine <br></td></tr><tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classpion_1_1_pion_engine.html">PionEngine</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_pion_engine.html#041692dfc331532fd97a79b43a7aeb74">getInstance</a> (void)</td></tr><tr><td colspan="2"><br><h2>Classes</h2></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_pion_engine_1_1_already_started_exception.html">AlreadyStartedException</a></td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">exception thrown if <a class="el" href="classpion_1_1_pion_engine.html#82d766568a1629f92f36ff6930ba0751" title="starts pion">start()</a> is called after <a class="el" href="structpion_1_1_pion.html">Pion</a> is running <a href="classpion_1_1_pion_engine_1_1_already_started_exception.html#_details">More...</a><br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1_pion_engine_1_1_no_servers_exception.html">NoServersException</a></td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">exception thrown if <a class="el" href="classpion_1_1_pion_engine.html#82d766568a1629f92f36ff6930ba0751" title="starts pion">start()</a> is called before any servers are defined <a href="classpion_1_1_pion_engine_1_1_no_servers_exception.html#_details">More...</a><br></td></tr></table><hr><h2>Member Function Documentation</h2><a class="anchor" name="041692dfc331532fd97a79b43a7aeb74"></a><!-- doxytag: member="pion::PionEngine::getInstance" ref="041692dfc331532fd97a79b43a7aeb74" args="(void)" --><div class="memitem"><div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="classpion_1_1_pion_engine.html">PionEngine</a>& pion::PionEngine::getInstance </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [inline, static]</code></td> </tr> </table></div><div class="memdoc"><p>return an instance of the <a class="el" href="classpion_1_1_pion_engine.html">PionEngine</a> singleton<p><dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="classpion_1_1_pion_engine.html">PionEngine</a>& instance of <a class="el" href="classpion_1_1_pion_engine.html">PionEngine</a> </dd></dl><p>Definition at line <a class="el" href="_pion_engine_8hpp-source.html#l00061">61</a> of file <a class="el" href="_pion_engine_8hpp-source.html">PionEngine.hpp</a>.<p>Referenced by <a class="el" href="_pion_8hpp-source.html#l00043">pion::Pion::addHTTPServer()</a>, <a class="el" href="_pion_8hpp-source.html#l00032">pion::Pion::addServer()</a>, <a class="el" href="_pion_8hpp-source.html#l00093">pion::Pion::getLogger()</a>, <a class="el" href="_pion_8hpp-source.html#l00083">pion::Pion::getNumThreads()</a>, <a class="el" href="_pion_8hpp-source.html#l00054">pion::Pion::getServer()</a>, <a class="el" href="_pion_8hpp-source.html#l00073">pion::Pion::join()</a>, <a class="el" href="_pion_8hpp-source.html#l00088">pion::Pion::setLogger()</a>, <a class="el" href="_pion_8hpp-source.html#l00078">pion::Pion::setNumThreads()</a>, <a class="el" href="_pion_8hpp-source.html#l00068">pion::Pion::start()</a>, and <a class="el" href="_pion_8hpp-source.html#l00063">pion::Pion::stop()</a>.</div></div><p><a class="anchor" name="39c7e8b0eeca284001cf7a9455cbb5ae"></a><!-- doxytag: member="pion::PionEngine::addServer" ref="39c7e8b0eeca284001cf7a9455cbb5ae" args="(TCPServerPtr tcp_server)" --><div class="memitem"><div class="memproto"> <table class="memname"> <tr> <td class="memname">bool pion::PionEngine::addServer </td> <td>(</td> <td class="paramtype"><a class="el" href="namespacepion.html#a54ac170d28fb8b88d560775581a9b8f">TCPServerPtr</a> </td> <td class="paramname"> <em>tcp_server</em> </td> <td> ) </td> <td width="100%"></td>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -