Revision 241
Updated libdragonfly documentation.
| structPacketGroupHandler.html | ||
|---|---|---|
| 1 | 1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| 2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
|
| 2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
|
|
| 3 | 3 |
<title>libwireless: PacketGroupHandler Struct Reference</title> |
| 4 | 4 |
<link href="doxygen.css" rel="stylesheet" type="text/css"> |
| 5 | 5 |
<link href="tabs.css" rel="stylesheet" type="text/css"> |
| 6 | 6 |
</head><body> |
| 7 |
<!-- Generated by Doxygen 1.4.6 -->
|
|
| 7 |
<!-- Generated by Doxygen 1.5.3 -->
|
|
| 8 | 8 |
<div class="tabs"> |
| 9 | 9 |
<ul> |
| 10 | 10 |
<li><a href="index.html"><span>Main Page</span></a></li> |
| 11 | 11 |
<li><a href="modules.html"><span>Modules</span></a></li> |
| 12 |
<li id="current"><a href="annotated.html"><span>Data Structures</span></a></li>
|
|
| 12 |
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
|
|
| 13 | 13 |
<li><a href="files.html"><span>Files</span></a></li> |
| 14 |
</ul></div> |
|
| 14 |
</ul> |
|
| 15 |
</div> |
|
| 15 | 16 |
<div class="tabs"> |
| 16 | 17 |
<ul> |
| 17 | 18 |
<li><a href="annotated.html"><span>Data Structures</span></a></li> |
| 18 |
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
|
| 19 | 19 |
<li><a href="functions.html"><span>Data Fields</span></a></li> |
| 20 |
</ul></div> |
|
| 20 |
</ul> |
|
| 21 |
</div> |
|
| 21 | 22 |
<h1>PacketGroupHandler Struct Reference<br> |
| 22 | 23 |
<small> |
| 23 | 24 |
[<a class="el" href="group__wireless.html">Wireless</a>, <a class="el" href="group__wireless.html">Wireless</a>]</small> |
| ... | ... | |
| 38 | 39 |
|
| 39 | 40 |
</table> |
| 40 | 41 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
| 41 |
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. |
|
| 42 |
<p> |
|
| 43 |
<hr><h2>Field Documentation</h2> |
|
| 44 |
<a class="anchor" name="f0849c643f1b1e257ccfe96110109950"></a><!-- doxytag: member="PacketGroupHandler::groupCode" ref="f0849c643f1b1e257ccfe96110109950" args="" --><p> |
|
| 45 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
|
| 46 |
<tr> |
|
| 47 |
<td class="mdRow"> |
|
| 48 |
<table cellpadding="0" cellspacing="0" border="0"> |
|
| 42 |
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"> |
|
| 49 | 47 |
<tr> |
| 50 |
<td class="md" nowrap valign="top">unsigned int <a class="el" href="structPacketGroupHandler.html#f0849c643f1b1e257ccfe96110109950">PacketGroupHandler::groupCode</a> </td>
|
|
| 48 |
<td class="memname">unsigned int <a class="el" href="structPacketGroupHandler.html#f0849c643f1b1e257ccfe96110109950">PacketGroupHandler::groupCode</a> </td>
|
|
| 51 | 49 |
</tr> |
| 52 | 50 |
</table> |
| 53 |
</td> |
|
| 54 |
</tr> |
|
| 55 |
</table> |
|
| 56 |
<table cellspacing="5" cellpadding="0" border="0"> |
|
| 57 |
<tr> |
|
| 58 |
<td> |
|
| 59 |
|
|
| 60 |
</td> |
|
| 61 |
<td> |
|
| 51 |
</div> |
|
| 52 |
<div class="memdoc"> |
|
| 62 | 53 |
|
| 63 | 54 |
<p> |
| 64 |
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. </td> |
|
| 65 |
</tr> |
|
| 66 |
</table> |
|
| 67 |
<a class="anchor" name="5c01636d72de2ddafc734ab754d93104"></a><!-- doxytag: member="PacketGroupHandler::handle_receive" ref="5c01636d72de2ddafc734ab754d93104" args=")(char type, int source, unsigned char *packet, int length)" --><p> |
|
| 68 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
|
| 69 |
<tr> |
|
| 70 |
<td class="mdRow"> |
|
| 71 |
<table cellpadding="0" cellspacing="0" border="0"> |
|
| 55 |
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"> |
|
| 72 | 62 |
<tr> |
| 73 |
<td class="md" nowrap valign="top">void(* <a class="el" href="structPacketGroupHandler.html#5c01636d72de2ddafc734ab754d93104">PacketGroupHandler::handle_receive</a>)(char type, int source, unsigned char *packet, int length) </td>
|
|
| 63 |
<td class="memname">void(* <a class="el" href="structPacketGroupHandler.html#952b4b63982db13f55c02e17c55ab5ac">PacketGroupHandler::timeout_handler</a>)(void) </td>
|
|
| 74 | 64 |
</tr> |
| 75 | 65 |
</table> |
| 76 |
</td> |
|
| 77 |
</tr> |
|
| 78 |
</table> |
|
| 79 |
<table cellspacing="5" cellpadding="0" border="0"> |
|
| 80 |
<tr> |
|
| 81 |
<td> |
|
| 82 |
|
|
| 83 |
</td> |
|
| 84 |
<td> |
|
| 66 |
</div> |
|
| 67 |
<div class="memdoc"> |
|
| 85 | 68 |
|
| 86 | 69 |
<p> |
| 87 |
Called when we receive a packet from this group.<p> |
|
| 88 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
|
| 89 |
<table border="0" cellspacing="2" cellpadding="0"> |
|
| 90 |
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>the packet type </td></tr> |
|
| 91 |
<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> |
|
| 92 |
<tr><td valign="top"></td><td valign="top"><em>packet</em> </td><td>the packet received </td></tr> |
|
| 93 |
<tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>the length of the packet </td></tr> |
|
| 94 |
</table> |
|
| 95 |
</dl> |
|
| 96 |
</td> |
|
| 97 |
</tr> |
|
| 98 |
</table> |
|
| 99 |
<a class="anchor" name="045939030c6e2f2dd0d53b5718d9f902"></a><!-- doxytag: member="PacketGroupHandler::handle_response" ref="045939030c6e2f2dd0d53b5718d9f902" args=")(int frame, int received)" --><p> |
|
| 100 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
|
| 101 |
<tr> |
|
| 102 |
<td class="mdRow"> |
|
| 103 |
<table cellpadding="0" cellspacing="0" border="0"> |
|
| 70 |
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"> |
|
| 104 | 77 |
<tr> |
| 105 |
<td class="md" nowrap valign="top">void(* <a class="el" href="structPacketGroupHandler.html#045939030c6e2f2dd0d53b5718d9f902">PacketGroupHandler::handle_response</a>)(int frame, int received) </td>
|
|
| 78 |
<td class="memname">void(* <a class="el" href="structPacketGroupHandler.html#045939030c6e2f2dd0d53b5718d9f902">PacketGroupHandler::handle_response</a>)(int frame, int received) </td>
|
|
| 106 | 79 |
</tr> |
| 107 | 80 |
</table> |
| 108 |
</td> |
|
| 109 |
</tr> |
|
| 110 |
</table> |
|
| 111 |
<table cellspacing="5" cellpadding="0" border="0"> |
|
| 112 |
<tr> |
|
| 113 |
<td> |
|
| 114 |
|
|
| 115 |
</td> |
|
| 116 |
<td> |
|
| 81 |
</div> |
|
| 82 |
<div class="memdoc"> |
|
| 117 | 83 |
|
| 118 | 84 |
<p> |
| 119 | 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> |
| ... | ... | |
| 123 | 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> |
| 124 | 90 |
</table> |
| 125 | 91 |
</dl> |
| 126 |
</td> |
|
| 127 |
</tr> |
|
| 128 |
</table> |
|
| 129 |
<a class="anchor" name="952b4b63982db13f55c02e17c55ab5ac"></a><!-- doxytag: member="PacketGroupHandler::timeout_handler" ref="952b4b63982db13f55c02e17c55ab5ac" args=")(void)" --><p> |
|
| 130 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
|
| 131 |
<tr> |
|
| 132 |
<td class="mdRow"> |
|
| 133 |
<table cellpadding="0" cellspacing="0" border="0"> |
|
| 92 |
|
|
| 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"> |
|
| 134 | 99 |
<tr> |
| 135 |
<td class="md" nowrap valign="top">void(* <a class="el" href="structPacketGroupHandler.html#952b4b63982db13f55c02e17c55ab5ac">PacketGroupHandler::timeout_handler</a>)(void) </td>
|
|
| 100 |
<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>
|
|
| 136 | 101 |
</tr> |
| 137 | 102 |
</table> |
| 138 |
</td> |
|
| 139 |
</tr> |
|
| 140 |
</table> |
|
| 141 |
<table cellspacing="5" cellpadding="0" border="0"> |
|
| 142 |
<tr> |
|
| 143 |
<td> |
|
| 144 |
|
|
| 145 |
</td> |
|
| 146 |
<td> |
|
| 103 |
</div> |
|
| 104 |
<div class="memdoc"> |
|
| 147 | 105 |
|
| 148 | 106 |
<p> |
| 149 |
Called every half second (not in interrupt, but in wl_do). </td> |
|
| 150 |
</tr> |
|
| 151 |
</table> |
|
| 152 |
<a class="anchor" name="c03247d5c07e97e35b1f557c0937b0eb"></a><!-- doxytag: member="PacketGroupHandler::unregister" ref="c03247d5c07e97e35b1f557c0937b0eb" args=")(void)" --><p> |
|
| 153 |
<table class="mdTable" cellpadding="2" cellspacing="0"> |
|
| 154 |
<tr> |
|
| 155 |
<td class="mdRow"> |
|
| 156 |
<table cellpadding="0" cellspacing="0" border="0"> |
|
| 107 |
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"> |
|
| 157 | 123 |
<tr> |
| 158 |
<td class="md" nowrap valign="top">void(* <a class="el" href="structPacketGroupHandler.html#c03247d5c07e97e35b1f557c0937b0eb">PacketGroupHandler::unregister</a>)(void) </td>
|
|
| 124 |
<td class="memname">void(* <a class="el" href="structPacketGroupHandler.html#c03247d5c07e97e35b1f557c0937b0eb">PacketGroupHandler::unregister</a>)(void) </td>
|
|
| 159 | 125 |
</tr> |
| 160 | 126 |
</table> |
| 161 |
</td> |
|
| 162 |
</tr> |
|
| 163 |
</table> |
|
| 164 |
<table cellspacing="5" cellpadding="0" border="0"> |
|
| 165 |
<tr> |
|
| 166 |
<td> |
|
| 167 |
|
|
| 168 |
</td> |
|
| 169 |
<td> |
|
| 127 |
</div> |
|
| 128 |
<div class="memdoc"> |
|
| 170 | 129 |
|
| 171 | 130 |
<p> |
| 172 |
Called for any cleanup when the network is turned off. </td>
|
|
| 173 |
</tr>
|
|
| 174 |
</table>
|
|
| 131 |
Called for any cleanup when the network is turned off. |
|
| 132 |
</div>
|
|
| 133 |
</div><p>
|
|
| 175 | 134 |
<hr>The documentation for this struct was generated from the following file:<ul> |
| 176 | 135 |
<li><a class="el" href="wireless_8h-source.html">wireless.h</a></ul> |
| 177 |
<hr size="1"><address style="align: right;"><small>Generated on Wed Oct 31 17:54:43 2007 for libwireless by
|
|
| 136 |
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Nov 8 22:16:25 2007 for libwireless by
|
|
| 178 | 137 |
<a href="http://www.doxygen.org/index.html"> |
| 179 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
|
|
| 138 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
|
|
| 180 | 139 |
</body> |
| 181 | 140 |
</html> |
Also available in: Unified diff