a00206.html

uip-1.0,give everyone who want.

<a name="l00407"></a>00407 <span class="preprocessor">#ifndef UIP_CONF_LOGGING</span>
<a name="l00408"></a><a class="code" href="a00153.html#g21664b7441cfa37d280228d23316d609">00408</a> <span class="preprocessor"></span><span class="preprocessor">#define UIP_LOGGING     0</span>
<a name="l00409"></a>00409 <span class="preprocessor"></span><span class="preprocessor">#else </span><span class="comment">/* UIP_CONF_LOGGING */</span>
<a name="l00410"></a>00410 <span class="preprocessor">#define UIP_LOGGING     UIP_CONF_LOGGING</span>
<a name="l00411"></a>00411 <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* UIP_CONF_LOGGING */</span>
<a name="l00412"></a>00412 <span class="comment"></span>
<a name="l00413"></a>00413 <span class="comment">/**</span>
<a name="l00414"></a>00414 <span class="comment"> * Broadcast support.</span>
<a name="l00415"></a>00415 <span class="comment"> *</span>
<a name="l00416"></a>00416 <span class="comment"> * This flag configures IP broadcast support. This is useful only</span>
<a name="l00417"></a>00417 <span class="comment"> * together with UDP.</span>
<a name="l00418"></a>00418 <span class="comment"> *</span>
<a name="l00419"></a>00419 <span class="comment"> * \hideinitializer</span>
<a name="l00420"></a>00420 <span class="comment"> *</span>
<a name="l00421"></a>00421 <span class="comment"> */</span>
<a name="l00422"></a>00422 <span class="preprocessor">#ifndef UIP_CONF_BROADCAST</span>
<a name="l00423"></a><a class="code" href="a00153.html#g156dd2891a57035e4afdc4c2bc0b0ebf">00423</a> <span class="preprocessor"></span><span class="preprocessor">#define UIP_BROADCAST 0</span>
<a name="l00424"></a>00424 <span class="preprocessor"></span><span class="preprocessor">#else </span><span class="comment">/* UIP_CONF_BROADCAST */</span>
<a name="l00425"></a>00425 <span class="preprocessor">#define UIP_BROADCAST UIP_CONF_BROADCAST</span>
<a name="l00426"></a>00426 <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* UIP_CONF_BROADCAST */</span>
<a name="l00427"></a>00427 <span class="comment"></span>
<a name="l00428"></a>00428 <span class="comment">/**</span>
<a name="l00429"></a>00429 <span class="comment"> * Print out a uIP log message.</span>
<a name="l00430"></a>00430 <span class="comment"> *</span>
<a name="l00431"></a>00431 <span class="comment"> * This function must be implemented by the module that uses uIP, and</span>
<a name="l00432"></a>00432 <span class="comment"> * is called by uIP whenever a log message is generated.</span>
<a name="l00433"></a>00433 <span class="comment"> */</span>
<a name="l00434"></a>00434 <span class="keywordtype">void</span> <a class="code" href="a00153.html#gb58e1ceb7cb73ca2bcd73146b6c1b4e7">uip_log</a>(<span class="keywordtype">char</span> *msg);
<a name="l00435"></a>00435 <span class="comment"></span>
<a name="l00436"></a>00436 <span class="comment">/**</span>
<a name="l00437"></a>00437 <span class="comment"> * The link level header length.</span>
<a name="l00438"></a>00438 <span class="comment"> *</span>
<a name="l00439"></a>00439 <span class="comment"> * This is the offset into the uip_buf where the IP header can be</span>
<a name="l00440"></a>00440 <span class="comment"> * found. For Ethernet, this should be set to 14. For SLIP, this</span>
<a name="l00441"></a>00441 <span class="comment"> * should be set to 0.</span>
<a name="l00442"></a>00442 <span class="comment"> *</span>
<a name="l00443"></a>00443 <span class="comment"> * \hideinitializer</span>
<a name="l00444"></a>00444 <span class="comment"> */</span>
<a name="l00445"></a>00445 <span class="preprocessor">#ifdef UIP_CONF_LLH_LEN</span>
<a name="l00446"></a>00446 <span class="preprocessor"></span><span class="preprocessor">#define UIP_LLH_LEN UIP_CONF_LLH_LEN</span>
<a name="l00447"></a>00447 <span class="preprocessor"></span><span class="preprocessor">#else </span><span class="comment">/* UIP_CONF_LLH_LEN */</span>
<a name="l00448"></a><a class="code" href="a00153.html#ge6f4a2453dbd8bc60e6a82774552366a">00448</a> <span class="preprocessor">#define UIP_LLH_LEN     14</span>
<a name="l00449"></a>00449 <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* UIP_CONF_LLH_LEN */</span>
<a name="l00450"></a>00450 <span class="comment"></span>
<a name="l00451"></a>00451 <span class="comment">/** @} */</span>
<a name="l00452"></a>00452 <span class="comment">/*------------------------------------------------------------------------------*/</span><span class="comment"></span>
<a name="l00453"></a>00453 <span class="comment">/**</span>
<a name="l00454"></a>00454 <span class="comment"> * \name CPU architecture configuration</span>
<a name="l00455"></a>00455 <span class="comment"> * @{</span>
<a name="l00456"></a>00456 <span class="comment"> *</span>
<a name="l00457"></a>00457 <span class="comment"> * The CPU architecture configuration is where the endianess of the</span>
<a name="l00458"></a>00458 <span class="comment"> * CPU on which uIP is to be run is specified. Most CPUs today are</span>
<a name="l00459"></a>00459 <span class="comment"> * little endian, and the most notable exception are the Motorolas</span>
<a name="l00460"></a>00460 <span class="comment"> * which are big endian. The BYTE_ORDER macro should be changed to</span>
<a name="l00461"></a>00461 <span class="comment"> * reflect the CPU architecture on which uIP is to be run.</span>
<a name="l00462"></a>00462 <span class="comment"> */</span>
<a name="l00463"></a>00463 <span class="comment"></span>
<a name="l00464"></a>00464 <span class="comment">/**</span>
<a name="l00465"></a>00465 <span class="comment"> * The byte order of the CPU architecture on which uIP is to be run.</span>
<a name="l00466"></a>00466 <span class="comment"> *</span>
<a name="l00467"></a>00467 <span class="comment"> * This option can be either BIG_ENDIAN (Motorola byte order) or</span>
<a name="l00468"></a>00468 <span class="comment"> * LITTLE_ENDIAN (Intel byte order).</span>
<a name="l00469"></a>00469 <span class="comment"> *</span>
<a name="l00470"></a>00470 <span class="comment"> * \hideinitializer</span>
<a name="l00471"></a>00471 <span class="comment"> */</span>
<a name="l00472"></a>00472 <span class="preprocessor">#ifdef UIP_CONF_BYTE_ORDER</span>
<a name="l00473"></a>00473 <span class="preprocessor"></span><span class="preprocessor">#define UIP_BYTE_ORDER     UIP_CONF_BYTE_ORDER</span>
<a name="l00474"></a>00474 <span class="preprocessor"></span><span class="preprocessor">#else </span><span class="comment">/* UIP_CONF_BYTE_ORDER */</span>
<a name="l00475"></a><a class="code" href="a00153.html#g285a80366aed9428f64282b8d13c918b">00475</a> <span class="preprocessor">#define UIP_BYTE_ORDER     UIP_LITTLE_ENDIAN</span>
<a name="l00476"></a>00476 <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* UIP_CONF_BYTE_ORDER */</span>
<a name="l00477"></a>00477 <span class="comment"></span>
<a name="l00478"></a>00478 <span class="comment">/** @} */</span>
<a name="l00479"></a>00479 <span class="comment">/*------------------------------------------------------------------------------*/</span>
<a name="l00480"></a>00480 <span class="comment"></span>
<a name="l00481"></a>00481 <span class="comment">/**</span>
<a name="l00482"></a>00482 <span class="comment"> * \name Appication specific configurations</span>
<a name="l00483"></a>00483 <span class="comment"> * @{</span>
<a name="l00484"></a>00484 <span class="comment"> *</span>
<a name="l00485"></a>00485 <span class="comment"> * An uIP application is implemented using a single application</span>
<a name="l00486"></a>00486 <span class="comment"> * function that is called by uIP whenever a TCP/IP event occurs. The</span>
<a name="l00487"></a>00487 <span class="comment"> * name of this function must be registered with uIP at compile time</span>
<a name="l00488"></a>00488 <span class="comment"> * using the UIP_APPCALL definition.</span>
<a name="l00489"></a>00489 <span class="comment"> *</span>
<a name="l00490"></a>00490 <span class="comment"> * uIP applications can store the application state within the</span>
<a name="l00491"></a>00491 <span class="comment"> * uip_conn structure by specifying the type of the application</span>
<a name="l00492"></a>00492 <span class="comment"> * structure by typedef:ing the type uip_tcp_appstate_t and uip_udp_appstate_t.</span>
<a name="l00493"></a>00493 <span class="comment"> *</span>
<a name="l00494"></a>00494 <span class="comment"> * The file containing the definitions must be included in the</span>
<a name="l00495"></a>00495 <span class="comment"> * uipopt.h file.</span>
<a name="l00496"></a>00496 <span class="comment"> *</span>
<a name="l00497"></a>00497 <span class="comment"> * The following example illustrates how this can look.</span>
<a name="l00498"></a>00498 <span class="comment"> \code</span>
<a name="l00499"></a>00499 <span class="comment"></span>
<a name="l00500"></a>00500 <span class="comment">void httpd_appcall(void);</span>
<a name="l00501"></a>00501 <span class="comment">#define UIP_APPCALL     httpd_appcall</span>
<a name="l00502"></a>00502 <span class="comment"></span>
<a name="l00503"></a>00503 <span class="comment">struct httpd_state {</span>
<a name="l00504"></a>00504 <span class="comment">  u8_t state;</span>
<a name="l00505"></a>00505 <span class="comment">  u16_t count;</span>
<a name="l00506"></a>00506 <span class="comment">  char *dataptr;</span>
<a name="l00507"></a>00507 <span class="comment">  char *script;</span>
<a name="l00508"></a>00508 <span class="comment">};</span>
<a name="l00509"></a>00509 <span class="comment">typedef struct httpd_state uip_tcp_appstate_t</span>
<a name="l00510"></a>00510 <span class="comment"> \endcode</span>
<a name="l00511"></a>00511 <span class="comment"> */</span>
<a name="l00512"></a>00512 <span class="comment"></span>
<a name="l00513"></a>00513 <span class="comment">/**</span>
<a name="l00514"></a>00514 <span class="comment"> * \var #define UIP_APPCALL</span>
<a name="l00515"></a>00515 <span class="comment"> *</span>
<a name="l00516"></a>00516 <span class="comment"> * The name of the application function that uIP should call in</span>
<a name="l00517"></a>00517 <span class="comment"> * response to TCP/IP events.</span>
<a name="l00518"></a>00518 <span class="comment"> *</span>
<a name="l00519"></a>00519 <span class="comment"> */</span>
<a name="l00520"></a>00520 <span class="comment"></span>
<a name="l00521"></a>00521 <span class="comment">/**</span>
<a name="l00522"></a>00522 <span class="comment"> * \var typedef uip_tcp_appstate_t</span>
<a name="l00523"></a>00523 <span class="comment"> *</span>
<a name="l00524"></a>00524 <span class="comment"> * The type of the application state that is to be stored in the</span>
<a name="l00525"></a>00525 <span class="comment"> * uip_conn structure. This usually is typedef:ed to a struct holding</span>
<a name="l00526"></a>00526 <span class="comment"> * application state information.</span>
<a name="l00527"></a>00527 <span class="comment"> */</span>
<a name="l00528"></a>00528 <span class="comment"></span>
<a name="l00529"></a>00529 <span class="comment">/**</span>
<a name="l00530"></a>00530 <span class="comment"> * \var typedef uip_udp_appstate_t</span>
<a name="l00531"></a>00531 <span class="comment"> *</span>
<a name="l00532"></a>00532 <span class="comment"> * The type of the application state that is to be stored in the</span>
<a name="l00533"></a>00533 <span class="comment"> * uip_conn structure. This usually is typedef:ed to a struct holding</span>
<a name="l00534"></a>00534 <span class="comment"> * application state information.</span>
<a name="l00535"></a>00535 <span class="comment"> */</span><span class="comment"></span>
<a name="l00536"></a>00536 <span class="comment">/** @} */</span><span class="comment"></span>
<a name="l00537"></a>00537 <span class="comment">/** @} */</span>
<a name="l00538"></a>00538 
<a name="l00539"></a>00539 <span class="preprocessor">#endif </span><span class="comment">/* __UIPOPT_H__ */</span>
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Mon Jun 12 10:23:01 2006 for uIP 1.0 by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
</body>
</html>