libctru/3dslink_8h_source.html
2024-11-03 20:36:34 +00:00

119 lines
11 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libctru: include/3ds/3dslink.h Source File</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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libctru
&#160;<span id="projectnumber">v2.4.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_d475325f6a9fe3bfc3a495c72a9e475e.html">3ds</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">3dslink.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="3dslink_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * @file 3dslink.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * @brief Netloader (3dslink) utilities</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160; </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160; </div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#include &lt;stdbool.h&gt;</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160; </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="keyword">struct </span><a class="code" href="structin__addr.html">in_addr</a>;</div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">/// Address of the host connected through 3dslink</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"></span><span class="keyword">extern</span> <span class="keyword">struct </span><a class="code" href="structin__addr.html">in_addr</a> <a class="code" href="3dslink_8h.html#a52d8c00d8441076d345a8a576dec91a8">__3dslink_host</a>;</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
<div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="3dslink_8h.html#aa4098b9693935197a8b839b7e789d3b2"> 15</a></span>&#160;<span class="preprocessor">#define LINK3DS_COMM_PORT 17491 </span><span class="comment">///&lt; 3dslink TCP server port</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> * @brief Connects to the 3dslink host, setting up an output stream.</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment"> * @param[in] redirStdout Whether to redirect stdout to nxlink output.</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment"> * @param[in] redirStderr Whether to redirect stderr to nxlink output.</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment"> * @return Socket fd on success, negative number on failure.</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment"> * @note The socket should be closed with close() during application cleanup.</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="3dslink_8h.html#a36e97864ece00580f644ba39d2e0b8fe"> 24</a></span>&#160;<span class="keywordtype">int</span> <a class="code" href="3dslink_8h.html#a36e97864ece00580f644ba39d2e0b8fe">link3dsConnectToHost</a>(<span class="keywordtype">bool</span> redirStdout, <span class="keywordtype">bool</span> redirStderr);</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="comment">/// Same as \ref link3dsConnectToHost but redirecting both stdout/stderr.</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="3dslink_8h.html#a53eba8d89b5d8a17f91a4a84e3904ed2"> 27</a></span>&#160;<span class="comment"></span><span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">int</span> <a class="code" href="3dslink_8h.html#a53eba8d89b5d8a17f91a4a84e3904ed2">link3dsStdio</a>(<span class="keywordtype">void</span>) {</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <span class="keywordflow">return</span> <a class="code" href="3dslink_8h.html#a36e97864ece00580f644ba39d2e0b8fe">link3dsConnectToHost</a>(<span class="keyword">true</span>, <span class="keyword">true</span>);</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;}</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="comment">/// Same as \ref link3dsConnectToHost but redirecting only stderr.</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="3dslink_8h.html#accd3d099fe5f87e7fa884a739c220ade"> 32</a></span>&#160;<span class="comment"></span><span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">int</span> <a class="code" href="3dslink_8h.html#accd3d099fe5f87e7fa884a739c220ade">link3dsStdioForDebug</a>(<span class="keywordtype">void</span>) {</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <span class="keywordflow">return</span> <a class="code" href="3dslink_8h.html#a36e97864ece00580f644ba39d2e0b8fe">link3dsConnectToHost</a>(<span class="keyword">false</span>, <span class="keyword">true</span>);</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;}</div>
<div class="ttc" id="a3dslink_8h_html_a36e97864ece00580f644ba39d2e0b8fe"><div class="ttname"><a href="3dslink_8h.html#a36e97864ece00580f644ba39d2e0b8fe">link3dsConnectToHost</a></div><div class="ttdeci">int link3dsConnectToHost(bool redirStdout, bool redirStderr)</div><div class="ttdoc">Connects to the 3dslink host, setting up an output stream.</div></div>
<div class="ttc" id="a3dslink_8h_html_a52d8c00d8441076d345a8a576dec91a8"><div class="ttname"><a href="3dslink_8h.html#a52d8c00d8441076d345a8a576dec91a8">__3dslink_host</a></div><div class="ttdeci">struct in_addr __3dslink_host</div><div class="ttdoc">Address of the host connected through 3dslink.</div></div>
<div class="ttc" id="a3dslink_8h_html_a53eba8d89b5d8a17f91a4a84e3904ed2"><div class="ttname"><a href="3dslink_8h.html#a53eba8d89b5d8a17f91a4a84e3904ed2">link3dsStdio</a></div><div class="ttdeci">static int link3dsStdio(void)</div><div class="ttdoc">Same as link3dsConnectToHost but redirecting both stdout/stderr.</div><div class="ttdef"><b>Definition:</b> 3dslink.h:27</div></div>
<div class="ttc" id="a3dslink_8h_html_accd3d099fe5f87e7fa884a739c220ade"><div class="ttname"><a href="3dslink_8h.html#accd3d099fe5f87e7fa884a739c220ade">link3dsStdioForDebug</a></div><div class="ttdeci">static int link3dsStdioForDebug(void)</div><div class="ttdoc">Same as link3dsConnectToHost but redirecting only stderr.</div><div class="ttdef"><b>Definition:</b> 3dslink.h:32</div></div>
<div class="ttc" id="astructin__addr_html"><div class="ttname"><a href="structin__addr.html">in_addr</a></div><div class="ttdef"><b>Definition:</b> in.h:30</div></div>
</div><!-- fragment --></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.1
</small></address>
</body>
</html>