root / trunk / docs / libwireless / structPacketGroupHandler.html @ 406
History | View | Annotate | Download (7.33 KB)
1 | 19 | bcoltin | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
---|---|---|---|
2 | 241 | bcoltin | <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> |
3 | 19 | bcoltin | <title>libwireless: PacketGroupHandler Struct Reference</title> |
4 | <link href="doxygen.css" rel="stylesheet" type="text/css"> |
||
5 | <link href="tabs.css" rel="stylesheet" type="text/css"> |
||
6 | </head><body> |
||
7 | 241 | bcoltin | <!-- Generated by Doxygen 1.5.3 -->
|
8 | 19 | bcoltin | <div class="tabs"> |
9 | <ul>
|
||
10 | <li><a href="index.html"><span>Main Page</span></a></li> |
||
11 | <li><a href="modules.html"><span>Modules</span></a></li> |
||
12 | 241 | bcoltin | <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> |
13 | 19 | bcoltin | <li><a href="files.html"><span>Files</span></a></li> |
14 | 241 | bcoltin | </ul>
|
15 | </div>
|
||
16 | 19 | bcoltin | <div class="tabs"> |
17 | <ul>
|
||
18 | <li><a href="annotated.html"><span>Data Structures</span></a></li> |
||
19 | <li><a href="functions.html"><span>Data Fields</span></a></li> |
||
20 | 241 | bcoltin | </ul>
|
21 | </div>
|
||
22 | 19 | bcoltin | <h1>PacketGroupHandler Struct Reference<br> |
23 | <small>
|
||
24 | [<a class="el" href="group__wireless.html">Wireless</a>, <a class="el" href="group__wireless.html">Wireless</a>]</small> |
||
25 | </h1><!-- doxytag: class="PacketGroupHandler" --><code>#include <<a class="el" href="wireless_8h-source.html">wireless.h</a>></code> |
||
26 | <p>
|
||
27 | <table border="0" cellpadding="0" cellspacing="0"> |
||
28 | <tr><td></td></tr> |
||
29 | <tr><td colspan="2"><br><h2>Data Fields</h2></td></tr> |
||
30 | <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="structPacketGroupHandler.html#f0849c643f1b1e257ccfe96110109950">groupCode</a></td></tr> |
||
31 | |||
32 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structPacketGroupHandler.html#952b4b63982db13f55c02e17c55ab5ac">timeout_handler</a> )(void)</td></tr> |
||
33 | |||
34 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structPacketGroupHandler.html#045939030c6e2f2dd0d53b5718d9f902">handle_response</a> )(int frame, int received)</td></tr> |
||
35 | |||
36 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structPacketGroupHandler.html#5c01636d72de2ddafc734ab754d93104">handle_receive</a> )(char type, int source, unsigned char *packet, int length)</td></tr> |
||
37 | |||
38 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structPacketGroupHandler.html#c03247d5c07e97e35b1f557c0937b0eb">unregister</a> )(void)</td></tr> |
||
39 | |||
40 | </table>
|
||
41 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
||
42 | 241 | bcoltin | A <a class="el" href="structPacketGroupHandler.html">PacketGroupHandler</a> represents a packet group, and is used to register a packet group with the wireless library. It contains handlers for various events which can occur related to a packet group. <hr><h2>Field Documentation</h2> |
43 | <a class="anchor" name="f0849c643f1b1e257ccfe96110109950"></a><!-- doxytag: member="PacketGroupHandler::groupCode" ref="f0849c643f1b1e257ccfe96110109950" args="" --> |
||
44 | <div class="memitem"> |
||
45 | <div class="memproto"> |
||
46 | <table class="memname"> |
||
47 | 19 | bcoltin | <tr>
|
48 | 241 | bcoltin | <td class="memname">unsigned int <a class="el" href="structPacketGroupHandler.html#f0849c643f1b1e257ccfe96110109950">PacketGroupHandler::groupCode</a> </td> |
49 | 19 | bcoltin | </tr>
|
50 | </table>
|
||
51 | 241 | bcoltin | </div>
|
52 | <div class="memdoc"> |
||
53 | 19 | bcoltin | |
54 | <p>
|
||
55 | 241 | bcoltin | The group code for this packet group. This number must be unique. The maximum number of packet groups is defined by WL_MAX_PACKET_GROUPS. |
56 | </div>
|
||
57 | </div><p> |
||
58 | <a class="anchor" name="952b4b63982db13f55c02e17c55ab5ac"></a><!-- doxytag: member="PacketGroupHandler::timeout_handler" ref="952b4b63982db13f55c02e17c55ab5ac" args=")(void)" --> |
||
59 | <div class="memitem"> |
||
60 | <div class="memproto"> |
||
61 | <table class="memname"> |
||
62 | 19 | bcoltin | <tr>
|
63 | 241 | bcoltin | <td class="memname">void(* <a class="el" href="structPacketGroupHandler.html#952b4b63982db13f55c02e17c55ab5ac">PacketGroupHandler::timeout_handler</a>)(void) </td> |
64 | 19 | bcoltin | </tr>
|
65 | </table>
|
||
66 | 241 | bcoltin | </div>
|
67 | <div class="memdoc"> |
||
68 | 19 | bcoltin | |
69 | <p>
|
||
70 | 241 | bcoltin | Called every half second (not in interrupt, but in wl_do). |
71 | </div>
|
||
72 | </div><p> |
||
73 | <a class="anchor" name="045939030c6e2f2dd0d53b5718d9f902"></a><!-- doxytag: member="PacketGroupHandler::handle_response" ref="045939030c6e2f2dd0d53b5718d9f902" args=")(int frame, int received)" --> |
||
74 | <div class="memitem"> |
||
75 | <div class="memproto"> |
||
76 | <table class="memname"> |
||
77 | 19 | bcoltin | <tr>
|
78 | 241 | bcoltin | <td class="memname">void(* <a class="el" href="structPacketGroupHandler.html#045939030c6e2f2dd0d53b5718d9f902">PacketGroupHandler::handle_response</a>)(int frame, int received) </td> |
79 | 19 | bcoltin | </tr>
|
80 | </table>
|
||
81 | 241 | bcoltin | </div>
|
82 | <div class="memdoc"> |
||
83 | 19 | bcoltin | |
84 | <p>
|
||
85 | Called when a transmit status packet is received from the XBee where the first four bits of the frame are the group code.<p>
|
||
86 | <dl compact><dt><b>Parameters:</b></dt><dd> |
||
87 | <table border="0" cellspacing="2" cellpadding="0"> |
||
88 | <tr><td valign="top"></td><td valign="top"><em>frame</em> </td><td>the last four bits of the frame </td></tr> |
||
89 | <tr><td valign="top"></td><td valign="top"><em>received</em> </td><td>is true if we received an ack, 0 if we did not. </td></tr> |
||
90 | </table>
|
||
91 | </dl>
|
||
92 | 241 | bcoltin | |
93 | </div>
|
||
94 | </div><p> |
||
95 | <a class="anchor" name="5c01636d72de2ddafc734ab754d93104"></a><!-- doxytag: member="PacketGroupHandler::handle_receive" ref="5c01636d72de2ddafc734ab754d93104" args=")(char type, int source, unsigned char *packet, int length)" --> |
||
96 | <div class="memitem"> |
||
97 | <div class="memproto"> |
||
98 | <table class="memname"> |
||
99 | 19 | bcoltin | <tr>
|
100 | 241 | bcoltin | <td class="memname">void(* <a class="el" href="structPacketGroupHandler.html#5c01636d72de2ddafc734ab754d93104">PacketGroupHandler::handle_receive</a>)(char type, int source, unsigned char *packet, int length) </td> |
101 | 19 | bcoltin | </tr>
|
102 | </table>
|
||
103 | 241 | bcoltin | </div>
|
104 | <div class="memdoc"> |
||
105 | 19 | bcoltin | |
106 | <p>
|
||
107 | 241 | bcoltin | Called when we receive a packet from this group.<p>
|
108 | <dl compact><dt><b>Parameters:</b></dt><dd> |
||
109 | <table border="0" cellspacing="2" cellpadding="0"> |
||
110 | <tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>the packet type </td></tr> |
||
111 | <tr><td valign="top"></td><td valign="top"><em>source</em> </td><td>the 16-bit address of the XBee this packet was sent from </td></tr> |
||
112 | <tr><td valign="top"></td><td valign="top"><em>packet</em> </td><td>the packet received </td></tr> |
||
113 | <tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>the length of the packet </td></tr> |
||
114 | </table>
|
||
115 | </dl>
|
||
116 | |||
117 | </div>
|
||
118 | </div><p> |
||
119 | <a class="anchor" name="c03247d5c07e97e35b1f557c0937b0eb"></a><!-- doxytag: member="PacketGroupHandler::unregister" ref="c03247d5c07e97e35b1f557c0937b0eb" args=")(void)" --> |
||
120 | <div class="memitem"> |
||
121 | <div class="memproto"> |
||
122 | <table class="memname"> |
||
123 | 19 | bcoltin | <tr>
|
124 | 241 | bcoltin | <td class="memname">void(* <a class="el" href="structPacketGroupHandler.html#c03247d5c07e97e35b1f557c0937b0eb">PacketGroupHandler::unregister</a>)(void) </td> |
125 | 19 | bcoltin | </tr>
|
126 | </table>
|
||
127 | 241 | bcoltin | </div>
|
128 | <div class="memdoc"> |
||
129 | 19 | bcoltin | |
130 | <p>
|
||
131 | 241 | bcoltin | Called for any cleanup when the network is turned off. |
132 | </div>
|
||
133 | </div><p> |
||
134 | 19 | bcoltin | <hr>The documentation for this struct was generated from the following file:<ul> |
135 | <li><a class="el" href="wireless_8h-source.html">wireless.h</a></ul> |
||
136 | 242 | bcoltin | <hr size="1"><address style="text-align: right;"><small>Generated on Thu Nov 8 23:27:23 2007 for libwireless by |
137 | 19 | bcoltin | <a href="http://www.doxygen.org/index.html"> |
138 | 241 | bcoltin | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address> |
139 | 19 | bcoltin | </body>
|
140 | </html> |