Skip to content

Commit f5b5a00

Browse files
chinglee-iotchinglee-iot
committed
Doxygen for ce947f1 
1 parent ffcb6d8 commit f5b5a00

File tree

264 files changed

+38561
-84
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

264 files changed

+38561
-84
lines changed

‎V4.2.2/_free_r_t_o_s___a_r_p_8c.html‎

Lines changed: 859 additions & 0 deletions
Large diffs are not rendered by default.

‎V4.2.2/_free_r_t_o_s___bit_config_8c.html‎

Lines changed: 567 additions & 0 deletions
Large diffs are not rendered by default.

‎V4.2.2/_free_r_t_o_s___d_h_c_p_8c.html‎

Lines changed: 919 additions & 0 deletions
Large diffs are not rendered by default.

‎V4.2.2/_free_r_t_o_s___d_h_c_pv6_8c.html‎

Lines changed: 991 additions & 0 deletions
Large diffs are not rendered by default.

‎V4.2.2/_free_r_t_o_s___d_n_s_8c.html‎

Lines changed: 1296 additions & 0 deletions
Large diffs are not rendered by default.

‎V4.2.2/_free_r_t_o_s___d_n_s___cache_8c.html‎

Lines changed: 718 additions & 0 deletions
Large diffs are not rendered by default.

‎V4.2.2/_free_r_t_o_s___d_n_s___callback_8c.html‎

Lines changed: 299 additions & 0 deletions
Large diffs are not rendered by default.

‎V4.2.2/_free_r_t_o_s___d_n_s___networking_8c.html‎

