Doxygen for c894f3f3a5db164b11fa1916f40a8bcec3732f2a

FreeRTOS · Dec 16, 2024 · 95652d3 · 95652d3
1 parent 7c5c924
commit 95652d3
Show file tree

Hide file tree

Showing 180 changed files with 38,535 additions and 0 deletions.
diff --git a/V4.3.1/_free_r_t_o_s___a_r_p_8c.html b/V4.3.1/_free_r_t_o_s___a_r_p_8c.html
diff --git a/V4.3.1/_free_r_t_o_s___bit_config_8c.html b/V4.3.1/_free_r_t_o_s___bit_config_8c.html
diff --git a/V4.3.1/_free_r_t_o_s___d_h_c_p_8c.html b/V4.3.1/_free_r_t_o_s___d_h_c_p_8c.html
diff --git a/V4.3.1/_free_r_t_o_s___d_h_c_pv6_8c.html b/V4.3.1/_free_r_t_o_s___d_h_c_pv6_8c.html
diff --git a/V4.3.1/_free_r_t_o_s___d_n_s_8c.html b/V4.3.1/_free_r_t_o_s___d_n_s_8c.html
diff --git a/V4.3.1/_free_r_t_o_s___d_n_s___cache_8c.html b/V4.3.1/_free_r_t_o_s___d_n_s___cache_8c.html
diff --git a/V4.3.1/_free_r_t_o_s___d_n_s___callback_8c.html b/V4.3.1/_free_r_t_o_s___d_n_s___callback_8c.html
diff --git a/V4.3.1/_free_r_t_o_s___d_n_s___networking_8c.html b/V4.3.1/_free_r_t_o_s___d_n_s___networking_8c.html
@@ -0,0 +1,316 @@
+<!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.6"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>FreeRTOS-Plus-TCP: FreeRTOS_DNS_Networking.c File Reference</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="jquery.js"></script>
+<script type="text/javascript" src="dynsections.js"></script>
+<link href="navtree.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="resize.js"></script>
+<script type="text/javascript" src="navtreedata.js"></script>
+<script type="text/javascript" src="navtree.js"></script>
+<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">
+/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
+  $(document).ready(function() { init_search(); });
+/* @license-end */
+</script>
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
+<link href="style.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">FreeRTOS-Plus-TCP<span id="projectnumber">&#160;V4.3.0</span>
+   </div>
+   <div id="projectbrief">FreeRTOS TCP/IP library</div>
+  </td>
+    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
+        <span class="left">
+          <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
+          <input type="text" id="MSearchField" value="" placeholder="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.svg" alt=""/></a>
+          </span>
+        </div>
+</td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.9.6 -->
+<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>
+</div><!-- top -->
+<div id="side-nav" class="ui-resizable side-nav-resizable">
+  <div id="nav-tree">
+    <div id="nav-tree-contents">
+      <div id="nav-sync" class="sync"></div>
+    </div>
+  </div>
+  <div id="splitbar" style="-moz-user-select:none;" 
+       class="ui-resizable-handle">
+  </div>
+</div>
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
+$(document).ready(function(){initNavTree('_free_r_t_o_s___d_n_s___networking_8c.html',''); initResizable(); });
+/* @license-end */
+</script>
+<div id="doc-content">
+<!-- window showing the filter options -->
+<div id="MSearchSelectWindow"
+     onmouseover="return searchBox.OnSearchSelectShow()"
+     onmouseout="return searchBox.OnSearchSelectHide()"
+     onkeydown="return searchBox.OnSearchSelectKey(event)">
+</div>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<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 class="header">
+  <div class="summary">
+<a href="#func-members">Functions</a>  </div>
+  <div class="headertitle"><div class="title">FreeRTOS_DNS_Networking.c File Reference</div></div>
+</div><!--header-->
+<div class="contents">
+
+<p>Implements the Domain Name System Networking for the FreeRTOS+TCP network stack.  
+<a href="#details">More...</a></p>
+<div class="textblock"><code>#include &quot;FreeRTOS.h&quot;</code><br />
+<code>#include &quot;FreeRTOS_DNS_Networking.h&quot;</code><br />
+</div><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:a998bd58d554c5c8ca8acb9583e9c6a77"><td class="memItemLeft" align="right" valign="top">BaseType_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_free_r_t_o_s___d_n_s___networking_8c.html#a998bd58d554c5c8ca8acb9583e9c6a77">DNS_BindSocket</a> (Socket_t xSocket, uint16_t usPort)</td></tr>
+<tr class="memdesc:a998bd58d554c5c8ca8acb9583e9c6a77"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bind the socket to a port number.  <br /></td></tr>
+<tr class="separator:a998bd58d554c5c8ca8acb9583e9c6a77"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aa2e0265014529ef9a417612308bf2b5d"><td class="memItemLeft" align="right" valign="top">Socket_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_free_r_t_o_s___d_n_s___networking_8c.html#aa2e0265014529ef9a417612308bf2b5d">DNS_CreateSocket</a> (TickType_t uxReadTimeOut_ticks)</td></tr>
+<tr class="memdesc:aa2e0265014529ef9a417612308bf2b5d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a socket and bind it to the standard DNS port number.  <br /></td></tr>
+<tr class="separator:aa2e0265014529ef9a417612308bf2b5d"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a89cfa1f2a25312a01483f36e50265eb0"><td class="memItemLeft" align="right" valign="top">BaseType_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_free_r_t_o_s___d_n_s___networking_8c.html#a89cfa1f2a25312a01483f36e50265eb0">DNS_SendRequest</a> (Socket_t xDNSSocket, const <a class="el" href="structstruct.html">struct</a> freertos_sockaddr *xAddress, const <a class="el" href="structstruct.html">struct</a> xDNSBuffer *pxDNSBuf)</td></tr>
+<tr class="memdesc:a89cfa1f2a25312a01483f36e50265eb0"><td class="mdescLeft">&#160;</td><td class="mdescRight">perform a DNS network request  <br /></td></tr>
+<tr class="separator:a89cfa1f2a25312a01483f36e50265eb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a16c7cb7023cfa29b6aa5cfac6406ad78"><td class="memItemLeft" align="right" valign="top">BaseType_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_free_r_t_o_s___d_n_s___networking_8c.html#a16c7cb7023cfa29b6aa5cfac6406ad78">DNS_ReadReply</a> (ConstSocket_t xDNSSocket, <a class="el" href="structstruct.html">struct</a> freertos_sockaddr *xAddress, <a class="el" href="structstruct.html">struct</a> xDNSBuffer *pxReceiveBuffer)</td></tr>
+<tr class="memdesc:a16c7cb7023cfa29b6aa5cfac6406ad78"><td class="mdescLeft">&#160;</td><td class="mdescRight">perform a DNS network read  <br /></td></tr>
+<tr class="separator:a16c7cb7023cfa29b6aa5cfac6406ad78"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ade7d8a2ebf3b318b01c68ceb0f6ec225"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_free_r_t_o_s___d_n_s___networking_8c.html#ade7d8a2ebf3b318b01c68ceb0f6ec225">DNS_CloseSocket</a> (Socket_t xDNSSocket)</td></tr>
+<tr class="memdesc:ade7d8a2ebf3b318b01c68ceb0f6ec225"><td class="mdescLeft">&#160;</td><td class="mdescRight">perform a DNS network close  <br /></td></tr>
+<tr class="separator:ade7d8a2ebf3b318b01c68ceb0f6ec225"><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>Implements the Domain Name System Networking for the FreeRTOS+TCP network stack. </p>
+</div><h2 class="groupheader">Function Documentation</h2>
+<a id="a998bd58d554c5c8ca8acb9583e9c6a77" name="a998bd58d554c5c8ca8acb9583e9c6a77"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a998bd58d554c5c8ca8acb9583e9c6a77">&#9670;&#160;</a></span>DNS_BindSocket()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">BaseType_t DNS_BindSocket </td>
+          <td>(</td>
+          <td class="paramtype">Socket_t&#160;</td>
+          <td class="paramname"><em>xSocket</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">uint16_t&#160;</td>
+          <td class="paramname"><em>usPort</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Bind the socket to a port number. </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramdir">[in]</td><td class="paramname">xSocket</td><td>the socket that must be bound. </td></tr>
+    <tr><td class="paramdir">[in]</td><td class="paramname">usPort</td><td>the port number to bind to. </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>The created socket - or NULL if the socket could not be created or could not be bound. </dd></dl>
+
+</div>
+</div>
+<a id="aa2e0265014529ef9a417612308bf2b5d" name="aa2e0265014529ef9a417612308bf2b5d"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aa2e0265014529ef9a417612308bf2b5d">&#9670;&#160;</a></span>DNS_CreateSocket()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">Socket_t DNS_CreateSocket </td>
+          <td>(</td>
+          <td class="paramtype">TickType_t&#160;</td>
+          <td class="paramname"><em>uxReadTimeOut_ticks</em></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Create a socket and bind it to the standard DNS port number. </p>
+<dl class="section return"><dt>Returns</dt><dd>The created socket - or NULL if the socket could not be created or could not be bound. </dd></dl>
+
+</div>
+</div>
+<a id="a89cfa1f2a25312a01483f36e50265eb0" name="a89cfa1f2a25312a01483f36e50265eb0"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a89cfa1f2a25312a01483f36e50265eb0">&#9670;&#160;</a></span>DNS_SendRequest()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">BaseType_t DNS_SendRequest </td>
+          <td>(</td>
+          <td class="paramtype">Socket_t&#160;</td>
+          <td class="paramname"><em>xDNSSocket</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const <a class="el" href="structstruct.html">struct</a> freertos_sockaddr *&#160;</td>
+          <td class="paramname"><em>xAddress</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">const <a class="el" href="structstruct.html">struct</a> xDNSBuffer *&#160;</td>
+          <td class="paramname"><em>pxDNSBuf</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>perform a DNS network request </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">xDNSSocket</td><td>Created socket </td></tr>
+    <tr><td class="paramname">xAddress</td><td>address structure (ip, port etc) </td></tr>
+    <tr><td class="paramname">pxDNSBuf</td><td>buffer to send </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>xReturn: true if the message could be sent false otherwise </dd></dl>
+
+</div>
+</div>
+<a id="a16c7cb7023cfa29b6aa5cfac6406ad78" name="a16c7cb7023cfa29b6aa5cfac6406ad78"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a16c7cb7023cfa29b6aa5cfac6406ad78">&#9670;&#160;</a></span>DNS_ReadReply()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">BaseType_t DNS_ReadReply </td>
+          <td>(</td>
+          <td class="paramtype">ConstSocket_t&#160;</td>
+          <td class="paramname"><em>xDNSSocket</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype"><a class="el" href="structstruct.html">struct</a> freertos_sockaddr *&#160;</td>
+          <td class="paramname"><em>xAddress</em>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype"><a class="el" href="structstruct.html">struct</a> xDNSBuffer *&#160;</td>
+          <td class="paramname"><em>pxReceiveBuffer</em>&#160;</td>
+        </tr>
+        <tr>
+          <td></td>
+          <td>)</td>
+          <td></td><td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>perform a DNS network read </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">xDNSSocket</td><td>socket </td></tr>
+    <tr><td class="paramname">xAddress</td><td>address to read from </td></tr>
+    <tr><td class="paramname">pxReceiveBuffer</td><td>buffer to fill with received data </td></tr>
+  </table>
+  </dd>
+</dl>
+
+</div>
+</div>
+<a id="ade7d8a2ebf3b318b01c68ceb0f6ec225" name="ade7d8a2ebf3b318b01c68ceb0f6ec225"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ade7d8a2ebf3b318b01c68ceb0f6ec225">&#9670;&#160;</a></span>DNS_CloseSocket()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">void DNS_CloseSocket </td>
+          <td>(</td>
+          <td class="paramtype">Socket_t&#160;</td>
+          <td class="paramname"><em>xDNSSocket</em></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>perform a DNS network close </p>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">xDNSSocket</td><td>the DNS socket to close </td></tr>
+  </table>
+  </dd>
+</dl>
+
+</div>
+</div>
+</div><!-- contents -->
+</div><!-- doc-content -->
+<!-- start footer part -->
+<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
+  <ul>
+    <li class="navelem"><a class="el" href="dir_b2f33c71d4aa5e7af42a1ca61ff5af1b.html">source</a></li><li class="navelem"><a class="el" href="_free_r_t_o_s___d_n_s___networking_8c.html">FreeRTOS_DNS_Networking.c</a></li>
+    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6 </li>
+  </ul>
+</div>
+</body>
+</html>