mirror of
https://github.com/encounter/libnx.git
synced 2026-03-30 11:18:54 -07:00
doozer-agent
116 lines
20 KiB
HTML
116 lines
20 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>libnx: include/switch/runtime/devices/socket.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>
|
|
<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">libnx
|
|
</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 Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="annotated.html"><span>Data Structures</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 List</span></a></li>
|
|
<li><a href="globals.html"><span>Globals</span></a></li>
|
|
</ul>
|
|
</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_42bea3d40f1f1694e41a8f3166c98108.html">switch</a></li><li class="navelem"><a class="el" href="dir_afd0453aeaaca58db0f3a26ffe540381.html">runtime</a></li><li class="navelem"><a class="el" href="dir_8e84a2b4adc47392539d92413dc3768e.html">devices</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">socket.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#include "../../types.h"</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"></span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">/// Configuration structure for socketInitalize</span></div><div class="line"><a name="l00005"></a><span class="lineno"><a class="line" href="structSocketInitConfig.html"> 5</a></span> <span class="comment"></span><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div><div class="line"><a name="l00006"></a><span class="lineno"><a class="line" href="structSocketInitConfig.html#ab44886a55ed95149780f50af454b611c"> 6</a></span>  <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> <a class="code" href="structSocketInitConfig.html#ab44886a55ed95149780f50af454b611c">bsdsockets_version</a>; <span class="comment">///< Observed 1 on 2.0 LibAppletWeb, 2 on 3.0.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"></span></div><div class="line"><a name="l00008"></a><span class="lineno"><a class="line" href="structSocketInitConfig.html#abe6d6668dfaea18108d01cf672aa6f3b"> 8</a></span>  <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> <a class="code" href="structSocketInitConfig.html#abe6d6668dfaea18108d01cf672aa6f3b">tcp_tx_buf_size</a>; <span class="comment">///< Size of the TCP transfer (send) buffer (initial or fixed).</span></div><div class="line"><a name="l00009"></a><span class="lineno"><a class="line" href="structSocketInitConfig.html#a40fbf6221246e85eaac30edbc2d612b3"> 9</a></span> <span class="comment"></span> <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> <a class="code" href="structSocketInitConfig.html#a40fbf6221246e85eaac30edbc2d612b3">tcp_rx_buf_size</a>; <span class="comment">///< Size of the TCP recieve buffer (initial or fixed).</span></div><div class="line"><a name="l00010"></a><span class="lineno"><a class="line" href="structSocketInitConfig.html#a582276138af99fc3396210f534df019b"> 10</a></span> <span class="comment"></span> <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> <a class="code" href="structSocketInitConfig.html#a582276138af99fc3396210f534df019b">tcp_tx_buf_max_size</a>; <span class="comment">///< Maximum size of the TCP transfer (send) buffer. If it is 0, the size of the buffer is fixed to its initial value.</span></div><div class="line"><a name="l00011"></a><span class="lineno"><a class="line" href="structSocketInitConfig.html#a2b52dbceb30c6118b91a418121fa5fa1"> 11</a></span> <span class="comment"></span> <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> <a class="code" href="structSocketInitConfig.html#a2b52dbceb30c6118b91a418121fa5fa1">tcp_rx_buf_max_size</a>; <span class="comment">///< Maximum size of the TCP receive buffer. If it is 0, the size of the buffer is fixed to its initial value.</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"></span></div><div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="structSocketInitConfig.html#a5e92f93b7b7068013ffc4f58322eb323"> 13</a></span>  <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> <a class="code" href="structSocketInitConfig.html#a5e92f93b7b7068013ffc4f58322eb323">udp_tx_buf_size</a>; <span class="comment">///< Size of the UDP transfer (send) buffer (typically 0x2400 bytes).</span></div><div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="structSocketInitConfig.html#a7699c71de8e65df1ab3f029492f3569a"> 14</a></span> <span class="comment"></span> <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> <a class="code" href="structSocketInitConfig.html#a7699c71de8e65df1ab3f029492f3569a">udp_rx_buf_size</a>; <span class="comment">///< Size of the UDP receive buffer (typically 0xA500 bytes).</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"></span></div><div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="structSocketInitConfig.html#a7a1ad302f5547de3a396d827c1fa8c16"> 16</a></span>  <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> <a class="code" href="structSocketInitConfig.html#a7a1ad302f5547de3a396d827c1fa8c16">sb_efficiency</a>; <span class="comment">///< Number of buffers for each socket (standard values range from 1 to 8).</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"></span></div><div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="structSocketInitConfig.html#a7ac306082a8ab7705531fffc36a5984b"> 18</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="structSocketInitConfig.html#a7ac306082a8ab7705531fffc36a5984b">serialized_out_addrinfos_max_size</a>; <span class="comment">///< For getaddrinfo.</span></div><div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="structSocketInitConfig.html#ad70d786f871d5a3b7dc1e725d86dad35"> 19</a></span> <span class="comment"></span> <span class="keywordtype">size_t</span> <a class="code" href="structSocketInitConfig.html#ad70d786f871d5a3b7dc1e725d86dad35">serialized_out_hostent_max_size</a>; <span class="comment">///< For gethostbyname/gethostbyaddr.</span></div><div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="structSocketInitConfig.html#a0c4eaadec9f51853b257fc2f7b7e9eac"> 20</a></span> <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="structSocketInitConfig.html#a0c4eaadec9f51853b257fc2f7b7e9eac">bypass_nsd</a>; <span class="comment">///< For name gethostbyname/getaddrinfo: bypass the Name Server Daemon.</span></div><div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="structSocketInitConfig.html#a83c7d422596a40c7cba04f419b2d0f21"> 21</a></span> <span class="comment"></span> <span class="keywordtype">int</span> <a class="code" href="structSocketInitConfig.html#a83c7d422596a40c7cba04f419b2d0f21">dns_timeout</a>; <span class="comment">///< For DNS requests: timeout or 0.</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"></span>} <a class="code" href="structSocketInitConfig.html">SocketInitConfig</a>;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">/// Fetch the default configuration for the socket driver.</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"></span><span class="keyword">const</span> <a class="code" href="structSocketInitConfig.html">SocketInitConfig</a> *socketGetDefaultInitConfig(<span class="keywordtype">void</span>);<span class="comment"></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">/// Initalize the socket driver.</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"></span><a class="code" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> socketInitialize(<span class="keyword">const</span> <a class="code" href="structSocketInitConfig.html">SocketInitConfig</a> *config);<span class="comment"></span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">/// Fetch the last bsd:u/s Switch result code (thread-local).</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"></span><a class="code" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> socketGetLastBsdResult(<span class="keywordtype">void</span>);<span class="comment"></span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">/// Fetch the last sfdnsres Switch result code (thread-local).</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"></span><a class="code" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> socketGetLastSfdnsresResult(<span class="keywordtype">void</span>);<span class="comment"></span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">/// Deinitialize the socket driver.</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"></span><span class="keywordtype">void</span> socketExit(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"></span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">/// Initalize the socket driver using the default configuration.</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"></span><span class="keyword">static</span> <span class="keyword">inline</span> <a class="code" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> socketInitializeDefault(<span class="keywordtype">void</span>) {</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keywordflow">return</span> socketInitialize(socketGetDefaultInitConfig());</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> }</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="ttc" id="structSocketInitConfig_html_a40fbf6221246e85eaac30edbc2d612b3"><div class="ttname"><a href="structSocketInitConfig.html#a40fbf6221246e85eaac30edbc2d612b3">SocketInitConfig::tcp_rx_buf_size</a></div><div class="ttdeci">u32 tcp_rx_buf_size</div><div class="ttdoc">Size of the TCP recieve buffer (initial or fixed). </div><div class="ttdef"><b>Definition:</b> socket.h:9</div></div>
|
|
<div class="ttc" id="structSocketInitConfig_html_a582276138af99fc3396210f534df019b"><div class="ttname"><a href="structSocketInitConfig.html#a582276138af99fc3396210f534df019b">SocketInitConfig::tcp_tx_buf_max_size</a></div><div class="ttdeci">u32 tcp_tx_buf_max_size</div><div class="ttdoc">Maximum size of the TCP transfer (send) buffer. If it is 0, the size of the buffer is fixed to its in...</div><div class="ttdef"><b>Definition:</b> socket.h:10</div></div>
|
|
<div class="ttc" id="structSocketInitConfig_html_ad70d786f871d5a3b7dc1e725d86dad35"><div class="ttname"><a href="structSocketInitConfig.html#ad70d786f871d5a3b7dc1e725d86dad35">SocketInitConfig::serialized_out_hostent_max_size</a></div><div class="ttdeci">size_t serialized_out_hostent_max_size</div><div class="ttdoc">For gethostbyname/gethostbyaddr. </div><div class="ttdef"><b>Definition:</b> socket.h:19</div></div>
|
|
<div class="ttc" id="types_8h_html_ad1be2721625a17f1be47fac918032afe"><div class="ttname"><a href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a></div><div class="ttdeci">u32 Result</div><div class="ttdoc">Function error code result type. </div><div class="ttdef"><b>Definition:</b> types.h:46</div></div>
|
|
<div class="ttc" id="structSocketInitConfig_html_a2b52dbceb30c6118b91a418121fa5fa1"><div class="ttname"><a href="structSocketInitConfig.html#a2b52dbceb30c6118b91a418121fa5fa1">SocketInitConfig::tcp_rx_buf_max_size</a></div><div class="ttdeci">u32 tcp_rx_buf_max_size</div><div class="ttdoc">Maximum size of the TCP receive buffer. If it is 0, the size of the buffer is fixed to its initial va...</div><div class="ttdef"><b>Definition:</b> socket.h:11</div></div>
|
|
<div class="ttc" id="types_8h_html_afaa62991928fb9fb18ff0db62a040aba"><div class="ttname"><a href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a></div><div class="ttdeci">uint32_t u32</div><div class="ttdoc">32-bit unsigned integer. </div><div class="ttdef"><b>Definition:</b> types.h:23</div></div>
|
|
<div class="ttc" id="structSocketInitConfig_html_a7ac306082a8ab7705531fffc36a5984b"><div class="ttname"><a href="structSocketInitConfig.html#a7ac306082a8ab7705531fffc36a5984b">SocketInitConfig::serialized_out_addrinfos_max_size</a></div><div class="ttdeci">size_t serialized_out_addrinfos_max_size</div><div class="ttdoc">For getaddrinfo. </div><div class="ttdef"><b>Definition:</b> socket.h:18</div></div>
|
|
<div class="ttc" id="structSocketInitConfig_html"><div class="ttname"><a href="structSocketInitConfig.html">SocketInitConfig</a></div><div class="ttdoc">Configuration structure for socketInitalize. </div><div class="ttdef"><b>Definition:</b> socket.h:5</div></div>
|
|
<div class="ttc" id="structSocketInitConfig_html_abe6d6668dfaea18108d01cf672aa6f3b"><div class="ttname"><a href="structSocketInitConfig.html#abe6d6668dfaea18108d01cf672aa6f3b">SocketInitConfig::tcp_tx_buf_size</a></div><div class="ttdeci">u32 tcp_tx_buf_size</div><div class="ttdoc">Size of the TCP transfer (send) buffer (initial or fixed). </div><div class="ttdef"><b>Definition:</b> socket.h:8</div></div>
|
|
<div class="ttc" id="structSocketInitConfig_html_a7699c71de8e65df1ab3f029492f3569a"><div class="ttname"><a href="structSocketInitConfig.html#a7699c71de8e65df1ab3f029492f3569a">SocketInitConfig::udp_rx_buf_size</a></div><div class="ttdeci">u32 udp_rx_buf_size</div><div class="ttdoc">Size of the UDP receive buffer (typically 0xA500 bytes). </div><div class="ttdef"><b>Definition:</b> socket.h:14</div></div>
|
|
<div class="ttc" id="structSocketInitConfig_html_a0c4eaadec9f51853b257fc2f7b7e9eac"><div class="ttname"><a href="structSocketInitConfig.html#a0c4eaadec9f51853b257fc2f7b7e9eac">SocketInitConfig::bypass_nsd</a></div><div class="ttdeci">bool bypass_nsd</div><div class="ttdoc">For name gethostbyname/getaddrinfo: bypass the Name Server Daemon. </div><div class="ttdef"><b>Definition:</b> socket.h:20</div></div>
|
|
<div class="ttc" id="structSocketInitConfig_html_a7a1ad302f5547de3a396d827c1fa8c16"><div class="ttname"><a href="structSocketInitConfig.html#a7a1ad302f5547de3a396d827c1fa8c16">SocketInitConfig::sb_efficiency</a></div><div class="ttdeci">u32 sb_efficiency</div><div class="ttdoc">Number of buffers for each socket (standard values range from 1 to 8). </div><div class="ttdef"><b>Definition:</b> socket.h:16</div></div>
|
|
<div class="ttc" id="structSocketInitConfig_html_a5e92f93b7b7068013ffc4f58322eb323"><div class="ttname"><a href="structSocketInitConfig.html#a5e92f93b7b7068013ffc4f58322eb323">SocketInitConfig::udp_tx_buf_size</a></div><div class="ttdeci">u32 udp_tx_buf_size</div><div class="ttdoc">Size of the UDP transfer (send) buffer (typically 0x2400 bytes). </div><div class="ttdef"><b>Definition:</b> socket.h:13</div></div>
|
|
<div class="ttc" id="structSocketInitConfig_html_ab44886a55ed95149780f50af454b611c"><div class="ttname"><a href="structSocketInitConfig.html#ab44886a55ed95149780f50af454b611c">SocketInitConfig::bsdsockets_version</a></div><div class="ttdeci">u32 bsdsockets_version</div><div class="ttdoc">Observed 1 on 2.0 LibAppletWeb, 2 on 3.0. </div><div class="ttdef"><b>Definition:</b> socket.h:6</div></div>
|
|
<div class="ttc" id="structSocketInitConfig_html_a83c7d422596a40c7cba04f419b2d0f21"><div class="ttname"><a href="structSocketInitConfig.html#a83c7d422596a40c7cba04f419b2d0f21">SocketInitConfig::dns_timeout</a></div><div class="ttdeci">int dns_timeout</div><div class="ttdoc">For DNS requests: timeout or 0. </div><div class="ttdef"><b>Definition:</b> socket.h:21</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.11
|
|
</small></address>
|
|
</body>
|
|
</html>
|