root / trunk / docs / libwireless / structPacketGroupHandler.html @ 1395
History | View | Annotate | Download (8.36 KB)
| 1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|---|---|
| 2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> |
| 3 |
<title>libwireless: PacketGroupHandler Struct Reference</title> |
| 4 |
<link href="tabs.css" rel="stylesheet" type="text/css"> |
| 5 |
<link href="doxygen.css" rel="stylesheet" type="text/css"> |
| 6 |
</head><body> |
| 7 |
<!-- Generated by Doxygen 1.5.9 -->
|
| 8 |
<div class="navigation" id="top"> |
| 9 |
<div class="tabs"> |
| 10 |
<ul>
|
| 11 |
<li><a href="index.html"><span>Main Page</span></a></li> |
| 12 |
<li><a href="modules.html"><span>Modules</span></a></li> |
| 13 |
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> |
| 14 |
<li><a href="files.html"><span>Files</span></a></li> |
| 15 |
</ul>
|
| 16 |
</div>
|
| 17 |
<div class="tabs"> |
| 18 |
<ul>
|
| 19 |
<li><a href="annotated.html"><span>Data Structures</span></a></li> |
| 20 |
<li><a href="functions.html"><span>Data Fields</span></a></li> |
| 21 |
</ul>
|
| 22 |
</div>
|
| 23 |
</div>
|
| 24 |
<div class="contents"> |
| 25 |
<h1>PacketGroupHandler Struct Reference<br> |
| 26 |
<small>
|
| 27 |
[<a class="el" href="group__wireless.html">Wireless</a>]</small> |
| 28 |
</h1><!-- doxytag: class="PacketGroupHandler" --><code>#include <<a class="el" href="wireless_8h_source.html">wireless.h</a>></code> |
| 29 |
<p>
|
| 30 |
<table border="0" cellpadding="0" cellspacing="0"> |
| 31 |
<tr><td></td></tr> |
| 32 |
<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr> |
| 33 |
<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> |
| 34 |
|
| 35 |
<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> |
| 36 |
|
| 37 |
<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> |
| 38 |
|
| 39 |
<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> |
| 40 |
|
| 41 |
<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> |
| 42 |
|
| 43 |
</table>
|
| 44 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
| 45 |
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> |
| 46 |
<a class="anchor" name="f0849c643f1b1e257ccfe96110109950"></a><!-- doxytag: member="PacketGroupHandler::groupCode" ref="f0849c643f1b1e257ccfe96110109950" args="" --> |
| 47 |
<div class="memitem"> |
| 48 |
<div class="memproto"> |
| 49 |
<table class="memname"> |
| 50 |
<tr>
|
| 51 |
<td class="memname">unsigned int <a class="el" href="structPacketGroupHandler.html#f0849c643f1b1e257ccfe96110109950">PacketGroupHandler::groupCode</a> </td> |
| 52 |
</tr>
|
| 53 |
</table>
|
| 54 |
</div>
|
| 55 |
<div class="memdoc"> |
| 56 |
|
| 57 |
<p>
|
| 58 |
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. |
| 59 |
<p>Referenced by <a class="el" href="wl__basic_8c_source.html#l00042">wl_basic_register_handler()</a>, <a class="el" href="wireless_8c_source.html#l00342">wl_register_packet_group()</a>, and <a class="el" href="wireless_8c_source.html#l00362">wl_unregister_packet_group()</a>.</p> |
| 60 |
|
| 61 |
</div>
|
| 62 |
</div><p> |
| 63 |
<a class="anchor" name="5c01636d72de2ddafc734ab754d93104"></a><!-- doxytag: member="PacketGroupHandler::handle_receive" ref="5c01636d72de2ddafc734ab754d93104" args=")(char type, int source, unsigned char *packet, int length)" --> |
| 64 |
<div class="memitem"> |
| 65 |
<div class="memproto"> |
| 66 |
<table class="memname"> |
| 67 |
<tr>
|
| 68 |
<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> |
| 69 |
</tr>
|
| 70 |
</table>
|
| 71 |
</div>
|
| 72 |
<div class="memdoc"> |
| 73 |
|
| 74 |
<p>
|
| 75 |
Called when we receive a packet from this group.<p>
|
| 76 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 77 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 78 |
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>the packet type </td></tr> |
| 79 |
<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> |
| 80 |
<tr><td valign="top"></td><td valign="top"><em>packet</em> </td><td>the packet received </td></tr> |
| 81 |
<tr><td valign="top"></td><td valign="top"><em>length</em> </td><td>the length of the packet </td></tr> |
| 82 |
</table>
|
| 83 |
</dl>
|
| 84 |
|
| 85 |
<p>Referenced by <a class="el" href="wl__basic_8c_source.html#l00042">wl_basic_register_handler()</a>, and <a class="el" href="wireless_8c_source.html#l00390">wl_do()</a>.</p> |
| 86 |
|
| 87 |
</div>
|
| 88 |
</div><p> |
| 89 |
<a class="anchor" name="045939030c6e2f2dd0d53b5718d9f902"></a><!-- doxytag: member="PacketGroupHandler::handle_response" ref="045939030c6e2f2dd0d53b5718d9f902" args=")(int frame, int received)" --> |
| 90 |
<div class="memitem"> |
| 91 |
<div class="memproto"> |
| 92 |
<table class="memname"> |
| 93 |
<tr>
|
| 94 |
<td class="memname">void(* <a class="el" href="structPacketGroupHandler.html#045939030c6e2f2dd0d53b5718d9f902">PacketGroupHandler::handle_response</a>)(int frame, int received) </td> |
| 95 |
</tr>
|
| 96 |
</table>
|
| 97 |
</div>
|
| 98 |
<div class="memdoc"> |
| 99 |
|
| 100 |
<p>
|
| 101 |
Called when a transmit status packet is received from the XBee where the first four bits of the frame are the group code.<p>
|
| 102 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 103 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 104 |
<tr><td valign="top"></td><td valign="top"><em>frame</em> </td><td>the last four bits of the frame </td></tr> |
| 105 |
<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> |
| 106 |
</table>
|
| 107 |
</dl>
|
| 108 |
|
| 109 |
<p>Referenced by <a class="el" href="wl__basic_8c_source.html#l00042">wl_basic_register_handler()</a>, and <a class="el" href="wireless_8c_source.html#l00390">wl_do()</a>.</p> |
| 110 |
|
| 111 |
</div>
|
| 112 |
</div><p> |
| 113 |
<a class="anchor" name="952b4b63982db13f55c02e17c55ab5ac"></a><!-- doxytag: member="PacketGroupHandler::timeout_handler" ref="952b4b63982db13f55c02e17c55ab5ac" args=")(void)" --> |
| 114 |
<div class="memitem"> |
| 115 |
<div class="memproto"> |
| 116 |
<table class="memname"> |
| 117 |
<tr>
|
| 118 |
<td class="memname">void(* <a class="el" href="structPacketGroupHandler.html#952b4b63982db13f55c02e17c55ab5ac">PacketGroupHandler::timeout_handler</a>)(void) </td> |
| 119 |
</tr>
|
| 120 |
</table>
|
| 121 |
</div>
|
| 122 |
<div class="memdoc"> |
| 123 |
|
| 124 |
<p>
|
| 125 |
Called every half second (not in interrupt, but in wl_do). |
| 126 |
<p>Referenced by <a class="el" href="wl__basic_8c_source.html#l00042">wl_basic_register_handler()</a>.</p> |
| 127 |
|
| 128 |
</div>
|
| 129 |
</div><p> |
| 130 |
<a class="anchor" name="c03247d5c07e97e35b1f557c0937b0eb"></a><!-- doxytag: member="PacketGroupHandler::unregister" ref="c03247d5c07e97e35b1f557c0937b0eb" args=")(void)" --> |
| 131 |
<div class="memitem"> |
| 132 |
<div class="memproto"> |
| 133 |
<table class="memname"> |
| 134 |
<tr>
|
| 135 |
<td class="memname">void(* <a class="el" href="structPacketGroupHandler.html#c03247d5c07e97e35b1f557c0937b0eb">PacketGroupHandler::unregister</a>)(void) </td> |
| 136 |
</tr>
|
| 137 |
</table>
|
| 138 |
</div>
|
| 139 |
<div class="memdoc"> |
| 140 |
|
| 141 |
<p>
|
| 142 |
Called for any cleanup when the network is turned off. |
| 143 |
<p>Referenced by <a class="el" href="wl__basic_8c_source.html#l00042">wl_basic_register_handler()</a>, <a class="el" href="wireless_8c_source.html#l00159">wl_terminate()</a>, and <a class="el" href="wireless_8c_source.html#l00362">wl_unregister_packet_group()</a>.</p> |
| 144 |
|
| 145 |
</div>
|
| 146 |
</div><p> |
| 147 |
<hr>The documentation for this struct was generated from the following file:<ul> |
| 148 |
<li><a class="el" href="wireless_8h_source.html">wireless.h</a></ul> |
| 149 |
</div>
|
| 150 |
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Sep 8 19:59:17 2009 for libwireless by |
| 151 |
<a href="http://www.doxygen.org/index.html"> |
| 152 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> |
| 153 |
</body>
|
| 154 |
</html>
|