jbus/Common_8hpp.html

213 lines
15 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: include/jbus/Common.hpp File 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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><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="files.html"><span>File&#160;List</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('Common_8hpp.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="#namespaces">Namespaces</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Common.hpp File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;functional&gt;</code><br />
<code>#include &lt;stdint.h&gt;</code><br />
<code>#include &lt;stdlib.h&gt;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for Common.hpp:</div>
<div class="dyncontent">
<div class="center"><img src="Common_8hpp__incl.png" border="0" usemap="#include_2jbus_2Common_8hpp" alt=""/></div>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="Common_8hpp__dep__incl.png" border="0" usemap="#include_2jbus_2Common_8hppdep" alt=""/></div>
<map name="include_2jbus_2Common_8hppdep" id="include_2jbus_2Common_8hppdep">
<area shape="rect" id="node2" href="Endpoint_8hpp.html" title="include/jbus/Endpoint.hpp" alt="" coords="5,152,179,177"/>
<area shape="rect" id="node3" href="Socket_8hpp.html" title="include/jbus/Socket.hpp" alt="" coords="109,79,271,104"/>
<area shape="rect" id="node4" href="Listener_8hpp.html" title="include/jbus/Listener.hpp" alt="" coords="214,152,382,177"/>
</map>
</div>
</div>
<p><a href="Common_8hpp_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespacejbus"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacejbus.html">jbus</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a416b65eae1b2ff9ab63c4c71ff857ea4"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacejbus.html#a416b65eae1b2ff9ab63c4c71ff857ea4">jbus::s8</a> = int8_t</td></tr>
<tr class="separator:a416b65eae1b2ff9ab63c4c71ff857ea4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a19d112b8b9f912fca094b41ce26c4fef"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacejbus.html#a19d112b8b9f912fca094b41ce26c4fef">jbus::u8</a> = uint8_t</td></tr>
<tr class="separator:a19d112b8b9f912fca094b41ce26c4fef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa767fe4f71e145e2c0b12eccbeb83071"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacejbus.html#aa767fe4f71e145e2c0b12eccbeb83071">jbus::s16</a> = int16_t</td></tr>
<tr class="separator:aa767fe4f71e145e2c0b12eccbeb83071"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff2760609de15f92daafbdff7be79b33"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacejbus.html#aff2760609de15f92daafbdff7be79b33">jbus::u16</a> = uint16_t</td></tr>
<tr class="separator:aff2760609de15f92daafbdff7be79b33"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33e5022738a0799c066372ce74d04c37"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacejbus.html#a33e5022738a0799c066372ce74d04c37">jbus::s32</a> = int32_t</td></tr>
<tr class="separator:a33e5022738a0799c066372ce74d04c37"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae4a7d015f3b8913ec0b563caa0a53221"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacejbus.html#ae4a7d015f3b8913ec0b563caa0a53221">jbus::u32</a> = uint32_t</td></tr>
<tr class="separator:ae4a7d015f3b8913ec0b563caa0a53221"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a69133321c9f11f1fa0e49c072244d377"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacejbus.html#a69133321c9f11f1fa0e49c072244d377">jbus::s64</a> = int64_t</td></tr>
<tr class="separator:a69133321c9f11f1fa0e49c072244d377"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a36fb1f7488218c972a50b1f9dd547b81"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacejbus.html#a36fb1f7488218c972a50b1f9dd547b81">jbus::u64</a> = uint64_t</td></tr>
<tr class="separator:a36fb1f7488218c972a50b1f9dd547b81"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae1577e03ea8c6e27361cb389c992280d"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacejbus.html#ae1577e03ea8c6e27361cb389c992280d">jbus::FGBACallback</a> = std::function&lt; void(ThreadLocalEndpoint &amp;endpoint, EJoyReturn status)&gt;</td></tr>
<tr class="memdesc:ae1577e03ea8c6e27361cb389c992280d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Standard callback for asynchronous <a class="el" href="classjbus_1_1Endpoint.html">jbus::Endpoint</a> APIs. <a href="namespacejbus.html#ae1577e03ea8c6e27361cb389c992280d">More...</a><br /></td></tr>
<tr class="separator:ae1577e03ea8c6e27361cb389c992280d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a6a14af068c46e5eaac52e4c6ae081ab9"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacejbus.html#a6a14af068c46e5eaac52e4c6ae081ab9">jbus::EJStatFlags</a> { <br />
&#160;&#160;<a class="el" href="namespacejbus.html#a6a14af068c46e5eaac52e4c6ae081ab9a073fa6fd8ff5ae41567160cf897db7c1">jbus::GBA_JSTAT_MASK</a> = 0x3a,
<a class="el" href="namespacejbus.html#a6a14af068c46e5eaac52e4c6ae081ab9a92d3659e0d24e5242af71dbfa1a25b20">jbus::GBA_JSTAT_FLAGS_SHIFT</a> = 4,
<a class="el" href="namespacejbus.html#a6a14af068c46e5eaac52e4c6ae081ab9a78506d78e40b43d15ff101f4efa00269">jbus::GBA_JSTAT_FLAGS_MASK</a> = 0x30,
<a class="el" href="namespacejbus.html#a6a14af068c46e5eaac52e4c6ae081ab9a93e801d066708e0c98eec71c42803f94">jbus::GBA_JSTAT_PSF1</a> = 0x20,
<br />
&#160;&#160;<a class="el" href="namespacejbus.html#a6a14af068c46e5eaac52e4c6ae081ab9a9d1af0345a227524011d9845c0c3c4f8">jbus::GBA_JSTAT_PSF0</a> = 0x10,
<a class="el" href="namespacejbus.html#a6a14af068c46e5eaac52e4c6ae081ab9afe5cad6728edc3ab4aab7b0a9375350c">jbus::GBA_JSTAT_SEND</a> = 0x08,
<a class="el" href="namespacejbus.html#a6a14af068c46e5eaac52e4c6ae081ab9a814553611e2f05ce7daede703c9b0a20">jbus::GBA_JSTAT_RECV</a> = 0x02
<br />
}</td></tr>
<tr class="separator:a6a14af068c46e5eaac52e4c6ae081ab9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7118bfa3cb9d51e588418220bca20117"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacejbus.html#a7118bfa3cb9d51e588418220bca20117">jbus::EJoyReturn</a> { <br />
&#160;&#160;<a class="el" href="namespacejbus.html#a7118bfa3cb9d51e588418220bca20117a1e5f181b31229228f6741a4e3106c3fd">jbus::GBA_READY</a> = 0,
<a class="el" href="namespacejbus.html#a7118bfa3cb9d51e588418220bca20117aac3cd7dd0e4cb525e5045cb9e9c1f09a">jbus::GBA_NOT_READY</a> = 1,
<a class="el" href="namespacejbus.html#a7118bfa3cb9d51e588418220bca20117a97f6047ad685bdd832831954ab4454a0">jbus::GBA_BUSY</a> = 2,
<a class="el" href="namespacejbus.html#a7118bfa3cb9d51e588418220bca20117a5f890238a7828bd688477a32fdef34db">jbus::GBA_JOYBOOT_UNKNOWN_STATE</a> = 3,
<br />
&#160;&#160;<a class="el" href="namespacejbus.html#a7118bfa3cb9d51e588418220bca20117abdeee79304d78d822a4b5f5b71f5ddad">jbus::GBA_JOYBOOT_ERR_INVALID</a> = 4
<br />
}</td></tr>
<tr class="separator:a7118bfa3cb9d51e588418220bca20117"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a5944719111a14f5920ec765e5dcf71db"><td class="memItemLeft" align="right" valign="top">u64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacejbus.html#a5944719111a14f5920ec765e5dcf71db">jbus::GetGCTicks</a> ()</td></tr>
<tr class="memdesc:a5944719111a14f5920ec765e5dcf71db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get host system's timebase scaled into Dolphin ticks. <a href="namespacejbus.html#a5944719111a14f5920ec765e5dcf71db">More...</a><br /></td></tr>
<tr class="separator:a5944719111a14f5920ec765e5dcf71db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a918fbee6d761952c56c4914c900c2876"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacejbus.html#a918fbee6d761952c56c4914c900c2876">jbus::WaitGCTicks</a> (u64 ticks)</td></tr>
<tr class="memdesc:a918fbee6d761952c56c4914c900c2876"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait an approximate Dolphin tick duration (avoid using, it's rather inaccurate). <a href="namespacejbus.html#a918fbee6d761952c56c4914c900c2876">More...</a><br /></td></tr>
<tr class="separator:a918fbee6d761952c56c4914c900c2876"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae0b3017c3755ceb8c9dd580965b8bc04"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacejbus.html#ae0b3017c3755ceb8c9dd580965b8bc04">jbus::Initialize</a> ()</td></tr>
<tr class="memdesc:ae0b3017c3755ceb8c9dd580965b8bc04"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize platform specifics of JBus library. <a href="namespacejbus.html#ae0b3017c3755ceb8c9dd580965b8bc04">More...</a><br /></td></tr>
<tr class="separator:ae0b3017c3755ceb8c9dd580965b8bc04"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</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="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_4525d057f72f34aebe3436e89afccf45.html">jbus</a></li><li class="navelem"><a class="el" href="Common_8hpp.html">Common.hpp</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>