root / trunk / docs / libwireless / wl__basic_8c.html @ 1395
History | View | Annotate | Download (5.36 KB)
| 1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|---|---|
| 2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> |
| 3 |
<title>libwireless: wl_basic.c File Reference</title> |
| 4 |
<link href="tabs.css" rel="stylesheet" type="text/css"> |
| 5 |
<link href="doxygen.css" rel="stylesheet" type="text/css"> |
| 6 |
</head><body> |
| 7 |
<!-- Generated by Doxygen 1.5.9 -->
|
| 8 |
<div class="navigation" id="top"> |
| 9 |
<div class="tabs"> |
| 10 |
<ul>
|
| 11 |
<li><a href="index.html"><span>Main Page</span></a></li> |
| 12 |
<li><a href="modules.html"><span>Modules</span></a></li> |
| 13 |
<li><a href="annotated.html"><span>Data Structures</span></a></li> |
| 14 |
<li class="current"><a href="files.html"><span>Files</span></a></li> |
| 15 |
</ul>
|
| 16 |
</div>
|
| 17 |
<div class="tabs"> |
| 18 |
<ul>
|
| 19 |
<li><a href="files.html"><span>File List</span></a></li> |
| 20 |
<li><a href="globals.html"><span>Globals</span></a></li> |
| 21 |
</ul>
|
| 22 |
</div>
|
| 23 |
</div>
|
| 24 |
<div class="contents"> |
| 25 |
<h1>wl_basic.c File Reference</h1>High Level Wireless Packet Sending-Receiving Functions. |
| 26 |
<a href="#_details">More...</a> |
| 27 |
<p>
|
| 28 |
<code>#include <<a class="el" href="wireless_8h_source.html">wireless.h</a>></code><br> |
| 29 |
<code>#include "<a class="el" href="wl__basic_8h_source.html">wl_basic.h</a>"</code><br> |
| 30 |
<table border="0" cellpadding="0" cellspacing="0"> |
| 31 |
<tr><td></td></tr> |
| 32 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
| 33 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#gae4a8ae98cc33955ee20b6e481d47adf">wl_basic_init</a> (void(*handle_receive)(char type, int source, unsigned char *packet, int length))</td></tr> |
| 34 |
|
| 35 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">init wireless for Basic Group <a href="group__wl__basic.html#gae4a8ae98cc33955ee20b6e481d47adf"></a><br></td></tr> |
| 36 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ge482937c7c29521030a33ecbc5d2dd9d"></a><!-- doxytag: member="wl_basic.c::wl_basic_init_default" ref="ge482937c7c29521030a33ecbc5d2dd9d" args="()" --> |
| 37 |
int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#ge482937c7c29521030a33ecbc5d2dd9d">wl_basic_init_default</a> ()</td></tr> |
| 38 |
|
| 39 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">init wireless for Basic Group with default packet handling <br></td></tr> |
| 40 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#gebc714e1bf382a98ac7a43762bf905c5">wl_basic_register_handler</a> (void(*handle_receive)(char type, int source, unsigned char *packet, int length))</td></tr> |
| 41 |
|
| 42 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">internal function to register a packet handler function <a href="group__wl__basic.html#gebc714e1bf382a98ac7a43762bf905c5"></a><br></td></tr> |
| 43 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#gd5d7334484e49cc3cb9ebe2cfc323115">wl_basic_send_robot_packet</a> (char type, char *data, int len, int dest)</td></tr> |
| 44 |
|
| 45 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">send a packet to a single robot in Basic Group <a href="group__wl__basic.html#gd5d7334484e49cc3cb9ebe2cfc323115"></a><br></td></tr> |
| 46 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#g72d4f604603ef2541b5f4d3ae467938e">wl_basic_send_global_packet</a> (char type, char *data, int len)</td></tr> |
| 47 |
|
| 48 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">send a packet to all robots in Basic Group <a href="group__wl__basic.html#g72d4f604603ef2541b5f4d3ae467938e"></a><br></td></tr> |
| 49 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#g0ad976b2b61cca0081123606101c97cd">wl_basic_packet_receive_handler</a> (char type, int source, unsigned char *packet, int length)</td></tr> |
| 50 |
|
| 51 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">default packet handler if none is specified on init <a href="group__wl__basic.html#g0ad976b2b61cca0081123606101c97cd"></a><br></td></tr> |
| 52 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#gae39ab95ba4a1b2ba2736f844c03cee7">wl_basic_do</a> (void)</td></tr> |
| 53 |
|
| 54 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">wrapper for <a class="el" href="group__wireless.html#g5c1f1a0e20fc718e59edc29246afd703" title="Perform wireless library functionality.">wl_do()</a> to return packet data buffer <a href="group__wl__basic.html#gae39ab95ba4a1b2ba2736f844c03cee7"></a><br></td></tr> |
| 55 |
</table>
|
| 56 |
<hr><h2>Detailed Description</h2> |
| 57 |
High Level Wireless Packet Sending-Receiving Functions. |
| 58 |
<p>
|
| 59 |
Abstracted wireless functionality for sending and receiving packets<p>
|
| 60 |
<dl class="author" compact><dt><b>Author:</b></dt><dd>Christopher Mar, Colony Project, CMU Robotics Club </dd></dl> |
| 61 |
</div>
|
| 62 |
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Sep 8 19:59:17 2009 for libwireless by |
| 63 |
<a href="http://www.doxygen.org/index.html"> |
| 64 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> |
| 65 |
</body>
|
| 66 |
</html>
|