Revision 241
Updated libdragonfly documentation.
| wl__token__ring_8h-source.html | ||
|---|---|---|
| 1 | 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">
|
|
| 2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
|
|
| 3 | 3 |
<title>libwireless: wl_token_ring.h Source File</title> |
| 4 | 4 |
<link href="doxygen.css" rel="stylesheet" type="text/css"> |
| 5 | 5 |
<link href="tabs.css" rel="stylesheet" type="text/css"> |
| 6 | 6 |
</head><body> |
| 7 |
<!-- Generated by Doxygen 1.4.6 -->
|
|
| 7 |
<!-- Generated by Doxygen 1.5.3 -->
|
|
| 8 | 8 |
<div class="tabs"> |
| 9 | 9 |
<ul> |
| 10 | 10 |
<li><a href="index.html"><span>Main Page</span></a></li> |
| 11 | 11 |
<li><a href="modules.html"><span>Modules</span></a></li> |
| 12 | 12 |
<li><a href="annotated.html"><span>Data Structures</span></a></li> |
| 13 |
<li id="current"><a href="files.html"><span>Files</span></a></li> |
|
| 14 |
</ul></div> |
|
| 15 |
<div class="tabs"> |
|
| 16 |
<ul> |
|
| 17 |
<li><a href="files.html"><span>File List</span></a></li> |
|
| 18 |
<li><a href="globals.html"><span>Globals</span></a></li> |
|
| 19 |
</ul></div> |
|
| 13 |
<li class="current"><a href="files.html"><span>Files</span></a></li> |
|
| 14 |
</ul> |
|
| 15 |
</div> |
|
| 20 | 16 |
<h1>wl_token_ring.h</h1><a href="wl__token__ring_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 |
| 21 | 17 |
<a name="l00010"></a>00010 <span class="preprocessor">#ifndef WL_TOKEN_RING_H</span> |
| 22 | 18 |
<a name="l00011"></a>00011 <span class="preprocessor"></span><span class="preprocessor">#define WL_TOKEN_RING_H</span> |
| 23 | 19 |
<a name="l00012"></a>00012 <span class="preprocessor"></span> |
| 24 |
<a name="l00025"></a>00025 <span class="keywordtype">void</span> <a class="code" href="group__tokenring.html#g7bfd97ec1f89b442b278bbcddc6b6ee1">wl_token_ring_register</a>(<span class="keywordtype">void</span>); |
|
| 25 |
<a name="l00027"></a>00027 <span class="keywordtype">void</span> <a class="code" href="group__tokenring.html#gde3dd682b6a757bab6ce4cbc9c518f8e">wl_token_ring_unregister</a>(<span class="keywordtype">void</span>); |
|
| 26 |
<a name="l00029"></a>00029 <span class="keywordtype">void</span> <a class="code" href="group__tokenring.html#g0c407d5c215a97d58c67006bcc6e53ce">wl_token_ring_set_bom_functions</a>(<span class="keywordtype">void</span> (*on_function) (<span class="keywordtype">void</span>), |
|
| 20 |
<a name="l00025"></a>00025 <span class="keywordtype">void</span> <a class="code" href="group__tokenring.html#g7bfd97ec1f89b442b278bbcddc6b6ee1" title="Register the token ring group with the wireless library.">wl_token_ring_register</a>(<span class="keywordtype">void</span>);
|
|
| 21 |
<a name="l00027"></a>00027 <span class="keywordtype">void</span> <a class="code" href="group__tokenring.html#gde3dd682b6a757bab6ce4cbc9c518f8e" title="Unregister the token ring group with the wirelss library.">wl_token_ring_unregister</a>(<span class="keywordtype">void</span>);
|
|
| 22 |
<a name="l00029"></a>00029 <span class="keywordtype">void</span> <a class="code" href="group__tokenring.html#g0c407d5c215a97d58c67006bcc6e53ce" title="Set the functions called to turn the bom on and off.">wl_token_ring_set_bom_functions</a>(<span class="keywordtype">void</span> (*on_function) (<span class="keywordtype">void</span>),
|
|
| 27 | 23 |
<a name="l00030"></a>00030 <span class="keywordtype">void</span> (*off_function) (<span class="keywordtype">void</span>), <span class="keywordtype">int</span> (*max_bom_function) (<span class="keywordtype">void</span>)); |
| 28 | 24 |
<a name="l00031"></a>00031 |
| 29 |
<a name="l00033"></a>00033 <span class="keywordtype">void</span> <a class="code" href="group__tokenring.html#gbdb1e2258d1c69086692d2d31e02fb27">wl_token_ring_join</a>(<span class="keywordtype">void</span>); |
|
| 30 |
<a name="l00035"></a>00035 <span class="keywordtype">void</span> <a class="code" href="group__tokenring.html#g6c2dd8742e100f63d4fb002707d1e85a">wl_token_ring_leave</a>(<span class="keywordtype">void</span>); |
|
| 25 |
<a name="l00033"></a>00033 <span class="keywordtype">void</span> <a class="code" href="group__tokenring.html#gbdb1e2258d1c69086692d2d31e02fb27" title="Join the token ring.">wl_token_ring_join</a>(<span class="keywordtype">void</span>);
|
|
| 26 |
<a name="l00035"></a>00035 <span class="keywordtype">void</span> <a class="code" href="group__tokenring.html#g6c2dd8742e100f63d4fb002707d1e85a" title="Leave the token ring.">wl_token_ring_leave</a>(<span class="keywordtype">void</span>);
|
|
| 31 | 27 |
<a name="l00036"></a>00036 |
| 32 |
<a name="l00038"></a>00038 <span class="keywordtype">int</span> <a class="code" href="group__tokenring.html#g0c61bb8892aa5513706e00cd8ce5ca8b">wl_token_get_robots_in_ring</a>(<span class="keywordtype">void</span>); |
|
| 33 |
<a name="l00040"></a>00040 <span class="keywordtype">int</span> <a class="code" href="group__tokenring.html#g14e005f0b9582eca7e3585f247c4cd72">wl_token_is_robot_in_ring</a>(<span class="keywordtype">int</span> robot); |
|
| 28 |
<a name="l00038"></a>00038 <span class="keywordtype">int</span> <a class="code" href="group__tokenring.html#g0c61bb8892aa5513706e00cd8ce5ca8b" title="Return the number of robots in the token ring.">wl_token_get_robots_in_ring</a>(<span class="keywordtype">void</span>);
|
|
| 29 |
<a name="l00040"></a>00040 <span class="keywordtype">int</span> <a class="code" href="group__tokenring.html#g14e005f0b9582eca7e3585f247c4cd72" title="Return whether a given robot is in the token ring.">wl_token_is_robot_in_ring</a>(<span class="keywordtype">int</span> robot);
|
|
| 34 | 30 |
<a name="l00041"></a>00041 |
| 35 |
<a name="l00043"></a>00043 <span class="keywordtype">void</span> <a class="code" href="group__tokenring.html#g37ab9fb00e9eef273b4d0fcda81a2620">wl_token_iterator_begin</a>(<span class="keywordtype">void</span>); |
|
| 36 |
<a name="l00045"></a>00045 <span class="keywordtype">int</span> <a class="code" href="group__tokenring.html#gbd7dc40ee796a67e1160b2b2b8e7d02f">wl_token_iterator_has_next</a>(<span class="keywordtype">void</span>); |
|
| 37 |
<a name="l00047"></a>00047 <span class="keywordtype">int</span> <a class="code" href="group__tokenring.html#gd9196324178877770d8ffc91d40893c3">wl_token_iterator_next</a>(<span class="keywordtype">void</span>); |
|
| 31 |
<a name="l00043"></a>00043 <span class="keywordtype">void</span> <a class="code" href="group__tokenring.html#g37ab9fb00e9eef273b4d0fcda81a2620" title="Begin iterating through robots in the token ring.">wl_token_iterator_begin</a>(<span class="keywordtype">void</span>);
|
|
| 32 |
<a name="l00045"></a>00045 <span class="keywordtype">int</span> <a class="code" href="group__tokenring.html#gbd7dc40ee796a67e1160b2b2b8e7d02f" title="Returns whether there are more robots to iterate through.">wl_token_iterator_has_next</a>(<span class="keywordtype">void</span>);
|
|
| 33 |
<a name="l00047"></a>00047 <span class="keywordtype">int</span> <a class="code" href="group__tokenring.html#gd9196324178877770d8ffc91d40893c3" title="Returns the ID of the next robot in the token ring.">wl_token_iterator_next</a>(<span class="keywordtype">void</span>);
|
|
| 38 | 34 |
<a name="l00048"></a>00048 |
| 39 |
<a name="l00050"></a>00050 <span class="keywordtype">int</span> <a class="code" href="group__tokenring.html#gb4afd4b8e034d22d415f3c4a42a652fc">wl_token_get_sensor_reading</a>(<span class="keywordtype">int</span> source, <span class="keywordtype">int</span> dest); |
|
| 40 |
<a name="l00052"></a>00052 <span class="keywordtype">int</span> <a class="code" href="group__tokenring.html#g1938c1d79dd9438dcd413d6d26372877">wl_token_get_my_sensor_reading</a>(<span class="keywordtype">int</span> dest); |
|
| 41 |
<a name="l00054"></a>00054 <span class="keywordtype">int</span> <a class="code" href="group__tokenring.html#gf0d311d4feae71afc8bcb0b8c8e6ba57">wl_token_get_num_robots</a>(<span class="keywordtype">void</span>); |
|
| 42 |
<a name="l00056"></a>00056 <span class="keywordtype">int</span> <a class="code" href="group__tokenring.html#g5fe1508968d450a970b0d5417a06431d">wl_token_get_matrix_size</a>(<span class="keywordtype">void</span>); |
|
| 35 |
<a name="l00050"></a>00050 <span class="keywordtype">int</span> <a class="code" href="group__tokenring.html#gb4afd4b8e034d22d415f3c4a42a652fc" title="Return the latest BOM reading between two robots.">wl_token_get_sensor_reading</a>(<span class="keywordtype">int</span> source, <span class="keywordtype">int</span> dest);
|
|
| 36 |
<a name="l00052"></a>00052 <span class="keywordtype">int</span> <a class="code" href="group__tokenring.html#g1938c1d79dd9438dcd413d6d26372877" title="Return the latest BOM reading between us and another robot.">wl_token_get_my_sensor_reading</a>(<span class="keywordtype">int</span> dest);
|
|
| 37 |
<a name="l00054"></a>00054 <span class="keywordtype">int</span> <a class="code" href="group__tokenring.html#gf0d311d4feae71afc8bcb0b8c8e6ba57" title="Return the number of robots in the sensor matrix.">wl_token_get_num_robots</a>(<span class="keywordtype">void</span>);
|
|
| 38 |
<a name="l00056"></a>00056 <span class="keywordtype">int</span> <a class="code" href="group__tokenring.html#g5fe1508968d450a970b0d5417a06431d" title="Return the number of non-null elements in the sensor matrix.">wl_token_get_matrix_size</a>(<span class="keywordtype">void</span>);
|
|
| 43 | 39 |
<a name="l00057"></a>00057 <span class="comment">//end token ring group</span> |
| 44 | 40 |
<a name="l00059"></a>00059 |
| 45 | 41 |
<a name="l00060"></a>00060 <span class="preprocessor">#endif</span> |
| 46 |
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Wed Oct 31 17:54:43 2007 for libwireless by
|
|
| 42 |
</pre></div><hr size="1"><address style="text-align: right;"><small>Generated on Thu Nov 8 22:16:24 2007 for libwireless by
|
|
| 47 | 43 |
<a href="http://www.doxygen.org/index.html"> |
| 48 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
|
|
| 44 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
|
|
| 49 | 45 |
</body> |
| 50 | 46 |
</html> |
Also available in: Unified diff