DevKit7/libctru
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
gh-pages
libctru/soc_8h.html
WinterMute e52f3175e1 Deploying to gh-pages from @ 8cbcce773b 🚀
2024-11-03 20:36:34 +00:00

462 lines
33 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">
<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/services/soc.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="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><li class="navelem"><a class="el" href="dir_0e005207343684f6967052d1f51a7e66.html">services</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">soc.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>SOC service for sockets communications.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;netinet/in.h&gt;</code><br />
<code>#include &lt;sys/socket.h&gt;</code><br />
</div>
<p><a href="soc_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSOCU__ARPTableEntry.html">SOCU_ARPTableEntry</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">One entry of the ARP table retrieved by using <a class="el" href="soc_8h.html#a08ae584539cdc85bd756bcc22e9bce93">SOCU_GetNetworkOpt</a> and <a class="el" href="soc_8h.html#a68bfdefaf8aaf20a49442b5a16bc195bad54186bb5d20deb3f23f4f68af9bb46f">NETOPT_ARP_TABLE</a>. <a href="structSOCU__ARPTableEntry.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSOCU__IPInfo.html">SOCU_IPInfo</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Structure returned by <a class="el" href="soc_8h.html#a08ae584539cdc85bd756bcc22e9bce93">SOCU_GetNetworkOpt</a> when using <a class="el" href="soc_8h.html#a68bfdefaf8aaf20a49442b5a16bc195bad87e12b1a746874485def4698fc299d6">NETOPT_IP_INFO</a>. <a href="structSOCU__IPInfo.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSOCU__RoutingTableEntry.html">SOCU_RoutingTableEntry</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">One entry of the routing table retrieved by using <a class="el" href="soc_8h.html#a08ae584539cdc85bd756bcc22e9bce93">SOCU_GetNetworkOpt</a> and <a class="el" href="soc_8h.html#a68bfdefaf8aaf20a49442b5a16bc195ba84ecb7d26ff74c7e92d7b6837d83c9b3">NETOPT_ROUTING_TABLE</a>. <a href="structSOCU__RoutingTableEntry.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSOCU__UDPTableEntry.html">SOCU_UDPTableEntry</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">One entry of the UDP sockets table retrieved by using <a class="el" href="soc_8h.html#a08ae584539cdc85bd756bcc22e9bce93">SOCU_GetNetworkOpt</a> and <a class="el" href="soc_8h.html#a68bfdefaf8aaf20a49442b5a16bc195bacf2e5444441f93c89d89eceda5eebf4c">NETOPT_UDP_TABLE</a>. <a href="structSOCU__UDPTableEntry.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSOCU__TCPTableEntry.html">SOCU_TCPTableEntry</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">One entry of the TCP sockets table retrieved by using <a class="el" href="soc_8h.html#a08ae584539cdc85bd756bcc22e9bce93">SOCU_GetNetworkOpt</a> and <a class="el" href="soc_8h.html#a68bfdefaf8aaf20a49442b5a16bc195ba7de29cd696b4bbafac7255ba4e86b806">NETOPT_TCP_TABLE</a>. <a href="structSOCU__TCPTableEntry.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSOCU__DNSTableEntry.html">SOCU_DNSTableEntry</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">One entry of the DNS servers table retrieved by using <a class="el" href="soc_8h.html#a08ae584539cdc85bd756bcc22e9bce93">SOCU_GetNetworkOpt</a> and <a class="el" href="soc_8h.html#a68bfdefaf8aaf20a49442b5a16bc195ba54167541fe52565a71798a1de933a03e">NETOPT_DNS_TABLE</a>. <a href="structSOCU__DNSTableEntry.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:abc8cb94624da1c70e1a77ad3d0a2676d"><td class="memItemLeft" align="right" valign="top"><a id="abc8cb94624da1c70e1a77ad3d0a2676d"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="soc_8h.html#abc8cb94624da1c70e1a77ad3d0a2676d">SOL_CONFIG</a>&#160;&#160;&#160;0xfffe</td></tr>
<tr class="memdesc:abc8cb94624da1c70e1a77ad3d0a2676d"><td class="mdescLeft">&#160;</td><td class="mdescRight">The config level to be used with <a class="el" href="soc_8h.html#a08ae584539cdc85bd756bcc22e9bce93">SOCU_GetNetworkOpt</a>. <br /></td></tr>
<tr class="separator:abc8cb94624da1c70e1a77ad3d0a2676d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9cee173a7c2a0b5b667fbce872b79a55"><td class="memItemLeft" align="right" valign="top"><a id="a9cee173a7c2a0b5b667fbce872b79a55"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="soc_8h.html#a9cee173a7c2a0b5b667fbce872b79a55">ROUTING_FLAG_G</a>&#160;&#160;&#160;0x01</td></tr>
<tr class="memdesc:a9cee173a7c2a0b5b667fbce872b79a55"><td class="mdescLeft">&#160;</td><td class="mdescRight">The route uses a gateway. <br /></td></tr>
<tr class="separator:a9cee173a7c2a0b5b667fbce872b79a55"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">TCP states</div></td></tr>
<tr class="memitem:a32ee06b80f80c1562c4c7e9c72313dca"><td class="memItemLeft" align="right" valign="top"><a id="a32ee06b80f80c1562c4c7e9c72313dca"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>TCP_STATE_CLOSED</b>&#160;&#160;&#160;1</td></tr>
<tr class="separator:a32ee06b80f80c1562c4c7e9c72313dca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a98e3d71dde3ddd2c4e7e0ecbc0393a55"><td class="memItemLeft" align="right" valign="top"><a id="a98e3d71dde3ddd2c4e7e0ecbc0393a55"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>TCP_STATE_LISTEN</b>&#160;&#160;&#160;2</td></tr>
<tr class="separator:a98e3d71dde3ddd2c4e7e0ecbc0393a55"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab514cdbbc6f92872a41f20d679307a41"><td class="memItemLeft" align="right" valign="top"><a id="ab514cdbbc6f92872a41f20d679307a41"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>TCP_STATE_ESTABLISHED</b>&#160;&#160;&#160;5</td></tr>
<tr class="separator:ab514cdbbc6f92872a41f20d679307a41"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7befbeb7079cf9e791cd5195dfa5c4ea"><td class="memItemLeft" align="right" valign="top"><a id="a7befbeb7079cf9e791cd5195dfa5c4ea"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>TCP_STATE_FINWAIT1</b>&#160;&#160;&#160;6</td></tr>
<tr class="separator:a7befbeb7079cf9e791cd5195dfa5c4ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abeb0eee5bcb9ffe89ebd44c9c4495ebb"><td class="memItemLeft" align="right" valign="top"><a id="abeb0eee5bcb9ffe89ebd44c9c4495ebb"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>TCP_STATE_FINWAIT2</b>&#160;&#160;&#160;7</td></tr>
<tr class="separator:abeb0eee5bcb9ffe89ebd44c9c4495ebb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac3fdf15cb5b921687f5f73e70aea8545"><td class="memItemLeft" align="right" valign="top"><a id="ac3fdf15cb5b921687f5f73e70aea8545"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>TCP_STATE_CLOSE_WAIT</b>&#160;&#160;&#160;8</td></tr>
<tr class="separator:ac3fdf15cb5b921687f5f73e70aea8545"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab46a9f415e344099294d6076d31b6dc6"><td class="memItemLeft" align="right" valign="top"><a id="ab46a9f415e344099294d6076d31b6dc6"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>TCP_STATE_LAST_ACK</b>&#160;&#160;&#160;9</td></tr>
<tr class="separator:ab46a9f415e344099294d6076d31b6dc6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9fd94eaf2206fa3f9b5607a9febb656c"><td class="memItemLeft" align="right" valign="top"><a id="a9fd94eaf2206fa3f9b5607a9febb656c"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>TCP_STATE_TIME_WAIT</b>&#160;&#160;&#160;11</td></tr>
<tr class="separator:a9fd94eaf2206fa3f9b5607a9febb656c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a68bfdefaf8aaf20a49442b5a16bc195b"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="soc_8h.html#a68bfdefaf8aaf20a49442b5a16bc195b">NetworkOpt</a> { <br />
&#160;&#160;<a class="el" href="soc_8h.html#a68bfdefaf8aaf20a49442b5a16bc195ba151701448597b75b590349b671df99d9">NETOPT_MAC_ADDRESS</a> = 0x1004
, <br />
&#160;&#160;<a class="el" href="soc_8h.html#a68bfdefaf8aaf20a49442b5a16bc195bad54186bb5d20deb3f23f4f68af9bb46f">NETOPT_ARP_TABLE</a> = 0x3002
, <br />
&#160;&#160;<a class="el" href="soc_8h.html#a68bfdefaf8aaf20a49442b5a16bc195bad87e12b1a746874485def4698fc299d6">NETOPT_IP_INFO</a> = 0x4003
, <br />
&#160;&#160;<a class="el" href="soc_8h.html#a68bfdefaf8aaf20a49442b5a16bc195baf40c8ab5617941e0c2688330404b432e">NETOPT_IP_MTU</a> = 0x4004
, <br />
&#160;&#160;<a class="el" href="soc_8h.html#a68bfdefaf8aaf20a49442b5a16bc195ba84ecb7d26ff74c7e92d7b6837d83c9b3">NETOPT_ROUTING_TABLE</a> = 0x4006
, <br />
&#160;&#160;<a class="el" href="soc_8h.html#a68bfdefaf8aaf20a49442b5a16bc195ba9e1b6ce01f6201e942cf9f3d73f0dc15">NETOPT_UDP_NUMBER</a> = 0x8002
, <br />
&#160;&#160;<a class="el" href="soc_8h.html#a68bfdefaf8aaf20a49442b5a16bc195bacf2e5444441f93c89d89eceda5eebf4c">NETOPT_UDP_TABLE</a> = 0x8003
, <br />
&#160;&#160;<a class="el" href="soc_8h.html#a68bfdefaf8aaf20a49442b5a16bc195ba5def01a955bd5ccbd6f8bb5ff6fa585c">NETOPT_TCP_NUMBER</a> = 0x9002
, <br />
&#160;&#160;<a class="el" href="soc_8h.html#a68bfdefaf8aaf20a49442b5a16bc195ba7de29cd696b4bbafac7255ba4e86b806">NETOPT_TCP_TABLE</a> = 0x9003
, <br />
&#160;&#160;<a class="el" href="soc_8h.html#a68bfdefaf8aaf20a49442b5a16bc195ba54167541fe52565a71798a1de933a03e">NETOPT_DNS_TABLE</a> = 0xB003
, <br />
&#160;&#160;<a class="el" href="soc_8h.html#a68bfdefaf8aaf20a49442b5a16bc195ba6c2850ad357b5e7c3d4b7fed113066fe">NETOPT_DHCP_LEASE_TIME</a> = 0xC001
<br />
}</td></tr>
<tr class="memdesc:a68bfdefaf8aaf20a49442b5a16bc195b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Options to be used with <a class="el" href="soc_8h.html#a08ae584539cdc85bd756bcc22e9bce93">SOCU_GetNetworkOpt</a>. <a href="soc_8h.html#a68bfdefaf8aaf20a49442b5a16bc195b">More...</a><br /></td></tr>
<tr class="separator:a68bfdefaf8aaf20a49442b5a16bc195b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a0c15255d27f548252f23860e1f7fe39b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="soc_8h.html#a0c15255d27f548252f23860e1f7fe39b">socInit</a> (<a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *context_addr, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> context_size)</td></tr>
<tr class="memdesc:a0c15255d27f548252f23860e1f7fe39b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the SOC service. <a href="soc_8h.html#a0c15255d27f548252f23860e1f7fe39b">More...</a><br /></td></tr>
<tr class="separator:a0c15255d27f548252f23860e1f7fe39b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4c165678b18a16dccc315220ec61e1ee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="soc_8h.html#a4c165678b18a16dccc315220ec61e1ee">socExit</a> (void)</td></tr>
<tr class="memdesc:a4c165678b18a16dccc315220ec61e1ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Closes the soc service. <a href="soc_8h.html#a4c165678b18a16dccc315220ec61e1ee">More...</a><br /></td></tr>
<tr class="separator:a4c165678b18a16dccc315220ec61e1ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab7b49a1dc7a37a50ea146982bc01eee1"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="soc_8h.html#ab7b49a1dc7a37a50ea146982bc01eee1">gethostid</a> (void)</td></tr>
<tr class="memdesc:ab7b49a1dc7a37a50ea146982bc01eee1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the system's host ID. <a href="soc_8h.html#ab7b49a1dc7a37a50ea146982bc01eee1">More...</a><br /></td></tr>
<tr class="separator:ab7b49a1dc7a37a50ea146982bc01eee1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a68a4afc75ebd44db18557d02b4dc52c3"><td class="memItemLeft" align="right" valign="top"><a id="a68a4afc75ebd44db18557d02b4dc52c3"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>gethostname</b> (char *name, size_t namelen)</td></tr>
<tr class="separator:a68a4afc75ebd44db18557d02b4dc52c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af198ba277601e1f88ce1c8d1d378a08c"><td class="memItemLeft" align="right" valign="top"><a id="af198ba277601e1f88ce1c8d1d378a08c"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>SOCU_ShutdownSockets</b> (void)</td></tr>
<tr class="separator:af198ba277601e1f88ce1c8d1d378a08c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d0aac0ab613fd02d58c1f0c7683166b"><td class="memItemLeft" align="right" valign="top"><a id="a1d0aac0ab613fd02d58c1f0c7683166b"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>SOCU_CloseSockets</b> (void)</td></tr>
<tr class="separator:a1d0aac0ab613fd02d58c1f0c7683166b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a08ae584539cdc85bd756bcc22e9bce93"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="soc_8h.html#a08ae584539cdc85bd756bcc22e9bce93">SOCU_GetNetworkOpt</a> (int level, <a class="el" href="soc_8h.html#a68bfdefaf8aaf20a49442b5a16bc195b">NetworkOpt</a> optname, void *optval, socklen_t *optlen)</td></tr>
<tr class="memdesc:a08ae584539cdc85bd756bcc22e9bce93"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves information from the network configuration. <a href="soc_8h.html#a08ae584539cdc85bd756bcc22e9bce93">More...</a><br /></td></tr>
<tr class="separator:a08ae584539cdc85bd756bcc22e9bce93"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a894b9a96c2a1a91d52f4a2cb54b173d1"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="soc_8h.html#a894b9a96c2a1a91d52f4a2cb54b173d1">SOCU_GetIPInfo</a> (struct <a class="el" href="structin__addr.html">in_addr</a> *ip, struct <a class="el" href="structin__addr.html">in_addr</a> *netmask, struct <a class="el" href="structin__addr.html">in_addr</a> *broadcast)</td></tr>
<tr class="memdesc:a894b9a96c2a1a91d52f4a2cb54b173d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the system's IP address, netmask, and subnet broadcast. <a href="soc_8h.html#a894b9a96c2a1a91d52f4a2cb54b173d1">More...</a><br /></td></tr>
<tr class="separator:a894b9a96c2a1a91d52f4a2cb54b173d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3bef58a0883bdf3000eb8466d1eedb37"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="soc_8h.html#a3bef58a0883bdf3000eb8466d1eedb37">SOCU_AddGlobalSocket</a> (int sockfd)</td></tr>
<tr class="memdesc:a3bef58a0883bdf3000eb8466d1eedb37"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a global socket. <a href="soc_8h.html#a3bef58a0883bdf3000eb8466d1eedb37">More...</a><br /></td></tr>
<tr class="separator:a3bef58a0883bdf3000eb8466d1eedb37"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>SOC service for sockets communications. </p>
<p>After initializing this service you will be able to use system calls from <a class="el" href="netdb_8h_source.html">netdb.h</a>, <a class="el" href="socket_8h_source.html">sys/socket.h</a> etc. </p>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a68bfdefaf8aaf20a49442b5a16bc195b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68bfdefaf8aaf20a49442b5a16bc195b">&#9670;&nbsp;</a></span>NetworkOpt</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="soc_8h.html#a68bfdefaf8aaf20a49442b5a16bc195b">NetworkOpt</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Options to be used with <a class="el" href="soc_8h.html#a08ae584539cdc85bd756bcc22e9bce93">SOCU_GetNetworkOpt</a>. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a68bfdefaf8aaf20a49442b5a16bc195ba151701448597b75b590349b671df99d9"></a>NETOPT_MAC_ADDRESS&#160;</td><td class="fielddoc"><p>The mac address of the interface (u32 mac[6]) </p>
</td></tr>
<tr><td class="fieldname"><a id="a68bfdefaf8aaf20a49442b5a16bc195bad54186bb5d20deb3f23f4f68af9bb46f"></a>NETOPT_ARP_TABLE&#160;</td><td class="fielddoc"><p>The ARP table. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structSOCU__ARPTableEntry.html" title="One entry of the ARP table retrieved by using SOCU_GetNetworkOpt and NETOPT_ARP_TABLE.">SOCU_ARPTableEntry</a> </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a68bfdefaf8aaf20a49442b5a16bc195bad87e12b1a746874485def4698fc299d6"></a>NETOPT_IP_INFO&#160;</td><td class="fielddoc"><p>The current IP setup. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structSOCU__IPInfo.html" title="Structure returned by SOCU_GetNetworkOpt when using NETOPT_IP_INFO.">SOCU_IPInfo</a> </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a68bfdefaf8aaf20a49442b5a16bc195baf40c8ab5617941e0c2688330404b432e"></a>NETOPT_IP_MTU&#160;</td><td class="fielddoc"><p>The value of the IP MTU (u32) </p>
</td></tr>
<tr><td class="fieldname"><a id="a68bfdefaf8aaf20a49442b5a16bc195ba84ecb7d26ff74c7e92d7b6837d83c9b3"></a>NETOPT_ROUTING_TABLE&#160;</td><td class="fielddoc"><p>The routing table. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structSOCU__RoutingTableEntry.html" title="One entry of the routing table retrieved by using SOCU_GetNetworkOpt and NETOPT_ROUTING_TABLE.">SOCU_RoutingTableEntry</a> </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a68bfdefaf8aaf20a49442b5a16bc195ba9e1b6ce01f6201e942cf9f3d73f0dc15"></a>NETOPT_UDP_NUMBER&#160;</td><td class="fielddoc"><p>The number of sockets in the UDP table (u32) </p>
</td></tr>
<tr><td class="fieldname"><a id="a68bfdefaf8aaf20a49442b5a16bc195bacf2e5444441f93c89d89eceda5eebf4c"></a>NETOPT_UDP_TABLE&#160;</td><td class="fielddoc"><p>The table of opened UDP sockets. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structSOCU__UDPTableEntry.html" title="One entry of the UDP sockets table retrieved by using SOCU_GetNetworkOpt and NETOPT_UDP_TABLE.">SOCU_UDPTableEntry</a> </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a68bfdefaf8aaf20a49442b5a16bc195ba5def01a955bd5ccbd6f8bb5ff6fa585c"></a>NETOPT_TCP_NUMBER&#160;</td><td class="fielddoc"><p>The number of sockets in the TCP table (u32) </p>
</td></tr>
<tr><td class="fieldname"><a id="a68bfdefaf8aaf20a49442b5a16bc195ba7de29cd696b4bbafac7255ba4e86b806"></a>NETOPT_TCP_TABLE&#160;</td><td class="fielddoc"><p>The table of opened TCP sockets. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structSOCU__TCPTableEntry.html" title="One entry of the TCP sockets table retrieved by using SOCU_GetNetworkOpt and NETOPT_TCP_TABLE.">SOCU_TCPTableEntry</a> </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a68bfdefaf8aaf20a49442b5a16bc195ba54167541fe52565a71798a1de933a03e"></a>NETOPT_DNS_TABLE&#160;</td><td class="fielddoc"><p>The table of the DNS servers. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structSOCU__DNSTableEntry.html" title="One entry of the DNS servers table retrieved by using SOCU_GetNetworkOpt and NETOPT_DNS_TABLE.">SOCU_DNSTableEntry</a> &ndash; Returns a buffer of size 336 but only 2 entries are set ? </dd></dl>
</td></tr>
<tr><td class="fieldname"><a id="a68bfdefaf8aaf20a49442b5a16bc195ba6c2850ad357b5e7c3d4b7fed113066fe"></a>NETOPT_DHCP_LEASE_TIME&#160;</td><td class="fielddoc"><p>The DHCP lease time remaining, in seconds. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ab7b49a1dc7a37a50ea146982bc01eee1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab7b49a1dc7a37a50ea146982bc01eee1">&#9670;&nbsp;</a></span>gethostid()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long gethostid </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the system's host ID. </p>
<dl class="section return"><dt>Returns</dt><dd>The system's host ID. </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="network_2sockets_2source_2sockets_8c-example.html#a8">network/sockets/source/sockets.c</a>.</dd>
</dl>
</div>
</div>
<a id="a4c165678b18a16dccc315220ec61e1ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4c165678b18a16dccc315220ec61e1ee">&#9670;&nbsp;</a></span>socExit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> socExit </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Closes the soc service. </p>
<dl class="section note"><dt>Note</dt><dd>You need to call this in order to be able to use the buffer again. </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="network_2sockets_2source_2sockets_8c-example.html#a1">network/sockets/source/sockets.c</a>, and <a class="el" href="network_2sslc_2source_2ssl_8c-example.html#a16">network/sslc/source/ssl.c</a>.</dd>
</dl>
</div>
</div>
<a id="a0c15255d27f548252f23860e1f7fe39b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0c15255d27f548252f23860e1f7fe39b">&#9670;&nbsp;</a></span>socInit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> socInit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *&#160;</td>
<td class="paramname"><em>context_addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td>
<td class="paramname"><em>context_size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes the SOC service. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">context_addr</td><td>Address of a page-aligned (0x1000) buffer to be used. </td></tr>
<tr><td class="paramname">context_size</td><td>Size of the buffer, a multiple of 0x1000. </td></tr>
</table>
</dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>The specified context buffer can no longer be accessed by the process which called this function, since the userland permissions for this block are set to no-access. </dd></dl>
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="network_2sockets_2source_2sockets_8c-example.html#a7">network/sockets/source/sockets.c</a>, and <a class="el" href="network_2sslc_2source_2ssl_8c-example.html#a13">network/sslc/source/ssl.c</a>.</dd>
</dl>
</div>
</div>
<a id="a3bef58a0883bdf3000eb8466d1eedb37"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3bef58a0883bdf3000eb8466d1eedb37">&#9670;&nbsp;</a></span>SOCU_AddGlobalSocket()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int SOCU_AddGlobalSocket </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>sockfd</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds a global socket. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sockfd</td><td>The socket fd. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>error </dd></dl>
</div>
</div>
<a id="a894b9a96c2a1a91d52f4a2cb54b173d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a894b9a96c2a1a91d52f4a2cb54b173d1">&#9670;&nbsp;</a></span>SOCU_GetIPInfo()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int SOCU_GetIPInfo </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structin__addr.html">in_addr</a> *&#160;</td>
<td class="paramname"><em>ip</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structin__addr.html">in_addr</a> *&#160;</td>
<td class="paramname"><em>netmask</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">struct <a class="el" href="structin__addr.html">in_addr</a> *&#160;</td>
<td class="paramname"><em>broadcast</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the system's IP address, netmask, and subnet broadcast. </p>
<dl class="section return"><dt>Returns</dt><dd>error </dd></dl>
</div>
</div>
<a id="a08ae584539cdc85bd756bcc22e9bce93"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a08ae584539cdc85bd756bcc22e9bce93">&#9670;&nbsp;</a></span>SOCU_GetNetworkOpt()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int SOCU_GetNetworkOpt </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>level</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="soc_8h.html#a68bfdefaf8aaf20a49442b5a16bc195b">NetworkOpt</a>&#160;</td>
<td class="paramname"><em>optname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>optval</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">socklen_t *&#160;</td>
<td class="paramname"><em>optlen</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves information from the network configuration. </p>
<p>Similar to getsockopt(). </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">level</td><td>Only value allowed seems to be <a class="el" href="soc_8h.html#abc8cb94624da1c70e1a77ad3d0a2676d">SOL_CONFIG</a> </td></tr>
<tr><td class="paramname">optname</td><td>The option to be retrieved </td></tr>
<tr><td class="paramname">optval</td><td>Will contain the output of the command </td></tr>
<tr><td class="paramname">optlen</td><td>Size of the optval buffer, will be updated to hold the size of the output </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful. -1 if failed, and errno will be set accordingly. Can also return a system error code. </dd></dl>
</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.1
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink