root / trunk / docs / libwireless / group__tokenring.html @ 52
History | View | Annotate | Download (24 KB)
| 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>libwireless: Token Ring</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="index.html"><span>Main Page</span></a></li> |
| 11 |
<li><a href="modules.html"><span>Modules</span></a></li> |
| 12 |
<li><a href="annotated.html"><span>Data Structures</span></a></li> |
| 13 |
<li><a href="files.html"><span>Files</span></a></li> |
| 14 |
</ul></div> |
| 15 |
<h1>Token Ring</h1>Wireless library token ring implementation. |
| 16 |
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0"> |
| 17 |
<tr><td></td></tr> |
| 18 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
| 19 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#g7bfd97ec1f89b442b278bbcddc6b6ee1">wl_token_ring_register</a> (void)</td></tr> |
| 20 |
|
| 21 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Register the token ring group with the wireless library. <a href="#g7bfd97ec1f89b442b278bbcddc6b6ee1"></a><br></td></tr> |
| 22 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#gde3dd682b6a757bab6ce4cbc9c518f8e">wl_token_ring_unregister</a> (void)</td></tr> |
| 23 |
|
| 24 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unregister the token ring group with the wirelss library. <a href="#gde3dd682b6a757bab6ce4cbc9c518f8e"></a><br></td></tr> |
| 25 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#g0c407d5c215a97d58c67006bcc6e53ce">wl_token_ring_set_bom_functions</a> (void(*on_function)(void), void(*off_function)(void), int(*max_bom_function)(void))</td></tr> |
| 26 |
|
| 27 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the functions called to turn the bom on and off. <a href="#g0c407d5c215a97d58c67006bcc6e53ce"></a><br></td></tr> |
| 28 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#gbdb1e2258d1c69086692d2d31e02fb27">wl_token_ring_join</a> (void)</td></tr> |
| 29 |
|
| 30 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Join the token ring. <a href="#gbdb1e2258d1c69086692d2d31e02fb27"></a><br></td></tr> |
| 31 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#g6c2dd8742e100f63d4fb002707d1e85a">wl_token_ring_leave</a> (void)</td></tr> |
| 32 |
|
| 33 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Leave the token ring. <a href="#g6c2dd8742e100f63d4fb002707d1e85a"></a><br></td></tr> |
| 34 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#g23b4e34098b6fc32dc55ccab7fe17b5b">wl_token_request</a> (int robot)</td></tr> |
| 35 |
|
| 36 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Request a BOM flash from the specified robot. <a href="#g23b4e34098b6fc32dc55ccab7fe17b5b"></a><br></td></tr> |
| 37 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#g0c61bb8892aa5513706e00cd8ce5ca8b">wl_token_get_robots_in_ring</a> (void)</td></tr> |
| 38 |
|
| 39 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of robots in the token ring. <a href="#g0c61bb8892aa5513706e00cd8ce5ca8b"></a><br></td></tr> |
| 40 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#g14e005f0b9582eca7e3585f247c4cd72">wl_token_is_robot_in_ring</a> (int robot)</td></tr> |
| 41 |
|
| 42 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return whether a given robot is in the token ring. <a href="#g14e005f0b9582eca7e3585f247c4cd72"></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__tokenring.html#g37ab9fb00e9eef273b4d0fcda81a2620">wl_token_iterator_begin</a> (void)</td></tr> |
| 44 |
|
| 45 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Begin iterating through robots in the token ring. <a href="#g37ab9fb00e9eef273b4d0fcda81a2620"></a><br></td></tr> |
| 46 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#gbd7dc40ee796a67e1160b2b2b8e7d02f">wl_token_iterator_has_next</a> (void)</td></tr> |
| 47 |
|
| 48 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether there are more robots to iterate through. <a href="#gbd7dc40ee796a67e1160b2b2b8e7d02f"></a><br></td></tr> |
| 49 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#gd9196324178877770d8ffc91d40893c3">wl_token_iterator_next</a> (void)</td></tr> |
| 50 |
|
| 51 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the ID of the next robot in the token ring. <a href="#gd9196324178877770d8ffc91d40893c3"></a><br></td></tr> |
| 52 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#gb4afd4b8e034d22d415f3c4a42a652fc">wl_token_get_sensor_reading</a> (int source, int dest)</td></tr> |
| 53 |
|
| 54 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the latest BOM reading between two robots. <a href="#gb4afd4b8e034d22d415f3c4a42a652fc"></a><br></td></tr> |
| 55 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#g1938c1d79dd9438dcd413d6d26372877">wl_token_get_my_sensor_reading</a> (int dest)</td></tr> |
| 56 |
|
| 57 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the latest BOM reading between us and another robot. <a href="#g1938c1d79dd9438dcd413d6d26372877"></a><br></td></tr> |
| 58 |
</table>
|
| 59 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
| 60 |
Wireless library token ring implementation. |
| 61 |
<p>
|
| 62 |
This packet group is used to form a token ring, which keeps track of the relative directions of the robots from one another. <hr><h2>Function Documentation</h2> |
| 63 |
<a class="anchor" name="g1938c1d79dd9438dcd413d6d26372877"></a><!-- doxytag: member="wl_token_ring.h::wl_token_get_my_sensor_reading" ref="g1938c1d79dd9438dcd413d6d26372877" args="(int dest)" --><p> |
| 64 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
| 65 |
<tr>
|
| 66 |
<td class="mdRow"> |
| 67 |
<table cellpadding="0" cellspacing="0" border="0"> |
| 68 |
<tr>
|
| 69 |
<td class="md" nowrap valign="top">int wl_token_get_my_sensor_reading </td> |
| 70 |
<td class="md" valign="top">( </td> |
| 71 |
<td class="md" nowrap valign="top">int </td> |
| 72 |
<td class="mdname1" valign="top" nowrap> <em>dest</em> </td> |
| 73 |
<td class="md" valign="top"> ) </td> |
| 74 |
<td class="md" nowrap></td> |
| 75 |
</tr>
|
| 76 |
</table>
|
| 77 |
</td>
|
| 78 |
</tr>
|
| 79 |
</table>
|
| 80 |
<table cellspacing="5" cellpadding="0" border="0"> |
| 81 |
<tr>
|
| 82 |
<td>
|
| 83 |
|
| 84 |
</td>
|
| 85 |
<td>
|
| 86 |
|
| 87 |
<p>
|
| 88 |
Return the latest BOM reading between us and another robot. |
| 89 |
<p>
|
| 90 |
Returns the BOM reading we have for robot dest.<p>
|
| 91 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 92 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 93 |
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>the robot whose relative location is returned</td></tr> |
| 94 |
</table>
|
| 95 |
</dl>
|
| 96 |
<dl compact><dt><b>Returns:</b></dt><dd>a BOM reading from us to robot dest, in the range 0-15, or -1 if it is unkown </dd></dl> |
| 97 |
</td>
|
| 98 |
</tr>
|
| 99 |
</table>
|
| 100 |
<a class="anchor" name="g0c61bb8892aa5513706e00cd8ce5ca8b"></a><!-- doxytag: member="wl_token_ring.h::wl_token_get_robots_in_ring" ref="g0c61bb8892aa5513706e00cd8ce5ca8b" args="(void)" --><p> |
| 101 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
| 102 |
<tr>
|
| 103 |
<td class="mdRow"> |
| 104 |
<table cellpadding="0" cellspacing="0" border="0"> |
| 105 |
<tr>
|
| 106 |
<td class="md" nowrap valign="top">int wl_token_get_robots_in_ring </td> |
| 107 |
<td class="md" valign="top">( </td> |
| 108 |
<td class="md" nowrap valign="top">void </td> |
| 109 |
<td class="mdname1" valign="top" nowrap> </td> |
| 110 |
<td class="md" valign="top"> ) </td> |
| 111 |
<td class="md" nowrap></td> |
| 112 |
</tr>
|
| 113 |
</table>
|
| 114 |
</td>
|
| 115 |
</tr>
|
| 116 |
</table>
|
| 117 |
<table cellspacing="5" cellpadding="0" border="0"> |
| 118 |
<tr>
|
| 119 |
<td>
|
| 120 |
|
| 121 |
</td>
|
| 122 |
<td>
|
| 123 |
|
| 124 |
<p>
|
| 125 |
Return the number of robots in the token ring. |
| 126 |
<p>
|
| 127 |
Returns the number of robots in the token ring.<p>
|
| 128 |
<dl compact><dt><b>Returns:</b></dt><dd>the number of robots in the token ring </dd></dl> |
| 129 |
</td>
|
| 130 |
</tr>
|
| 131 |
</table>
|
| 132 |
<a class="anchor" name="gb4afd4b8e034d22d415f3c4a42a652fc"></a><!-- doxytag: member="wl_token_ring.h::wl_token_get_sensor_reading" ref="gb4afd4b8e034d22d415f3c4a42a652fc" args="(int source, int dest)" --><p> |
| 133 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
| 134 |
<tr>
|
| 135 |
<td class="mdRow"> |
| 136 |
<table cellpadding="0" cellspacing="0" border="0"> |
| 137 |
<tr>
|
| 138 |
<td class="md" nowrap valign="top">int wl_token_get_sensor_reading </td> |
| 139 |
<td class="md" valign="top">( </td> |
| 140 |
<td class="md" nowrap valign="top">int </td> |
| 141 |
<td class="mdname" nowrap> <em>source</em>, </td> |
| 142 |
</tr>
|
| 143 |
<tr>
|
| 144 |
<td class="md" nowrap align="right"></td> |
| 145 |
<td class="md"></td> |
| 146 |
<td class="md" nowrap>int </td> |
| 147 |
<td class="mdname" nowrap> <em>dest</em></td> |
| 148 |
</tr>
|
| 149 |
<tr>
|
| 150 |
<td class="md"></td> |
| 151 |
<td class="md">) </td> |
| 152 |
<td class="md" colspan="2"></td> |
| 153 |
</tr>
|
| 154 |
</table>
|
| 155 |
</td>
|
| 156 |
</tr>
|
| 157 |
</table>
|
| 158 |
<table cellspacing="5" cellpadding="0" border="0"> |
| 159 |
<tr>
|
| 160 |
<td>
|
| 161 |
|
| 162 |
</td>
|
| 163 |
<td>
|
| 164 |
|
| 165 |
<p>
|
| 166 |
Return the latest BOM reading between two robots. |
| 167 |
<p>
|
| 168 |
Returns the BOM reading robot source has for robot dest.<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>source</em> </td><td>the robot that made the BOM reading </td></tr> |
| 172 |
<tr><td valign="top"></td><td valign="top"><em>dest</em> </td><td>the robot whose relative location is returned</td></tr> |
| 173 |
</table>
|
| 174 |
</dl>
|
| 175 |
<dl compact><dt><b>Returns:</b></dt><dd>a BOM reading from robot source to robot dest, in the range 0-15, or -1 if it is unknown </dd></dl> |
| 176 |
</td>
|
| 177 |
</tr>
|
| 178 |
</table>
|
| 179 |
<a class="anchor" name="g14e005f0b9582eca7e3585f247c4cd72"></a><!-- doxytag: member="wl_token_ring.h::wl_token_is_robot_in_ring" ref="g14e005f0b9582eca7e3585f247c4cd72" args="(int robot)" --><p> |
| 180 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
| 181 |
<tr>
|
| 182 |
<td class="mdRow"> |
| 183 |
<table cellpadding="0" cellspacing="0" border="0"> |
| 184 |
<tr>
|
| 185 |
<td class="md" nowrap valign="top">int wl_token_is_robot_in_ring </td> |
| 186 |
<td class="md" valign="top">( </td> |
| 187 |
<td class="md" nowrap valign="top">int </td> |
| 188 |
<td class="mdname1" valign="top" nowrap> <em>robot</em> </td> |
| 189 |
<td class="md" valign="top"> ) </td> |
| 190 |
<td class="md" nowrap></td> |
| 191 |
</tr>
|
| 192 |
</table>
|
| 193 |
</td>
|
| 194 |
</tr>
|
| 195 |
</table>
|
| 196 |
<table cellspacing="5" cellpadding="0" border="0"> |
| 197 |
<tr>
|
| 198 |
<td>
|
| 199 |
|
| 200 |
</td>
|
| 201 |
<td>
|
| 202 |
|
| 203 |
<p>
|
| 204 |
Return whether a given robot is in the token ring. |
| 205 |
<p>
|
| 206 |
Returns true if the specified robot is in the token ring, false otherwise.<p>
|
| 207 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 208 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 209 |
<tr><td valign="top"></td><td valign="top"><em>robot</em> </td><td>the robot to check for whether it is in the token ring </td></tr> |
| 210 |
</table>
|
| 211 |
</dl>
|
| 212 |
<dl compact><dt><b>Returns:</b></dt><dd>nonzero if the robot is in the token ring, zero otherwise </dd></dl> |
| 213 |
</td>
|
| 214 |
</tr>
|
| 215 |
</table>
|
| 216 |
<a class="anchor" name="g37ab9fb00e9eef273b4d0fcda81a2620"></a><!-- doxytag: member="wl_token_ring.h::wl_token_iterator_begin" ref="g37ab9fb00e9eef273b4d0fcda81a2620" args="(void)" --><p> |
| 217 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
| 218 |
<tr>
|
| 219 |
<td class="mdRow"> |
| 220 |
<table cellpadding="0" cellspacing="0" border="0"> |
| 221 |
<tr>
|
| 222 |
<td class="md" nowrap valign="top">void wl_token_iterator_begin </td> |
| 223 |
<td class="md" valign="top">( </td> |
| 224 |
<td class="md" nowrap valign="top">void </td> |
| 225 |
<td class="mdname1" valign="top" nowrap> </td> |
| 226 |
<td class="md" valign="top"> ) </td> |
| 227 |
<td class="md" nowrap></td> |
| 228 |
</tr>
|
| 229 |
</table>
|
| 230 |
</td>
|
| 231 |
</tr>
|
| 232 |
</table>
|
| 233 |
<table cellspacing="5" cellpadding="0" border="0"> |
| 234 |
<tr>
|
| 235 |
<td>
|
| 236 |
|
| 237 |
</td>
|
| 238 |
<td>
|
| 239 |
|
| 240 |
<p>
|
| 241 |
Begin iterating through robots in the token ring. |
| 242 |
<p>
|
| 243 |
Begins iterating through the robots in the token ring.<p>
|
| 244 |
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__tokenring.html#gbd7dc40ee796a67e1160b2b2b8e7d02f">wl_token_iterator_has_next</a>, <a class="el" href="group__tokenring.html#gd9196324178877770d8ffc91d40893c3">wl_token_iterator_next</a> </dd></dl> |
| 245 |
</td>
|
| 246 |
</tr>
|
| 247 |
</table>
|
| 248 |
<a class="anchor" name="gbd7dc40ee796a67e1160b2b2b8e7d02f"></a><!-- doxytag: member="wl_token_ring.h::wl_token_iterator_has_next" ref="gbd7dc40ee796a67e1160b2b2b8e7d02f" args="(void)" --><p> |
| 249 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
| 250 |
<tr>
|
| 251 |
<td class="mdRow"> |
| 252 |
<table cellpadding="0" cellspacing="0" border="0"> |
| 253 |
<tr>
|
| 254 |
<td class="md" nowrap valign="top">int wl_token_iterator_has_next </td> |
| 255 |
<td class="md" valign="top">( </td> |
| 256 |
<td class="md" nowrap valign="top">void </td> |
| 257 |
<td class="mdname1" valign="top" nowrap> </td> |
| 258 |
<td class="md" valign="top"> ) </td> |
| 259 |
<td class="md" nowrap></td> |
| 260 |
</tr>
|
| 261 |
</table>
|
| 262 |
</td>
|
| 263 |
</tr>
|
| 264 |
</table>
|
| 265 |
<table cellspacing="5" cellpadding="0" border="0"> |
| 266 |
<tr>
|
| 267 |
<td>
|
| 268 |
|
| 269 |
</td>
|
| 270 |
<td>
|
| 271 |
|
| 272 |
<p>
|
| 273 |
Returns whether there are more robots to iterate through. |
| 274 |
<p>
|
| 275 |
Returns true if there are more robots in the token ring to iterate through, and false otherwise.<p>
|
| 276 |
<dl compact><dt><b>Returns:</b></dt><dd>nonzero if there are more robots to iterate through, zero otherwise</dd></dl> |
| 277 |
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__tokenring.html#g37ab9fb00e9eef273b4d0fcda81a2620">wl_token_iterator_begin</a>, <a class="el" href="group__tokenring.html#gd9196324178877770d8ffc91d40893c3">wl_token_iterator_next</a> </dd></dl> |
| 278 |
</td>
|
| 279 |
</tr>
|
| 280 |
</table>
|
| 281 |
<a class="anchor" name="gd9196324178877770d8ffc91d40893c3"></a><!-- doxytag: member="wl_token_ring.h::wl_token_iterator_next" ref="gd9196324178877770d8ffc91d40893c3" args="(void)" --><p> |
| 282 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
| 283 |
<tr>
|
| 284 |
<td class="mdRow"> |
| 285 |
<table cellpadding="0" cellspacing="0" border="0"> |
| 286 |
<tr>
|
| 287 |
<td class="md" nowrap valign="top">int wl_token_iterator_next </td> |
| 288 |
<td class="md" valign="top">( </td> |
| 289 |
<td class="md" nowrap valign="top">void </td> |
| 290 |
<td class="mdname1" valign="top" nowrap> </td> |
| 291 |
<td class="md" valign="top"> ) </td> |
| 292 |
<td class="md" nowrap></td> |
| 293 |
</tr>
|
| 294 |
</table>
|
| 295 |
</td>
|
| 296 |
</tr>
|
| 297 |
</table>
|
| 298 |
<table cellspacing="5" cellpadding="0" border="0"> |
| 299 |
<tr>
|
| 300 |
<td>
|
| 301 |
|
| 302 |
</td>
|
| 303 |
<td>
|
| 304 |
|
| 305 |
<p>
|
| 306 |
Returns the ID of the next robot in the token ring. |
| 307 |
<p>
|
| 308 |
Returns the next robot ID in the token ring.<p>
|
| 309 |
<dl compact><dt><b>Returns:</b></dt><dd>the next robot ID in the token ring, or -1 if none exists</dd></dl> |
| 310 |
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__tokenring.html#g37ab9fb00e9eef273b4d0fcda81a2620">wl_token_iterator_begin</a>, <a class="el" href="group__tokenring.html#gbd7dc40ee796a67e1160b2b2b8e7d02f">wl_token_iterator_has_next</a> </dd></dl> |
| 311 |
</td>
|
| 312 |
</tr>
|
| 313 |
</table>
|
| 314 |
<a class="anchor" name="g23b4e34098b6fc32dc55ccab7fe17b5b"></a><!-- doxytag: member="wl_token_ring.h::wl_token_request" ref="g23b4e34098b6fc32dc55ccab7fe17b5b" args="(int robot)" --><p> |
| 315 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
| 316 |
<tr>
|
| 317 |
<td class="mdRow"> |
| 318 |
<table cellpadding="0" cellspacing="0" border="0"> |
| 319 |
<tr>
|
| 320 |
<td class="md" nowrap valign="top">void wl_token_request </td> |
| 321 |
<td class="md" valign="top">( </td> |
| 322 |
<td class="md" nowrap valign="top">int </td> |
| 323 |
<td class="mdname1" valign="top" nowrap> <em>robot</em> </td> |
| 324 |
<td class="md" valign="top"> ) </td> |
| 325 |
<td class="md" nowrap></td> |
| 326 |
</tr>
|
| 327 |
</table>
|
| 328 |
</td>
|
| 329 |
</tr>
|
| 330 |
</table>
|
| 331 |
<table cellspacing="5" cellpadding="0" border="0"> |
| 332 |
<tr>
|
| 333 |
<td>
|
| 334 |
|
| 335 |
</td>
|
| 336 |
<td>
|
| 337 |
|
| 338 |
<p>
|
| 339 |
Request a BOM flash from the specified robot. |
| 340 |
<p>
|
| 341 |
Requests that the specified robot be given the token and allowed to flash its BOM. After its BOM is flashed, the token will return to the robot who sent it.<p>
|
| 342 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 343 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 344 |
<tr><td valign="top"></td><td valign="top"><em>robot</em> </td><td>the ID of the robot which should flash its BOM </td></tr> |
| 345 |
</table>
|
| 346 |
</dl>
|
| 347 |
</td>
|
| 348 |
</tr>
|
| 349 |
</table>
|
| 350 |
<a class="anchor" name="gbdb1e2258d1c69086692d2d31e02fb27"></a><!-- doxytag: member="wl_token_ring.h::wl_token_ring_join" ref="gbdb1e2258d1c69086692d2d31e02fb27" args="(void)" --><p> |
| 351 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
| 352 |
<tr>
|
| 353 |
<td class="mdRow"> |
| 354 |
<table cellpadding="0" cellspacing="0" border="0"> |
| 355 |
<tr>
|
| 356 |
<td class="md" nowrap valign="top">void wl_token_ring_join </td> |
| 357 |
<td class="md" valign="top">( </td> |
| 358 |
<td class="md" nowrap valign="top">void </td> |
| 359 |
<td class="mdname1" valign="top" nowrap> </td> |
| 360 |
<td class="md" valign="top"> ) </td> |
| 361 |
<td class="md" nowrap></td> |
| 362 |
</tr>
|
| 363 |
</table>
|
| 364 |
</td>
|
| 365 |
</tr>
|
| 366 |
</table>
|
| 367 |
<table cellspacing="5" cellpadding="0" border="0"> |
| 368 |
<tr>
|
| 369 |
<td>
|
| 370 |
|
| 371 |
</td>
|
| 372 |
<td>
|
| 373 |
|
| 374 |
<p>
|
| 375 |
Join the token ring. |
| 376 |
<p>
|
| 377 |
Causes the robot to join an existing token ring, or create one if no token ring exists. The token ring uses global and robot to robot packets, and does not rely on any PAN. </td>
|
| 378 |
</tr>
|
| 379 |
</table>
|
| 380 |
<a class="anchor" name="g6c2dd8742e100f63d4fb002707d1e85a"></a><!-- doxytag: member="wl_token_ring.h::wl_token_ring_leave" ref="g6c2dd8742e100f63d4fb002707d1e85a" args="(void)" --><p> |
| 381 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
| 382 |
<tr>
|
| 383 |
<td class="mdRow"> |
| 384 |
<table cellpadding="0" cellspacing="0" border="0"> |
| 385 |
<tr>
|
| 386 |
<td class="md" nowrap valign="top">void wl_token_ring_leave </td> |
| 387 |
<td class="md" valign="top">( </td> |
| 388 |
<td class="md" nowrap valign="top">void </td> |
| 389 |
<td class="mdname1" valign="top" nowrap> </td> |
| 390 |
<td class="md" valign="top"> ) </td> |
| 391 |
<td class="md" nowrap></td> |
| 392 |
</tr>
|
| 393 |
</table>
|
| 394 |
</td>
|
| 395 |
</tr>
|
| 396 |
</table>
|
| 397 |
<table cellspacing="5" cellpadding="0" border="0"> |
| 398 |
<tr>
|
| 399 |
<td>
|
| 400 |
|
| 401 |
</td>
|
| 402 |
<td>
|
| 403 |
|
| 404 |
<p>
|
| 405 |
Leave the token ring. |
| 406 |
<p>
|
| 407 |
Causes the robot to leave the token ring. The robot stops alerting others of its location, but continues storing the locations of other robots. </td>
|
| 408 |
</tr>
|
| 409 |
</table>
|
| 410 |
<a class="anchor" name="g7bfd97ec1f89b442b278bbcddc6b6ee1"></a><!-- doxytag: member="wl_token_ring.h::wl_token_ring_register" ref="g7bfd97ec1f89b442b278bbcddc6b6ee1" args="(void)" --><p> |
| 411 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
| 412 |
<tr>
|
| 413 |
<td class="mdRow"> |
| 414 |
<table cellpadding="0" cellspacing="0" border="0"> |
| 415 |
<tr>
|
| 416 |
<td class="md" nowrap valign="top">void wl_token_ring_register </td> |
| 417 |
<td class="md" valign="top">( </td> |
| 418 |
<td class="md" nowrap valign="top">void </td> |
| 419 |
<td class="mdname1" valign="top" nowrap> </td> |
| 420 |
<td class="md" valign="top"> ) </td> |
| 421 |
<td class="md" nowrap></td> |
| 422 |
</tr>
|
| 423 |
</table>
|
| 424 |
</td>
|
| 425 |
</tr>
|
| 426 |
</table>
|
| 427 |
<table cellspacing="5" cellpadding="0" border="0"> |
| 428 |
<tr>
|
| 429 |
<td>
|
| 430 |
|
| 431 |
</td>
|
| 432 |
<td>
|
| 433 |
|
| 434 |
<p>
|
| 435 |
Register the token ring group with the wireless library. |
| 436 |
<p>
|
| 437 |
Initialize the token ring packet group and register it with the wireless library. The robot will not join a token ring. </td>
|
| 438 |
</tr>
|
| 439 |
</table>
|
| 440 |
<a class="anchor" name="g0c407d5c215a97d58c67006bcc6e53ce"></a><!-- doxytag: member="wl_token_ring.h::wl_token_ring_set_bom_functions" ref="g0c407d5c215a97d58c67006bcc6e53ce" args="(void(*on_function)(void), void(*off_function)(void), int(*max_bom_function)(void))" --><p> |
| 441 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
| 442 |
<tr>
|
| 443 |
<td class="mdRow"> |
| 444 |
<table cellpadding="0" cellspacing="0" border="0"> |
| 445 |
<tr>
|
| 446 |
<td class="md" nowrap valign="top">void wl_token_ring_set_bom_functions </td> |
| 447 |
<td class="md" valign="top">( </td> |
| 448 |
<td class="md" nowrap valign="top">void(*)(void) </td> |
| 449 |
<td class="mdname" nowrap> <em>on_function</em>, </td> |
| 450 |
</tr>
|
| 451 |
<tr>
|
| 452 |
<td class="md" nowrap align="right"></td> |
| 453 |
<td class="md"></td> |
| 454 |
<td class="md" nowrap>void(*)(void) </td> |
| 455 |
<td class="mdname" nowrap> <em>off_function</em>, </td> |
| 456 |
</tr>
|
| 457 |
<tr>
|
| 458 |
<td class="md" nowrap align="right"></td> |
| 459 |
<td class="md"></td> |
| 460 |
<td class="md" nowrap>int(*)(void) </td> |
| 461 |
<td class="mdname" nowrap> <em>max_bom_function</em></td> |
| 462 |
</tr>
|
| 463 |
<tr>
|
| 464 |
<td class="md"></td> |
| 465 |
<td class="md">) </td> |
| 466 |
<td class="md" colspan="2"></td> |
| 467 |
</tr>
|
| 468 |
</table>
|
| 469 |
</td>
|
| 470 |
</tr>
|
| 471 |
</table>
|
| 472 |
<table cellspacing="5" cellpadding="0" border="0"> |
| 473 |
<tr>
|
| 474 |
<td>
|
| 475 |
|
| 476 |
</td>
|
| 477 |
<td>
|
| 478 |
|
| 479 |
<p>
|
| 480 |
Set the functions called to turn the bom on and off. |
| 481 |
<p>
|
| 482 |
Sets the functions that are called when the BOM ought to be turned on or off. This could be used for things such as charging stations, which have multiple BOMs.<p>
|
| 483 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 484 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 485 |
<tr><td valign="top"></td><td valign="top"><em>on_function</em> </td><td>the function to be called when the BOM should be turned on </td></tr> |
| 486 |
<tr><td valign="top"></td><td valign="top"><em>off_function</em> </td><td>the function to be called when the BOM should be turned off </td></tr> |
| 487 |
<tr><td valign="top"></td><td valign="top"><em>max_bom_function</em> </td><td>the function to be called when a measurement of the maximum BOM reading is needed. </td></tr> |
| 488 |
</table>
|
| 489 |
</dl>
|
| 490 |
</td>
|
| 491 |
</tr>
|
| 492 |
</table>
|
| 493 |
<a class="anchor" name="gde3dd682b6a757bab6ce4cbc9c518f8e"></a><!-- doxytag: member="wl_token_ring.h::wl_token_ring_unregister" ref="gde3dd682b6a757bab6ce4cbc9c518f8e" args="(void)" --><p> |
| 494 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
| 495 |
<tr>
|
| 496 |
<td class="mdRow"> |
| 497 |
<table cellpadding="0" cellspacing="0" border="0"> |
| 498 |
<tr>
|
| 499 |
<td class="md" nowrap valign="top">void wl_token_ring_unregister </td> |
| 500 |
<td class="md" valign="top">( </td> |
| 501 |
<td class="md" nowrap valign="top">void </td> |
| 502 |
<td class="mdname1" valign="top" nowrap> </td> |
| 503 |
<td class="md" valign="top"> ) </td> |
| 504 |
<td class="md" nowrap></td> |
| 505 |
</tr>
|
| 506 |
</table>
|
| 507 |
</td>
|
| 508 |
</tr>
|
| 509 |
</table>
|
| 510 |
<table cellspacing="5" cellpadding="0" border="0"> |
| 511 |
<tr>
|
| 512 |
<td>
|
| 513 |
|
| 514 |
</td>
|
| 515 |
<td>
|
| 516 |
|
| 517 |
<p>
|
| 518 |
Unregister the token ring group with the wirelss library. |
| 519 |
<p>
|
| 520 |
Removes the packet group from the wireless library. </td>
|
| 521 |
</tr>
|
| 522 |
</table>
|
| 523 |
<hr size="1"><address style="align: right;"><small>Generated on Fri Sep 21 12:57:06 2007 for libwireless by |
| 524 |
<a href="http://www.doxygen.org/index.html"> |
| 525 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address> |
| 526 |
</body>
|
| 527 |
</html>
|