Project

General

Profile

Statistics
| Revision:

root / branches / simulator / projects / libwireless / logger / wl_token_logger.h @ 1128

History | View | Annotate | Download (791 Bytes)

1
/**
2
 * @file wl_token_logger.h
3
 * @brief Declarations for the token ring packet group logger
4
 * 
5
 * Contains declarations for the token ring packet group logger.
6
 *
7
 * @author Brian Coltin, Colony Project, CMU Robotics Club
8
 **/
9

    
10
#ifndef WL_TOKEN_LOGGER_H
11
#define WL_TOKEN_LOGGER_H
12

    
13
/**
14
 * @defgroup tokenring Token Ring
15
 * @brief Wireless library token ring implementation
16
 *
17
 * This packet group is used to form a token ring, which
18
 * keeps track of the relative directions of the robots
19
 * from one another.
20
 *
21
 * @{
22
 **/
23

    
24
/**@brief Register the token ring group with the wireless library.**/
25
void wl_token_logger_register(int delay);
26
/**@brief Unregister the token ring group with the wirelss library.**/
27
void wl_token_logger_unregister(void);
28

    
29
/** @} **/ //end token ring group
30

    
31
#endif