Project

General

Profile

Statistics
| Revision:

root / trunk / docs / libwireless / wl__token__ring_8c.html @ 1380

History | View | Annotate | Download (11.9 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_token_ring.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&nbsp;Page</span></a></li>
12
      <li><a href="modules.html"><span>Modules</span></a></li>
13
      <li><a href="annotated.html"><span>Data&nbsp;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&nbsp;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_token_ring.c File Reference</h1>Token Ring Implementation.  
26
<a href="#_details">More...</a>
27
<p>
28
<code>#include &lt;<a class="el" href="wl__token__ring_8h_source.html">wl_token_ring.h</a>&gt;</code><br>
29
<code>#include &lt;stdlib.h&gt;</code><br>
30
<code>#include &lt;stdio.h&gt;</code><br>
31
<code>#include &lt;<a class="el" href="wl__defs_8h_source.html">wl_defs.h</a>&gt;</code><br>
32
<code>#include &lt;<a class="el" href="wireless_8h_source.html">wireless.h</a>&gt;</code><br>
33
<code>#include &lt;<a class="el" href="sensor__matrix_8h_source.html">sensor_matrix.h</a>&gt;</code><br>
34
<table border="0" cellpadding="0" cellspacing="0">
35
<tr><td></td></tr>
36
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
37
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="836fd7c4964a2217217db4a7fdc76d8f"></a><!-- doxytag: member="wl_token_ring.c::DEFAULT_SENSOR_MATRIX_SIZE" ref="836fd7c4964a2217217db4a7fdc76d8f" args="" -->
38
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>DEFAULT_SENSOR_MATRIX_SIZE</b>&nbsp;&nbsp;&nbsp;20</td></tr>
39

    
40
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="63d59bc033d9191620659852e403bcd2"></a><!-- doxytag: member="wl_token_ring.c::NONMEMBER" ref="63d59bc033d9191620659852e403bcd2" args="" -->
41
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>NONMEMBER</b>&nbsp;&nbsp;&nbsp;0</td></tr>
42

    
43
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a52ae0448e8215abe6a23dbf094ade02"></a><!-- doxytag: member="wl_token_ring.c::MEMBER" ref="a52ae0448e8215abe6a23dbf094ade02" args="" -->
44
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>MEMBER</b>&nbsp;&nbsp;&nbsp;1</td></tr>
45

    
46
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e195ab8b0f7282dfcb827ca293ee961c"></a><!-- doxytag: member="wl_token_ring.c::JOINING" ref="e195ab8b0f7282dfcb827ca293ee961c" args="" -->
47
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>JOINING</b>&nbsp;&nbsp;&nbsp;2</td></tr>
48

    
49
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="43005b6b1934800f67a6d169c779c92b"></a><!-- doxytag: member="wl_token_ring.c::ACCEPTED" ref="43005b6b1934800f67a6d169c779c92b" args="" -->
50
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>ACCEPTED</b>&nbsp;&nbsp;&nbsp;3</td></tr>
51

    
52
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4715c3dc3c7382c64bea0d659955ddb"></a><!-- doxytag: member="wl_token_ring.c::LEAVING" ref="a4715c3dc3c7382c64bea0d659955ddb" args="" -->
53
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>LEAVING</b>&nbsp;&nbsp;&nbsp;4</td></tr>
54

    
55
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b1100951756d412b73adde98733e08ec"></a><!-- doxytag: member="wl_token_ring.c::TOKEN_JOIN_ACCEPT_FRAME" ref="b1100951756d412b73adde98733e08ec" args="" -->
56
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>TOKEN_JOIN_ACCEPT_FRAME</b>&nbsp;&nbsp;&nbsp;1</td></tr>
57

    
58
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4754c5c2d5c89d8bebe41ccfeb866b1d"></a><!-- doxytag: member="wl_token_ring.c::WL_TOKEN_PASS_FRAME" ref="4754c5c2d5c89d8bebe41ccfeb866b1d" args="" -->
59
#define&nbsp;</td><td class="memItemRight" valign="bottom"><b>WL_TOKEN_PASS_FRAME</b>&nbsp;&nbsp;&nbsp;2</td></tr>
60

    
61
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
62
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#ge1012b6d6c1c46b26a6c6da7e4ec7c88">wl_token_ring_join</a> ()</td></tr>
63

    
64
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Join the token ring.  <a href="group__tokenring.html#ge1012b6d6c1c46b26a6c6da7e4ec7c88"></a><br></td></tr>
65
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#g6c2dd8742e100f63d4fb002707d1e85a">wl_token_ring_leave</a> ()</td></tr>
66

    
67
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Leave the token ring.  <a href="group__tokenring.html#g6c2dd8742e100f63d4fb002707d1e85a"></a><br></td></tr>
68
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#g00fb5cca21a50d39aa1e82fdc679ca44">wl_token_ring_register</a> ()</td></tr>
69

    
70
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Register the token ring group with the wireless library.  <a href="group__tokenring.html#g00fb5cca21a50d39aa1e82fdc679ca44"></a><br></td></tr>
71
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#gde3dd682b6a757bab6ce4cbc9c518f8e">wl_token_ring_unregister</a> ()</td></tr>
72

    
73
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Unregister the token ring group with the wirelss library.  <a href="group__tokenring.html#gde3dd682b6a757bab6ce4cbc9c518f8e"></a><br></td></tr>
74
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</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>
75

    
76
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the functions called to turn the bom on and off.  <a href="group__tokenring.html#g0c407d5c215a97d58c67006bcc6e53ce"></a><br></td></tr>
77
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</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>
78

    
79
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the latest BOM reading between two robots.  <a href="group__tokenring.html#gb4afd4b8e034d22d415f3c4a42a652fc"></a><br></td></tr>
80
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</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>
81

    
82
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the latest BOM reading between us and another robot.  <a href="group__tokenring.html#g1938c1d79dd9438dcd413d6d26372877"></a><br></td></tr>
83
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#g0c61bb8892aa5513706e00cd8ce5ca8b">wl_token_get_robots_in_ring</a> (void)</td></tr>
84

    
85
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the number of robots in the token ring.  <a href="group__tokenring.html#g0c61bb8892aa5513706e00cd8ce5ca8b"></a><br></td></tr>
86
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</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>
87

    
88
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return whether a given robot is in the token ring.  <a href="group__tokenring.html#g14e005f0b9582eca7e3585f247c4cd72"></a><br></td></tr>
89
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#g37ab9fb00e9eef273b4d0fcda81a2620">wl_token_iterator_begin</a> (void)</td></tr>
90

    
91
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Begin iterating through robots in the token ring.  <a href="group__tokenring.html#g37ab9fb00e9eef273b4d0fcda81a2620"></a><br></td></tr>
92
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#gbd7dc40ee796a67e1160b2b2b8e7d02f">wl_token_iterator_has_next</a> (void)</td></tr>
93

    
94
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns whether there are more robots to iterate through.  <a href="group__tokenring.html#gbd7dc40ee796a67e1160b2b2b8e7d02f"></a><br></td></tr>
95
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#gd9196324178877770d8ffc91d40893c3">wl_token_iterator_next</a> (void)</td></tr>
96

    
97
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the ID of the next robot in the token ring.  <a href="group__tokenring.html#gd9196324178877770d8ffc91d40893c3"></a><br></td></tr>
98
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#gf0d311d4feae71afc8bcb0b8c8e6ba57">wl_token_get_num_robots</a> (void)</td></tr>
99

    
100
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the number of robots in the sensor matrix.  <a href="group__tokenring.html#gf0d311d4feae71afc8bcb0b8c8e6ba57"></a><br></td></tr>
101
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__tokenring.html#g5fe1508968d450a970b0d5417a06431d">wl_token_get_matrix_size</a> (void)</td></tr>
102

    
103
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the number of non-null elements in the sensor matrix.  <a href="group__tokenring.html#g5fe1508968d450a970b0d5417a06431d"></a><br></td></tr>
104
</table>
105
<hr><h2>Detailed Description</h2>
106
Token Ring Implementation. 
107
<p>
108
Copyright (c) 2007 Colony Project<p>
109
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:<p>
110
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.<p>
111
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.<p>
112
Implementation of the token ring packet group.<p>
113
<dl class="author" compact><dt><b>Author:</b></dt><dd>Brian Coltin, Colony Project, CMU Robotics Club </dd></dl>
114
</div>
115
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Sep 4 13:14:45 2009 for libwireless by&nbsp;
116
<a href="http://www.doxygen.org/index.html">
117
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
118
</body>
119
</html>