/usr/share/doc/libpion-doc/html/classpion_1_1one__to__one__scheduler.html is in libpion-doc 5.0.4+dfsg-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 | <!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>pion: pion::one_to_one_scheduler Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</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="navpath"><b>pion</b>::<a class="el" href="classpion_1_1one__to__one__scheduler.html">one_to_one_scheduler</a>
</div>
</div>
<div class="contents">
<h1>pion::one_to_one_scheduler Class Reference</h1><!-- doxytag: class="pion::one_to_one_scheduler" --><!-- doxytag: inherits="pion::multi_thread_scheduler" -->
<p><code>#include <<a class="el" href="scheduler_8hpp_source.html">scheduler.hpp</a>></code></p>
<p>Inherits <a class="el" href="classpion_1_1multi__thread__scheduler.html">pion::multi_thread_scheduler</a>.</p>
<p><a href="classpion_1_1one__to__one__scheduler-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structpion_1_1one__to__one__scheduler_1_1service__pair__type.html">service_pair_type</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">typedef for a pair object where first is an IO service and second is a deadline timer <a href="structpion_1_1one__to__one__scheduler_1_1service__pair__type.html#_details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1cf085d6cabbbe06891f316a3c0cb938"></a><!-- doxytag: member="pion::one_to_one_scheduler::one_to_one_scheduler" ref="a1cf085d6cabbbe06891f316a3c0cb938" args="(void)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1one__to__one__scheduler.html#a1cf085d6cabbbe06891f316a3c0cb938">one_to_one_scheduler</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">constructs a new <a class="el" href="classpion_1_1one__to__one__scheduler.html">one_to_one_scheduler</a> <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a76da28c9f319dced91f30b1d303da518"></a><!-- doxytag: member="pion::one_to_one_scheduler::~one_to_one_scheduler" ref="a76da28c9f319dced91f30b1d303da518" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1one__to__one__scheduler.html#a76da28c9f319dced91f30b1d303da518">~one_to_one_scheduler</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">virtual destructor <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6ead3ddcbbcbfb0eba98b102530d2a90"></a><!-- doxytag: member="pion::one_to_one_scheduler::get_io_service" ref="a6ead3ddcbbcbfb0eba98b102530d2a90" args="(void)" -->
virtual boost::asio::io_service & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1one__to__one__scheduler.html#a6ead3ddcbbcbfb0eba98b102530d2a90">get_io_service</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns an async I/O service used to schedule work <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual boost::asio::io_service & </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1one__to__one__scheduler.html#a5af0e30b2ef08cbbaf40278c9066c166">get_io_service</a> (boost::uint32_t n)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8f32fd88bc0d95d9952c5045849e09b9"></a><!-- doxytag: member="pion::one_to_one_scheduler::startup" ref="a8f32fd88bc0d95d9952c5045849e09b9" args="(void)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1one__to__one__scheduler.html#a8f32fd88bc0d95d9952c5045849e09b9">startup</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Starts the thread <a class="el" href="classpion_1_1scheduler.html">scheduler</a> (this is called automatically when necessary). <br/></td></tr>
<tr><td colspan="2"><h2>Protected Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac41a2d4f38f49673139a77e609b1d084"></a><!-- doxytag: member="pion::one_to_one_scheduler::service_pool_type" ref="ac41a2d4f38f49673139a77e609b1d084" args="" -->
typedef std::vector<br class="typebreak"/>
< boost::shared_ptr<br class="typebreak"/>
< <a class="el" href="structpion_1_1one__to__one__scheduler_1_1service__pair__type.html">service_pair_type</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1one__to__one__scheduler.html#ac41a2d4f38f49673139a77e609b1d084">service_pool_type</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">typedef for a pool of IO services <br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a39c02d4a67bf5cd28da3ce22363dd698"></a><!-- doxytag: member="pion::one_to_one_scheduler::stop_services" ref="a39c02d4a67bf5cd28da3ce22363dd698" args="(void)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1one__to__one__scheduler.html#a39c02d4a67bf5cd28da3ce22363dd698">stop_services</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">stops all services used to schedule work <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3e9f1380789598587a27f0857e7c9133"></a><!-- doxytag: member="pion::one_to_one_scheduler::finish_services" ref="a3e9f1380789598587a27f0857e7c9133" args="(void)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1one__to__one__scheduler.html#a3e9f1380789598587a27f0857e7c9133">finish_services</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">finishes all services used to schedule work <br/></td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8b6ae075086a579e46ca08a89085c07a"></a><!-- doxytag: member="pion::one_to_one_scheduler::m_service_pool" ref="a8b6ae075086a579e46ca08a89085c07a" args="" -->
<a class="el" href="classpion_1_1one__to__one__scheduler.html#ac41a2d4f38f49673139a77e609b1d084">service_pool_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1one__to__one__scheduler.html#a8b6ae075086a579e46ca08a89085c07a">m_service_pool</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">pool of IO services used to schedule work <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae4e2b2a157c1c9e36694e86b6ae354b1"></a><!-- doxytag: member="pion::one_to_one_scheduler::m_next_service" ref="ae4e2b2a157c1c9e36694e86b6ae354b1" args="" -->
boost::uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classpion_1_1one__to__one__scheduler.html#ae4e2b2a157c1c9e36694e86b6ae354b1">m_next_service</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">the next service to use for scheduling work <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="classpion_1_1one__to__one__scheduler.html">one_to_one_scheduler</a>: uses a single IO service for each thread </p>
<p>Definition at line <a class="el" href="scheduler_8hpp_source.html#l00286">286</a> of file <a class="el" href="scheduler_8hpp_source.html">scheduler.hpp</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a5af0e30b2ef08cbbaf40278c9066c166"></a><!-- doxytag: member="pion::one_to_one_scheduler::get_io_service" ref="a5af0e30b2ef08cbbaf40278c9066c166" args="(boost::uint32_t n)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual boost::asio::io_service& pion::one_to_one_scheduler::get_io_service </td>
<td>(</td>
<td class="paramtype">boost::uint32_t </td>
<td class="paramname"> <em>n</em></td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>returns an async I/O service used to schedule work (provides direct access to avoid locking when possible)</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>n</em> </td><td>integer number representing the service object </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="scheduler_8hpp_source.html#l00318">318</a> of file <a class="el" href="scheduler_8hpp_source.html">scheduler.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/pion/<a class="el" href="scheduler_8hpp_source.html">scheduler.hpp</a></li>
<li>src/<a class="el" href="scheduler_8cpp_source.html">scheduler.cpp</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 16 Sep 2013 for pion by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
|