Lines changed: 316 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,316 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6+
<meta name="generator" content="Doxygen 1.9.6"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>FreeRTOS-Plus-TCP: FreeRTOS_DNS_Networking.c File Reference</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="navtree.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="resize.js"></script>
14+
<script type="text/javascript" src="navtreedata.js"></script>
15+
<script type="text/javascript" src="navtree.js"></script>
16+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
17+
<script type="text/javascript" src="search/searchdata.js"></script>
18+
<script type="text/javascript" src="search/search.js"></script>
19+
<script type="text/javascript">
20+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
21+
$(document).ready(function() { init_search(); });
22+
/* @license-end */
23+
</script>
24+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
25+
<link href="style.css" rel="stylesheet" type="text/css"/>
26+
</head>
27+
<body>
28+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
29+
<div id="titlearea">
30+
<table cellspacing="0" cellpadding="0">
31+
<tbody>
32+
<tr id="projectrow">
33+
<td id="projectalign">
34+
<div id="projectname">FreeRTOS-Plus-TCP<span id="projectnumber">&#160;V4.2.2</span>
35+
</div>
36+
<div id="projectbrief">FreeRTOS TCP/IP library</div>
37+
</td>
38+
<td> <div id="MSearchBox" class="MSearchBoxInactive">
39+
<span class="left">
40+
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
41+
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
42+
onfocus="searchBox.OnSearchFieldFocus(true)"
43+
onblur="searchBox.OnSearchFieldFocus(false)"
44+
onkeyup="searchBox.OnSearchFieldChange(event)"/>
45+
</span><span class="right">
46+
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
47+
</span>
48+
</div>
49+
</td>
50+
</tr>
51+
</tbody>
52+
</table>
53+
</div>
54+
<!-- end header part -->
55+
<!-- Generated by Doxygen 1.9.6 -->
56+
<script type="text/javascript">
57+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
58+
var searchBox = new SearchBox("searchBox", "search/",'.html');
59+
/* @license-end */
60+
</script>
61+
</div><!-- top -->
62+
<div id="side-nav" class="ui-resizable side-nav-resizable">
63+
<div id="nav-tree">
64+
<div id="nav-tree-contents">
65+
<div id="nav-sync" class="sync"></div>
66+
</div>
67+
</div>
68+
<div id="splitbar" style="-moz-user-select:none;"
69+
class="ui-resizable-handle">
70+
</div>
71+
</div>
72+
<script type="text/javascript">
73+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
74+
$(document).ready(function(){initNavTree('_free_r_t_o_s___d_n_s___networking_8c.html',''); initResizable(); });
75+
/* @license-end */
76+
</script>
77+
<div id="doc-content">
78+
<!-- window showing the filter options -->
79+
<div id="MSearchSelectWindow"
80+
onmouseover="return searchBox.OnSearchSelectShow()"
81+
onmouseout="return searchBox.OnSearchSelectHide()"
82+
onkeydown="return searchBox.OnSearchSelectKey(event)">
83+
</div>
84+
85+
<!-- iframe showing the search results (closed by default) -->
86+
<div id="MSearchResultsWindow">
87+
<div id="MSearchResults">
88+
<div class="SRPage">
89+
<div id="SRIndex">
90+
<div id="SRResults"></div>
91+
<div class="SRStatus" id="Loading">Loading...</div>
92+
<div class="SRStatus" id="Searching">Searching...</div>
93+
<div class="SRStatus" id="NoMatches">No Matches</div>
94+
</div>
95+
</div>
96+
</div>
97+
</div>
98+
99+
<div class="header">
100+
<div class="summary">
101+
<a href="#func-members">Functions</a> </div>
102+
<div class="headertitle"><div class="title">FreeRTOS_DNS_Networking.c File Reference</div></div>
103+
</div><!--header-->
104+
<div class="contents">
105+
106+
<p>Implements the Domain Name System Networking for the FreeRTOS+TCP network stack.
107+
<a href="#details">More...</a></p>
108+
<div class="textblock"><code>#include &quot;FreeRTOS.h&quot;</code><br />
109+
<code>#include &quot;FreeRTOS_DNS_Networking.h&quot;</code><br />
110+
</div><table class="memberdecls">
111+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
112+
Functions</h2></td></tr>
113+
<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>
114+
<tr class="memdesc:a998bd58d554c5c8ca8acb9583e9c6a77"><td class="mdescLeft">&#160;</td><td class="mdescRight">Bind the socket to a port number. <br /></td></tr>
115+
<tr class="separator:a998bd58d554c5c8ca8acb9583e9c6a77"><td class="memSeparator" colspan="2">&#160;</td></tr>
116+
<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>
117+
<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>
118+
<tr class="separator:aa2e0265014529ef9a417612308bf2b5d"><td class="memSeparator" colspan="2">&#160;</td></tr>
119+
<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>
120+
<tr class="memdesc:a89cfa1f2a25312a01483f36e50265eb0"><td class="mdescLeft">&#160;</td><td class="mdescRight">perform a DNS network request <br /></td></tr>
121+
<tr class="separator:a89cfa1f2a25312a01483f36e50265eb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
122+
<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>
123+
<tr class="memdesc:a16c7cb7023cfa29b6aa5cfac6406ad78"><td class="mdescLeft">&#160;</td><td class="mdescRight">perform a DNS network read <br /></td></tr>
124+
<tr class="separator:a16c7cb7023cfa29b6aa5cfac6406ad78"><td class="memSeparator" colspan="2">&#160;</td></tr>
125+
<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>
126+
<tr class="memdesc:ade7d8a2ebf3b318b01c68ceb0f6ec225"><td class="mdescLeft">&#160;</td><td class="mdescRight">perform a DNS network close <br /></td></tr>
127+
<tr class="separator:ade7d8a2ebf3b318b01c68ceb0f6ec225"><td class="memSeparator" colspan="2">&#160;</td></tr>
128+
</table>
129+
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
130+
<div class="textblock"><p>Implements the Domain Name System Networking for the FreeRTOS+TCP network stack. </p>
131+
</div><h2 class="groupheader">Function Documentation</h2>
132+
<a id="a998bd58d554c5c8ca8acb9583e9c6a77" name="a998bd58d554c5c8ca8acb9583e9c6a77"></a>
133+
<h2 class="memtitle"><span class="permalink"><a href="#a998bd58d554c5c8ca8acb9583e9c6a77">&#9670;&#160;</a></span>DNS_BindSocket()</h2>
134+
135+
<div class="memitem">
136+
<div class="memproto">
137+
<table class="memname">
138+
<tr>
139+
<td class="memname">BaseType_t DNS_BindSocket </td>
140+
<td>(</td>
141+
<td class="paramtype">Socket_t&#160;</td>
142+
<td class="paramname"><em>xSocket</em>, </td>
143+
</tr>
144+
<tr>
145+
<td class="paramkey"></td>
146+
<td></td>
147+
<td class="paramtype">uint16_t&#160;</td>
148+
<td class="paramname"><em>usPort</em>&#160;</td>
149+
</tr>
150+
<tr>
151+
<td></td>
152+
<td>)</td>
153+
<td></td><td></td>
154+
</tr>
155+
</table>
156+
</div><div class="memdoc">
157+
158+
<p>Bind the socket to a port number. </p>
159+
<dl class="params"><dt>Parameters</dt><dd>
160+
<table class="params">
161+
<tr><td class="paramdir">[in]</td><td class="paramname">xSocket</td><td>the socket that must be bound. </td></tr>
162+
<tr><td class="paramdir">[in]</td><td class="paramname">usPort</td><td>the port number to bind to. </td></tr>
163+
</table>
164+
</dd>
165+
</dl>
166+
<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>
167+
168+
</div>
169+
</div>
170+
<a id="aa2e0265014529ef9a417612308bf2b5d" name="aa2e0265014529ef9a417612308bf2b5d"></a>
171+
<h2 class="memtitle"><span class="permalink"><a href="#aa2e0265014529ef9a417612308bf2b5d">&#9670;&#160;</a></span>DNS_CreateSocket()</h2>
172+
173+
<div class="memitem">
174+
<div class="memproto">
175+
<table class="memname">
176+
<tr>
177+
<td class="memname">Socket_t DNS_CreateSocket </td>
178+
<td>(</td>
179+
<td class="paramtype">TickType_t&#160;</td>
180+
<td class="paramname"><em>uxReadTimeOut_ticks</em></td><td>)</td>
181+
<td></td>
182+
</tr>
183+
</table>
184+
</div><div class="memdoc">
185+
186+
<p>Create a socket and bind it to the standard DNS port number. </p>
187+
<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>
188+
189+
</div>
190+
</div>
191+
<a id="a89cfa1f2a25312a01483f36e50265eb0" name="a89cfa1f2a25312a01483f36e50265eb0"></a>
192+
<h2 class="memtitle"><span class="permalink"><a href="#a89cfa1f2a25312a01483f36e50265eb0">&#9670;&#160;</a></span>DNS_SendRequest()</h2>
193+
194+
<div class="memitem">
195+
<div class="memproto">
196+
<table class="memname">
197+
<tr>
198+
<td class="memname">BaseType_t DNS_SendRequest </td>
199+
<td>(</td>
200+
<td class="paramtype">Socket_t&#160;</td>
201+
<td class="paramname"><em>xDNSSocket</em>, </td>
202+
</tr>
203+
<tr>
204+
<td class="paramkey"></td>
205+
<td></td>
206+
<td class="paramtype">const <a class="el" href="structstruct.html">struct</a> freertos_sockaddr *&#160;</td>
207+
<td class="paramname"><em>xAddress</em>, </td>
208+
</tr>
209+
<tr>
210+
<td class="paramkey"></td>
211+
<td></td>
212+
<td class="paramtype">const <a class="el" href="structstruct.html">struct</a> xDNSBuffer *&#160;</td>
213+
<td class="paramname"><em>pxDNSBuf</em>&#160;</td>
214+
</tr>
215+
<tr>
216+
<td></td>
217+
<td>)</td>
218+
<td></td><td></td>
219+
</tr>
220+
</table>
221+
</div><div class="memdoc">
222+
223+
<p>perform a DNS network request </p>
224+
<dl class="params"><dt>Parameters</dt><dd>
225+
<table class="params">
226+
<tr><td class="paramname">xDNSSocket</td><td>Created socket </td></tr>
227+
<tr><td class="paramname">xAddress</td><td>address structure (ip, port etc) </td></tr>
228+
<tr><td class="paramname">pxDNSBuf</td><td>buffer to send </td></tr>
229+
</table>
230+
</dd>
231+
</dl>
232+
<dl class="section return"><dt>Returns</dt><dd>xReturn: true if the message could be sent false otherwise </dd></dl>
233+
234+
</div>
235+
</div>
236+
<a id="a16c7cb7023cfa29b6aa5cfac6406ad78" name="a16c7cb7023cfa29b6aa5cfac6406ad78"></a>
237+
<h2 class="memtitle"><span class="permalink"><a href="#a16c7cb7023cfa29b6aa5cfac6406ad78">&#9670;&#160;</a></span>DNS_ReadReply()</h2>
238+
239+
<div class="memitem">
240+
<div class="memproto">
241+
<table class="memname">
242+
<tr>
243+
<td class="memname">BaseType_t DNS_ReadReply </td>
244+
<td>(</td>
245+
<td class="paramtype">ConstSocket_t&#160;</td>
246+
<td class="paramname"><em>xDNSSocket</em>, </td>
247+
</tr>
248+
<tr>
249+
<td class="paramkey"></td>
250+
<td></td>
251+
<td class="paramtype"><a class="el" href="structstruct.html">struct</a> freertos_sockaddr *&#160;</td>
252+
<td class="paramname"><em>xAddress</em>, </td>
253+
</tr>
254+
<tr>
255+
<td class="paramkey"></td>
256+
<td></td>
257+
<td class="paramtype"><a class="el" href="structstruct.html">struct</a> xDNSBuffer *&#160;</td>
258+
<td class="paramname"><em>pxReceiveBuffer</em>&#160;</td>
259+
</tr>
260+
<tr>
261+
<td></td>
262+
<td>)</td>
263+
<td></td><td></td>
264+
</tr>
265+
</table>
266+
</div><div class="memdoc">
267+
268+
<p>perform a DNS network read </p>
269+
<dl class="params"><dt>Parameters</dt><dd>
270+
<table class="params">
271+
<tr><td class="paramname">xDNSSocket</td><td>socket </td></tr>
272+
<tr><td class="paramname">xAddress</td><td>address to read from </td></tr>
273+
<tr><td class="paramname">pxReceiveBuffer</td><td>buffer to fill with received data </td></tr>
274+
</table>
275+
</dd>
276+
</dl>
277+
278+
</div>
279+
</div>
280+
<a id="ade7d8a2ebf3b318b01c68ceb0f6ec225" name="ade7d8a2ebf3b318b01c68ceb0f6ec225"></a>
281+
<h2 class="memtitle"><span class="permalink"><a href="#ade7d8a2ebf3b318b01c68ceb0f6ec225">&#9670;&#160;</a></span>DNS_CloseSocket()</h2>
282+
283+
<div class="memitem">
284+
<div class="memproto">
285+
<table class="memname">
286+
<tr>
287+
<td class="memname">void DNS_CloseSocket </td>
288+
<td>(</td>
289+
<td class="paramtype">Socket_t&#160;</td>
290+
<td class="paramname"><em>xDNSSocket</em></td><td>)</td>
291+
<td></td>
292+
</tr>
293+
</table>
294+
</div><div class="memdoc">
295+
296+
<p>perform a DNS network close </p>
297+
<dl class="params"><dt>Parameters</dt><dd>
298+
<table class="params">
299+
<tr><td class="paramname">xDNSSocket</td><td>the DNS socket to close </td></tr>
300+
</table>
301+
</dd>
302+
</dl>
303+
304+
</div>
305+
</div>
306+
</div><!-- contents -->
307+
</div><!-- doc-content -->
308+
<!-- start footer part -->
309+
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
310+
<ul>
311+
<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>
312+
<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>
313+
</ul>
314+
</div>
315+
</body>
316+
</html>

0 commit comments

Comments
 (0)