This commit is contained in:
rozmansi
2023-08-29 08:10:06 +00:00
parent 3ccf77e66e
commit fa4f7f1747
361 changed files with 8214 additions and 8076 deletions

View File

@@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.7"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>stdex: stdex::ring&lt; T, CAPACITY &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -30,7 +30,7 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.7 -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
@@ -90,60 +90,60 @@ $(function() {
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a3e41365e5bcb914099baff6b02686bca"><td class="memItemLeft" align="right" valign="top">std::tuple&lt; T *, size_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstdex_1_1ring.html#a3e41365e5bcb914099baff6b02686bca">back</a> ()</td></tr>
<tr class="memitem:a3e41365e5bcb914099baff6b02686bca" id="r_a3e41365e5bcb914099baff6b02686bca"><td class="memItemLeft" align="right" valign="top">std::tuple&lt; T *, size_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstdex_1_1ring.html#a3e41365e5bcb914099baff6b02686bca">back</a> ()</td></tr>
<tr class="memdesc:a3e41365e5bcb914099baff6b02686bca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocates the data after the ring tail. Use <a class="el" href="classstdex_1_1ring.html#ab8b671ab4a84c370bdf8d4d2df7c0d9d" title="Notifies the receiver the data was populated.">push()</a> after the allocated data is populated. <br /></td></tr>
<tr class="separator:a3e41365e5bcb914099baff6b02686bca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab8b671ab4a84c370bdf8d4d2df7c0d9d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstdex_1_1ring.html#ab8b671ab4a84c370bdf8d4d2df7c0d9d">push</a> (size_t size)</td></tr>
<tr class="memitem:ab8b671ab4a84c370bdf8d4d2df7c0d9d" id="r_ab8b671ab4a84c370bdf8d4d2df7c0d9d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstdex_1_1ring.html#ab8b671ab4a84c370bdf8d4d2df7c0d9d">push</a> (size_t size)</td></tr>
<tr class="memdesc:ab8b671ab4a84c370bdf8d4d2df7c0d9d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Notifies the receiver the data was populated. <br /></td></tr>
<tr class="separator:ab8b671ab4a84c370bdf8d4d2df7c0d9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b6571832cc636d98885af61651a0998"><td class="memItemLeft" align="right" valign="top">std::tuple&lt; T *, size_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstdex_1_1ring.html#a9b6571832cc636d98885af61651a0998">front</a> ()</td></tr>
<tr class="memitem:a9b6571832cc636d98885af61651a0998" id="r_a9b6571832cc636d98885af61651a0998"><td class="memItemLeft" align="right" valign="top">std::tuple&lt; T *, size_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstdex_1_1ring.html#a9b6571832cc636d98885af61651a0998">front</a> ()</td></tr>
<tr class="memdesc:a9b6571832cc636d98885af61651a0998"><td class="mdescLeft">&#160;</td><td class="mdescRight">Peeks the data at the ring head. Use <a class="el" href="classstdex_1_1ring.html#a6360d8186fa2bda1ef4b4ddbcae93749" title="Notifies the sender the data was consumed.">pop()</a> after the data was consumed. <br /></td></tr>
<tr class="separator:a9b6571832cc636d98885af61651a0998"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6360d8186fa2bda1ef4b4ddbcae93749"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstdex_1_1ring.html#a6360d8186fa2bda1ef4b4ddbcae93749">pop</a> (size_t size)</td></tr>
<tr class="memitem:a6360d8186fa2bda1ef4b4ddbcae93749" id="r_a6360d8186fa2bda1ef4b4ddbcae93749"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstdex_1_1ring.html#a6360d8186fa2bda1ef4b4ddbcae93749">pop</a> (size_t size)</td></tr>
<tr class="memdesc:a6360d8186fa2bda1ef4b4ddbcae93749"><td class="mdescLeft">&#160;</td><td class="mdescRight">Notifies the sender the data was consumed. <br /></td></tr>
<tr class="separator:a6360d8186fa2bda1ef4b4ddbcae93749"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a385d1648c6fb8e61154e518f954a0a0e"><td class="memItemLeft" align="right" valign="top"><a id="a385d1648c6fb8e61154e518f954a0a0e" name="a385d1648c6fb8e61154e518f954a0a0e"></a>
<tr class="memitem:a385d1648c6fb8e61154e518f954a0a0e" id="r_a385d1648c6fb8e61154e518f954a0a0e"><td class="memItemLeft" align="right" valign="top"><a id="a385d1648c6fb8e61154e518f954a0a0e" name="a385d1648c6fb8e61154e518f954a0a0e"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>quit</b> ()</td></tr>
<tr class="memdesc:a385d1648c6fb8e61154e518f954a0a0e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cancells waiting sender and receiver. <br /></td></tr>
<tr class="separator:a385d1648c6fb8e61154e518f954a0a0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a68e471c5801c9c8232464005a3225eb3"><td class="memItemLeft" align="right" valign="top"><a id="a68e471c5801c9c8232464005a3225eb3" name="a68e471c5801c9c8232464005a3225eb3"></a>
<tr class="memitem:a68e471c5801c9c8232464005a3225eb3" id="r_a68e471c5801c9c8232464005a3225eb3"><td class="memItemLeft" align="right" valign="top"><a id="a68e471c5801c9c8232464005a3225eb3" name="a68e471c5801c9c8232464005a3225eb3"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>sync</b> ()</td></tr>
<tr class="memdesc:a68e471c5801c9c8232464005a3225eb3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Waits until the ring is flush. <br /></td></tr>
<tr class="separator:a68e471c5801c9c8232464005a3225eb3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:af5917276a296edf2d43780357f889280"><td class="memItemLeft" align="right" valign="top"><a id="af5917276a296edf2d43780357f889280" name="af5917276a296edf2d43780357f889280"></a>
<tr class="memitem:af5917276a296edf2d43780357f889280" id="r_af5917276a296edf2d43780357f889280"><td class="memItemLeft" align="right" valign="top"><a id="af5917276a296edf2d43780357f889280" name="af5917276a296edf2d43780357f889280"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>wrap</b> (size_t idx) const</td></tr>
<tr class="separator:af5917276a296edf2d43780357f889280"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58ffa738243ed1cf759db3534d01fb89"><td class="memItemLeft" align="right" valign="top"><a id="a58ffa738243ed1cf759db3534d01fb89" name="a58ffa738243ed1cf759db3534d01fb89"></a>
<tr class="memitem:a58ffa738243ed1cf759db3534d01fb89" id="r_a58ffa738243ed1cf759db3534d01fb89"><td class="memItemLeft" align="right" valign="top"><a id="a58ffa738243ed1cf759db3534d01fb89" name="a58ffa738243ed1cf759db3534d01fb89"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>space</b> () const</td></tr>
<tr class="separator:a58ffa738243ed1cf759db3534d01fb89"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa0b426f13b65d46f025936a65a3a89fb"><td class="memItemLeft" align="right" valign="top"><a id="aa0b426f13b65d46f025936a65a3a89fb" name="aa0b426f13b65d46f025936a65a3a89fb"></a>
<tr class="memitem:aa0b426f13b65d46f025936a65a3a89fb" id="r_aa0b426f13b65d46f025936a65a3a89fb"><td class="memItemLeft" align="right" valign="top"><a id="aa0b426f13b65d46f025936a65a3a89fb" name="aa0b426f13b65d46f025936a65a3a89fb"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>empty</b> () const</td></tr>
<tr class="separator:aa0b426f13b65d46f025936a65a3a89fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a02966cd9edca7a173801fe3a07c6affb"><td class="memItemLeft" align="right" valign="top"><a id="a02966cd9edca7a173801fe3a07c6affb" name="a02966cd9edca7a173801fe3a07c6affb"></a>
<tr class="memitem:a02966cd9edca7a173801fe3a07c6affb" id="r_a02966cd9edca7a173801fe3a07c6affb"><td class="memItemLeft" align="right" valign="top"><a id="a02966cd9edca7a173801fe3a07c6affb" name="a02966cd9edca7a173801fe3a07c6affb"></a>
std::mutex&#160;</td><td class="memItemRight" valign="bottom"><b>m_mutex</b></td></tr>
<tr class="separator:a02966cd9edca7a173801fe3a07c6affb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a585e10bd6efa383b4440ced86c0ff382"><td class="memItemLeft" align="right" valign="top"><a id="a585e10bd6efa383b4440ced86c0ff382" name="a585e10bd6efa383b4440ced86c0ff382"></a>
<tr class="memitem:a585e10bd6efa383b4440ced86c0ff382" id="r_a585e10bd6efa383b4440ced86c0ff382"><td class="memItemLeft" align="right" valign="top"><a id="a585e10bd6efa383b4440ced86c0ff382" name="a585e10bd6efa383b4440ced86c0ff382"></a>
std::condition_variable&#160;</td><td class="memItemRight" valign="bottom"><b>m_head_moved</b></td></tr>
<tr class="separator:a585e10bd6efa383b4440ced86c0ff382"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc6c39ad959faa84e14096ae26ea552e"><td class="memItemLeft" align="right" valign="top"><a id="acc6c39ad959faa84e14096ae26ea552e" name="acc6c39ad959faa84e14096ae26ea552e"></a>
<tr class="memitem:acc6c39ad959faa84e14096ae26ea552e" id="r_acc6c39ad959faa84e14096ae26ea552e"><td class="memItemLeft" align="right" valign="top"><a id="acc6c39ad959faa84e14096ae26ea552e" name="acc6c39ad959faa84e14096ae26ea552e"></a>
std::condition_variable&#160;</td><td class="memItemRight" valign="bottom"><b>m_tail_moved</b></td></tr>
<tr class="separator:acc6c39ad959faa84e14096ae26ea552e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2a2ebd0d0d94e38e8fdd4789fcb92678"><td class="memItemLeft" align="right" valign="top"><a id="a2a2ebd0d0d94e38e8fdd4789fcb92678" name="a2a2ebd0d0d94e38e8fdd4789fcb92678"></a>
<tr class="memitem:a2a2ebd0d0d94e38e8fdd4789fcb92678" id="r_a2a2ebd0d0d94e38e8fdd4789fcb92678"><td class="memItemLeft" align="right" valign="top"><a id="a2a2ebd0d0d94e38e8fdd4789fcb92678" name="a2a2ebd0d0d94e38e8fdd4789fcb92678"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>m_head</b></td></tr>
<tr class="separator:a2a2ebd0d0d94e38e8fdd4789fcb92678"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c238fbeb5c0aa236d17b6f0798e7e37"><td class="memItemLeft" align="right" valign="top"><a id="a8c238fbeb5c0aa236d17b6f0798e7e37" name="a8c238fbeb5c0aa236d17b6f0798e7e37"></a>
<tr class="memitem:a8c238fbeb5c0aa236d17b6f0798e7e37" id="r_a8c238fbeb5c0aa236d17b6f0798e7e37"><td class="memItemLeft" align="right" valign="top"><a id="a8c238fbeb5c0aa236d17b6f0798e7e37" name="a8c238fbeb5c0aa236d17b6f0798e7e37"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>m_size</b></td></tr>
<tr class="separator:a8c238fbeb5c0aa236d17b6f0798e7e37"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7528cb47db972ce7ec6978084c68c40"><td class="memItemLeft" align="right" valign="top"><a id="ac7528cb47db972ce7ec6978084c68c40" name="ac7528cb47db972ce7ec6978084c68c40"></a>
<tr class="memitem:ac7528cb47db972ce7ec6978084c68c40" id="r_ac7528cb47db972ce7ec6978084c68c40"><td class="memItemLeft" align="right" valign="top"><a id="ac7528cb47db972ce7ec6978084c68c40" name="ac7528cb47db972ce7ec6978084c68c40"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>m_quit</b></td></tr>
<tr class="separator:ac7528cb47db972ce7ec6978084c68c40"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a08e6198db9de0df59e86e5d283dedc58"><td class="memItemLeft" align="right" valign="top"><a id="a08e6198db9de0df59e86e5d283dedc58" name="a08e6198db9de0df59e86e5d283dedc58"></a>
<tr class="memitem:a08e6198db9de0df59e86e5d283dedc58" id="r_a08e6198db9de0df59e86e5d283dedc58"><td class="memItemLeft" align="right" valign="top"><a id="a08e6198db9de0df59e86e5d283dedc58" name="a08e6198db9de0df59e86e5d283dedc58"></a>
T&#160;</td><td class="memItemRight" valign="bottom"><b>m_data</b> [CAPACITY]</td></tr>
<tr class="separator:a08e6198db9de0df59e86e5d283dedc58"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
@@ -296,7 +296,7 @@ template&lt;class T , size_t CAPACITY&gt; </div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Aug 25 2023 09:25:09 for stdex by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.7
Generated on Tue Aug 29 2023 08:10:04 for stdex by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>