Statistics
| Revision:

root / trunk / docs / libwireless / structPacketGroupHandler.html @ 1427

History | View | Annotate | Download (8.4 KB)

1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
<html xmlns="http://www.w3.org/1999/xhtml">
3
<head>
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5
<title>libwireless: PacketGroupHandler Struct Reference</title>
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
8
</head>
9
<body>
10
<!-- Generated by Doxygen 1.6.1 -->
11
<div class="navigation" id="top">
12
  <div class="tabs">
13
    <ul>
14
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
15
      <li><a href="modules.html"><span>Modules</span></a></li>
16
      <li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
17
      <li><a href="files.html"><span>Files</span></a></li>
18
    </ul>
19
  </div>
20
  <div class="tabs">
21
    <ul>
22
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
23
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
24
    </ul>
25
  </div>
26
</div>
27
<div class="contents">
28
<h1>PacketGroupHandler Struct Reference<br/>
29
<small>
30
[<a class="el" href="group__wireless.html">Wireless</a>]</small>
31
</h1><!-- doxytag: class="PacketGroupHandler" -->
32
<p><code>#include &lt;<a class="el" href="wireless_8h_source.html">wireless.h</a>&gt;</code></p>
33
<table border="0" cellpadding="0" cellspacing="0">
34
<tr><td colspan="2"><h2>Data Fields</h2></td></tr>
35
<tr><td class="memItemLeft" align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPacketGroupHandler.html#af0849c643f1b1e257ccfe96110109950">groupCode</a></td></tr>
36
<tr><td class="memItemLeft" align="right" valign="top">void(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPacketGroupHandler.html#a952b4b63982db13f55c02e17c55ab5ac">timeout_handler</a> )(void)</td></tr>
37
<tr><td class="memItemLeft" align="right" valign="top">void(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPacketGroupHandler.html#a045939030c6e2f2dd0d53b5718d9f902">handle_response</a> )(int frame, int received)</td></tr>
38
<tr><td class="memItemLeft" align="right" valign="top">void(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPacketGroupHandler.html#a5c01636d72de2ddafc734ab754d93104">handle_receive</a> )(char type, int source, unsigned char *packet, int length)</td></tr>
39
<tr><td class="memItemLeft" align="right" valign="top">void(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPacketGroupHandler.html#ac03247d5c07e97e35b1f557c0937b0eb">unregister</a> )(void)</td></tr>
40
</table>
41
<hr/><a name="_details"></a><h2>Detailed Description</h2>
42
<p>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. </p>
43
<hr/><h2>Field Documentation</h2>
44
<a class="anchor" id="af0849c643f1b1e257ccfe96110109950"></a><!-- doxytag: member="PacketGroupHandler::groupCode" ref="af0849c643f1b1e257ccfe96110109950" args="" -->
45
<div class="memitem">
46
<div class="memproto">
47
      <table class="memname">
48
        <tr>
49
          <td class="memname">unsigned int <a class="el" href="structPacketGroupHandler.html#af0849c643f1b1e257ccfe96110109950">PacketGroupHandler::groupCode</a></td>
50
        </tr>
51
      </table>
52
</div>
53
<div class="memdoc">
54
<p>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. </p>
55




56
<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>





57




58
</div>





59
</div>





60
<a class="anchor" id="a5c01636d72de2ddafc734ab754d93104"></a><!-- doxytag: member="PacketGroupHandler::handle_receive" ref="a5c01636d72de2ddafc734ab754d93104" args=")(char type, int source, unsigned char *packet, int length)" -->





61
<div class="memitem">





62
<div class="memproto">





63
      <table class="memname">





64
        <tr>





65
          <td class="memname">void(* <a class="el" href="structPacketGroupHandler.html#a5c01636d72de2ddafc734ab754d93104">PacketGroupHandler::handle_receive</a>)(char type, int source, unsigned char *packet, int length)</td>





66
        </tr>





67
      </table>





68
</div>





69
<div class="memdoc">





70
<p>Called when we receive a packet from this group.</p>





71
<dl><dt><b>Parameters:</b></dt><dd>





72
  <table border="0" cellspacing="2" cellpadding="0">





73
    <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>the packet type </td></tr>





74
    <tr><td valign="top"></td><td valign="top"><em>source</em>&nbsp;</td><td>the 16-bit address of the XBee this packet was sent from </td></tr>





75
    <tr><td valign="top"></td><td valign="top"><em>packet</em>&nbsp;</td><td>the packet received </td></tr>





76
    <tr><td valign="top"></td><td valign="top"><em>length</em>&nbsp;</td><td>the length of the packet </td></tr>





77
  </table>





78
  </dd>





79
</dl>





80




81
<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>





82




83
</div>





84
</div>





85
<a class="anchor" id="a045939030c6e2f2dd0d53b5718d9f902"></a><!-- doxytag: member="PacketGroupHandler::handle_response" ref="a045939030c6e2f2dd0d53b5718d9f902" args=")(int frame, int received)" -->





86
<div class="memitem">





87
<div class="memproto">





88
      <table class="memname">





89
        <tr>





90
          <td class="memname">void(* <a class="el" href="structPacketGroupHandler.html#a045939030c6e2f2dd0d53b5718d9f902">PacketGroupHandler::handle_response</a>)(int frame, int received)</td>





91
        </tr>





92
      </table>





93
</div>





94
<div class="memdoc">





95
<p>Called when a transmit status packet is received from the XBee where the first four bits of the frame are the group code.</p>





96
<dl><dt><b>Parameters:</b></dt><dd>





97
  <table border="0" cellspacing="2" cellpadding="0">





98
    <tr><td valign="top"></td><td valign="top"><em>frame</em>&nbsp;</td><td>the last four bits of the frame </td></tr>





99
    <tr><td valign="top"></td><td valign="top"><em>received</em>&nbsp;</td><td>is true if we received an ack, 0 if we did not. </td></tr>





100
  </table>





101
  </dd>





102
</dl>





103




104
<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>





105




106
</div>





107
</div>





108
<a class="anchor" id="a952b4b63982db13f55c02e17c55ab5ac"></a><!-- doxytag: member="PacketGroupHandler::timeout_handler" ref="a952b4b63982db13f55c02e17c55ab5ac" args=")(void)" -->





109
<div class="memitem">





110
<div class="memproto">





111
      <table class="memname">





112
        <tr>





113
          <td class="memname">void(* <a class="el" href="structPacketGroupHandler.html#a952b4b63982db13f55c02e17c55ab5ac">PacketGroupHandler::timeout_handler</a>)(void)</td>





114
        </tr>





115
      </table>





116
</div>





117
<div class="memdoc">





118
<p>Called every half second (not in interrupt, but in wl_do). </p>





119




120
<p>Referenced by <a class="el" href="wl__basic_8c_source.html#l00042">wl_basic_register_handler()</a>.</p>





121




122
</div>





123
</div>





124
<a class="anchor" id="ac03247d5c07e97e35b1f557c0937b0eb"></a><!-- doxytag: member="PacketGroupHandler::unregister" ref="ac03247d5c07e97e35b1f557c0937b0eb" args=")(void)" -->





125
<div class="memitem">





126
<div class="memproto">





127
      <table class="memname">





128
        <tr>





129
          <td class="memname">void(* <a class="el" href="structPacketGroupHandler.html#ac03247d5c07e97e35b1f557c0937b0eb">PacketGroupHandler::unregister</a>)(void)</td>





130
        </tr>





131
      </table>





132
</div>





133
<div class="memdoc">





134
<p>Called for any cleanup when the network is turned off. </p>





135




136
<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>





137




138
</div>





139
</div>





140
<hr/>The documentation for this struct was generated from the following file:<ul>





141
<li><a class="el" href="wireless_8h_source.html">wireless.h</a></li>





142
</ul>





143
</div>





144
<hr size="1"/><address style="text-align: right;"><small>Generated on Wed Sep 23 12:51:07 2009 for libwireless by&nbsp;





145
<a href="http://www.doxygen.org/index.html">





146
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>





147
</body>





148
</html>