1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> 3<title>uIP 1.0: uIP application functions</title> 4<link href="doxygen.css" rel="stylesheet" type="text/css"> 5<link href="tabs.css" rel="stylesheet" type="text/css"> 6</head><body> 7<!-- Generated by Doxygen 1.4.6 --> 8<div class="tabs"> 9 <ul> 10 <li><a href="main.html"><span>Main Page</span></a></li> 11 <li><a href="modules.html"><span>Modules</span></a></li> 12 <li><a href="classes.html"><span>Data Structures</span></a></li> 13 <li><a href="files.html"><span>Files</span></a></li> 14 <li><a href="examples.html"><span>Examples</span></a></li> 15 </ul></div> 16<h1>uIP application functions<br> 17<small> 18[<a class="el" href="a00150.html">The uIP TCP/IP stack</a>]</small> 19</h1><hr><a name="_details"></a><h2>Detailed Description</h2> 20Functions used by an application running of top of uIP. 21<p> 22 23<p> 24<table border="0" cellpadding="0" cellspacing="0"> 25<tr><td></td></tr> 26<tr><td colspan="2"><br><h2>Defines</h2></td></tr> 27<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gef14e83c046e19ab9fe9d1bbcca276c2"></a><!-- doxytag: member="uipappfunc::uip_outstanding" ref="gef14e83c046e19ab9fe9d1bbcca276c2" args="(conn)" --> 28#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00147.html#gef14e83c046e19ab9fe9d1bbcca276c2">uip_outstanding</a>(conn) ((conn)->len)</td></tr> 29 30<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00147.html#g1a1bc437c09ddef238abab41d77c3177">uip_datalen</a>()</td></tr> 31 32<tr><td class="mdescLeft"> </td><td class="mdescRight">The length of any incoming data that is currently avaliable (if avaliable) in the uip_appdata buffer. <a href="#g1a1bc437c09ddef238abab41d77c3177"></a><br></td></tr> 33<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00147.html#g8411c95a4d89367ad2d9d6bde1a3d537">uip_urgdatalen</a>()</td></tr> 34 35<tr><td class="mdescLeft"> </td><td class="mdescRight">The length of any out-of-band data (urgent data) that has arrived on the connection. <a href="#g8411c95a4d89367ad2d9d6bde1a3d537"></a><br></td></tr> 36<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00147.html#g61db1dcb7c760e4dd5d60bf4e5576dca">uip_close</a>()</td></tr> 37 38<tr><td class="mdescLeft"> </td><td class="mdescRight">Close the current connection. <a href="#g61db1dcb7c760e4dd5d60bf4e5576dca"></a><br></td></tr> 39<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00147.html#g88d2ccf7cd821f89d9a8df7e3948b56c">uip_abort</a>()</td></tr> 40 41<tr><td class="mdescLeft"> </td><td class="mdescRight">Abort the current connection. <a href="#g88d2ccf7cd821f89d9a8df7e3948b56c"></a><br></td></tr> 42<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00147.html#g0a8bb9d6d0f1f56852ccfccbbad6c5d8">uip_stop</a>()</td></tr> 43 44<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell the sending host to stop sending data. <a href="#g0a8bb9d6d0f1f56852ccfccbbad6c5d8"></a><br></td></tr> 45<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g64a238a5c02640a7a4aef004163aeb47"></a><!-- doxytag: member="uipappfunc::uip_stopped" ref="g64a238a5c02640a7a4aef004163aeb47" args="(conn)" --> 46#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00147.html#g64a238a5c02640a7a4aef004163aeb47">uip_stopped</a>(conn)</td></tr> 47 48<tr><td class="mdescLeft"> </td><td class="mdescRight">Find out if the current connection has been previously stopped with <a class="el" href="a00147.html#g0a8bb9d6d0f1f56852ccfccbbad6c5d8">uip_stop()</a>. <br></td></tr> 49<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00147.html#g81ac47cee1c18f6aa479044069db7ca3">uip_restart</a>()</td></tr> 50 51<tr><td class="mdescLeft"> </td><td class="mdescRight">Restart the current connection, if is has previously been stopped with <a class="el" href="a00147.html#g0a8bb9d6d0f1f56852ccfccbbad6c5d8">uip_stop()</a>. <a href="#g81ac47cee1c18f6aa479044069db7ca3"></a><br></td></tr> 52<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00147.html#ga9de254b8aa308eb4aab17efdde622d2">uip_udpconnection</a>()</td></tr> 53 54<tr><td class="mdescLeft"> </td><td class="mdescRight">Is the current connection a UDP connection? <a href="#ga9de254b8aa308eb4aab17efdde622d2"></a><br></td></tr> 55<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00147.html#g26a14b8dae3f861830af9e7cf1e03725">uip_newdata</a>()</td></tr> 56 57<tr><td class="mdescLeft"> </td><td class="mdescRight">Is new incoming data available? <a href="#g26a14b8dae3f861830af9e7cf1e03725"></a><br></td></tr> 58<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00147.html#gde6634974418e3240c212b9b16864368">uip_acked</a>()</td></tr> 59 60<tr><td class="mdescLeft"> </td><td class="mdescRight">Has previously sent data been acknowledged? <a href="#gde6634974418e3240c212b9b16864368"></a><br></td></tr> 61<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00147.html#gdb971fb1525d0c5002f52125b05f3218">uip_connected</a>()</td></tr> 62 63<tr><td class="mdescLeft"> </td><td class="mdescRight">Has the connection just been connected? <a href="#gdb971fb1525d0c5002f52125b05f3218"></a><br></td></tr> 64<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00147.html#gef6c4140c632b6a406779342cf3b6eb6">uip_closed</a>()</td></tr> 65 66<tr><td class="mdescLeft"> </td><td class="mdescRight">Has the connection been closed by the other end? <a href="#gef6c4140c632b6a406779342cf3b6eb6"></a><br></td></tr> 67<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00147.html#gfbd5fc486dfdf6bf6fc9db52b1f418c4">uip_aborted</a>()</td></tr> 68 69<tr><td class="mdescLeft"> </td><td class="mdescRight">Has the connection been aborted by the other end? <a href="#gfbd5fc486dfdf6bf6fc9db52b1f418c4"></a><br></td></tr> 70<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00147.html#g7b2ac4b18bd2ac3912fe67b3b17158c3">uip_timedout</a>()</td></tr> 71 72<tr><td class="mdescLeft"> </td><td class="mdescRight">Has the connection timed out? <a href="#g7b2ac4b18bd2ac3912fe67b3b17158c3"></a><br></td></tr> 73<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00147.html#ga8933ad15a2e2947dae4a5cff50e6007">uip_rexmit</a>()</td></tr> 74 75<tr><td class="mdescLeft"> </td><td class="mdescRight">Do we need to retransmit previously data? <a href="#ga8933ad15a2e2947dae4a5cff50e6007"></a><br></td></tr> 76<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00147.html#g58bb90796c1cdad3aac2ecf44d87b20e">uip_poll</a>()</td></tr> 77 78<tr><td class="mdescLeft"> </td><td class="mdescRight">Is the connection being polled by uIP? <a href="#g58bb90796c1cdad3aac2ecf44d87b20e"></a><br></td></tr> 79<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga87feebc7cffd4d8300e776cf64e4fec"></a><!-- doxytag: member="uipappfunc::uip_initialmss" ref="ga87feebc7cffd4d8300e776cf64e4fec" args="()" --> 80#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00147.html#ga87feebc7cffd4d8300e776cf64e4fec">uip_initialmss</a>()</td></tr> 81 82<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the initial maxium segment size (MSS) of the current connection. <br></td></tr> 83<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00147.html#gb5fecbc62edd128012cea0f47b57ab9f">uip_mss</a>()</td></tr> 84 85<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current maxium segment size that can be sent on the current connection. <a href="#gb5fecbc62edd128012cea0f47b57ab9f"></a><br></td></tr> 86<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00147.html#gf2dbaceb10c67783a115075b5b6d66df">uip_udp_remove</a>(conn)</td></tr> 87 88<tr><td class="mdescLeft"> </td><td class="mdescRight">Removed a UDP connection. <a href="#gf2dbaceb10c67783a115075b5b6d66df"></a><br></td></tr> 89<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00147.html#ga20812098a4663c8a9fc4ce8e95391b6">uip_udp_bind</a>(conn, port)</td></tr> 90 91<tr><td class="mdescLeft"> </td><td class="mdescRight">Bind a UDP connection to a local port. <a href="#ga20812098a4663c8a9fc4ce8e95391b6"></a><br></td></tr> 92<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00147.html#ge5ab69d40013e6cf86ef1763c95d920e">uip_udp_send</a>(len)</td></tr> 93 94<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a UDP datagram of length len on the current connection. <a href="#ge5ab69d40013e6cf86ef1763c95d920e"></a><br></td></tr> 95<tr><td colspan="2"><br><h2>Functions</h2></td></tr> 96<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00147.html#gdd1ab3704ecd4900eec61a6897d32dc8">uip_listen</a> (<a class="el" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> port)</td></tr> 97 98<tr><td class="mdescLeft"> </td><td class="mdescRight">Start listening to the specified port. <a href="#gdd1ab3704ecd4900eec61a6897d32dc8"></a><br></td></tr> 99<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00147.html#gaa585784b0914cac1d37f07f85457008">uip_unlisten</a> (<a class="el" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> port)</td></tr> 100 101<tr><td class="mdescLeft"> </td><td class="mdescRight">Stop listening to the specified port. <a href="#gaa585784b0914cac1d37f07f85457008"></a><br></td></tr> 102<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00088.html">uip_conn</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00147.html#g8096b0c4b543dc408f4dd031ddae7240">uip_connect</a> (<a class="el" href="a00150.html#g1ef35301f43a5bbb9f89f07b5a36b9a0">uip_ipaddr_t</a> *ripaddr, <a class="el" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> port)</td></tr> 103 104<tr><td class="mdescLeft"> </td><td class="mdescRight">Connect to a remote host using TCP. <a href="#g8096b0c4b543dc408f4dd031ddae7240"></a><br></td></tr> 105<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00147.html#g04b053a623aac7cd4195157d470661b3">uip_send</a> (const void *data, int len)</td></tr> 106 107<tr><td class="mdescLeft"> </td><td class="mdescRight">Send data on the current connection. <a href="#g04b053a623aac7cd4195157d470661b3"></a><br></td></tr> 108<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00095.html">uip_udp_conn</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00147.html#g79c4110211247df3fb30b8cf1c4c02af">uip_udp_new</a> (<a class="el" href="a00150.html#g1ef35301f43a5bbb9f89f07b5a36b9a0">uip_ipaddr_t</a> *ripaddr, <a class="el" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> rport)</td></tr> 109 110<tr><td class="mdescLeft"> </td><td class="mdescRight">Set up a new UDP connection. <a href="#g79c4110211247df3fb30b8cf1c4c02af"></a><br></td></tr> 111</table> 112<hr><h2>Define Documentation</h2> 113<a class="anchor" name="g88d2ccf7cd821f89d9a8df7e3948b56c"></a><!-- doxytag: member="uip.h::uip_abort" ref="g88d2ccf7cd821f89d9a8df7e3948b56c" args="()" --><p> 114<table class="mdTable" cellpadding="2" cellspacing="0"> 115 <tr> 116 <td class="mdRow"> 117 <table cellpadding="0" cellspacing="0" border="0"> 118 <tr> 119 <td class="md" nowrap valign="top">#define uip_abort </td> 120 <td class="md" valign="top">( </td> 121 </td> 122 <td class="mdname1" valign="top" nowrap> </td> 123 <td class="md" valign="top"> ) </td> 124 <td class="md" nowrap></td> 125 </tr> 126 </table> 127 </td> 128 </tr> 129</table> 130<table cellspacing="5" cellpadding="0" border="0"> 131 <tr> 132 <td> 133 134 </td> 135 <td> 136 137<p> 138Abort the current connection. 139<p> 140This function will abort (reset) the current connection, and is usually used when an error has occured that prevents using the <a class="el" href="a00147.html#g61db1dcb7c760e4dd5d60bf4e5576dca">uip_close()</a> function. <dl compact><dt><b>Examples: </b></dt><dd> 141<a class="el" href="a00040.html#a285">webclient.c</a>.</dl> 142<p> 143Definition at line <a class="el" href="a00202.html#l00581">581</a> of file <a class="el" href="a00202.html">uip.h</a>. 144<p> 145Referenced by <a class="el" href="a00184.html#l00298">httpd_appcall()</a>, and <a class="el" href="a00180.html#l00378">webclient_appcall()</a>. </td> 146 </tr> 147</table> 148<a class="anchor" name="gfbd5fc486dfdf6bf6fc9db52b1f418c4"></a><!-- doxytag: member="uip.h::uip_aborted" ref="gfbd5fc486dfdf6bf6fc9db52b1f418c4" args="()" --><p> 149<table class="mdTable" cellpadding="2" cellspacing="0"> 150 <tr> 151 <td class="mdRow"> 152 <table cellpadding="0" cellspacing="0" border="0"> 153 <tr> 154 <td class="md" nowrap valign="top">#define uip_aborted </td> 155 <td class="md" valign="top">( </td> 156 </td> 157 <td class="mdname1" valign="top" nowrap> </td> 158 <td class="md" valign="top"> ) </td> 159 <td class="md" nowrap></td> 160 </tr> 161 </table> 162 </td> 163 </tr> 164</table> 165<table cellspacing="5" cellpadding="0" border="0"> 166 <tr> 167 <td> 168 169 </td> 170 <td> 171 172<p> 173Has the connection been aborted by the other end? 174<p> 175Non-zero if the current connection has been aborted (reset) by the remote host. <dl compact><dt><b>Examples: </b></dt><dd> 176<a class="el" href="a00038.html#a185">smtp.c</a>, <a class="el" href="a00044.html#a236">telnetd.c</a>, and <a class="el" href="a00040.html#a297">webclient.c</a>.</dl> 177<p> 178Definition at line <a class="el" href="a00202.html#l00680">680</a> of file <a class="el" href="a00202.html">uip.h</a>. 179<p> 180Referenced by <a class="el" href="a00184.html#l00298">httpd_appcall()</a>, <a class="el" href="a00174.html#l00190">smtp_appcall()</a>, and <a class="el" href="a00180.html#l00378">webclient_appcall()</a>. </td> 181 </tr> 182</table> 183<a class="anchor" name="gde6634974418e3240c212b9b16864368"></a><!-- doxytag: member="uip.h::uip_acked" ref="gde6634974418e3240c212b9b16864368" args="()" --><p> 184<table class="mdTable" cellpadding="2" cellspacing="0"> 185 <tr> 186 <td class="mdRow"> 187 <table cellpadding="0" cellspacing="0" border="0"> 188 <tr> 189 <td class="md" nowrap valign="top">#define uip_acked </td> 190 <td class="md" valign="top">( </td> 191 </td> 192 <td class="mdname1" valign="top" nowrap> </td> 193 <td class="md" valign="top"> ) </td> 194 <td class="md" nowrap></td> 195 </tr> 196 </table> 197 </td> 198 </tr> 199</table> 200<table cellspacing="5" cellpadding="0" border="0"> 201 <tr> 202 <td> 203 204 </td> 205 <td> 206 207<p> 208Has previously sent data been acknowledged? 209<p> 210Will reduce to non-zero if the previously sent data has been acknowledged by the remote host. This means that the application can send new data. <dl compact><dt><b>Examples: </b></dt><dd> 211<a class="el" href="a00044.html#a238">telnetd.c</a>, and <a class="el" href="a00040.html#a300">webclient.c</a>.</dl> 212<p> 213Definition at line <a class="el" href="a00202.html#l00648">648</a> of file <a class="el" href="a00202.html">uip.h</a>. 214<p> 215Referenced by <a class="el" href="a00180.html#l00378">webclient_appcall()</a>. </td> 216 </tr> 217</table> 218<a class="anchor" name="g61db1dcb7c760e4dd5d60bf4e5576dca"></a><!-- doxytag: member="uip.h::uip_close" ref="g61db1dcb7c760e4dd5d60bf4e5576dca" args="()" --><p> 219<table class="mdTable" cellpadding="2" cellspacing="0"> 220 <tr> 221 <td class="mdRow"> 222 <table cellpadding="0" cellspacing="0" border="0"> 223 <tr> 224 <td class="md" nowrap valign="top">#define uip_close </td> 225 <td class="md" valign="top">( </td> 226 </td> 227 <td class="mdname1" valign="top" nowrap> </td> 228 <td class="md" valign="top"> ) </td> 229 <td class="md" nowrap></td> 230 </tr> 231 </table> 232 </td> 233 </tr> 234</table> 235<table cellspacing="5" cellpadding="0" border="0"> 236 <tr> 237 <td> 238 239 </td> 240 <td> 241 242<p> 243Close the current connection. 244<p> 245This function will close the current connection in a nice way. <dl compact><dt><b>Examples: </b></dt><dd> 246<a class="el" href="a00044.html#a234">telnetd.c</a>.</dl> 247<p> 248Definition at line <a class="el" href="a00202.html#l00570">570</a> of file <a class="el" href="a00202.html">uip.h</a>. </td> 249 </tr> 250</table> 251<a class="anchor" name="gef6c4140c632b6a406779342cf3b6eb6"></a><!-- doxytag: member="uip.h::uip_closed" ref="gef6c4140c632b6a406779342cf3b6eb6" args="()" --><p> 252<table class="mdTable" cellpadding="2" cellspacing="0"> 253 <tr> 254 <td class="mdRow"> 255 <table cellpadding="0" cellspacing="0" border="0"> 256 <tr> 257 <td class="md" nowrap valign="top">#define uip_closed </td> 258 <td class="md" valign="top">( </td> 259 </td> 260 <td class="mdname1" valign="top" nowrap> </td> 261 <td class="md" valign="top"> ) </td> 262 <td class="md" nowrap></td> 263 </tr> 264 </table> 265 </td> 266 </tr> 267</table> 268<table cellspacing="5" cellpadding="0" border="0"> 269 <tr> 270 <td> 271 272 </td> 273 <td> 274 275<p> 276Has the connection been closed by the other end? 277<p> 278Is non-zero if the connection has been closed by the remote host. The application may then do the necessary clean-ups. <dl compact><dt><b>Examples: </b></dt><dd> 279<a class="el" href="a00038.html#a184">smtp.c</a>, <a class="el" href="a00044.html#a235">telnetd.c</a>, and <a class="el" href="a00040.html#a305">webclient.c</a>.</dl> 280<p> 281Definition at line <a class="el" href="a00202.html#l00670">670</a> of file <a class="el" href="a00202.html">uip.h</a>. 282<p> 283Referenced by <a class="el" href="a00184.html#l00298">httpd_appcall()</a>, <a class="el" href="a00174.html#l00190">smtp_appcall()</a>, and <a class="el" href="a00180.html#l00378">webclient_appcall()</a>. </td> 284 </tr> 285</table> 286<a class="anchor" name="gdb971fb1525d0c5002f52125b05f3218"></a><!-- doxytag: member="uip.h::uip_connected" ref="gdb971fb1525d0c5002f52125b05f3218" args="()" --><p> 287<table class="mdTable" cellpadding="2" cellspacing="0"> 288 <tr> 289 <td class="mdRow"> 290 <table cellpadding="0" cellspacing="0" border="0"> 291 <tr> 292 <td class="md" nowrap valign="top">#define uip_connected </td> 293 <td class="md" valign="top">( </td> 294 </td> 295 <td class="mdname1" valign="top" nowrap> </td> 296 <td class="md" valign="top"> ) </td> 297 <td class="md" nowrap></td> 298 </tr> 299 </table> 300 </td> 301 </tr> 302</table> 303<table cellspacing="5" cellpadding="0" border="0"> 304 <tr> 305 <td> 306 307 </td> 308 <td> 309 310<p> 311Has the connection just been connected? 312<p> 313Reduces to non-zero if the current connection has been connected to a remote host. This will happen both if the connection has been actively opened (with <a class="el" href="a00147.html#g8096b0c4b543dc408f4dd031ddae7240">uip_connect()</a>) or passively opened (with <a class="el" href="a00147.html#gdd1ab3704ecd4900eec61a6897d32dc8">uip_listen()</a>). <dl compact><dt><b>Examples: </b></dt><dd> 314<a class="el" href="a00036.html#a107">hello-world.c</a>, <a class="el" href="a00044.html#a232">telnetd.c</a>, and <a class="el" href="a00040.html#a293">webclient.c</a>.</dl> 315<p> 316Definition at line <a class="el" href="a00202.html#l00660">660</a> of file <a class="el" href="a00202.html">uip.h</a>. 317<p> 318Referenced by <a class="el" href="a00170.html#l00055">hello_world_appcall()</a>, <a class="el" href="a00184.html#l00298">httpd_appcall()</a>, and <a class="el" href="a00180.html#l00378">webclient_appcall()</a>. </td> 319 </tr> 320</table> 321<a class="anchor" name="g1a1bc437c09ddef238abab41d77c3177"></a><!-- doxytag: member="uip.h::uip_datalen" ref="g1a1bc437c09ddef238abab41d77c3177" args="()" --><p> 322<table class="mdTable" cellpadding="2" cellspacing="0"> 323 <tr> 324 <td class="mdRow"> 325 <table cellpadding="0" cellspacing="0" border="0"> 326 <tr> 327 <td class="md" nowrap valign="top">#define uip_datalen </td> 328 <td class="md" valign="top">( </td> 329 </td> 330 <td class="mdname1" valign="top" nowrap> </td> 331 <td class="md" valign="top"> ) </td> 332 <td class="md" nowrap></td> 333 </tr> 334 </table> 335 </td> 336 </tr> 337</table> 338<table cellspacing="5" cellpadding="0" border="0"> 339 <tr> 340 <td> 341 342 </td> 343 <td> 344 345<p> 346The length of any incoming data that is currently avaliable (if avaliable) in the uip_appdata buffer. 347<p> 348The test function uip_data() must first be used to check if there is any data available at all. <dl compact><dt><b>Examples: </b></dt><dd> 349<a class="el" href="a00048.html#a15">dhcpc.c</a>, <a class="el" href="a00044.html#a231">telnetd.c</a>, and <a class="el" href="a00040.html#a290">webclient.c</a>.</dl> 350<p> 351Definition at line <a class="el" href="a00202.html#l00550">550</a> of file <a class="el" href="a00202.html">uip.h</a>. </td> 352 </tr> 353</table> 354<a class="anchor" name="gb5fecbc62edd128012cea0f47b57ab9f"></a><!-- doxytag: member="uip.h::uip_mss" ref="gb5fecbc62edd128012cea0f47b57ab9f" args="()" --><p> 355<table class="mdTable" cellpadding="2" cellspacing="0"> 356 <tr> 357 <td class="mdRow"> 358 <table cellpadding="0" cellspacing="0" border="0"> 359 <tr> 360 <td class="md" nowrap valign="top">#define uip_mss </td> 361 <td class="md" valign="top">( </td> 362 </td> 363 <td class="mdname1" valign="top" nowrap> </td> 364 <td class="md" valign="top"> ) </td> 365 <td class="md" nowrap></td> 366 </tr> 367 </table> 368 </td> 369 </tr> 370</table> 371<table cellspacing="5" cellpadding="0" border="0"> 372 <tr> 373 <td> 374 375 </td> 376 <td> 377 378<p> 379Get the current maxium segment size that can be sent on the current connection. 380<p> 381The current maxiumum segment size that can be sent on the connection is computed from the receiver's window and the MSS of the connection (which also is available by calling <a class="el" href="a00147.html#ga87feebc7cffd4d8300e776cf64e4fec">uip_initialmss()</a>). <dl compact><dt><b>Examples: </b></dt><dd> 382<a class="el" href="a00044.html#a225">telnetd.c</a>, and <a class="el" href="a00040.html#a277">webclient.c</a>.</dl> 383<p> 384Definition at line <a class="el" href="a00202.html#l00737">737</a> of file <a class="el" href="a00202.html">uip.h</a>. </td> 385 </tr> 386</table> 387<a class="anchor" name="g26a14b8dae3f861830af9e7cf1e03725"></a><!-- doxytag: member="uip.h::uip_newdata" ref="g26a14b8dae3f861830af9e7cf1e03725" args="()" --><p> 388<table class="mdTable" cellpadding="2" cellspacing="0"> 389 <tr> 390 <td class="mdRow"> 391 <table cellpadding="0" cellspacing="0" border="0"> 392 <tr> 393 <td class="md" nowrap valign="top">#define uip_newdata </td> 394 <td class="md" valign="top">( </td> 395 </td> 396 <td class="mdname1" valign="top" nowrap> </td> 397 <td class="md" valign="top"> ) </td> 398 <td class="md" nowrap></td> 399 </tr> 400 </table> 401 </td> 402 </tr> 403</table> 404<table cellspacing="5" cellpadding="0" border="0"> 405 <tr> 406 <td> 407 408 </td> 409 <td> 410 411<p> 412Is new incoming data available? 413<p> 414Will reduce to non-zero if there is new data for the application present at the uip_appdata pointer. The size of the data is avaliable through the uip_len variable. <dl compact><dt><b>Examples: </b></dt><dd> 415<a class="el" href="a00048.html#a25">dhcpc.c</a>, <a class="el" href="a00046.html#a145">resolv.c</a>, <a class="el" href="a00044.html#a239">telnetd.c</a>, and <a class="el" href="a00040.html#a301">webclient.c</a>.</dl> 416<p> 417Definition at line <a class="el" href="a00202.html#l00637">637</a> of file <a class="el" href="a00202.html">uip.h</a>. 418<p> 419Referenced by <a class="el" href="a00192.html#l00253">psock_newdata()</a>, <a class="el" href="a00172.html#l00331">resolv_appcall()</a>, and <a class="el" href="a00180.html#l00378">webclient_appcall()</a>. </td> 420 </tr> 421</table> 422<a class="anchor" name="g58bb90796c1cdad3aac2ecf44d87b20e"></a><!-- doxytag: member="uip.h::uip_poll" ref="g58bb90796c1cdad3aac2ecf44d87b20e" args="()" --><p> 423<table class="mdTable" cellpadding="2" cellspacing="0"> 424 <tr> 425 <td class="mdRow"> 426 <table cellpadding="0" cellspacing="0" border="0"> 427 <tr> 428 <td class="md" nowrap valign="top">#define uip_poll </td> 429 <td class="md" valign="top">( </td> 430 </td> 431 <td class="mdname1" valign="top" nowrap> </td> 432 <td class="md" valign="top"> ) </td> 433 <td class="md" nowrap></td> 434 </tr> 435 </table> 436 </td> 437 </tr> 438</table> 439<table cellspacing="5" cellpadding="0" border="0"> 440 <tr> 441 <td> 442 443 </td> 444 <td> 445 446<p> 447Is the connection being polled by uIP? 448<p> 449Is non-zero if the reason the application is invoked is that the current connection has been idle for a while and should be polled.<p> 450The polling event can be used for sending data without having to wait for the remote host to send data. <dl compact><dt><b>Examples: </b></dt><dd> 451<a class="el" href="a00046.html#a144">resolv.c</a>, <a class="el" href="a00044.html#a241">telnetd.c</a>, and <a class="el" href="a00040.html#a303">webclient.c</a>.</dl> 452<p> 453Definition at line <a class="el" href="a00202.html#l00716">716</a> of file <a class="el" href="a00202.html">uip.h</a>. 454<p> 455Referenced by <a class="el" href="a00184.html#l00298">httpd_appcall()</a>, <a class="el" href="a00172.html#l00331">resolv_appcall()</a>, and <a class="el" href="a00180.html#l00378">webclient_appcall()</a>. </td> 456 </tr> 457</table> 458<a class="anchor" name="g81ac47cee1c18f6aa479044069db7ca3"></a><!-- doxytag: member="uip.h::uip_restart" ref="g81ac47cee1c18f6aa479044069db7ca3" args="()" --><p> 459<table class="mdTable" cellpadding="2" cellspacing="0"> 460 <tr> 461 <td class="mdRow"> 462 <table cellpadding="0" cellspacing="0" border="0"> 463 <tr> 464 <td class="md" nowrap valign="top">#define uip_restart </td> 465 <td class="md" valign="top">( </td> 466 </td> 467 <td class="mdname1" valign="top" nowrap> </td> 468 <td class="md" valign="top"> ) </td> 469 <td class="md" nowrap></td> 470 </tr> 471 </table> 472 </td> 473 </tr> 474</table> 475<table cellspacing="5" cellpadding="0" border="0"> 476 <tr> 477 <td> 478 479 </td> 480 <td> 481 482<p> 483Restart the current connection, if is has previously been stopped with <a class="el" href="a00147.html#g0a8bb9d6d0f1f56852ccfccbbad6c5d8">uip_stop()</a>. 484<p> 485This function will open the receiver's window again so that we start receiving data for the current connection. 486<p> 487Definition at line <a class="el" href="a00202.html#l00610">610</a> of file <a class="el" href="a00202.html">uip.h</a>. </td> 488 </tr> 489</table> 490<a class="anchor" name="ga8933ad15a2e2947dae4a5cff50e6007"></a><!-- doxytag: member="uip.h::uip_rexmit" ref="ga8933ad15a2e2947dae4a5cff50e6007" args="()" --><p> 491<table class="mdTable" cellpadding="2" cellspacing="0"> 492 <tr> 493 <td class="mdRow"> 494 <table cellpadding="0" cellspacing="0" border="0"> 495 <tr> 496 <td class="md" nowrap valign="top">#define uip_rexmit </td> 497 <td class="md" valign="top">( </td> 498 </td> 499 <td class="mdname1" valign="top" nowrap> </td> 500 <td class="md" valign="top"> ) </td> 501 <td class="md" nowrap></td> 502 </tr> 503 </table> 504 </td> 505 </tr> 506</table> 507<table cellspacing="5" cellpadding="0" border="0"> 508 <tr> 509 <td> 510 511 </td> 512 <td> 513 514<p> 515Do we need to retransmit previously data? 516<p> 517Reduces to non-zero if the previously sent data has been lost in the network, and the application should retransmit it. The application should send the exact same data as it did the last time, using the <a class="el" href="a00147.html#g04b053a623aac7cd4195157d470661b3">uip_send()</a> function. <dl compact><dt><b>Examples: </b></dt><dd> 518<a class="el" href="a00044.html#a240">telnetd.c</a>, and <a class="el" href="a00040.html#a302">webclient.c</a>.</dl> 519<p> 520Definition at line <a class="el" href="a00202.html#l00702">702</a> of file <a class="el" href="a00202.html">uip.h</a>. 521<p> 522Referenced by <a class="el" href="a00180.html#l00378">webclient_appcall()</a>. </td> 523 </tr> 524</table> 525<a class="anchor" name="g0a8bb9d6d0f1f56852ccfccbbad6c5d8"></a><!-- doxytag: member="uip.h::uip_stop" ref="g0a8bb9d6d0f1f56852ccfccbbad6c5d8" args="()" --><p> 526<table class="mdTable" cellpadding="2" cellspacing="0"> 527 <tr> 528 <td class="mdRow"> 529 <table cellpadding="0" cellspacing="0" border="0"> 530 <tr> 531 <td class="md" nowrap valign="top">#define uip_stop </td> 532 <td class="md" valign="top">( </td> 533 </td> 534 <td class="mdname1" valign="top" nowrap> </td> 535 <td class="md" valign="top"> ) </td> 536 <td class="md" nowrap></td> 537 </tr> 538 </table> 539 </td> 540 </tr> 541</table> 542<table cellspacing="5" cellpadding="0" border="0"> 543 <tr> 544 <td> 545 546 </td> 547 <td> 548 549<p> 550Tell the sending host to stop sending data. 551<p> 552This function will close our receiver's window so that we stop receiving data for the current connection. 553<p> 554Definition at line <a class="el" href="a00202.html#l00591">591</a> of file <a class="el" href="a00202.html">uip.h</a>. </td> 555 </tr> 556</table> 557<a class="anchor" name="g7b2ac4b18bd2ac3912fe67b3b17158c3"></a><!-- doxytag: member="uip.h::uip_timedout" ref="g7b2ac4b18bd2ac3912fe67b3b17158c3" args="()" --><p> 558<table class="mdTable" cellpadding="2" cellspacing="0"> 559 <tr> 560 <td class="mdRow"> 561 <table cellpadding="0" cellspacing="0" border="0"> 562 <tr> 563 <td class="md" nowrap valign="top">#define uip_timedout </td> 564 <td class="md" valign="top">( </td> 565 </td> 566 <td class="mdname1" valign="top" nowrap> </td> 567 <td class="md" valign="top"> ) </td> 568 <td class="md" nowrap></td> 569 </tr> 570 </table> 571 </td> 572 </tr> 573</table> 574<table cellspacing="5" cellpadding="0" border="0"> 575 <tr> 576 <td> 577 578 </td> 579 <td> 580 581<p> 582Has the connection timed out? 583<p> 584Non-zero if the current connection has been aborted due to too many retransmissions. <dl compact><dt><b>Examples: </b></dt><dd> 585<a class="el" href="a00038.html#a186">smtp.c</a>, <a class="el" href="a00044.html#a237">telnetd.c</a>, and <a class="el" href="a00040.html#a298">webclient.c</a>.</dl> 586<p> 587Definition at line <a class="el" href="a00202.html#l00690">690</a> of file <a class="el" href="a00202.html">uip.h</a>. 588<p> 589Referenced by <a class="el" href="a00184.html#l00298">httpd_appcall()</a>, <a class="el" href="a00174.html#l00190">smtp_appcall()</a>, and <a class="el" href="a00180.html#l00378">webclient_appcall()</a>. </td> 590 </tr> 591</table> 592<a class="anchor" name="ga20812098a4663c8a9fc4ce8e95391b6"></a><!-- doxytag: member="uip.h::uip_udp_bind" ref="ga20812098a4663c8a9fc4ce8e95391b6" args="(conn, port)" --><p> 593<table class="mdTable" cellpadding="2" cellspacing="0"> 594 <tr> 595 <td class="mdRow"> 596 <table cellpadding="0" cellspacing="0" border="0"> 597 <tr> 598 <td class="md" nowrap valign="top">#define uip_udp_bind </td> 599 <td class="md" valign="top">( </td> 600 <td class="md" nowrap valign="top">conn, <tr> 601 <td class="md" nowrap align="right"></td> 602 <td class="md"></td> 603 <td class="md" nowrap>port </td> 604 <td class="mdname1" valign="top" nowrap> </td> 605 <td class="md" valign="top"> ) </td> 606 <td class="md" nowrap></td> 607 </tr> 608 </table> 609 </td> 610 </tr> 611</table> 612<table cellspacing="5" cellpadding="0" border="0"> 613 <tr> 614 <td> 615 616 </td> 617 <td> 618 619<p> 620Bind a UDP connection to a local port. 621<p> 622<dl compact><dt><b>Parameters:</b></dt><dd> 623 <table border="0" cellspacing="2" cellpadding="0"> 624 <tr><td valign="top"></td><td valign="top"><em>conn</em> </td><td>A pointer to the <a class="el" href="a00095.html">uip_udp_conn</a> structure for the connection.</td></tr> 625 <tr><td valign="top"></td><td valign="top"><em>port</em> </td><td>The local port number, in network byte order. </td></tr> 626 </table> 627</dl> 628<dl compact><dt><b>Examples: </b></dt><dd> 629<a class="el" href="a00048.html#a40">dhcpc.c</a>.</dl> 630<p> 631Definition at line <a class="el" href="a00202.html#l00787">787</a> of file <a class="el" href="a00202.html">uip.h</a>. </td> 632 </tr> 633</table> 634<a class="anchor" name="gf2dbaceb10c67783a115075b5b6d66df"></a><!-- doxytag: member="uip.h::uip_udp_remove" ref="gf2dbaceb10c67783a115075b5b6d66df" args="(conn)" --><p> 635<table class="mdTable" cellpadding="2" cellspacing="0"> 636 <tr> 637 <td class="mdRow"> 638 <table cellpadding="0" cellspacing="0" border="0"> 639 <tr> 640 <td class="md" nowrap valign="top">#define uip_udp_remove </td> 641 <td class="md" valign="top">( </td> 642 <td class="md" nowrap valign="top">conn </td> 643 <td class="mdname1" valign="top" nowrap> </td> 644 <td class="md" valign="top"> ) </td> 645 <td class="md" nowrap></td> 646 </tr> 647 </table> 648 </td> 649 </tr> 650</table> 651<table cellspacing="5" cellpadding="0" border="0"> 652 <tr> 653 <td> 654 655 </td> 656 <td> 657 658<p> 659Removed a UDP connection. 660<p> 661<dl compact><dt><b>Parameters:</b></dt><dd> 662 <table border="0" cellspacing="2" cellpadding="0"> 663 <tr><td valign="top"></td><td valign="top"><em>conn</em> </td><td>A pointer to the <a class="el" href="a00095.html">uip_udp_conn</a> structure for the connection. </td></tr> 664 </table> 665</dl> 666<dl compact><dt><b>Examples: </b></dt><dd> 667<a class="el" href="a00046.html#a152">resolv.c</a>.</dl> 668<p> 669Definition at line <a class="el" href="a00202.html#l00775">775</a> of file <a class="el" href="a00202.html">uip.h</a>. 670<p> 671Referenced by <a class="el" href="a00172.html#l00438">resolv_conf()</a>. </td> 672 </tr> 673</table> 674<a class="anchor" name="ge5ab69d40013e6cf86ef1763c95d920e"></a><!-- doxytag: member="uip.h::uip_udp_send" ref="ge5ab69d40013e6cf86ef1763c95d920e" args="(len)" --><p> 675<table class="mdTable" cellpadding="2" cellspacing="0"> 676 <tr> 677 <td class="mdRow"> 678 <table cellpadding="0" cellspacing="0" border="0"> 679 <tr> 680 <td class="md" nowrap valign="top">#define uip_udp_send </td> 681 <td class="md" valign="top">( </td> 682 <td class="md" nowrap valign="top">len </td> 683 <td class="mdname1" valign="top" nowrap> </td> 684 <td class="md" valign="top"> ) </td> 685 <td class="md" nowrap></td> 686 </tr> 687 </table> 688 </td> 689 </tr> 690</table> 691<table cellspacing="5" cellpadding="0" border="0"> 692 <tr> 693 <td> 694 695 </td> 696 <td> 697 698<p> 699Send a UDP datagram of length len on the current connection. 700<p> 701This function can only be called in response to a UDP event (poll or newdata). The data must be present in the uip_buf buffer, at the place pointed to by the uip_appdata pointer.<p> 702<dl compact><dt><b>Parameters:</b></dt><dd> 703 <table border="0" cellspacing="2" cellpadding="0"> 704 <tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>The length of the data in the uip_buf buffer. </td></tr> 705 </table> 706</dl> 707<dl compact><dt><b>Examples: </b></dt><dd> 708<a class="el" href="a00046.html#a140">resolv.c</a>.</dl> 709<p> 710Definition at line <a class="el" href="a00202.html#l00800">800</a> of file <a class="el" href="a00202.html">uip.h</a>. </td> 711 </tr> 712</table> 713<a class="anchor" name="ga9de254b8aa308eb4aab17efdde622d2"></a><!-- doxytag: member="uip.h::uip_udpconnection" ref="ga9de254b8aa308eb4aab17efdde622d2" args="()" --><p> 714<table class="mdTable" cellpadding="2" cellspacing="0"> 715 <tr> 716 <td class="mdRow"> 717 <table cellpadding="0" cellspacing="0" border="0"> 718 <tr> 719 <td class="md" nowrap valign="top">#define uip_udpconnection </td> 720 <td class="md" valign="top">( </td> 721 </td> 722 <td class="mdname1" valign="top" nowrap> </td> 723 <td class="md" valign="top"> ) </td> 724 <td class="md" nowrap></td> 725 </tr> 726 </table> 727 </td> 728 </tr> 729</table> 730<table cellspacing="5" cellpadding="0" border="0"> 731 <tr> 732 <td> 733 734 </td> 735 <td> 736 737<p> 738Is the current connection a UDP connection? 739<p> 740This function checks whether the current connection is a UDP connection. 741<p> 742Definition at line <a class="el" href="a00202.html#l00626">626</a> of file <a class="el" href="a00202.html">uip.h</a>. </td> 743 </tr> 744</table> 745<a class="anchor" name="g8411c95a4d89367ad2d9d6bde1a3d537"></a><!-- doxytag: member="uip.h::uip_urgdatalen" ref="g8411c95a4d89367ad2d9d6bde1a3d537" args="()" --><p> 746<table class="mdTable" cellpadding="2" cellspacing="0"> 747 <tr> 748 <td class="mdRow"> 749 <table cellpadding="0" cellspacing="0" border="0"> 750 <tr> 751 <td class="md" nowrap valign="top">#define uip_urgdatalen </td> 752 <td class="md" valign="top">( </td> 753 </td> 754 <td class="mdname1" valign="top" nowrap> </td> 755 <td class="md" valign="top"> ) </td> 756 <td class="md" nowrap></td> 757 </tr> 758 </table> 759 </td> 760 </tr> 761</table> 762<table cellspacing="5" cellpadding="0" border="0"> 763 <tr> 764 <td> 765 766 </td> 767 <td> 768 769<p> 770The length of any out-of-band data (urgent data) that has arrived on the connection. 771<p> 772<dl compact><dt><b>Note:</b></dt><dd>The configuration parameter UIP_URGDATA must be set for this function to be enabled. </dd></dl> 773 774<p> 775Definition at line <a class="el" href="a00202.html#l00561">561</a> of file <a class="el" href="a00202.html">uip.h</a>. </td> 776 </tr> 777</table> 778<hr><h2>Function Documentation</h2> 779<a class="anchor" name="g8096b0c4b543dc408f4dd031ddae7240"></a><!-- doxytag: member="uip.h::uip_connect" ref="g8096b0c4b543dc408f4dd031ddae7240" args="(uip_ipaddr_t *ripaddr, u16_t port)" --><p> 780<table class="mdTable" cellpadding="2" cellspacing="0"> 781 <tr> 782 <td class="mdRow"> 783 <table cellpadding="0" cellspacing="0" border="0"> 784 <tr> 785 <td class="md" nowrap valign="top">struct <a class="el" href="a00088.html">uip_conn</a>* uip_connect </td> 786 <td class="md" valign="top">( </td> 787 <td class="md" nowrap valign="top"><a class="el" href="a00150.html#g1ef35301f43a5bbb9f89f07b5a36b9a0">uip_ipaddr_t</a> * </td> 788 <td class="mdname" nowrap> <em>ripaddr</em>, </td> 789 </tr> 790 <tr> 791 <td class="md" nowrap align="right"></td> 792 <td class="md"></td> 793 <td class="md" nowrap><a class="el" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> </td> 794 <td class="mdname" nowrap> <em>port</em></td> 795 </tr> 796 <tr> 797 <td class="md"></td> 798 <td class="md">) </td> 799 <td class="md" colspan="2"></td> 800 </tr> 801 </table> 802 </td> 803 </tr> 804</table> 805<table cellspacing="5" cellpadding="0" border="0"> 806 <tr> 807 <td> 808 809 </td> 810 <td> 811 812<p> 813Connect to a remote host using TCP. 814<p> 815This function is used to start a new connection to the specified port on the specied host. It allocates a new connection identifier, sets the connection to the SYN_SENT state and sets the retransmission timer to 0. This will cause a TCP SYN segment to be sent out the next time this connection is periodically processed, which usually is done within 0.5 seconds after the call to <a class="el" href="a00147.html#g8096b0c4b543dc408f4dd031ddae7240">uip_connect()</a>.<p> 816<dl compact><dt><b>Note:</b></dt><dd>This function is avaliable only if support for active open has been configured by defining UIP_ACTIVE_OPEN to 1 in <a class="el" href="a00140.html">uipopt.h</a>.<p> 817Since this function requires the port number to be in network byte order, a conversion using <a class="el" href="a00148.html#g69a7a4951ff21b302267532c21ee78fc">HTONS()</a> or <a class="el" href="a00148.html#ga22b04cac8cf283ca12f028578bebc06">htons()</a> is necessary.</dd></dl> 818<div class="fragment"><pre class="fragment"> <a class="code" href="a00150.html#g1ef35301f43a5bbb9f89f07b5a36b9a0">uip_ipaddr_t</a> ipaddr; 819 820 <a class="code" href="a00148.html#g87f0b54ade0d159fba495089128a4932">uip_ipaddr</a>(&ipaddr, 192,168,1,2); 821 <a class="code" href="a00147.html#g8096b0c4b543dc408f4dd031ddae7240">uip_connect</a>(&ipaddr, <a class="code" href="a00148.html#g69a7a4951ff21b302267532c21ee78fc">HTONS</a>(80)); 822</pre></div><p> 823<dl compact><dt><b>Parameters:</b></dt><dd> 824 <table border="0" cellspacing="2" cellpadding="0"> 825 <tr><td valign="top"></td><td valign="top"><em>ripaddr</em> </td><td>The IP address of the remote hot.</td></tr> 826 <tr><td valign="top"></td><td valign="top"><em>port</em> </td><td>A 16-bit port number in network byte order.</td></tr> 827 </table> 828</dl> 829<dl compact><dt><b>Returns:</b></dt><dd>A pointer to the uIP connection identifier for the new connection, or NULL if no connection could be allocated. </dd></dl> 830<dl compact><dt><b>Examples: </b></dt><dd> 831<a class="el" href="a00038.html#a190">smtp.c</a>, and <a class="el" href="a00040.html#a273">webclient.c</a>.</dl> 832<p> 833Definition at line <a class="el" href="a00201.html#l00407">407</a> of file <a class="el" href="a00201.html">uip.c</a>. 834<p> 835References <a class="el" href="a00201.html#l01882">htons()</a>, <a class="el" href="a00202.html#l01156">uip_conn::lport</a>, <a class="el" href="a00202.html#l01174">uip_conn::tcpstateflags</a>, <a class="el" href="a00202.html#l01372">UIP_CLOSED</a>, <a class="el" href="a00201.html#l00163">uip_conn</a>, <a class="el" href="a00206.html#l00245">UIP_CONNS</a>, and <a class="el" href="a00201.html#l00166">uip_conns</a>. 836<p> 837Referenced by <a class="el" href="a00174.html#l00233">smtp_send()</a>, and <a class="el" href="a00180.html#l00140">webclient_get()</a>. </td> 838 </tr> 839</table> 840<a class="anchor" name="gdd1ab3704ecd4900eec61a6897d32dc8"></a><!-- doxytag: member="uip.h::uip_listen" ref="gdd1ab3704ecd4900eec61a6897d32dc8" args="(u16_t port)" --><p> 841<table class="mdTable" cellpadding="2" cellspacing="0"> 842 <tr> 843 <td class="mdRow"> 844 <table cellpadding="0" cellspacing="0" border="0"> 845 <tr> 846 <td class="md" nowrap valign="top">void uip_listen </td> 847 <td class="md" valign="top">( </td> 848 <td class="md" nowrap valign="top"><a class="el" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> </td> 849 <td class="mdname1" valign="top" nowrap> <em>port</em> </td> 850 <td class="md" valign="top"> ) </td> 851 <td class="md" nowrap></td> 852 </tr> 853 </table> 854 </td> 855 </tr> 856</table> 857<table cellspacing="5" cellpadding="0" border="0"> 858 <tr> 859 <td> 860 861 </td> 862 <td> 863 864<p> 865Start listening to the specified port. 866<p> 867<dl compact><dt><b>Note:</b></dt><dd>Since this function expects the port number in network byte order, a conversion using <a class="el" href="a00148.html#g69a7a4951ff21b302267532c21ee78fc">HTONS()</a> or <a class="el" href="a00148.html#ga22b04cac8cf283ca12f028578bebc06">htons()</a> is necessary.</dd></dl> 868<div class="fragment"><pre class="fragment"> <a class="code" href="a00147.html#gdd1ab3704ecd4900eec61a6897d32dc8">uip_listen</a>(<a class="code" href="a00148.html#g69a7a4951ff21b302267532c21ee78fc">HTONS</a>(80)); 869</pre></div><p> 870<dl compact><dt><b>Parameters:</b></dt><dd> 871 <table border="0" cellspacing="2" cellpadding="0"> 872 <tr><td valign="top"></td><td valign="top"><em>port</em> </td><td>A 16-bit port number in network byte order. </td></tr> 873 </table> 874</dl> 875<dl compact><dt><b>Examples: </b></dt><dd> 876<a class="el" href="a00036.html#a102">hello-world.c</a>, and <a class="el" href="a00044.html#a218">telnetd.c</a>.</dl> 877<p> 878Definition at line <a class="el" href="a00201.html#l00529">529</a> of file <a class="el" href="a00201.html">uip.c</a>. 879<p> 880References <a class="el" href="a00206.html#l00259">UIP_LISTENPORTS</a>. 881<p> 882Referenced by <a class="el" href="a00170.html#l00041">hello_world_init()</a>, and <a class="el" href="a00184.html#l00333">httpd_init()</a>. </td> 883 </tr> 884</table> 885<a class="anchor" name="g04b053a623aac7cd4195157d470661b3"></a><!-- doxytag: member="uip.h::uip_send" ref="g04b053a623aac7cd4195157d470661b3" args="(const void *data, int len)" --><p> 886<table class="mdTable" cellpadding="2" cellspacing="0"> 887 <tr> 888 <td class="mdRow"> 889 <table cellpadding="0" cellspacing="0" border="0"> 890 <tr> 891 <td class="md" nowrap valign="top">void uip_send </td> 892 <td class="md" valign="top">( </td> 893 <td class="md" nowrap valign="top">const void * </td> 894 <td class="mdname" nowrap> <em>data</em>, </td> 895 </tr> 896 <tr> 897 <td class="md" nowrap align="right"></td> 898 <td class="md"></td> 899 <td class="md" nowrap>int </td> 900 <td class="mdname" nowrap> <em>len</em></td> 901 </tr> 902 <tr> 903 <td class="md"></td> 904 <td class="md">) </td> 905 <td class="md" colspan="2"></td> 906 </tr> 907 </table> 908 </td> 909 </tr> 910</table> 911<table cellspacing="5" cellpadding="0" border="0"> 912 <tr> 913 <td> 914 915 </td> 916 <td> 917 918<p> 919Send data on the current connection. 920<p> 921This function is used to send out a single segment of TCP data. Only applications that have been invoked by uIP for event processing can send data.<p> 922The amount of data that actually is sent out after a call to this funcion is determined by the maximum amount of data TCP allows. uIP will automatically crop the data so that only the appropriate amount of data is sent. The function <a class="el" href="a00147.html#gb5fecbc62edd128012cea0f47b57ab9f">uip_mss()</a> can be used to query uIP for the amount of data that actually will be sent.<p> 923<dl compact><dt><b>Note:</b></dt><dd>This function does not guarantee that the sent data will arrive at the destination. If the data is lost in the network, the application will be invoked with the <a class="el" href="a00147.html#ga8933ad15a2e2947dae4a5cff50e6007">uip_rexmit()</a> event being set. The application will then have to resend the data using this function.</dd></dl> 924<dl compact><dt><b>Parameters:</b></dt><dd> 925 <table border="0" cellspacing="2" cellpadding="0"> 926 <tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>A pointer to the data which is to be sent.</td></tr> 927 <tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>The maximum amount of data bytes to be sent. </td></tr> 928 </table> 929</dl> 930<dl compact><dt><b>Examples: </b></dt><dd> 931<a class="el" href="a00048.html#a10">dhcpc.c</a>, <a class="el" href="a00044.html#a226">telnetd.c</a>, and <a class="el" href="a00040.html#a278">webclient.c</a>.</dl> 932<p> 933Definition at line <a class="el" href="a00201.html#l01888">1888</a> of file <a class="el" href="a00201.html">uip.c</a>. 934<p> 935References <a class="el" href="a00201.html#l00145">uip_sappdata</a>, and <a class="el" href="a00201.html#l00155">uip_slen</a>. </td> 936 </tr> 937</table> 938<a class="anchor" name="g79c4110211247df3fb30b8cf1c4c02af"></a><!-- doxytag: member="uip.h::uip_udp_new" ref="g79c4110211247df3fb30b8cf1c4c02af" args="(uip_ipaddr_t *ripaddr, u16_t rport)" --><p> 939<table class="mdTable" cellpadding="2" cellspacing="0"> 940 <tr> 941 <td class="mdRow"> 942 <table cellpadding="0" cellspacing="0" border="0"> 943 <tr> 944 <td class="md" nowrap valign="top">struct <a class="el" href="a00095.html">uip_udp_conn</a>* uip_udp_new </td> 945 <td class="md" valign="top">( </td> 946 <td class="md" nowrap valign="top"><a class="el" href="a00150.html#g1ef35301f43a5bbb9f89f07b5a36b9a0">uip_ipaddr_t</a> * </td> 947 <td class="mdname" nowrap> <em>ripaddr</em>, </td> 948 </tr> 949 <tr> 950 <td class="md" nowrap align="right"></td> 951 <td class="md"></td> 952 <td class="md" nowrap><a class="el" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> </td> 953 <td class="mdname" nowrap> <em>rport</em></td> 954 </tr> 955 <tr> 956 <td class="md"></td> 957 <td class="md">) </td> 958 <td class="md" colspan="2"></td> 959 </tr> 960 </table> 961 </td> 962 </tr> 963</table> 964<table cellspacing="5" cellpadding="0" border="0"> 965 <tr> 966 <td> 967 968 </td> 969 <td> 970 971<p> 972Set up a new UDP connection. 973<p> 974This function sets up a new UDP connection. The function will automatically allocate an unused local port for the new connection. However, another port can be chosen by using the <a class="el" href="a00147.html#ga20812098a4663c8a9fc4ce8e95391b6">uip_udp_bind()</a> call, after the <a class="el" href="a00147.html#g79c4110211247df3fb30b8cf1c4c02af">uip_udp_new()</a> function has been called.<p> 975Example: <div class="fragment"><pre class="fragment"> <a class="code" href="a00150.html#g1ef35301f43a5bbb9f89f07b5a36b9a0">uip_ipaddr_t</a> addr; 976 <span class="keyword">struct </span><a class="code" href="a00095.html">uip_udp_conn</a> *c; 977 978 <a class="code" href="a00148.html#g87f0b54ade0d159fba495089128a4932">uip_ipaddr</a>(&addr, 192,168,2,1); 979 c = <a class="code" href="a00147.html#g79c4110211247df3fb30b8cf1c4c02af">uip_udp_new</a>(&addr, <a class="code" href="a00148.html#g69a7a4951ff21b302267532c21ee78fc">HTONS</a>(12345)); 980 <span class="keywordflow">if</span>(c != <a class="code" href="a00160.html#g070d2ce7b6bb7e5c05602aa8c308d0c4">NULL</a>) { 981 <a class="code" href="a00147.html#ga20812098a4663c8a9fc4ce8e95391b6">uip_udp_bind</a>(c, <a class="code" href="a00148.html#g69a7a4951ff21b302267532c21ee78fc">HTONS</a>(12344)); 982 } 983</pre></div> <dl compact><dt><b>Parameters:</b></dt><dd> 984 <table border="0" cellspacing="2" cellpadding="0"> 985 <tr><td valign="top"></td><td valign="top"><em>ripaddr</em> </td><td>The IP address of the remote host.</td></tr> 986 <tr><td valign="top"></td><td valign="top"><em>rport</em> </td><td>The remote port number in network byte order.</td></tr> 987 </table> 988</dl> 989<dl compact><dt><b>Returns:</b></dt><dd>The <a class="el" href="a00095.html">uip_udp_conn</a> structure for the new connection or NULL if no connection could be allocated. </dd></dl> 990<dl compact><dt><b>Examples: </b></dt><dd> 991<a class="el" href="a00048.html#a38">dhcpc.c</a>, and <a class="el" href="a00046.html#a153">resolv.c</a>.</dl> 992<p> 993Definition at line <a class="el" href="a00201.html#l00473">473</a> of file <a class="el" href="a00201.html">uip.c</a>. 994<p> 995References <a class="el" href="a00201.html#l01882">htons()</a>, <a class="el" href="a00202.html#l01212">uip_udp_conn::lport</a>, <a class="el" href="a00201.html#l00173">uip_udp_conn</a>, <a class="el" href="a00206.html#l00206">UIP_UDP_CONNS</a>, and <a class="el" href="a00201.html#l00174">uip_udp_conns</a>. 996<p> 997Referenced by <a class="el" href="a00172.html#l00438">resolv_conf()</a>. </td> 998 </tr> 999</table> 1000<a class="anchor" name="gaa585784b0914cac1d37f07f85457008"></a><!-- doxytag: member="uip.h::uip_unlisten" ref="gaa585784b0914cac1d37f07f85457008" args="(u16_t port)" --><p> 1001<table class="mdTable" cellpadding="2" cellspacing="0"> 1002 <tr> 1003 <td class="mdRow"> 1004 <table cellpadding="0" cellspacing="0" border="0"> 1005 <tr> 1006 <td class="md" nowrap valign="top">void uip_unlisten </td> 1007 <td class="md" valign="top">( </td> 1008 <td class="md" nowrap valign="top"><a class="el" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> </td> 1009 <td class="mdname1" valign="top" nowrap> <em>port</em> </td> 1010 <td class="md" valign="top"> ) </td> 1011 <td class="md" nowrap></td> 1012 </tr> 1013 </table> 1014 </td> 1015 </tr> 1016</table> 1017<table cellspacing="5" cellpadding="0" border="0"> 1018 <tr> 1019 <td> 1020 1021 </td> 1022 <td> 1023 1024<p> 1025Stop listening to the specified port. 1026<p> 1027<dl compact><dt><b>Note:</b></dt><dd>Since this function expects the port number in network byte order, a conversion using <a class="el" href="a00148.html#g69a7a4951ff21b302267532c21ee78fc">HTONS()</a> or <a class="el" href="a00148.html#ga22b04cac8cf283ca12f028578bebc06">htons()</a> is necessary.</dd></dl> 1028<div class="fragment"><pre class="fragment"> <a class="code" href="a00147.html#gaa585784b0914cac1d37f07f85457008">uip_unlisten</a>(<a class="code" href="a00148.html#g69a7a4951ff21b302267532c21ee78fc">HTONS</a>(80)); 1029</pre></div><p> 1030<dl compact><dt><b>Parameters:</b></dt><dd> 1031 <table border="0" cellspacing="2" cellpadding="0"> 1032 <tr><td valign="top"></td><td valign="top"><em>port</em> </td><td>A 16-bit port number in network byte order. </td></tr> 1033 </table> 1034</dl> 1035 1036<p> 1037Definition at line <a class="el" href="a00201.html#l00518">518</a> of file <a class="el" href="a00201.html">uip.c</a>. 1038<p> 1039References <a class="el" href="a00206.html#l00259">UIP_LISTENPORTS</a>. </td> 1040 </tr> 1041</table> 1042<hr size="1"><address style="align: right;"><small>Generated on Mon Jun 12 10:23:02 2006 for uIP 1.0 by 1043<a href="http://www.doxygen.org/index.html"> 1044<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address> 1045</body> 1046</html> 1047
