📄 structpion_1_1_pion.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::Pion Struct 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="structpion_1_1_pion.html">Pion</a></div><h1>pion::Pion Struct Reference</h1><!-- doxytag: class="pion::Pion" --><code>#include <<a class="el" href="_pion_8hpp-source.html">Pion.hpp</a>></code><p><a href="structpion_1_1_pion-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2><a class="el" href="structpion_1_1_pion.html">Pion</a>: library wrapper for the <a class="el" href="classpion_1_1_pion_engine.html">PionEngine</a> singleton <p><p>Definition at line <a class="el" href="_pion_8hpp-source.html#l00023">23</a> of file <a class="el" href="_pion_8hpp-source.html">Pion.hpp</a>.<table border="0" cellpadding="0" cellspacing="0"><tr><td></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 bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structpion_1_1_pion.html#33a29edd3cc9c0038859db498b60da83">addServer</a> (<a class="el" href="namespacepion.html#a54ac170d28fb8b88d560775581a9b8f">TCPServerPtr</a> tcp_server)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="namespacepion.html#7ed8c1f0fbb318801a8a19dda04f7001">HTTPServerPtr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structpion_1_1_pion.html#28ecaa62ec039912d903c3005853f1c2">addHTTPServer</a> (const unsigned int tcp_port)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="namespacepion.html#a54ac170d28fb8b88d560775581a9b8f">TCPServerPtr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structpion_1_1_pion.html#c4f47bc006e8c4a38ccc7bca31d48357">getServer</a> (const unsigned int tcp_port)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="structpion_1_1_pion.html#b6a70d791c6d4d89a7e074e419ebc46e">stop</a> (const bool reset_servers=false)</td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5daa267c01446014a070b551f7d8c5a"></a><!-- doxytag: member="pion::Pion::start" ref="a5daa267c01446014a070b551f7d8c5a" args="(void)" -->static void </td><td class="memItemRight" valign="bottom"><a class="el" href="structpion_1_1_pion.html#a5daa267c01446014a070b551f7d8c5a">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="e6f662f606c222e5ed7f92f7c05f5e79"></a><!-- doxytag: member="pion::Pion::join" ref="e6f662f606c222e5ed7f92f7c05f5e79" args="(void)" -->static void </td><td class="memItemRight" valign="bottom"><a class="el" href="structpion_1_1_pion.html#e6f662f606c222e5ed7f92f7c05f5e79">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="6258082fd674d53140df67f2b5b60a72"></a><!-- doxytag: member="pion::Pion::setNumThreads" ref="6258082fd674d53140df67f2b5b60a72" args="(const unsigned int n)" -->static void </td><td class="memItemRight" valign="bottom"><a class="el" href="structpion_1_1_pion.html#6258082fd674d53140df67f2b5b60a72">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="ded3e48a839abae504e54a28299da56f"></a><!-- doxytag: member="pion::Pion::getNumThreads" ref="ded3e48a839abae504e54a28299da56f" args="(void)" -->static unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="structpion_1_1_pion.html#ded3e48a839abae504e54a28299da56f">getNumThreads</a> (void)</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="b8312ab1b94b9c8bbf24f81f4f58fb29"></a><!-- doxytag: member="pion::Pion::setLogger" ref="b8312ab1b94b9c8bbf24f81f4f58fb29" args="(PionLogger log_ptr)" -->static void </td><td class="memItemRight" valign="bottom"><a class="el" href="structpion_1_1_pion.html#b8312ab1b94b9c8bbf24f81f4f58fb29">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="dd7ba6ad98b594faa470040cd81c90dc"></a><!-- doxytag: member="pion::Pion::getLogger" ref="dd7ba6ad98b594faa470040cd81c90dc" args="(void)" -->static <a class="el" href="namespacepion.html#917bc483e4f692504156efb93c11b322">PionLogger</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structpion_1_1_pion.html#dd7ba6ad98b594faa470040cd81c90dc">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="33d3b7a929703cd30195ecfc1f16ae06"></a><!-- doxytag: member="pion::Pion::addPluginDirectory" ref="33d3b7a929703cd30195ecfc1f16ae06" args="(const std::string &dir)" -->static void </td><td class="memItemRight" valign="bottom"><a class="el" href="structpion_1_1_pion.html#33d3b7a929703cd30195ecfc1f16ae06">addPluginDirectory</a> (const std::string &dir)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">appends a directory to the plug-in search path <br></td></tr><tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="36fbf84d05e2b340eb14c5d7195dcb50"></a><!-- doxytag: member="pion::Pion::resetPluginDirectories" ref="36fbf84d05e2b340eb14c5d7195dcb50" args="(void)" -->static void </td><td class="memItemRight" valign="bottom"><a class="el" href="structpion_1_1_pion.html#36fbf84d05e2b340eb14c5d7195dcb50">resetPluginDirectories</a> (void)</td></tr><tr><td class="mdescLeft"> </td><td class="mdescRight">clears all directories from the plug-in search path <br></td></tr></table><hr><h2>Member Function Documentation</h2><a class="anchor" name="33a29edd3cc9c0038859db498b60da83"></a><!-- doxytag: member="pion::Pion::addServer" ref="33a29edd3cc9c0038859db498b60da83" args="(TCPServerPtr tcp_server)" --><div class="memitem"><div class="memproto"> <table class="memname"> <tr> <td class="memname">static bool pion::Pion::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%"><code> [inline, static]</code></td> </tr> </table></div><div class="memdoc"><p>Adds a new TCP server<p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>tcp_server</em> </td><td>the TCP server to add</td></tr> </table></dl><dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the server was added; false if a conflict occurred </dd></dl><p>Definition at line <a class="el" href="_pion_8hpp-source.html#l00032">32</a> of file <a class="el" href="_pion_8hpp-source.html">Pion.hpp</a>.<p>References <a class="el" href="_pion_engine_8cpp-source.html#l00126">pion::PionEngine::addServer()</a>, and <a class="el" href="_pion_engine_8hpp-source.html#l00061">pion::PionEngine::getInstance()</a>.</div></div><p><a class="anchor" name="28ecaa62ec039912d903c3005853f1c2"></a><!-- doxytag: member="pion::Pion::addHTTPServer" ref="28ecaa62ec039912d903c3005853f1c2" args="(const unsigned int tcp_port)" --><div class="memitem"><div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="namespacepion.html#7ed8c1f0fbb318801a8a19dda04f7001">HTTPServerPtr</a> pion::Pion::addHTTPServer </td> <td>(</td> <td class="paramtype">const unsigned int </td> <td class="paramname"> <em>tcp_port</em> </td> <td> ) </td> <td width="100%"><code> [inline, static]</code></td> </tr> </table></div><div class="memdoc"><p>Adds a new HTTP server<p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>tcp_port</em> </td><td>the TCP port the server listens to</td></tr> </table></dl><dl class="return" compact><dt><b>Returns:</b></dt><dd>pointer to the new server (pointer is undefined if failure) </dd></dl><p>Definition at line <a class="el" href="_pion_8hpp-source.html#l00043">43</a> of file <a class="el" href="_pion_8hpp-source.html">Pion.hpp</a>.<p>References <a class="el" href="_pion_engine_8cpp-source.html#l00138">pion::PionEngine::addHTTPServer()</a>, and <a class="el" href="_pion_engine_8hpp-source.html#l00061">pion::PionEngine::getInstance()</a>.</div></div><p><a class="anchor" name="c4f47bc006e8c4a38ccc7bca31d48357"></a><!-- doxytag: member="pion::Pion::getServer" ref="c4f47bc006e8c4a38ccc7bca31d48357" args="(const unsigned int tcp_port)" --><div class="memitem"><div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="namespacepion.html#a54ac170d28fb8b88d560775581a9b8f">TCPServerPtr</a> pion::Pion::getServer </td> <td>(</td> <td class="paramtype">const unsigned int </td> <td class="paramname"> <em>tcp_port</em> </td> <td> ) </td> <td width="100%"><code> [inline, static]</code></td> </tr> </table></div><div class="memdoc"><p>Retrieves an existing TCP server for the given port number<p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>tcp_port</em> </td><td>the TCP port the server listens to</td></tr> </table></dl><dl class="return" compact><dt><b>Returns:</b></dt><dd>pointer to the new server (pointer is undefined if failure) </dd></dl><p>Definition at line <a class="el" href="_pion_8hpp-source.html#l00054">54</a> of file <a class="el" href="_pion_8hpp-source.html">Pion.hpp</a>.<p>References <a class="el" href="_pion_engine_8hpp-source.html#l00061">pion::PionEngine::getInstance()</a>, and <a class="el" href="_pion_engine_8cpp-source.html#l00154">pion::PionEngine::getServer()</a>.</div></div><p><a class="anchor" name="b6a70d791c6d4d89a7e074e419ebc46e"></a><!-- doxytag: member="pion::Pion::stop" ref="b6a70d791c6d4d89a7e074e419ebc46e" args="(const bool reset_servers=false)" --><div class="memitem"><div class="memproto"> <table class="memname"> <tr> <td class="memname">static void pion::Pion::stop </td> <td>(</td> <td class="paramtype">const bool </td> <td class="paramname"> <em>reset_servers</em> = <code>false</code> </td> <td> ) </td> <td width="100%"><code> [inline, static]</code></td> </tr> </table></div><div class="memdoc"><p>stops <a class="el" href="namespacepion.html">pion</a><p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>reset_servers</em> </td><td>if true, all servers will be removed </td></tr> </table></dl><p>Definition at line <a class="el" href="_pion_8hpp-source.html#l00063">63</a> of file <a class="el" href="_pion_8hpp-source.html">Pion.hpp</a>.<p>References <a class="el" href="_pion_engine_8hpp-source.html#l00061">pion::PionEngine::getInstance()</a>, and <a class="el" href="_pion_engine_8cpp-source.html#l00061">pion::PionEngine::stop()</a>.</div></div><p><hr>The documentation for this struct was generated from the following file:<ul><li>/Users/mdickey/code/libpion-export/include/libpion/<a class="el" href="_pion_8hpp-source.html">Pion.hpp</a></ul><hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 19 13:29:23 2007 for libpion by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.2 </small></address></body></html>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -