303 lines
18 KiB
HTML
303 lines
18 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<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.8"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>stdex: stdex::ring< T, CAPACITY > 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="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 id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">stdex
|
|
</div>
|
|
<div id="projectbrief">Additional custom or not Standard C++ covered algorithms</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.8 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<!-- 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">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><b>stdex</b></li><li class="navelem"><a class="el" href="classstdex_1_1ring.html">ring</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
|
<a href="#pro-attribs">Protected Attributes</a> |
|
|
<a href="classstdex_1_1ring-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">stdex::ring< T, CAPACITY > Class Template Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Ring buffer.
|
|
<a href="classstdex_1_1ring.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="ring_8hpp_source.html">stdex/ring.hpp</a>></code></p>
|
|
<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" id="r_a3e41365e5bcb914099baff6b02686bca"><td class="memItemLeft" align="right" valign="top">std::tuple< T *, size_t > </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"> </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"> </td></tr>
|
|
<tr class="memitem:ab8b671ab4a84c370bdf8d4d2df7c0d9d" id="r_ab8b671ab4a84c370bdf8d4d2df7c0d9d"><td class="memItemLeft" align="right" valign="top">void </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"> </td><td class="mdescRight">Notifies the receiver the data was populated. <br /></td></tr>
|
|
<tr class="separator:ab8b671ab4a84c370bdf8d4d2df7c0d9d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9b6571832cc636d98885af61651a0998" id="r_a9b6571832cc636d98885af61651a0998"><td class="memItemLeft" align="right" valign="top">std::tuple< T *, size_t > </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"> </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"> </td></tr>
|
|
<tr class="memitem:a6360d8186fa2bda1ef4b4ddbcae93749" id="r_a6360d8186fa2bda1ef4b4ddbcae93749"><td class="memItemLeft" align="right" valign="top">void </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"> </td><td class="mdescRight">Notifies the sender the data was consumed. <br /></td></tr>
|
|
<tr class="separator:a6360d8186fa2bda1ef4b4ddbcae93749"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a385d1648c6fb8e61154e518f954a0a0e" id="r_a385d1648c6fb8e61154e518f954a0a0e"><td class="memItemLeft" align="right" valign="top"><a id="a385d1648c6fb8e61154e518f954a0a0e" name="a385d1648c6fb8e61154e518f954a0a0e"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>quit</b> ()</td></tr>
|
|
<tr class="memdesc:a385d1648c6fb8e61154e518f954a0a0e"><td class="mdescLeft"> </td><td class="mdescRight">Cancells waiting sender and receiver. <br /></td></tr>
|
|
<tr class="separator:a385d1648c6fb8e61154e518f954a0a0e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a68e471c5801c9c8232464005a3225eb3" id="r_a68e471c5801c9c8232464005a3225eb3"><td class="memItemLeft" align="right" valign="top"><a id="a68e471c5801c9c8232464005a3225eb3" name="a68e471c5801c9c8232464005a3225eb3"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>sync</b> ()</td></tr>
|
|
<tr class="memdesc:a68e471c5801c9c8232464005a3225eb3"><td class="mdescLeft"> </td><td class="mdescRight">Waits until the ring is flush. <br /></td></tr>
|
|
<tr class="separator:a68e471c5801c9c8232464005a3225eb3"><td class="memSeparator" colspan="2"> </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" id="r_af5917276a296edf2d43780357f889280"><td class="memItemLeft" align="right" valign="top"><a id="af5917276a296edf2d43780357f889280" name="af5917276a296edf2d43780357f889280"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>wrap</b> (size_t idx) const</td></tr>
|
|
<tr class="separator:af5917276a296edf2d43780357f889280"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a58ffa738243ed1cf759db3534d01fb89" id="r_a58ffa738243ed1cf759db3534d01fb89"><td class="memItemLeft" align="right" valign="top"><a id="a58ffa738243ed1cf759db3534d01fb89" name="a58ffa738243ed1cf759db3534d01fb89"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>space</b> () const</td></tr>
|
|
<tr class="separator:a58ffa738243ed1cf759db3534d01fb89"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa0b426f13b65d46f025936a65a3a89fb" id="r_aa0b426f13b65d46f025936a65a3a89fb"><td class="memItemLeft" align="right" valign="top"><a id="aa0b426f13b65d46f025936a65a3a89fb" name="aa0b426f13b65d46f025936a65a3a89fb"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>empty</b> () const</td></tr>
|
|
<tr class="separator:aa0b426f13b65d46f025936a65a3a89fb"><td class="memSeparator" colspan="2"> </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" id="r_a02966cd9edca7a173801fe3a07c6affb"><td class="memItemLeft" align="right" valign="top"><a id="a02966cd9edca7a173801fe3a07c6affb" name="a02966cd9edca7a173801fe3a07c6affb"></a>
|
|
std::mutex </td><td class="memItemRight" valign="bottom"><b>m_mutex</b></td></tr>
|
|
<tr class="separator:a02966cd9edca7a173801fe3a07c6affb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a585e10bd6efa383b4440ced86c0ff382" id="r_a585e10bd6efa383b4440ced86c0ff382"><td class="memItemLeft" align="right" valign="top"><a id="a585e10bd6efa383b4440ced86c0ff382" name="a585e10bd6efa383b4440ced86c0ff382"></a>
|
|
std::condition_variable </td><td class="memItemRight" valign="bottom"><b>m_head_moved</b></td></tr>
|
|
<tr class="separator:a585e10bd6efa383b4440ced86c0ff382"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acc6c39ad959faa84e14096ae26ea552e" id="r_acc6c39ad959faa84e14096ae26ea552e"><td class="memItemLeft" align="right" valign="top"><a id="acc6c39ad959faa84e14096ae26ea552e" name="acc6c39ad959faa84e14096ae26ea552e"></a>
|
|
std::condition_variable </td><td class="memItemRight" valign="bottom"><b>m_tail_moved</b></td></tr>
|
|
<tr class="separator:acc6c39ad959faa84e14096ae26ea552e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2a2ebd0d0d94e38e8fdd4789fcb92678" id="r_a2a2ebd0d0d94e38e8fdd4789fcb92678"><td class="memItemLeft" align="right" valign="top"><a id="a2a2ebd0d0d94e38e8fdd4789fcb92678" name="a2a2ebd0d0d94e38e8fdd4789fcb92678"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>m_head</b></td></tr>
|
|
<tr class="separator:a2a2ebd0d0d94e38e8fdd4789fcb92678"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8c238fbeb5c0aa236d17b6f0798e7e37" id="r_a8c238fbeb5c0aa236d17b6f0798e7e37"><td class="memItemLeft" align="right" valign="top"><a id="a8c238fbeb5c0aa236d17b6f0798e7e37" name="a8c238fbeb5c0aa236d17b6f0798e7e37"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>m_size</b></td></tr>
|
|
<tr class="separator:a8c238fbeb5c0aa236d17b6f0798e7e37"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac7528cb47db972ce7ec6978084c68c40" id="r_ac7528cb47db972ce7ec6978084c68c40"><td class="memItemLeft" align="right" valign="top"><a id="ac7528cb47db972ce7ec6978084c68c40" name="ac7528cb47db972ce7ec6978084c68c40"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>m_quit</b></td></tr>
|
|
<tr class="separator:ac7528cb47db972ce7ec6978084c68c40"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a08e6198db9de0df59e86e5d283dedc58" id="r_a08e6198db9de0df59e86e5d283dedc58"><td class="memItemLeft" align="right" valign="top"><a id="a08e6198db9de0df59e86e5d283dedc58" name="a08e6198db9de0df59e86e5d283dedc58"></a>
|
|
T </td><td class="memItemRight" valign="bottom"><b>m_data</b> [CAPACITY]</td></tr>
|
|
<tr class="separator:a08e6198db9de0df59e86e5d283dedc58"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><div class="compoundTemplParams">template<class T, size_t CAPACITY><br />
|
|
class stdex::ring< T, CAPACITY ></div><p>Ring buffer. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">T</td><td>Ring element type </td></tr>
|
|
<tr><td class="paramname">CAPACITY</td><td>Ring capacity (in number of elements) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a3e41365e5bcb914099baff6b02686bca" name="a3e41365e5bcb914099baff6b02686bca"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3e41365e5bcb914099baff6b02686bca">◆ </a></span>back()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T , size_t CAPACITY> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::tuple< T *, size_t > <a class="el" href="classstdex_1_1ring.html">stdex::ring</a>< T, CAPACITY >::back </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>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. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Pointer to data available for writing and maximum data size to write. Or, <code>{nullptr, 0}</code> if <a class="el" href="classstdex_1_1ring.html#a385d1648c6fb8e61154e518f954a0a0e" title="Cancells waiting sender and receiver.">quit()</a> has been called. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9b6571832cc636d98885af61651a0998" name="a9b6571832cc636d98885af61651a0998"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9b6571832cc636d98885af61651a0998">◆ </a></span>front()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T , size_t CAPACITY> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::tuple< T *, size_t > <a class="el" href="classstdex_1_1ring.html">stdex::ring</a>< T, CAPACITY >::front </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>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. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Pointer to data available for reading and maximum data size to read. Or, <code>{nullptr, 0}</code> if <a class="el" href="classstdex_1_1ring.html#a385d1648c6fb8e61154e518f954a0a0e" title="Cancells waiting sender and receiver.">quit()</a> has been called. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6360d8186fa2bda1ef4b4ddbcae93749" name="a6360d8186fa2bda1ef4b4ddbcae93749"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6360d8186fa2bda1ef4b4ddbcae93749">◆ </a></span>pop()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T , size_t CAPACITY> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classstdex_1_1ring.html">stdex::ring</a>< T, CAPACITY >::pop </td>
|
|
<td>(</td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>size</em></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>Notifies the sender the data was consumed. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Amount of data that was really consumed </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab8b671ab4a84c370bdf8d4d2df7c0d9d" name="ab8b671ab4a84c370bdf8d4d2df7c0d9d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab8b671ab4a84c370bdf8d4d2df7c0d9d">◆ </a></span>push()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class T , size_t CAPACITY> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void <a class="el" href="classstdex_1_1ring.html">stdex::ring</a>< T, CAPACITY >::push </td>
|
|
<td>(</td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>size</em></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>Notifies the receiver the data was populated. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Amount of data that was really populated </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>include/stdex/<a class="el" href="ring_8hpp_source.html">ring.hpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Wed Sep 13 2023 12:27:38 for stdex by <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>
|