root / trunk / code / projects / libwireless / lib / wl_error_group.h @ 1427
History | View | Annotate | Download (2.01 KB)
1 |
/**
|
---|---|
2 |
* Copyright (c) 2007 Colony Project
|
3 |
*
|
4 |
* Permission is hereby granted, free of charge, to any person
|
5 |
* obtaining a copy of this software and associated documentation
|
6 |
* files (the "Software"), to deal in the Software without
|
7 |
* restriction, including without limitation the rights to use,
|
8 |
* copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9 |
* copies of the Software, and to permit persons to whom the
|
10 |
* Software is furnished to do so, subject to the following
|
11 |
* conditions:
|
12 |
*
|
13 |
* The above copyright notice and this permission notice shall be
|
14 |
* included in all copies or substantial portions of the Software.
|
15 |
*
|
16 |
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17 |
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
18 |
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19 |
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
20 |
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
21 |
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
22 |
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
23 |
* OTHER DEALINGS IN THE SOFTWARE.
|
24 |
**/
|
25 |
|
26 |
/**
|
27 |
* @file wl_error_group.h
|
28 |
* @brief Error Packets
|
29 |
*
|
30 |
* A packet group for sending error packets.
|
31 |
*
|
32 |
* @author Brian Coltin, Colony Project, CMU Robotics Club
|
33 |
**/
|
34 |
|
35 |
#ifndef WL_ERROR_GROUP_H
|
36 |
#define WL_ERROR_GROUP_H
|
37 |
|
38 |
/**
|
39 |
* @file wl_error_group.h
|
40 |
* @brief A packet group for error messages.
|
41 |
*
|
42 |
* A packet group for sending and receiving error
|
43 |
* messages.
|
44 |
*
|
45 |
* @author Brian Coltin, Colony Project, CMU Robotics Club
|
46 |
**/
|
47 |
|
48 |
/**
|
49 |
* @defgroup wlerror Error Packets
|
50 |
* @brief Functions for sending and receiving error packets
|
51 |
*
|
52 |
* Functions for sending and receiving error packets.
|
53 |
*
|
54 |
* @{
|
55 |
**/
|
56 |
|
57 |
/**@brief Register this packet group with the wireless library **/
|
58 |
void wl_error_register(void); |
59 |
/**@brief Unregister this packet group with the wireless library **/
|
60 |
void wl_error_unregister(void); |
61 |
/**@brief Send a string in an error packet **/
|
62 |
void wl_error_send_string(char* str); |
63 |
|
64 |
/** @} **/ // end defgroup |
65 |
|
66 |
#endif
|