Leahnaya/wut
1
0
Fork 0
mirror of https://github.com/devkitPro/wut.git synced 2026-04-26 10:01:22 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity
gh-pages
wut/namespacenn_1_1uds_1_1Cafe.html

1422 lines
76 KiB
HTML
Raw Permalink Blame History

<!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>wut: nn::uds::Cafe Namespace 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">wut<span id="projectnumber">&#160;v1.9.1</span>
</div>
<div id="projectbrief">Wii U Toolchain</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&amp;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&amp;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"><a class="el" href="namespacenn.html">nn</a></li><li class="navelem"><a class="el" href="namespacenn_1_1uds.html">uds</a></li><li class="navelem"><a class="el" href="namespacenn_1_1uds_1_1Cafe.html">Cafe</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle"><div class="title">nn::uds::Cafe Namespace Reference</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:structnn_1_1uds_1_1Cafe_1_1ConnectionStatus" id="r_structnn_1_1uds_1_1Cafe_1_1ConnectionStatus"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenn_1_1uds_1_1Cafe.html#structnn_1_1uds_1_1Cafe_1_1ConnectionStatus">ConnectionStatus</a></td></tr>
<tr class="memdesc:structnn_1_1uds_1_1Cafe_1_1ConnectionStatus"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stores the connection status of the network. <a href="namespacenn_1_1uds_1_1Cafe.html#structnn_1_1uds_1_1Cafe_1_1ConnectionStatus">More...</a><br /></td></tr>
<tr class="separator:structnn_1_1uds_1_1Cafe_1_1ConnectionStatus"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:structnn_1_1uds_1_1Cafe_1_1NodeInformation" id="r_structnn_1_1uds_1_1Cafe_1_1NodeInformation"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenn_1_1uds_1_1Cafe.html#structnn_1_1uds_1_1Cafe_1_1NodeInformation">NodeInformation</a></td></tr>
<tr class="memdesc:structnn_1_1uds_1_1Cafe_1_1NodeInformation"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stores information about a node. <a href="namespacenn_1_1uds_1_1Cafe.html#structnn_1_1uds_1_1Cafe_1_1NodeInformation">More...</a><br /></td></tr>
<tr class="separator:structnn_1_1uds_1_1Cafe_1_1NodeInformation"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:structnn_1_1uds_1_1Cafe_1_1ScrambledLocalFriendCode" id="r_structnn_1_1uds_1_1Cafe_1_1ScrambledLocalFriendCode"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenn_1_1uds_1_1Cafe.html#structnn_1_1uds_1_1Cafe_1_1ScrambledLocalFriendCode">ScrambledLocalFriendCode</a></td></tr>
<tr class="memdesc:structnn_1_1uds_1_1Cafe_1_1ScrambledLocalFriendCode"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stores data about the scrambled local friend code of a node. <a href="namespacenn_1_1uds_1_1Cafe.html#structnn_1_1uds_1_1Cafe_1_1ScrambledLocalFriendCode">More...</a><br /></td></tr>
<tr class="separator:structnn_1_1uds_1_1Cafe_1_1ScrambledLocalFriendCode"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:aa61a754f0eb33098bb7e63916af6ccfb" id="r_aa61a754f0eb33098bb7e63916af6ccfb"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenn_1_1uds_1_1Cafe.html#aa61a754f0eb33098bb7e63916af6ccfb">EndpointDescriptor</a> = uint32_t</td></tr>
<tr class="memdesc:aa61a754f0eb33098bb7e63916af6ccfb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Describes a network endpoint. <br /></td></tr>
<tr class="separator:aa61a754f0eb33098bb7e63916af6ccfb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a4729f9a5a3ba330ac1e9b02299e1785c" id="r_a4729f9a5a3ba330ac1e9b02299e1785c"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenn_1_1uds_1_1Cafe.html#a4729f9a5a3ba330ac1e9b02299e1785c">PollStateChangeFlags</a> : uint8_t { <a class="el" href="namespacenn_1_1uds_1_1Cafe.html#a4729f9a5a3ba330ac1e9b02299e1785cafc31868755d2bb46ae2d5c8c640ad8d9">UDS_POLL_NONBLOCK</a> = 1 &lt;&lt; 0
}</td></tr>
<tr class="separator:a4729f9a5a3ba330ac1e9b02299e1785c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c2c4b538ee942af2793872be1386701" id="r_a9c2c4b538ee942af2793872be1386701"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenn_1_1uds_1_1Cafe.html#a9c2c4b538ee942af2793872be1386701">ReceiveFlags</a> : uint8_t { <a class="el" href="namespacenn_1_1uds_1_1Cafe.html#a9c2c4b538ee942af2793872be1386701a2e31c5c4187573ed025b05433afc49d9">UDS_RECEIVE_NONBLOCK</a> = 1 &lt;&lt; 0
}</td></tr>
<tr class="separator:a9c2c4b538ee942af2793872be1386701"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a0b16354147ef71f25cf0f9ace2e979e7" id="r_a0b16354147ef71f25cf0f9ace2e979e7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnn_1_1Result.html">nn::Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenn_1_1uds_1_1Cafe.html#a0b16354147ef71f25cf0f9ace2e979e7">AllowToConnect</a> () asm(&quot;AllowToConnect__Q3_2nn3uds4CafeFv&quot;)</td></tr>
<tr class="memdesc:a0b16354147ef71f25cf0f9ace2e979e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allows clients to connect to the network. <br /></td></tr>
<tr class="separator:a0b16354147ef71f25cf0f9ace2e979e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd03c351829da3e30e45bdae406d3b27" id="r_acd03c351829da3e30e45bdae406d3b27"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnn_1_1Result.html">nn::Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenn_1_1uds_1_1Cafe.html#acd03c351829da3e30e45bdae406d3b27">AllowToSpectate</a> () asm(&quot;AllowToSpectate__Q3_2nn3uds4CafeFv&quot;)</td></tr>
<tr class="memdesc:acd03c351829da3e30e45bdae406d3b27"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allows clients to spectate the network. <br /></td></tr>
<tr class="separator:acd03c351829da3e30e45bdae406d3b27"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad77f67a42ea9ef6f129c3b044874b7ea" id="r_ad77f67a42ea9ef6f129c3b044874b7ea"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnn_1_1Result.html">nn::Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenn_1_1uds_1_1Cafe.html#ad77f67a42ea9ef6f129c3b044874b7ea">Attach</a> (<a class="el" href="namespacenn_1_1uds_1_1Cafe.html#aa61a754f0eb33098bb7e63916af6ccfb">EndpointDescriptor</a> *fd, uint16_t networkNodeId, uint8_t dataChannel, uint32_t recvBufferSize) asm(&quot;Attach__Q3_2nn3uds4CafeFPQ4_2nn3uds4Cafe18EndpointDescriptorUsUcUi&quot;)</td></tr>
<tr class="memdesc:ad77f67a42ea9ef6f129c3b044874b7ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Attaches an endpoint to a specified node. <br /></td></tr>
<tr class="separator:ad77f67a42ea9ef6f129c3b044874b7ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1ba27f58201b71d6ca8332003612122" id="r_ac1ba27f58201b71d6ca8332003612122"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenn_1_1uds_1_1Cafe.html#ac1ba27f58201b71d6ca8332003612122">CreateLocalCommunicationId</a> (uint32_t uniqueId, bool unknown) asm(&quot;CreateLocalCommunicationId__Q3_2nn3uds4CafeFUib&quot;)</td></tr>
<tr class="memdesc:ac1ba27f58201b71d6ca8332003612122"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a local communication ID based on the given paramaters. <br /></td></tr>
<tr class="separator:ac1ba27f58201b71d6ca8332003612122"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a453c3c5fb84263abf841b42a818df54e" id="r_a453c3c5fb84263abf841b42a818df54e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnn_1_1Result.html">nn::Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenn_1_1uds_1_1Cafe.html#a453c3c5fb84263abf841b42a818df54e">CreateEndpoint</a> (<a class="el" href="namespacenn_1_1uds_1_1Cafe.html#aa61a754f0eb33098bb7e63916af6ccfb">EndpointDescriptor</a> *fd) asm(&quot;CreateEndpoint__Q3_2nn3uds4CafeFPQ4_2nn3uds4Cafe18EndpointDescriptor&quot;)</td></tr>
<tr class="memdesc:a453c3c5fb84263abf841b42a818df54e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new endpoint. <br /></td></tr>
<tr class="separator:a453c3c5fb84263abf841b42a818df54e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a624510fd0b820bcfeac3680eb0da0e9a" id="r_a624510fd0b820bcfeac3680eb0da0e9a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnn_1_1Result.html">nn::Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenn_1_1uds_1_1Cafe.html#a624510fd0b820bcfeac3680eb0da0e9a">CreateNetwork</a> (uint8_t id8, uint8_t maxNodes, uint32_t localCommunicationId, const char *passphrase, uint32_t passphraseSize, uint8_t channel) asm(&quot;CreateNetwork__Q3_2nn3uds4CafeFUcT1UiPCcT3T1&quot;)</td></tr>
<tr class="memdesc:a624510fd0b820bcfeac3680eb0da0e9a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new network with the given parameters. <br /></td></tr>
<tr class="separator:a624510fd0b820bcfeac3680eb0da0e9a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8636b4b056457cef9bba1dd1e29ca43b" id="r_a8636b4b056457cef9bba1dd1e29ca43b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnn_1_1Result.html">nn::Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenn_1_1uds_1_1Cafe.html#a8636b4b056457cef9bba1dd1e29ca43b">CreateNetwork</a> (uint8_t id8, uint8_t maxNodes, uint32_t localCommunicationId, const char *passphrase, uint32_t passphraseSize, uint8_t channel, const void *appData, uint32_t appDataSize) asm(&quot;CreateNetwork__Q3_2nn3uds4CafeFUcT1UiPCcT3T1PCvT3&quot;)</td></tr>
<tr class="memdesc:a8636b4b056457cef9bba1dd1e29ca43b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new network with the given parameters. <br /></td></tr>
<tr class="separator:a8636b4b056457cef9bba1dd1e29ca43b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a499c819003abef2308a21dbc4025552f" id="r_a499c819003abef2308a21dbc4025552f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnn_1_1Result.html">nn::Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenn_1_1uds_1_1Cafe.html#a499c819003abef2308a21dbc4025552f">CreateNetwork</a> (uint8_t id8, uint8_t maxNodes, uint32_t localCommunicationId, const char *passphrase, uint32_t passphraseSize, bool unused, uint8_t channel, const void *appData, uint32_t appDataSize) asm(&quot;CreateNetwork__Q3_2nn3uds4CafeFUcT1UiPCcT3bT1PCvT3&quot;)</td></tr>
<tr class="memdesc:a499c819003abef2308a21dbc4025552f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new network with the given parameters. <br /></td></tr>
<tr class="separator:a499c819003abef2308a21dbc4025552f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac70b88aa906adae1213955a4db50a95c" id="r_ac70b88aa906adae1213955a4db50a95c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnn_1_1Result.html">nn::Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenn_1_1uds_1_1Cafe.html#ac70b88aa906adae1213955a4db50a95c">DestroyEndpoint</a> (<a class="el" href="namespacenn_1_1uds_1_1Cafe.html#aa61a754f0eb33098bb7e63916af6ccfb">EndpointDescriptor</a> *fd) asm(&quot;DestroyEndpoint__Q3_2nn3uds4CafeFPQ4_2nn3uds4Cafe18EndpointDescriptor&quot;)</td></tr>
<tr class="memdesc:ac70b88aa906adae1213955a4db50a95c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys the given endpoint. <br /></td></tr>
<tr class="separator:ac70b88aa906adae1213955a4db50a95c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea567201960d39549d655ef97138bf0a" id="r_aea567201960d39549d655ef97138bf0a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnn_1_1Result.html">nn::Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenn_1_1uds_1_1Cafe.html#aea567201960d39549d655ef97138bf0a">DestroyNetwork</a> () asm(&quot;DestroyNetwork__Q3_2nn3uds4CafeFv&quot;)</td></tr>
<tr class="memdesc:aea567201960d39549d655ef97138bf0a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destroys the previously created network. <br /></td></tr>
<tr class="separator:aea567201960d39549d655ef97138bf0a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54c4686f698d469a049a5240feb3dc0a" id="r_a54c4686f698d469a049a5240feb3dc0a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnn_1_1Result.html">nn::Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenn_1_1uds_1_1Cafe.html#a54c4686f698d469a049a5240feb3dc0a">DisallowToConnect</a> (bool unknown) asm(&quot;DisallowToConnect__Q3_2nn3uds4CafeFb&quot;)</td></tr>
<tr class="memdesc:a54c4686f698d469a049a5240feb3dc0a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevents clients from connecting to the network. <br /></td></tr>
<tr class="separator:a54c4686f698d469a049a5240feb3dc0a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aab8e7e96f8cbf9f4da26454e8f9ae527" id="r_aab8e7e96f8cbf9f4da26454e8f9ae527"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnn_1_1Result.html">nn::Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenn_1_1uds_1_1Cafe.html#aab8e7e96f8cbf9f4da26454e8f9ae527">EjectClient</a> (uint16_t networkNodeId) asm(&quot;EjectClient__Q3_2nn3uds4CafeFUs&quot;)</td></tr>
<tr class="memdesc:aab8e7e96f8cbf9f4da26454e8f9ae527"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ejects the specified client from the network. <br /></td></tr>
<tr class="separator:aab8e7e96f8cbf9f4da26454e8f9ae527"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad7340fc4bccc9904292da316840e85a4" id="r_ad7340fc4bccc9904292da316840e85a4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnn_1_1Result.html">nn::Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenn_1_1uds_1_1Cafe.html#ad7340fc4bccc9904292da316840e85a4">EjectSpectator</a> () asm(&quot;EjectSpectator__Q3_2nn3uds4CafeFv&quot;)</td></tr>
<tr class="memdesc:ad7340fc4bccc9904292da316840e85a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ejects all spectators from the network. <br /></td></tr>
<tr class="separator:ad7340fc4bccc9904292da316840e85a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e7dffefae9dacbd7b9c744bd5c8654d" id="r_a3e7dffefae9dacbd7b9c744bd5c8654d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenn_1_1uds_1_1Cafe.html#a3e7dffefae9dacbd7b9c744bd5c8654d">Finalize</a> () asm(&quot;Finalize__Q3_2nn3uds4CafeFv&quot;)</td></tr>
<tr class="memdesc:a3e7dffefae9dacbd7b9c744bd5c8654d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finalizes UDS. <br /></td></tr>
<tr class="separator:a3e7dffefae9dacbd7b9c744bd5c8654d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0cbf5f66cdbbe3bc07c9917fd1899a8a" id="r_a0cbf5f66cdbbe3bc07c9917fd1899a8a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnn_1_1Result.html">nn::Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenn_1_1uds_1_1Cafe.html#a0cbf5f66cdbbe3bc07c9917fd1899a8a">GetApplicationDataFromBeacon</a> (void *appData, uint32_t *readSize, uint32_t size) asm(&quot;GetApplicationDataFromBeacon__Q3_2nn3uds4CafeFPvPUiUi&quot;)</td></tr>
<tr class="memdesc:a0cbf5f66cdbbe3bc07c9917fd1899a8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the application data from the network. <br /></td></tr>
<tr class="separator:a0cbf5f66cdbbe3bc07c9917fd1899a8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae5dc5d82ec2c7c9a142be9ce147b2e67" id="r_ae5dc5d82ec2c7c9a142be9ce147b2e67"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnn_1_1Result.html">nn::Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenn_1_1uds_1_1Cafe.html#ae5dc5d82ec2c7c9a142be9ce147b2e67">GetChannel</a> (uint8_t *channel) asm(&quot;GetChannel__Q3_2nn3uds4CafeFPUc&quot;)</td></tr>
<tr class="memdesc:ae5dc5d82ec2c7c9a142be9ce147b2e67"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the network channel. <br /></td></tr>
<tr class="separator:ae5dc5d82ec2c7c9a142be9ce147b2e67"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a890357ae74eedc24f39ddbc9c4f8b392" id="r_a890357ae74eedc24f39ddbc9c4f8b392"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnn_1_1Result.html">nn::Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenn_1_1uds_1_1Cafe.html#a890357ae74eedc24f39ddbc9c4f8b392">GetConnectionStatus</a> (<a class="el" href="namespacenn_1_1uds_1_1Cafe.html#structnn_1_1uds_1_1Cafe_1_1ConnectionStatus">ConnectionStatus</a> *status) asm(&quot;GetConnectionStatus__Q3_2nn3uds4CafeFPQ4_2nn3uds4Cafe16ConnectionStatus&quot;)</td></tr>
<tr class="memdesc:a890357ae74eedc24f39ddbc9c4f8b392"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the connection status of the network. <br /></td></tr>
<tr class="separator:a890357ae74eedc24f39ddbc9c4f8b392"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa9f9368f4b7aeb2c7050c97ba5c0961a" id="r_aa9f9368f4b7aeb2c7050c97ba5c0961a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnn_1_1Result.html">nn::Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenn_1_1uds_1_1Cafe.html#aa9f9368f4b7aeb2c7050c97ba5c0961a">GetNodeInformation</a> (<a class="el" href="namespacenn_1_1uds_1_1Cafe.html#structnn_1_1uds_1_1Cafe_1_1NodeInformation">NodeInformation</a> *info, uint16_t networkNodeId) asm(&quot;GetNodeInformation__Q3_2nn3uds4CafeFPQ4_2nn3uds4Cafe15NodeInformationUs&quot;)</td></tr>
<tr class="memdesc:aa9f9368f4b7aeb2c7050c97ba5c0961a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets information about a specified node. <br /></td></tr>
<tr class="separator:aa9f9368f4b7aeb2c7050c97ba5c0961a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6ad42060c468a8aac00582a49e8ba98e" id="r_a6ad42060c468a8aac00582a49e8ba98e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnn_1_1Result.html">nn::Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenn_1_1uds_1_1Cafe.html#a6ad42060c468a8aac00582a49e8ba98e">Initialize</a> (void *workMemory, uint32_t workMemorySize) asm(&quot;Initialize__Q3_2nn3uds4CafeFPvUi&quot;)</td></tr>
<tr class="memdesc:a6ad42060c468a8aac00582a49e8ba98e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes UDS. <br /></td></tr>
<tr class="separator:a6ad42060c468a8aac00582a49e8ba98e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab957a27c8deb6e392c1c43d4fddeaa78" id="r_ab957a27c8deb6e392c1c43d4fddeaa78"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnn_1_1Result.html">nn::Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenn_1_1uds_1_1Cafe.html#ab957a27c8deb6e392c1c43d4fddeaa78">Initialize</a> (void *workMemory, uint32_t workMemorySize, <a class="el" href="namespacenn_1_1cfg_1_1CTR.html#structnn_1_1cfg_1_1CTR_1_1UserName">nn::cfg::CTR::UserName</a> *username) asm(&quot;Initialize__Q3_2nn3uds4CafeFPvUiPQ4_2nn3cfg3CTR8UserName&quot;)</td></tr>
<tr class="memdesc:ab957a27c8deb6e392c1c43d4fddeaa78"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes UDS with the given username. <br /></td></tr>
<tr class="separator:ab957a27c8deb6e392c1c43d4fddeaa78"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e83e3034afa87b02a1a8764836e197e" id="r_a0e83e3034afa87b02a1a8764836e197e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnn_1_1Result.html">nn::Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenn_1_1uds_1_1Cafe.html#a0e83e3034afa87b02a1a8764836e197e">PollStateChange</a> (uint8_t flags) asm(&quot;PollStateChange__Q3_2nn3uds4CafeFUc&quot;)</td></tr>
<tr class="memdesc:a0e83e3034afa87b02a1a8764836e197e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if new data can be retrieved through <code>GetConnectionStatus</code>, and waits until new data is available if specified. <br /></td></tr>
<tr class="separator:a0e83e3034afa87b02a1a8764836e197e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6ba7eec29b5b67ab6ba09906fb1ab0b0" id="r_a6ba7eec29b5b67ab6ba09906fb1ab0b0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnn_1_1Result.html">nn::Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenn_1_1uds_1_1Cafe.html#a6ba7eec29b5b67ab6ba09906fb1ab0b0">ReceiveFrom</a> (const <a class="el" href="namespacenn_1_1uds_1_1Cafe.html#aa61a754f0eb33098bb7e63916af6ccfb">EndpointDescriptor</a> &amp;fd, void *buf, uint32_t *receivedSize, uint16_t *networkNodeId, uint32_t size, uint8_t flags) asm(&quot;ReceiveFrom__Q3_2nn3uds4CafeFRCQ4_2nn3uds4Cafe18EndpointDescriptorPvPUiPUsUiUc&quot;)</td></tr>
<tr class="memdesc:a6ba7eec29b5b67ab6ba09906fb1ab0b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receives data from the specified endpoint. <br /></td></tr>
<tr class="separator:a6ba7eec29b5b67ab6ba09906fb1ab0b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a97ac253a8bed2e0ed624842245ab3bf9" id="r_a97ac253a8bed2e0ed624842245ab3bf9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnn_1_1Result.html">nn::Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenn_1_1uds_1_1Cafe.html#a97ac253a8bed2e0ed624842245ab3bf9">Receive</a> (const <a class="el" href="namespacenn_1_1uds_1_1Cafe.html#aa61a754f0eb33098bb7e63916af6ccfb">EndpointDescriptor</a> &amp;fd, void *buf, uint32_t *receivedSize, uint32_t size, uint8_t flags) asm(&quot;Receive__Q3_2nn3uds4CafeFRCQ4_2nn3uds4Cafe18EndpointDescriptorPvPUiUiUc&quot;)</td></tr>
<tr class="memdesc:a97ac253a8bed2e0ed624842245ab3bf9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receives data from the specified endpoint. <br /></td></tr>
<tr class="separator:a97ac253a8bed2e0ed624842245ab3bf9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f6f3bcb6ef21f467c5c5e268f59c48b" id="r_a5f6f3bcb6ef21f467c5c5e268f59c48b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnn_1_1Result.html">nn::Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenn_1_1uds_1_1Cafe.html#a5f6f3bcb6ef21f467c5c5e268f59c48b">SendTo</a> (const <a class="el" href="namespacenn_1_1uds_1_1Cafe.html#aa61a754f0eb33098bb7e63916af6ccfb">EndpointDescriptor</a> &amp;fd, const void *buf, uint32_t size, uint16_t destNodeId, uint8_t dataChannel, uint8_t flags) asm(&quot;SendTo__Q3_2nn3uds4CafeFRCQ4_2nn3uds4Cafe18EndpointDescriptorPCvUiUsUcT5&quot;)</td></tr>
<tr class="memdesc:a5f6f3bcb6ef21f467c5c5e268f59c48b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sends data to the specified node ID through the given data channel. <br /></td></tr>
<tr class="separator:a5f6f3bcb6ef21f467c5c5e268f59c48b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a67c36c43ca0a4d5c65d5df2e2d454e8a" id="r_a67c36c43ca0a4d5c65d5df2e2d454e8a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classnn_1_1Result.html">nn::Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenn_1_1uds_1_1Cafe.html#a67c36c43ca0a4d5c65d5df2e2d454e8a">SetApplicationDataToBeacon</a> (const void *appData, uint32_t size) asm(&quot;SetApplicationDataToBeacon__Q3_2nn3uds4CafeFPCvUi&quot;)</td></tr>
<tr class="memdesc:a67c36c43ca0a4d5c65d5df2e2d454e8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the application data to the network. <br /></td></tr>
<tr class="separator:a67c36c43ca0a4d5c65d5df2e2d454e8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a72f820dd1ddd57ac1f8d0623b53b89c0" id="r_a72f820dd1ddd57ac1f8d0623b53b89c0"><td class="memItemLeft" align="right" valign="top">static constexpr uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenn_1_1uds_1_1Cafe.html#a72f820dd1ddd57ac1f8d0623b53b89c0">kWorkMemorySize</a> = 0x14000</td></tr>
<tr class="memdesc:a72f820dd1ddd57ac1f8d0623b53b89c0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Recommended size to use for work memory buffer. <br /></td></tr>
<tr class="separator:a72f820dd1ddd57ac1f8d0623b53b89c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
<a name="structnn_1_1uds_1_1Cafe_1_1ConnectionStatus" id="structnn_1_1uds_1_1Cafe_1_1ConnectionStatus"></a>
<h2 class="memtitle"><span class="permalink"><a href="#structnn_1_1uds_1_1Cafe_1_1ConnectionStatus">&#9670;&#160;</a></span>nn::uds::Cafe::ConnectionStatus</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct nn::uds::Cafe::ConnectionStatus</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>Stores the connection status of the network. </p>
<p class="definition">Definition at line <a class="el" href="uds_2Cafe_8h_source.html#l00031">31</a> of file <a class="el" href="uds_2Cafe_8h_source.html">Cafe.h</a>.</p>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a id="ade20423e91627f07e610924cb0081623" name="ade20423e91627f07e610924cb0081623"></a>uint32_t</td>
<td class="fieldname">
status</td>
<td class="fielddoc">
The network status. </td></tr>
<tr><td class="fieldtype">
<a id="a5ac0b16c31813f87b98e97cc5bacd64a" name="a5ac0b16c31813f87b98e97cc5bacd64a"></a>uint32_t</td>
<td class="fieldname">
reason</td>
<td class="fielddoc">
The reason why the status has changed. </td></tr>
<tr><td class="fieldtype">
<a id="a10958e1f6d0e99fbd62ee817b800e30d" name="a10958e1f6d0e99fbd62ee817b800e30d"></a>uint16_t</td>
<td class="fieldname">
networkNodeId</td>
<td class="fielddoc">
The network node ID of this device. </td></tr>
<tr><td class="fieldtype">
<a id="a9cfd14de13d1be6f51102e8a9301705c" name="a9cfd14de13d1be6f51102e8a9301705c"></a>uint16_t</td>
<td class="fieldname">
changedNodes</td>
<td class="fielddoc">
Bitmask of nodes that have changed. </td></tr>
<tr><td class="fieldtype">
<a id="a9f978de3d90a524ae5120b6c9b91ec53" name="a9f978de3d90a524ae5120b6c9b91ec53"></a>uint16_t</td>
<td class="fieldname">
nodes[<a class="el" href="group__nn__uds.html#ga5e7f28ad9efe486ecb69ff96a1679454">UDS_MAX_NODES</a>]</td>
<td class="fielddoc">
Array of nodes connected to the network. </td></tr>
<tr><td class="fieldtype">
<a id="aea659edc7f330d2433c6fac59be2ee5a" name="aea659edc7f330d2433c6fac59be2ee5a"></a>uint8_t</td>
<td class="fieldname">
totalNodes</td>
<td class="fielddoc">
Total amount of nodes connected to the network. </td></tr>
<tr><td class="fieldtype">
<a id="aa5463a3a8cf4e44cde81d0837602c007" name="aa5463a3a8cf4e44cde81d0837602c007"></a>uint8_t</td>
<td class="fieldname">
maxNodes</td>
<td class="fielddoc">
Maximum number of nodes that can connect to the network, including the host. </td></tr>
<tr><td class="fieldtype">
<a id="ae91ebaae3e53c225c77a3b734014ddcd" name="ae91ebaae3e53c225c77a3b734014ddcd"></a>uint16_t</td>
<td class="fieldname">
nodeBitmask</td>
<td class="fielddoc">
Bitmask of nodes connected to the network. </td></tr>
</table>
</div>
</div>
<a name="structnn_1_1uds_1_1Cafe_1_1NodeInformation" id="structnn_1_1uds_1_1Cafe_1_1NodeInformation"></a>
<h2 class="memtitle"><span class="permalink"><a href="#structnn_1_1uds_1_1Cafe_1_1NodeInformation">&#9670;&#160;</a></span>nn::uds::Cafe::NodeInformation</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct nn::uds::Cafe::NodeInformation</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>Stores information about a node. </p>
<p class="definition">Definition at line <a class="el" href="NodeInformation_8h_source.html#l00019">19</a> of file <a class="el" href="NodeInformation_8h_source.html">NodeInformation.h</a>.</p>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a id="a889e2e0dd061bd3e4f383d1ae5064452" name="a889e2e0dd061bd3e4f383d1ae5064452"></a><a class="el" href="namespacenn_1_1uds_1_1Cafe.html#structnn_1_1uds_1_1Cafe_1_1ScrambledLocalFriendCode">ScrambledLocalFriendCode</a></td>
<td class="fieldname">
scrambledLocalFriendCode</td>
<td class="fielddoc">
The scrambled local friend code of the node. </td></tr>
<tr><td class="fieldtype">
<a id="afa638214ac1c4b6ac8be309a17ed1d57" name="afa638214ac1c4b6ac8be309a17ed1d57"></a>UserName</td>
<td class="fieldname">
username</td>
<td class="fielddoc">
The node username. </td></tr>
<tr><td class="fieldtype">
<a id="a10958e1f6d0e99fbd62ee817b800e30d" name="a10958e1f6d0e99fbd62ee817b800e30d"></a>uint16_t</td>
<td class="fieldname">
networkNodeId</td>
<td class="fielddoc">
The network node ID. </td></tr>
</table>
</div>
</div>
<a name="structnn_1_1uds_1_1Cafe_1_1ScrambledLocalFriendCode" id="structnn_1_1uds_1_1Cafe_1_1ScrambledLocalFriendCode"></a>
<h2 class="memtitle"><span class="permalink"><a href="#structnn_1_1uds_1_1Cafe_1_1ScrambledLocalFriendCode">&#9670;&#160;</a></span>nn::uds::Cafe::ScrambledLocalFriendCode</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct nn::uds::Cafe::ScrambledLocalFriendCode</td>
</tr>
</table>
</div><div class="memdoc">
<div class="textblock"><p>Stores data about the scrambled local friend code of a node. </p>
<p class="definition">Definition at line <a class="el" href="ScrambledLocalFriendCode_8h_source.html#l00017">17</a> of file <a class="el" href="ScrambledLocalFriendCode_8h_source.html">ScrambledLocalFriendCode.h</a>.</p>
</div><table class="fieldtable">
<tr><th colspan="3">Data Fields</th></tr>
<tr><td class="fieldtype">
<a id="a48da0aec488890d08cb4fb603c22e666" name="a48da0aec488890d08cb4fb603c22e666"></a>uint64_t</td>
<td class="fieldname">
localFriendCode</td>
<td class="fielddoc">
The scrambled local friend code. On the Wii U this is always descrambled. </td></tr>
<tr><td class="fieldtype">
<a id="a10958e1f6d0e99fbd62ee817b800e30d" name="a10958e1f6d0e99fbd62ee817b800e30d"></a>uint16_t</td>
<td class="fieldname">
networkNodeId</td>
<td class="fielddoc">
The node ID that the local friend code belongs to. </td></tr>
<tr><td class="fieldtype">
<a id="a48e8211a9e4fa0d6de2ae315aa2a16d8" name="a48e8211a9e4fa0d6de2ae315aa2a16d8"></a>uint16_t</td>
<td class="fieldname">
xorKey</td>
<td class="fielddoc">
The XOR key used for descrambling the local friend code. </td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="aa61a754f0eb33098bb7e63916af6ccfb" name="aa61a754f0eb33098bb7e63916af6ccfb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa61a754f0eb33098bb7e63916af6ccfb">&#9670;&#160;</a></span>EndpointDescriptor</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="namespacenn_1_1uds_1_1Cafe.html#aa61a754f0eb33098bb7e63916af6ccfb">EndpointDescriptor</a> = uint32_t</td>
</tr>
</table>
</div><div class="memdoc">
<p>Describes a network endpoint. </p>
<p class="definition">Definition at line <a class="el" href="uds_2Cafe_8h_source.html#l00064">64</a> of file <a class="el" href="uds_2Cafe_8h_source.html">Cafe.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a4729f9a5a3ba330ac1e9b02299e1785c" name="a4729f9a5a3ba330ac1e9b02299e1785c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4729f9a5a3ba330ac1e9b02299e1785c">&#9670;&#160;</a></span>PollStateChangeFlags</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="namespacenn_1_1uds_1_1Cafe.html#a4729f9a5a3ba330ac1e9b02299e1785c">PollStateChangeFlags</a> : uint8_t</td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a4729f9a5a3ba330ac1e9b02299e1785cafc31868755d2bb46ae2d5c8c640ad8d9" name="a4729f9a5a3ba330ac1e9b02299e1785cafc31868755d2bb46ae2d5c8c640ad8d9"></a>UDS_POLL_NONBLOCK&#160;</td><td class="fielddoc"><p>Prevents <code>PollStateChange</code> from blocking if no new data is available. </p>
</td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="uds_2Cafe_8h_source.html#l00066">66</a> of file <a class="el" href="uds_2Cafe_8h_source.html">Cafe.h</a>.</p>
</div>
</div>
<a id="a9c2c4b538ee942af2793872be1386701" name="a9c2c4b538ee942af2793872be1386701"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9c2c4b538ee942af2793872be1386701">&#9670;&#160;</a></span>ReceiveFlags</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="namespacenn_1_1uds_1_1Cafe.html#a9c2c4b538ee942af2793872be1386701">ReceiveFlags</a> : uint8_t</td>
</tr>
</table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a9c2c4b538ee942af2793872be1386701a2e31c5c4187573ed025b05433afc49d9" name="a9c2c4b538ee942af2793872be1386701a2e31c5c4187573ed025b05433afc49d9"></a>UDS_RECEIVE_NONBLOCK&#160;</td><td class="fielddoc"><p>Prevents <code>Receive</code> from blocking if no new data is available. </p>
</td></tr>
</table>
<p class="definition">Definition at line <a class="el" href="uds_2Cafe_8h_source.html#l00073">73</a> of file <a class="el" href="uds_2Cafe_8h_source.html">Cafe.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a0b16354147ef71f25cf0f9ace2e979e7" name="a0b16354147ef71f25cf0f9ace2e979e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0b16354147ef71f25cf0f9ace2e979e7">&#9670;&#160;</a></span>AllowToConnect()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classnn_1_1Result.html">nn::Result</a> AllowToConnect </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Allows clients to connect to the network. </p>
</div>
</div>
<a id="acd03c351829da3e30e45bdae406d3b27" name="acd03c351829da3e30e45bdae406d3b27"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd03c351829da3e30e45bdae406d3b27">&#9670;&#160;</a></span>AllowToSpectate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classnn_1_1Result.html">nn::Result</a> AllowToSpectate </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Allows clients to spectate the network. </p>
</div>
</div>
<a id="ad77f67a42ea9ef6f129c3b044874b7ea" name="ad77f67a42ea9ef6f129c3b044874b7ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad77f67a42ea9ef6f129c3b044874b7ea">&#9670;&#160;</a></span>Attach()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classnn_1_1Result.html">nn::Result</a> Attach </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacenn_1_1uds_1_1Cafe.html#aa61a754f0eb33098bb7e63916af6ccfb">EndpointDescriptor</a> *&#160;</td>
<td class="paramname"><em>fd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>networkNodeId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>dataChannel</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>recvBufferSize</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Attaches an endpoint to a specified node. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fd</td><td>The endpoint descriptor.</td></tr>
<tr><td class="paramname">networkNodeId</td><td>The network node ID. Use <a class="el" href="group__nn__uds.html#ga2fc76b182595c16268e3bb785c7784a3">UDS_BROADCAST_NODE_ID</a> to attach to all nodes.</td></tr>
<tr><td class="paramname">dataChannel</td><td>Data channel to attach to. Must not be 0.</td></tr>
<tr><td class="paramname">recvBufferSize</td><td>Size to be allocated for the internal buffer for receiving data. Must be greater or equal than 1536 bytes. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac1ba27f58201b71d6ca8332003612122" name="ac1ba27f58201b71d6ca8332003612122"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac1ba27f58201b71d6ca8332003612122">&#9670;&#160;</a></span>CreateLocalCommunicationId()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t CreateLocalCommunicationId </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>uniqueId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>unknown</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a local communication ID based on the given paramaters. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">uniqueId</td><td>A unique identifier of the current title. This is truncated to 20 bits on the created ID.</td></tr>
<tr><td class="paramname">unknown</td><td>Enables or disables a flag on the created ID.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The created local communication ID. </dd></dl>
</div>
</div>
<a id="a453c3c5fb84263abf841b42a818df54e" name="a453c3c5fb84263abf841b42a818df54e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a453c3c5fb84263abf841b42a818df54e">&#9670;&#160;</a></span>CreateEndpoint()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classnn_1_1Result.html">nn::Result</a> CreateEndpoint </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacenn_1_1uds_1_1Cafe.html#aa61a754f0eb33098bb7e63916af6ccfb">EndpointDescriptor</a> *&#160;</td>
<td class="paramname"><em>fd</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new endpoint. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fd</td><td>A pointer where the endpoint descriptor is written. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a624510fd0b820bcfeac3680eb0da0e9a" name="a624510fd0b820bcfeac3680eb0da0e9a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a624510fd0b820bcfeac3680eb0da0e9a">&#9670;&#160;</a></span>CreateNetwork() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classnn_1_1Result.html">nn::Result</a> CreateNetwork </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>id8</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>maxNodes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>localCommunicationId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>passphrase</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>passphraseSize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>channel</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new network with the given parameters. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id8</td><td>ID8 to be used on the network. Must not be 0xFF.</td></tr>
<tr><td class="paramname">maxNodes</td><td>The maximum amount of nodes that will be able to connect to the network, including the host. Must be a number between 2 and 9 inclusively.</td></tr>
<tr><td class="paramname">localCommunicationId</td><td>Local communication ID used for identifying the network.</td></tr>
<tr><td class="paramname">passphrase</td><td>Passphrase to be used for the network.</td></tr>
<tr><td class="paramname">passphraseSize</td><td>Size of the passphrase, including NULL termination. Must be greater than 8 characters and lower than 255 characters inclusively.</td></tr>
<tr><td class="paramname">channel</td><td>Channel to use for hosting the network. Use 0 to choose a channel automatically. Must be either 0, 1, 6 or 11. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8636b4b056457cef9bba1dd1e29ca43b" name="a8636b4b056457cef9bba1dd1e29ca43b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8636b4b056457cef9bba1dd1e29ca43b">&#9670;&#160;</a></span>CreateNetwork() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classnn_1_1Result.html">nn::Result</a> CreateNetwork </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>id8</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>maxNodes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>localCommunicationId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>passphrase</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>passphraseSize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>channel</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void *&#160;</td>
<td class="paramname"><em>appData</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>appDataSize</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new network with the given parameters. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id8</td><td>ID8 to be used on the network. Must not be 0xFF.</td></tr>
<tr><td class="paramname">maxNodes</td><td>The maximum amount of nodes that will be able to connect to the network, including the host. Must be a number between 2 and 9 inclusively.</td></tr>
<tr><td class="paramname">localCommunicationId</td><td>Local communication ID used for identifying the network.</td></tr>
<tr><td class="paramname">passphrase</td><td>Passphrase to be used for the network.</td></tr>
<tr><td class="paramname">passphraseSize</td><td>Size of the passphrase, including NULL termination. Must be greater than 8 characters and lower than 255 characters inclusively.</td></tr>
<tr><td class="paramname">channel</td><td>Channel to use for hosting the network. Use 0 to choose a channel automatically. Must be either 0, 1, 6 or 11.</td></tr>
<tr><td class="paramname">appData</td><td>Pointer to application data.</td></tr>
<tr><td class="paramname">appDataSize</td><td>Size of application data. Must be lower than 200 bytes inclusively. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a499c819003abef2308a21dbc4025552f" name="a499c819003abef2308a21dbc4025552f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a499c819003abef2308a21dbc4025552f">&#9670;&#160;</a></span>CreateNetwork() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classnn_1_1Result.html">nn::Result</a> CreateNetwork </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>id8</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>maxNodes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>localCommunicationId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>passphrase</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>passphraseSize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>unused</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>channel</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void *&#160;</td>
<td class="paramname"><em>appData</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>appDataSize</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new network with the given parameters. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id8</td><td>ID8 to be used on the network. Must not be 0xFF.</td></tr>
<tr><td class="paramname">maxNodes</td><td>The maximum amount of nodes that will be able to connect to the network, including the host. Must be a number between 2 and 9 inclusively.</td></tr>
<tr><td class="paramname">localCommunicationId</td><td>Local communication ID used for identifying the network.</td></tr>
<tr><td class="paramname">passphrase</td><td>Passphrase to be used for the network.</td></tr>
<tr><td class="paramname">passphraseSize</td><td>Size of the passphrase, including NULL termination. Must be greater than 8 characters and lower than 255 characters inclusively.</td></tr>
<tr><td class="paramname">unused</td><td>This parameter is unused.</td></tr>
<tr><td class="paramname">channel</td><td>Channel to use for hosting the network. Use 0 to choose a channel automatically. Must be either 0, 1, 6 or 11.</td></tr>
<tr><td class="paramname">appData</td><td>Pointer to application data.</td></tr>
<tr><td class="paramname">appDataSize</td><td>Size of application data. Must be lower than 200 bytes inclusively. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac70b88aa906adae1213955a4db50a95c" name="ac70b88aa906adae1213955a4db50a95c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac70b88aa906adae1213955a4db50a95c">&#9670;&#160;</a></span>DestroyEndpoint()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classnn_1_1Result.html">nn::Result</a> DestroyEndpoint </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacenn_1_1uds_1_1Cafe.html#aa61a754f0eb33098bb7e63916af6ccfb">EndpointDescriptor</a> *&#160;</td>
<td class="paramname"><em>fd</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroys the given endpoint. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fd</td><td>The endpoint descriptor. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aea567201960d39549d655ef97138bf0a" name="aea567201960d39549d655ef97138bf0a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea567201960d39549d655ef97138bf0a">&#9670;&#160;</a></span>DestroyNetwork()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classnn_1_1Result.html">nn::Result</a> DestroyNetwork </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destroys the previously created network. </p>
</div>
</div>
<a id="a54c4686f698d469a049a5240feb3dc0a" name="a54c4686f698d469a049a5240feb3dc0a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a54c4686f698d469a049a5240feb3dc0a">&#9670;&#160;</a></span>DisallowToConnect()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classnn_1_1Result.html">nn::Result</a> DisallowToConnect </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>unknown</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Prevents clients from connecting to the network. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">unknown</td><td>Triggers an unknown flag. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aab8e7e96f8cbf9f4da26454e8f9ae527" name="aab8e7e96f8cbf9f4da26454e8f9ae527"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aab8e7e96f8cbf9f4da26454e8f9ae527">&#9670;&#160;</a></span>EjectClient()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classnn_1_1Result.html">nn::Result</a> EjectClient </td>
<td>(</td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>networkNodeId</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Ejects the specified client from the network. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">networkNodeId</td><td>The network node ID of the client. Use <a class="el" href="group__nn__uds.html#ga2fc76b182595c16268e3bb785c7784a3">UDS_BROADCAST_NODE_ID</a> to eject all clients. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ad7340fc4bccc9904292da316840e85a4" name="ad7340fc4bccc9904292da316840e85a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad7340fc4bccc9904292da316840e85a4">&#9670;&#160;</a></span>EjectSpectator()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classnn_1_1Result.html">nn::Result</a> EjectSpectator </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Ejects all spectators from the network. </p>
</div>
</div>
<a id="a3e7dffefae9dacbd7b9c744bd5c8654d" name="a3e7dffefae9dacbd7b9c744bd5c8654d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3e7dffefae9dacbd7b9c744bd5c8654d">&#9670;&#160;</a></span>Finalize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Finalize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Finalizes UDS. </p>
</div>
</div>
<a id="a0cbf5f66cdbbe3bc07c9917fd1899a8a" name="a0cbf5f66cdbbe3bc07c9917fd1899a8a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0cbf5f66cdbbe3bc07c9917fd1899a8a">&#9670;&#160;</a></span>GetApplicationDataFromBeacon()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classnn_1_1Result.html">nn::Result</a> GetApplicationDataFromBeacon </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>appData</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t *&#160;</td>
<td class="paramname"><em>readSize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the application data from the network. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">appData</td><td>Buffer where the application data is written.</td></tr>
<tr><td class="paramname">readSize</td><td>Pointer where the size of the application data is written.</td></tr>
<tr><td class="paramname">size</td><td>Size of the buffer. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae5dc5d82ec2c7c9a142be9ce147b2e67" name="ae5dc5d82ec2c7c9a142be9ce147b2e67"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae5dc5d82ec2c7c9a142be9ce147b2e67">&#9670;&#160;</a></span>GetChannel()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classnn_1_1Result.html">nn::Result</a> GetChannel </td>
<td>(</td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>channel</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the network channel. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">channel</td><td>Pointer where the channel is written. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a890357ae74eedc24f39ddbc9c4f8b392" name="a890357ae74eedc24f39ddbc9c4f8b392"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a890357ae74eedc24f39ddbc9c4f8b392">&#9670;&#160;</a></span>GetConnectionStatus()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classnn_1_1Result.html">nn::Result</a> GetConnectionStatus </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacenn_1_1uds_1_1Cafe.html#structnn_1_1uds_1_1Cafe_1_1ConnectionStatus">ConnectionStatus</a> *&#160;</td>
<td class="paramname"><em>status</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the connection status of the network. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">status</td><td>Pointer where the connection status is written. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa9f9368f4b7aeb2c7050c97ba5c0961a" name="aa9f9368f4b7aeb2c7050c97ba5c0961a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa9f9368f4b7aeb2c7050c97ba5c0961a">&#9670;&#160;</a></span>GetNodeInformation()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classnn_1_1Result.html">nn::Result</a> GetNodeInformation </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacenn_1_1uds_1_1Cafe.html#structnn_1_1uds_1_1Cafe_1_1NodeInformation">NodeInformation</a> *&#160;</td>
<td class="paramname"><em>info</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>networkNodeId</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets information about a specified node. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">info</td><td>Output node information.</td></tr>
<tr><td class="paramname">networkNodeId</td><td>The network node ID. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a6ad42060c468a8aac00582a49e8ba98e" name="a6ad42060c468a8aac00582a49e8ba98e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6ad42060c468a8aac00582a49e8ba98e">&#9670;&#160;</a></span>Initialize() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classnn_1_1Result.html">nn::Result</a> Initialize </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>workMemory</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>workMemorySize</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes UDS. </p>
<p>The username will be set to the Mii name.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">workMemory</td><td>Pointer to work memory to be used by UDS.</td></tr>
<tr><td class="paramname">workMemorySize</td><td>Size of work memory. See <a class="el" href="namespacenn_1_1uds_1_1Cafe.html#a72f820dd1ddd57ac1f8d0623b53b89c0">kWorkMemorySize</a> for a recomended amount of memory. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ab957a27c8deb6e392c1c43d4fddeaa78" name="ab957a27c8deb6e392c1c43d4fddeaa78"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab957a27c8deb6e392c1c43d4fddeaa78">&#9670;&#160;</a></span>Initialize() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classnn_1_1Result.html">nn::Result</a> Initialize </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>workMemory</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>workMemorySize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacenn_1_1cfg_1_1CTR.html#structnn_1_1cfg_1_1CTR_1_1UserName">nn::cfg::CTR::UserName</a> *&#160;</td>
<td class="paramname"><em>username</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes UDS with the given username. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">workMemory</td><td>Pointer to work memory to be used by UDS.</td></tr>
<tr><td class="paramname">workMemorySize</td><td>Size of work memory. See <a class="el" href="namespacenn_1_1uds_1_1Cafe.html#a72f820dd1ddd57ac1f8d0623b53b89c0">kWorkMemorySize</a> for a recomended amount of memory.</td></tr>
<tr><td class="paramname">username</td><td>The username to be used. If <code>NULL</code>, the username will be set to the Mii name. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a0e83e3034afa87b02a1a8764836e197e" name="a0e83e3034afa87b02a1a8764836e197e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e83e3034afa87b02a1a8764836e197e">&#9670;&#160;</a></span>PollStateChange()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classnn_1_1Result.html">nn::Result</a> PollStateChange </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>flags</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks if new data can be retrieved through <code>GetConnectionStatus</code>, and waits until new data is available if specified. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">flags</td><td>Flags, see <a class="el" href="namespacenn_1_1uds_1_1Cafe.html#a4729f9a5a3ba330ac1e9b02299e1785c">PollStateChangeFlags</a> for all flags. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a6ba7eec29b5b67ab6ba09906fb1ab0b0" name="a6ba7eec29b5b67ab6ba09906fb1ab0b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6ba7eec29b5b67ab6ba09906fb1ab0b0">&#9670;&#160;</a></span>ReceiveFrom()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classnn_1_1Result.html">nn::Result</a> ReceiveFrom </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacenn_1_1uds_1_1Cafe.html#aa61a754f0eb33098bb7e63916af6ccfb">EndpointDescriptor</a> &amp;&#160;</td>
<td class="paramname"><em>fd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t *&#160;</td>
<td class="paramname"><em>receivedSize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t *&#160;</td>
<td class="paramname"><em>networkNodeId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>flags</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Receives data from the specified endpoint. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fd</td><td>The endpoint descriptor.</td></tr>
<tr><td class="paramname">buf</td><td>Output buffer where the data will be written.</td></tr>
<tr><td class="paramname">receivedSize</td><td>Pointer where the received size is written.</td></tr>
<tr><td class="paramname">networkNodeId</td><td>Pointer where the incoming node ID is written.</td></tr>
<tr><td class="paramname">size</td><td>Size of the buffer. Must be 4-byte aligned.</td></tr>
<tr><td class="paramname">flags</td><td>Flags, see <a class="el" href="namespacenn_1_1uds_1_1Cafe.html#a9c2c4b538ee942af2793872be1386701">ReceiveFlags</a> for all flags. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a97ac253a8bed2e0ed624842245ab3bf9" name="a97ac253a8bed2e0ed624842245ab3bf9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a97ac253a8bed2e0ed624842245ab3bf9">&#9670;&#160;</a></span>Receive()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classnn_1_1Result.html">nn::Result</a> Receive </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacenn_1_1uds_1_1Cafe.html#aa61a754f0eb33098bb7e63916af6ccfb">EndpointDescriptor</a> &amp;&#160;</td>
<td class="paramname"><em>fd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t *&#160;</td>
<td class="paramname"><em>receivedSize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>flags</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Receives data from the specified endpoint. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fd</td><td>The endpoint descriptor.</td></tr>
<tr><td class="paramname">buf</td><td>Output buffer where the data will be written.</td></tr>
<tr><td class="paramname">receivedSize</td><td>Pointer where the received size is written.</td></tr>
<tr><td class="paramname">size</td><td>Size of the buffer. Must be 4-byte aligned.</td></tr>
<tr><td class="paramname">flags</td><td>Flags, see <a class="el" href="namespacenn_1_1uds_1_1Cafe.html#a9c2c4b538ee942af2793872be1386701">ReceiveFlags</a> for all flags. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a5f6f3bcb6ef21f467c5c5e268f59c48b" name="a5f6f3bcb6ef21f467c5c5e268f59c48b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5f6f3bcb6ef21f467c5c5e268f59c48b">&#9670;&#160;</a></span>SendTo()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classnn_1_1Result.html">nn::Result</a> SendTo </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacenn_1_1uds_1_1Cafe.html#aa61a754f0eb33098bb7e63916af6ccfb">EndpointDescriptor</a> &amp;&#160;</td>
<td class="paramname"><em>fd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void *&#160;</td>
<td class="paramname"><em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>destNodeId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>dataChannel</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>flags</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sends data to the specified node ID through the given data channel. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fd</td><td>THe endpoint descriptor.</td></tr>
<tr><td class="paramname">buf</td><td>Buffer which holds the data to be sent.</td></tr>
<tr><td class="paramname">size</td><td>Size of the buffer. Must be lower or equal than 1478 bytes.</td></tr>
<tr><td class="paramname">destNodeId</td><td>The destination node ID.</td></tr>
<tr><td class="paramname">dataChannel</td><td>The destination data channel.</td></tr>
<tr><td class="paramname">flags</td><td>Unknown flags. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a67c36c43ca0a4d5c65d5df2e2d454e8a" name="a67c36c43ca0a4d5c65d5df2e2d454e8a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a67c36c43ca0a4d5c65d5df2e2d454e8a">&#9670;&#160;</a></span>SetApplicationDataToBeacon()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classnn_1_1Result.html">nn::Result</a> SetApplicationDataToBeacon </td>
<td>(</td>
<td class="paramtype">const void *&#160;</td>
<td class="paramname"><em>appData</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the application data to the network. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">appData</td><td>Application data.</td></tr>
<tr><td class="paramname">size</td><td>Size of application data. Must be lower or equal to 200 bytes. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a72f820dd1ddd57ac1f8d0623b53b89c0" name="a72f820dd1ddd57ac1f8d0623b53b89c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a72f820dd1ddd57ac1f8d0623b53b89c0">&#9670;&#160;</a></span>kWorkMemorySize</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr uint32_t kWorkMemorySize = 0x14000</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Recommended size to use for work memory buffer. </p>
<p class="definition">Definition at line <a class="el" href="uds_2Cafe_8h_source.html#l00061">61</a> of file <a class="el" href="uds_2Cafe_8h_source.html">Cafe.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated 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>
Reference in New Issue View Git Blame Copy Permalink