root / trunk / docs / libwireless / wl__basic_8h.html @ 1427
History | View | Annotate | Download (7.56 KB)
| 1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|---|---|
| 2 |
<html xmlns="http://www.w3.org/1999/xhtml"> |
| 3 |
<head>
|
| 4 |
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| 5 |
<title>libwireless: wl_basic.h File Reference</title> |
| 6 |
<link href="tabs.css" rel="stylesheet" type="text/css"/> |
| 7 |
<link href="doxygen.css" rel="stylesheet" type="text/css"/> |
| 8 |
</head>
|
| 9 |
<body>
|
| 10 |
<!-- Generated by Doxygen 1.6.1 -->
|
| 11 |
<div class="navigation" id="top"> |
| 12 |
<div class="tabs"> |
| 13 |
<ul>
|
| 14 |
<li><a href="index.html"><span>Main Page</span></a></li> |
| 15 |
<li><a href="modules.html"><span>Modules</span></a></li> |
| 16 |
<li><a href="annotated.html"><span>Data Structures</span></a></li> |
| 17 |
<li class="current"><a href="files.html"><span>Files</span></a></li> |
| 18 |
</ul>
|
| 19 |
</div>
|
| 20 |
<div class="tabs"> |
| 21 |
<ul>
|
| 22 |
<li><a href="files.html"><span>File List</span></a></li> |
| 23 |
<li><a href="globals.html"><span>Globals</span></a></li> |
| 24 |
</ul>
|
| 25 |
</div>
|
| 26 |
</div>
|
| 27 |
<div class="contents"> |
| 28 |
<h1>wl_basic.h File Reference</h1> |
| 29 |
<p>High Level Wireless Packet Sending-Receiving Functions.
|
| 30 |
<a href="#_details">More...</a></p> |
| 31 |
<code>#include <<a class="el" href="wireless_8h_source.html">wireless.h</a>></code><br/> |
| 32 |
|
| 33 |
<p><a href="wl__basic_8h_source.html">Go to the source code of this file.</a></p> |
| 34 |
<table border="0" cellpadding="0" cellspacing="0"> |
| 35 |
<tr><td colspan="2"><h2>Data Structures</h2></td></tr> |
| 36 |
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structPacketInfo.html">PacketInfo</a></td></tr> |
| 37 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">struct that contains relevant packet information <a href="structPacketInfo.html#_details">More...</a><br/></td></tr> |
| 38 |
<tr><td colspan="2"><h2>Defines</h2></td></tr> |
| 39 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga366b705160e22c2a6c4ea2c3c22e3485"></a><!-- doxytag: member="wl_basic.h::WL_BASIC_GROUP" ref="ga366b705160e22c2a6c4ea2c3c22e3485" args="" --> |
| 40 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#ga366b705160e22c2a6c4ea2c3c22e3485">WL_BASIC_GROUP</a> 8</td></tr> |
| 41 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">default wireless group for basic sending and receiving packets <br/></td></tr> |
| 42 |
<tr><td colspan="2"><h2>Functions</h2></td></tr> |
| 43 |
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#gaae4a8ae98cc33955ee20b6e481d47adf">wl_basic_init</a> (void(*handle_receive)(char type, int source, unsigned char *packet, int length))</td></tr> |
| 44 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">init wireless for Basic Group <a href="group__wl__basic.html#gaae4a8ae98cc33955ee20b6e481d47adf"></a><br/></td></tr> |
| 45 |
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#gae482937c7c29521030a33ecbc5d2dd9d">wl_basic_init_default</a> (void)</td></tr> |
| 46 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">init wireless for Basic Group with default packet handling <a href="group__wl__basic.html#gae482937c7c29521030a33ecbc5d2dd9d"></a><br/></td></tr> |
| 47 |
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#gaebc714e1bf382a98ac7a43762bf905c5">wl_basic_register_handler</a> (void(*handle_receive)(char type, int source, unsigned char *packet, int length))</td></tr> |
| 48 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">internal function to register a packet handler function <a href="group__wl__basic.html#gaebc714e1bf382a98ac7a43762bf905c5"></a><br/></td></tr> |
| 49 |
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#gad5d7334484e49cc3cb9ebe2cfc323115">wl_basic_send_robot_packet</a> (char type, char *data, int len, int dest)</td></tr> |
| 50 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">send a packet to a single robot in Basic Group <a href="group__wl__basic.html#gad5d7334484e49cc3cb9ebe2cfc323115"></a><br/></td></tr> |
| 51 |
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#ga72d4f604603ef2541b5f4d3ae467938e">wl_basic_send_global_packet</a> (char type, char *data, int len)</td></tr> |
| 52 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">send a packet to all robots in Basic Group <a href="group__wl__basic.html#ga72d4f604603ef2541b5f4d3ae467938e"></a><br/></td></tr> |
| 53 |
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#ga0ad976b2b61cca0081123606101c97cd">wl_basic_packet_receive_handler</a> (char type, int source, unsigned char *packet, int length)</td></tr> |
| 54 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">internal default packet handler if none is specified on init <a href="group__wl__basic.html#ga0ad976b2b61cca0081123606101c97cd"></a><br/></td></tr> |
| 55 |
<tr><td class="memItemLeft" align="right" valign="top">unsigned char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#gac3f8a6f5c4d9c258ab9f29f9557632d0">wl_basic_do_default</a> (int *length)</td></tr> |
| 56 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">wrapper for <a class="el" href="group__wireless.html#ga5c1f1a0e20fc718e59edc29246afd703" title="Perform wireless library functionality.">wl_do()</a> to return packet data buffer <a href="group__wl__basic.html#gac3f8a6f5c4d9c258ab9f29f9557632d0"></a><br/></td></tr> |
| 57 |
<tr><td colspan="2"><h2>Variables</h2></td></tr> |
| 58 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaf0fa88111d706ef4e8b3bda5bc32596c"></a><!-- doxytag: member="wl_basic.h::wl_basic_group_handler" ref="gaf0fa88111d706ef4e8b3bda5bc32596c" args="" --> |
| 59 |
<a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#gaf0fa88111d706ef4e8b3bda5bc32596c">wl_basic_group_handler</a></td></tr> |
| 60 |
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> struct for Basic Group. <br/></td></tr> |
| 61 |
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga6c9a887fb0b719948025f195efff1af9"></a><!-- doxytag: member="wl_basic.h::current_packet" ref="ga6c9a887fb0b719948025f195efff1af9" args="" --> |
| 62 |
struct <a class="el" href="structPacketInfo.html">PacketInfo</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#ga6c9a887fb0b719948025f195efff1af9">current_packet</a></td></tr> |
| 63 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">current packet information, correct after wl_basic_do() <br/></td></tr> |
| 64 |
</table>
|
| 65 |
<hr/><a name="_details"></a><h2>Detailed Description</h2> |
| 66 |
<p>High Level Wireless Packet Sending-Receiving Functions. </p> |
| 67 |
<p>Abstracted wireless functionality for sending and receiving packets</p> |
| 68 |
<dl class="author"><dt><b>Author:</b></dt><dd>Christopher Mar, Colony Project, CMU Robotics Club </dd></dl> |
| 69 |
</div>
|
| 70 |
<hr size="1"/><address style="text-align: right;"><small>Generated on Wed Sep 23 12:51:07 2009 for libwireless by |
| 71 |
<a href="http://www.doxygen.org/index.html"> |
| 72 |
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> |
| 73 |
</body>
|
| 74 |
</html>
|