jbus/classjbus_1_1ThreadLocalEnd...

376 lines
19 KiB
HTML

<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>JBus: jbus::ThreadLocalEndpoint Class 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">JBus
</div>
<div id="projectbrief">JoyBus communication server</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;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>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classjbus_1_1ThreadLocalEndpoint.html','');});
</script>
<div id="doc-content">
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classjbus_1_1ThreadLocalEndpoint-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">jbus::ThreadLocalEndpoint Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="Endpoint_8hpp_source.html">Endpoint.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ad81335c0018a42ef9085d6941c4cddd5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacejbus.html#a7118bfa3cb9d51e588418220bca20117">EJoyReturn</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classjbus_1_1ThreadLocalEndpoint.html#ad81335c0018a42ef9085d6941c4cddd5">GBAGetStatusAsync</a> (<a class="el" href="namespacejbus.html#a19d112b8b9f912fca094b41ce26c4fef">u8</a> *status, <a class="el" href="namespacejbus.html#ae1577e03ea8c6e27361cb389c992280d">FGBACallback</a> &amp;&amp;callback)</td></tr>
<tr class="memdesc:ad81335c0018a42ef9085d6941c4cddd5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get JOYSTAT register from GBA asynchronously. <a href="#ad81335c0018a42ef9085d6941c4cddd5">More...</a><br /></td></tr>
<tr class="separator:ad81335c0018a42ef9085d6941c4cddd5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aab260d6d6686c2c3fc2ff31f57cf436d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacejbus.html#a7118bfa3cb9d51e588418220bca20117">EJoyReturn</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classjbus_1_1ThreadLocalEndpoint.html#aab260d6d6686c2c3fc2ff31f57cf436d">GBAResetAsync</a> (<a class="el" href="namespacejbus.html#a19d112b8b9f912fca094b41ce26c4fef">u8</a> *status, <a class="el" href="namespacejbus.html#ae1577e03ea8c6e27361cb389c992280d">FGBACallback</a> &amp;&amp;callback)</td></tr>
<tr class="memdesc:aab260d6d6686c2c3fc2ff31f57cf436d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send RESET command to GBA asynchronously. <a href="#aab260d6d6686c2c3fc2ff31f57cf436d">More...</a><br /></td></tr>
<tr class="separator:aab260d6d6686c2c3fc2ff31f57cf436d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1b9704d834d55b5118d4612dc335f4c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacejbus.html#a7118bfa3cb9d51e588418220bca20117">EJoyReturn</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classjbus_1_1ThreadLocalEndpoint.html#aa1b9704d834d55b5118d4612dc335f4c">GBAReadAsync</a> (<a class="el" href="namespacejbus.html#a19d112b8b9f912fca094b41ce26c4fef">u8</a> *dst, <a class="el" href="namespacejbus.html#a19d112b8b9f912fca094b41ce26c4fef">u8</a> *status, <a class="el" href="namespacejbus.html#ae1577e03ea8c6e27361cb389c992280d">FGBACallback</a> &amp;&amp;callback)</td></tr>
<tr class="memdesc:aa1b9704d834d55b5118d4612dc335f4c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send READ command to GBA asynchronously. <a href="#aa1b9704d834d55b5118d4612dc335f4c">More...</a><br /></td></tr>
<tr class="separator:aa1b9704d834d55b5118d4612dc335f4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1625ccaf1f817831d56cf32554bc40c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacejbus.html#a7118bfa3cb9d51e588418220bca20117">EJoyReturn</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classjbus_1_1ThreadLocalEndpoint.html#aa1625ccaf1f817831d56cf32554bc40c">GBAWriteAsync</a> (const <a class="el" href="namespacejbus.html#a19d112b8b9f912fca094b41ce26c4fef">u8</a> *src, <a class="el" href="namespacejbus.html#a19d112b8b9f912fca094b41ce26c4fef">u8</a> *status, <a class="el" href="namespacejbus.html#ae1577e03ea8c6e27361cb389c992280d">FGBACallback</a> &amp;&amp;callback)</td></tr>
<tr class="memdesc:aa1625ccaf1f817831d56cf32554bc40c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send WRITE command to GBA asynchronously. <a href="#aa1625ccaf1f817831d56cf32554bc40c">More...</a><br /></td></tr>
<tr class="separator:aa1625ccaf1f817831d56cf32554bc40c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1205d985c7e71b42a9cf2c1be06383b2"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classjbus_1_1ThreadLocalEndpoint.html#a1205d985c7e71b42a9cf2c1be06383b2">getChan</a> () const </td></tr>
<tr class="memdesc:a1205d985c7e71b42a9cf2c1be06383b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get virtual SI channel assigned to this endpoint. <a href="#a1205d985c7e71b42a9cf2c1be06383b2">More...</a><br /></td></tr>
<tr class="separator:a1205d985c7e71b42a9cf2c1be06383b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a500d74fc41e3ab6b4889a579193566ed"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classjbus_1_1ThreadLocalEndpoint.html#a500d74fc41e3ab6b4889a579193566ed">Endpoint</a></td></tr>
<tr class="separator:a500d74fc41e3ab6b4889a579193566ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Lockless wrapper interface for <a class="el" href="classjbus_1_1Endpoint.html">jbus::Endpoint</a>. This class is constructed internally and supplied as a callback argument. It should not be constructed directly. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ad81335c0018a42ef9085d6941c4cddd5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacejbus.html#a7118bfa3cb9d51e588418220bca20117">EJoyReturn</a> jbus::ThreadLocalEndpoint::GBAGetStatusAsync </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacejbus.html#a19d112b8b9f912fca094b41ce26c4fef">u8</a> *&#160;</td>
<td class="paramname"><em>status</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacejbus.html#ae1577e03ea8c6e27361cb389c992280d">FGBACallback</a> &amp;&amp;&#160;</td>
<td class="paramname"><em>callback</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get JOYSTAT register from GBA asynchronously. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">status</td><td>Destination pointer for EJStatFlags. </td></tr>
<tr><td class="paramname">callback</td><td>Functor to execute when operation completes. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>GBA_READY if submitted, or GBA_NOT_READY if another operation in progress. </dd></dl>
</div>
</div>
<a class="anchor" id="aa1b9704d834d55b5118d4612dc335f4c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacejbus.html#a7118bfa3cb9d51e588418220bca20117">EJoyReturn</a> jbus::ThreadLocalEndpoint::GBAReadAsync </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacejbus.html#a19d112b8b9f912fca094b41ce26c4fef">u8</a> *&#160;</td>
<td class="paramname"><em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacejbus.html#a19d112b8b9f912fca094b41ce26c4fef">u8</a> *&#160;</td>
<td class="paramname"><em>status</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacejbus.html#ae1577e03ea8c6e27361cb389c992280d">FGBACallback</a> &amp;&amp;&#160;</td>
<td class="paramname"><em>callback</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Send READ command to GBA asynchronously. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dst</td><td>Destination pointer for 4-byte packet of data. </td></tr>
<tr><td class="paramname">status</td><td>Destination pointer for EJStatFlags. </td></tr>
<tr><td class="paramname">callback</td><td>Functor to execute when operation completes. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>GBA_READY if submitted, or GBA_NOT_READY if another operation in progress. </dd></dl>
</div>
</div>
<a class="anchor" id="aab260d6d6686c2c3fc2ff31f57cf436d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacejbus.html#a7118bfa3cb9d51e588418220bca20117">EJoyReturn</a> jbus::ThreadLocalEndpoint::GBAResetAsync </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacejbus.html#a19d112b8b9f912fca094b41ce26c4fef">u8</a> *&#160;</td>
<td class="paramname"><em>status</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacejbus.html#ae1577e03ea8c6e27361cb389c992280d">FGBACallback</a> &amp;&amp;&#160;</td>
<td class="paramname"><em>callback</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Send RESET command to GBA asynchronously. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">status</td><td>Destination pointer for EJStatFlags. </td></tr>
<tr><td class="paramname">callback</td><td>Functor to execute when operation completes. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>GBA_READY if submitted, or GBA_NOT_READY if another operation in progress. </dd></dl>
</div>
</div>
<a class="anchor" id="aa1625ccaf1f817831d56cf32554bc40c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacejbus.html#a7118bfa3cb9d51e588418220bca20117">EJoyReturn</a> jbus::ThreadLocalEndpoint::GBAWriteAsync </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacejbus.html#a19d112b8b9f912fca094b41ce26c4fef">u8</a> *&#160;</td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacejbus.html#a19d112b8b9f912fca094b41ce26c4fef">u8</a> *&#160;</td>
<td class="paramname"><em>status</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacejbus.html#ae1577e03ea8c6e27361cb389c992280d">FGBACallback</a> &amp;&amp;&#160;</td>
<td class="paramname"><em>callback</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Send WRITE command to GBA asynchronously. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">src</td><td>Source pointer for 4-byte packet of data. It is not required to keep resident. </td></tr>
<tr><td class="paramname">status</td><td>Destination pointer for EJStatFlags. </td></tr>
<tr><td class="paramname">callback</td><td>Functor to execute when operation completes. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>GBA_READY if submitted, or GBA_NOT_READY if another operation in progress. </dd></dl>
</div>
</div>
<a class="anchor" id="a1205d985c7e71b42a9cf2c1be06383b2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int jbus::ThreadLocalEndpoint::getChan </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</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>Get virtual SI channel assigned to this endpoint. </p>
<dl class="section return"><dt>Returns</dt><dd>SI channel </dd></dl>
<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="classjbus_1_1ThreadLocalEndpoint_a1205d985c7e71b42a9cf2c1be06383b2_cgraph.png" border="0" usemap="#classjbus_1_1ThreadLocalEndpoint_a1205d985c7e71b42a9cf2c1be06383b2_cgraph" alt=""/></div>
<map name="classjbus_1_1ThreadLocalEndpoint_a1205d985c7e71b42a9cf2c1be06383b2_cgraph" id="classjbus_1_1ThreadLocalEndpoint_a1205d985c7e71b42a9cf2c1be06383b2_cgraph">
<area shape="rect" id="node2" href="classjbus_1_1Endpoint.html#a6aa5fa9049740d739b03e303719a764a" title="Get virtual SI channel assigned to this endpoint. " alt="" coords="233,12,397,37"/>
</map>
</div>
</p>
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a class="anchor" id="a500d74fc41e3ab6b4889a579193566ed"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classjbus_1_1Endpoint.html">Endpoint</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/jbus/<a class="el" href="Endpoint_8hpp_source.html">Endpoint.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacejbus.html">jbus</a></li><li class="navelem"><a class="el" href="classjbus_1_1ThreadLocalEndpoint.html">ThreadLocalEndpoint</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
</ul>
</div>
</body>
</html>