wl_token_ring.h File Reference

Declarations for the token ring packet group. More...

Go to the source code of this file.

Functions

int wl_token_ring_register (void)
 Register the token ring group with the wireless library.
void wl_token_ring_unregister (void)
 Unregister the token ring group with the wirelss library.
void wl_token_ring_set_bom_functions (void(*on_function)(void), void(*off_function)(void), int(*max_bom_function)(void))
 Set the functions called to turn the bom on and off.
int wl_token_ring_join (void)
 Join the token ring.
void wl_token_ring_leave (void)
 Leave the token ring.
int wl_token_get_robots_in_ring (void)
 Return the number of robots in the token ring.
int wl_token_is_robot_in_ring (int robot)
 Return whether a given robot is in the token ring.
void wl_token_iterator_begin (void)
 Begin iterating through robots in the token ring.
int wl_token_iterator_has_next (void)
 Returns whether there are more robots to iterate through.
int wl_token_iterator_next (void)
 Returns the ID of the next robot in the token ring.
int wl_token_get_sensor_reading (int source, int dest)
 Return the latest BOM reading between two robots.
int wl_token_get_my_sensor_reading (int dest)
 Return the latest BOM reading between us and another robot.
int wl_token_get_num_robots (void)
 Return the number of robots in the sensor matrix.
int wl_token_get_matrix_size (void)
 Return the number of non-null elements in the sensor matrix.

Detailed Description

Declarations for the token ring packet group.

Copyright (c) 2007 Colony Project

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:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

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.

Contains declarations for the token ring packet group.

Author:
Brian Coltin, Colony Project, CMU Robotics Club

Generated on Wed Sep 23 12:51:07 2009 for libwireless by  doxygen 1.6.1