root / trunk / docs / libwireless / group__wl__basic.html @ 1395
History | View | Annotate | Download (17.2 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: Wireless Basic</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><a href="files.html"><span>Files</span></a></li> |
| 15 |
</ul>
|
| 16 |
</div>
|
| 17 |
</div>
|
| 18 |
<div class="contents"> |
| 19 |
<h1>Wireless Basic</h1>Wireless abstraction for easily sending and receing packets. |
| 20 |
<a href="#_details">More...</a> |
| 21 |
<p>
|
| 22 |
<table border="0" cellpadding="0" cellspacing="0"> |
| 23 |
<tr><td></td></tr> |
| 24 |
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr> |
| 25 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><b>PacketInfo</b></td></tr> |
| 26 |
|
| 27 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
| 28 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g366b705160e22c2a6c4ea2c3c22e3485"></a><!-- doxytag: member="wl_basic::WL_BASIC_GROUP" ref="g366b705160e22c2a6c4ea2c3c22e3485" args="" --> |
| 29 |
#define </td><td class="memItemRight" valign="bottom"><b>WL_BASIC_GROUP</b> 8</td></tr> |
| 30 |
|
| 31 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
| 32 |
<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> |
| 33 |
|
| 34 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">init wireless for Basic Group <a href="#gae4a8ae98cc33955ee20b6e481d47adf"></a><br></td></tr> |
| 35 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ge482937c7c29521030a33ecbc5d2dd9d"></a><!-- doxytag: member="wl_basic::wl_basic_init_default" ref="ge482937c7c29521030a33ecbc5d2dd9d" args="(void)" --> |
| 36 |
int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#ge482937c7c29521030a33ecbc5d2dd9d">wl_basic_init_default</a> (void)</td></tr> |
| 37 |
|
| 38 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">init wireless for Basic Group with default packet handling <br></td></tr> |
| 39 |
<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> |
| 40 |
|
| 41 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">internal function to register a packet handler function <a href="#gebc714e1bf382a98ac7a43762bf905c5"></a><br></td></tr> |
| 42 |
<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> |
| 43 |
|
| 44 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">send a packet to a single robot in Basic Group <a href="#gd5d7334484e49cc3cb9ebe2cfc323115"></a><br></td></tr> |
| 45 |
<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> |
| 46 |
|
| 47 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">send a packet to all robots in Basic Group <a href="#g72d4f604603ef2541b5f4d3ae467938e"></a><br></td></tr> |
| 48 |
<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> |
| 49 |
|
| 50 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">default packet handler if none is specified on init <a href="#g0ad976b2b61cca0081123606101c97cd"></a><br></td></tr> |
| 51 |
<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> |
| 52 |
|
| 53 |
<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="#gae39ab95ba4a1b2ba2736f844c03cee7"></a><br></td></tr> |
| 54 |
<tr><td colspan="2"><br><h2>Variables</h2></td></tr> |
| 55 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gf0fa88111d706ef4e8b3bda5bc32596c"></a><!-- doxytag: member="wl_basic::wl_basic_group_handler" ref="gf0fa88111d706ef4e8b3bda5bc32596c" args="" --> |
| 56 |
<a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#gf0fa88111d706ef4e8b3bda5bc32596c">wl_basic_group_handler</a></td></tr> |
| 57 |
|
| 58 |
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> struct for Basic Group. <br></td></tr> |
| 59 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g6c9a887fb0b719948025f195efff1af9"></a><!-- doxytag: member="wl_basic::current_packet" ref="g6c9a887fb0b719948025f195efff1af9" args="" --> |
| 60 |
struct PacketInfo </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wl__basic.html#g6c9a887fb0b719948025f195efff1af9">current_packet</a></td></tr> |
| 61 |
|
| 62 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">current packet information, correct after <a class="el" href="group__wl__basic.html#gae39ab95ba4a1b2ba2736f844c03cee7" title="wrapper for wl_do() to return packet data buffer">wl_basic_do()</a> <br></td></tr> |
| 63 |
</table>
|
| 64 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
| 65 |
Wireless abstraction for easily sending and receing packets. |
| 66 |
<p>
|
| 67 |
A high level abstraction of the wireless library.<p>
|
| 68 |
This will allow you to easily send and receive packets. <hr><h2>Function Documentation</h2> |
| 69 |
<a class="anchor" name="gae39ab95ba4a1b2ba2736f844c03cee7"></a><!-- doxytag: member="wl_basic.h::wl_basic_do" ref="gae39ab95ba4a1b2ba2736f844c03cee7" args="(void)" --> |
| 70 |
<div class="memitem"> |
| 71 |
<div class="memproto"> |
| 72 |
<table class="memname"> |
| 73 |
<tr>
|
| 74 |
<td class="memname">unsigned char* wl_basic_do </td> |
| 75 |
<td>(</td> |
| 76 |
<td class="paramtype">void </td> |
| 77 |
<td class="paramname"> </td> |
| 78 |
<td> ) </td> |
| 79 |
<td></td> |
| 80 |
</tr>
|
| 81 |
</table>
|
| 82 |
</div>
|
| 83 |
<div class="memdoc"> |
| 84 |
|
| 85 |
<p>
|
| 86 |
wrapper for <a class="el" href="group__wireless.html#g5c1f1a0e20fc718e59edc29246afd703" title="Perform wireless library functionality.">wl_do()</a> to return packet data buffer |
| 87 |
<p>
|
| 88 |
Wrapper for <a class="el" href="group__wireless.html#g5c1f1a0e20fc718e59edc29246afd703" title="Perform wireless library functionality.">wl_do()</a><p> |
| 89 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>pointer to the data of the packet just received </dd></dl> |
| 90 |
|
| 91 |
<p>References <a class="el" href="wl__basic_8h_source.html#l00057">current_packet</a>, and <a class="el" href="wireless_8c_source.html#l00390">wl_do()</a>.</p> |
| 92 |
|
| 93 |
</div>
|
| 94 |
</div><p> |
| 95 |
<a class="anchor" name="gae4a8ae98cc33955ee20b6e481d47adf"></a><!-- doxytag: member="wl_basic.h::wl_basic_init" ref="gae4a8ae98cc33955ee20b6e481d47adf" args="(void(*handle_receive)(char type, int source, unsigned char *packet, int length))" --> |
| 96 |
<div class="memitem"> |
| 97 |
<div class="memproto"> |
| 98 |
<table class="memname"> |
| 99 |
<tr>
|
| 100 |
<td class="memname">int wl_basic_init </td> |
| 101 |
<td>(</td> |
| 102 |
<td class="paramtype">void(*)(char type, int source, unsigned char *packet, int length) </td> |
| 103 |
<td class="paramname"> <em>handle_receive</em> </td> |
| 104 |
<td> ) </td> |
| 105 |
<td></td> |
| 106 |
</tr>
|
| 107 |
</table>
|
| 108 |
</div>
|
| 109 |
<div class="memdoc"> |
| 110 |
|
| 111 |
<p>
|
| 112 |
init wireless for Basic Group |
| 113 |
<p>
|
| 114 |
Wrapper for <a class="el" href="group__wireless.html#gedd4562415e273ce6537f9c1a0f2701b" title="Initialize the wireless library.">wl_init()</a>. Initializes wireless and registers a packet handler function for Basic Group.<p> |
| 115 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 116 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 117 |
<tr><td valign="top"></td><td valign="top"><em>handle_receive</em> </td><td>function pointer to handler function for Basic Group </td></tr> |
| 118 |
</table>
|
| 119 |
</dl>
|
| 120 |
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, -1 on error </dd></dl> |
| 121 |
|
| 122 |
<p>References <a class="el" href="wl__basic_8h_source.html#l00057">current_packet</a>, <a class="el" href="wl__basic_8c_source.html#l00042">wl_basic_register_handler()</a>, and <a class="el" href="wireless_8c_source.html#l00102">wl_init()</a>.</p> |
| 123 |
|
| 124 |
<p>Referenced by <a class="el" href="wl__basic_8c_source.html#l00033">wl_basic_init_default()</a>.</p> |
| 125 |
|
| 126 |
</div>
|
| 127 |
</div><p> |
| 128 |
<a class="anchor" name="g0ad976b2b61cca0081123606101c97cd"></a><!-- doxytag: member="wl_basic.h::wl_basic_packet_receive_handler" ref="g0ad976b2b61cca0081123606101c97cd" args="(char type, int source, unsigned char *packet, int length)" --> |
| 129 |
<div class="memitem"> |
| 130 |
<div class="memproto"> |
| 131 |
<table class="memname"> |
| 132 |
<tr>
|
| 133 |
<td class="memname">void wl_basic_packet_receive_handler </td> |
| 134 |
<td>(</td> |
| 135 |
<td class="paramtype">char </td> |
| 136 |
<td class="paramname"> <em>type</em>, </td> |
| 137 |
</tr>
|
| 138 |
<tr>
|
| 139 |
<td class="paramkey"></td> |
| 140 |
<td></td> |
| 141 |
<td class="paramtype">int </td> |
| 142 |
<td class="paramname"> <em>source</em>, </td> |
| 143 |
</tr>
|
| 144 |
<tr>
|
| 145 |
<td class="paramkey"></td> |
| 146 |
<td></td> |
| 147 |
<td class="paramtype">unsigned char * </td> |
| 148 |
<td class="paramname"> <em>packet</em>, </td> |
| 149 |
</tr>
|
| 150 |
<tr>
|
| 151 |
<td class="paramkey"></td> |
| 152 |
<td></td> |
| 153 |
<td class="paramtype">int </td> |
| 154 |
<td class="paramname"> <em>length</em></td><td> </td> |
| 155 |
</tr>
|
| 156 |
<tr>
|
| 157 |
<td></td> |
| 158 |
<td>)</td> |
| 159 |
<td></td><td></td><td></td> |
| 160 |
</tr>
|
| 161 |
</table>
|
| 162 |
</div>
|
| 163 |
<div class="memdoc"> |
| 164 |
|
| 165 |
<p>
|
| 166 |
default packet handler if none is specified on init |
| 167 |
<p>
|
| 168 |
Default packet handler used if none is specified on init<p>
|
| 169 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 170 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 171 |
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>Packet type </td></tr> |
| 172 |
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>Packet buffer, data you received </td></tr> |
| 173 |
<tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>Length of the data buffer in bytes </td></tr> |
| 174 |
</table>
|
| 175 |
</dl>
|
| 176 |
|
| 177 |
<p>References <a class="el" href="wl__basic_8h_source.html#l00057">current_packet</a>.</p> |
| 178 |
|
| 179 |
<p>Referenced by <a class="el" href="wl__basic_8c_source.html#l00033">wl_basic_init_default()</a>.</p> |
| 180 |
|
| 181 |
</div>
|
| 182 |
</div><p> |
| 183 |
<a class="anchor" name="gebc714e1bf382a98ac7a43762bf905c5"></a><!-- doxytag: member="wl_basic.h::wl_basic_register_handler" ref="gebc714e1bf382a98ac7a43762bf905c5" args="(void(*handle_receive)(char type, int source, unsigned char *packet, int length))" --> |
| 184 |
<div class="memitem"> |
| 185 |
<div class="memproto"> |
| 186 |
<table class="memname"> |
| 187 |
<tr>
|
| 188 |
<td class="memname">void wl_basic_register_handler </td> |
| 189 |
<td>(</td> |
| 190 |
<td class="paramtype">void(*)(char type, int source, unsigned char *packet, int length) </td> |
| 191 |
<td class="paramname"> <em>handle_receive</em> </td> |
| 192 |
<td> ) </td> |
| 193 |
<td></td> |
| 194 |
</tr>
|
| 195 |
</table>
|
| 196 |
</div>
|
| 197 |
<div class="memdoc"> |
| 198 |
|
| 199 |
<p>
|
| 200 |
internal function to register a packet handler function |
| 201 |
<p>
|
| 202 |
Internal function to register a packet group handler for Basic Group<p>
|
| 203 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 204 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 205 |
<tr><td valign="top"></td><td valign="top"><em>handle_receive</em> </td><td>function pointer to handler function for Basic Group </td></tr> |
| 206 |
</table>
|
| 207 |
</dl>
|
| 208 |
|
| 209 |
<p>References <a class="el" href="wireless_8h_source.html#l00091">PacketGroupHandler::groupCode</a>, <a class="el" href="structPacketGroupHandler.html#5c01636d72de2ddafc734ab754d93104">PacketGroupHandler::handle_receive</a>, <a class="el" href="structPacketGroupHandler.html#045939030c6e2f2dd0d53b5718d9f902">PacketGroupHandler::handle_response</a>, <a class="el" href="structPacketGroupHandler.html#952b4b63982db13f55c02e17c55ab5ac">PacketGroupHandler::timeout_handler</a>, <a class="el" href="structPacketGroupHandler.html#c03247d5c07e97e35b1f557c0937b0eb">PacketGroupHandler::unregister</a>, <a class="el" href="wl__basic_8h_source.html#l00044">wl_basic_group_handler</a>, and <a class="el" href="wireless_8c_source.html#l00342">wl_register_packet_group()</a>.</p> |
| 210 |
|
| 211 |
<p>Referenced by <a class="el" href="wl__basic_8c_source.html#l00021">wl_basic_init()</a>.</p> |
| 212 |
|
| 213 |
</div>
|
| 214 |
</div><p> |
| 215 |
<a class="anchor" name="g72d4f604603ef2541b5f4d3ae467938e"></a><!-- doxytag: member="wl_basic.h::wl_basic_send_global_packet" ref="g72d4f604603ef2541b5f4d3ae467938e" args="(char type, char *data, int len)" --> |
| 216 |
<div class="memitem"> |
| 217 |
<div class="memproto"> |
| 218 |
<table class="memname"> |
| 219 |
<tr>
|
| 220 |
<td class="memname">void wl_basic_send_global_packet </td> |
| 221 |
<td>(</td> |
| 222 |
<td class="paramtype">char </td> |
| 223 |
<td class="paramname"> <em>type</em>, </td> |
| 224 |
</tr>
|
| 225 |
<tr>
|
| 226 |
<td class="paramkey"></td> |
| 227 |
<td></td> |
| 228 |
<td class="paramtype">char * </td> |
| 229 |
<td class="paramname"> <em>data</em>, </td> |
| 230 |
</tr>
|
| 231 |
<tr>
|
| 232 |
<td class="paramkey"></td> |
| 233 |
<td></td> |
| 234 |
<td class="paramtype">int </td> |
| 235 |
<td class="paramname"> <em>len</em></td><td> </td> |
| 236 |
</tr>
|
| 237 |
<tr>
|
| 238 |
<td></td> |
| 239 |
<td>)</td> |
| 240 |
<td></td><td></td><td></td> |
| 241 |
</tr>
|
| 242 |
</table>
|
| 243 |
</div>
|
| 244 |
<div class="memdoc"> |
| 245 |
|
| 246 |
<p>
|
| 247 |
send a packet to all robots in Basic Group |
| 248 |
<p>
|
| 249 |
Send a packet to all robots in Basic Group<p>
|
| 250 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 251 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 252 |
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>Packet type </td></tr> |
| 253 |
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>Packet buffer, data you want to send </td></tr> |
| 254 |
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>Length of the data buffer in bytes </td></tr> |
| 255 |
</table>
|
| 256 |
</dl>
|
| 257 |
|
| 258 |
<p>References <a class="el" href="wireless_8c_source.html#l00285">wl_send_global_packet()</a>.</p> |
| 259 |
|
| 260 |
</div>
|
| 261 |
</div><p> |
| 262 |
<a class="anchor" name="gd5d7334484e49cc3cb9ebe2cfc323115"></a><!-- doxytag: member="wl_basic.h::wl_basic_send_robot_packet" ref="gd5d7334484e49cc3cb9ebe2cfc323115" args="(char type, char *data, int len, int dest)" --> |
| 263 |
<div class="memitem"> |
| 264 |
<div class="memproto"> |
| 265 |
<table class="memname"> |
| 266 |
<tr>
|
| 267 |
<td class="memname">void wl_basic_send_robot_packet </td> |
| 268 |
<td>(</td> |
| 269 |
<td class="paramtype">char </td> |
| 270 |
<td class="paramname"> <em>type</em>, </td> |
| 271 |
</tr>
|
| 272 |
<tr>
|
| 273 |
<td class="paramkey"></td> |
| 274 |
<td></td> |
| 275 |
<td class="paramtype">char * </td> |
| 276 |
<td class="paramname"> <em>data</em>, </td> |
| 277 |
</tr>
|
| 278 |
<tr>
|
| 279 |
<td class="paramkey"></td> |
| 280 |
<td></td> |
| 281 |
<td class="paramtype">int </td> |
| 282 |
<td class="paramname"> <em>len</em>, </td> |
| 283 |
</tr>
|
| 284 |
<tr>
|
| 285 |
<td class="paramkey"></td> |
| 286 |
<td></td> |
| 287 |
<td class="paramtype">int </td> |
| 288 |
<td class="paramname"> <em>dest</em></td><td> </td> |
| 289 |
</tr>
|
| 290 |
<tr>
|
| 291 |
<td></td> |
| 292 |
<td>)</td> |
| 293 |
<td></td><td></td><td></td> |
| 294 |
</tr>
|
| 295 |
</table>
|
| 296 |
</div>
|
| 297 |
<div class="memdoc"> |
| 298 |
|
| 299 |
<p>
|
| 300 |
send a packet to a single robot in Basic Group |
| 301 |
<p>
|
| 302 |
Send a packet to a single robot in Basic Group<p>
|
| 303 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 304 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 305 |
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>Packet type </td></tr> |
| 306 |
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>Packet buffer, data you want to send </td></tr> |
| 307 |
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>Length of the data buffer in bytes Robot ID of the destination robot </td></tr> |
| 308 |
</table>
|
| 309 |
</dl>
|
| 310 |
|
| 311 |
<p>References <a class="el" href="wireless_8c_source.html#l00252">wl_send_robot_to_robot_global_packet()</a>.</p> |
| 312 |
|
| 313 |
</div>
|
| 314 |
</div><p> |
| 315 |
</div>
|
| 316 |
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Sep 8 19:59:17 2009 for libwireless by |
| 317 |
<a href="http://www.doxygen.org/index.html"> |
| 318 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> |
| 319 |
</body>
|
| 320 |
</html>
|