Project

General

Profile

Revision 1425

Added by Chris Mar about 10 years ago

updated wireless basic library code and docs

View differences:

structPacketGroupHandler.html
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">
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"/>
3 5
<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 -->
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 -->
8 11
<div class="navigation" id="top">
9 12
  <div class="tabs">
10 13
    <ul>
......
22 25
  </div>
23 26
</div>
24 27
<div class="contents">
25
<h1>PacketGroupHandler Struct Reference<br>
28
<h1>PacketGroupHandler Struct Reference<br/>
26 29
<small>
27 30
[<a class="el" href="group__wireless.html">Wireless</a>]</small>
28
</h1><!-- doxytag: class="PacketGroupHandler" --><code>#include &lt;<a class="el" href="wireless_8h_source.html">wireless.h</a>&gt;</code>
29
<p>
31
</h1><!-- doxytag: class="PacketGroupHandler" -->
32
<p><code>#include &lt;<a class="el" href="wireless_8h_source.html">wireless.h</a>&gt;</code></p>
30 33
<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&nbsp;</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(*&nbsp;</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(*&nbsp;</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(*&nbsp;</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(*&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPacketGroupHandler.html#c03247d5c07e97e35b1f557c0937b0eb">unregister</a> )(void)</td></tr>
42

  
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>
43 40
</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="" -->
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="" -->
47 45
<div class="memitem">
48 46
<div class="memproto">
49 47
      <table class="memname">
50 48
        <tr>
51
          <td class="memname">unsigned int <a class="el" href="structPacketGroupHandler.html#f0849c643f1b1e257ccfe96110109950">PacketGroupHandler::groupCode</a>          </td>
49
          <td class="memname">unsigned int <a class="el" href="structPacketGroupHandler.html#af0849c643f1b1e257ccfe96110109950">PacketGroupHandler::groupCode</a></td>
52 50
        </tr>
53 51
      </table>
54 52
</div>
55 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>
56 55

  
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 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>
60 57

  
61 58
</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)" -->
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)" -->
64 61
<div class="memitem">
65 62
<div class="memproto">
66 63
      <table class="memname">
67 64
        <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>
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>
69 66
        </tr>
70 67
      </table>
71 68
</div>
72 69
<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>
70
<p>Called when we receive a packet from this group.</p>
71
<dl><dt><b>Parameters:</b></dt><dd>
77 72
  <table border="0" cellspacing="2" cellpadding="0">
78 73
    <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>the packet type </td></tr>
79 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>
80 75
    <tr><td valign="top"></td><td valign="top"><em>packet</em>&nbsp;</td><td>the packet received </td></tr>
81 76
    <tr><td valign="top"></td><td valign="top"><em>length</em>&nbsp;</td><td>the length of the packet </td></tr>
82 77
  </table>
78
  </dd>
83 79
</dl>
84 80

  
85 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>
86 82

  
87 83
</div>
88
</div><p>
89
<a class="anchor" name="045939030c6e2f2dd0d53b5718d9f902"></a><!-- doxytag: member="PacketGroupHandler::handle_response" ref="045939030c6e2f2dd0d53b5718d9f902" args=")(int frame, int received)" -->
84
</div>
85
<a class="anchor" id="a045939030c6e2f2dd0d53b5718d9f902"></a><!-- doxytag: member="PacketGroupHandler::handle_response" ref="a045939030c6e2f2dd0d53b5718d9f902" args=")(int frame, int received)" -->
90 86
<div class="memitem">
91 87
<div class="memproto">
92 88
      <table class="memname">
93 89
        <tr>
94
          <td class="memname">void(* <a class="el" href="structPacketGroupHandler.html#045939030c6e2f2dd0d53b5718d9f902">PacketGroupHandler::handle_response</a>)(int frame, int received)          </td>
90
          <td class="memname">void(* <a class="el" href="structPacketGroupHandler.html#a045939030c6e2f2dd0d53b5718d9f902">PacketGroupHandler::handle_response</a>)(int frame, int received)</td>
95 91
        </tr>
96 92
      </table>
97 93
</div>
98 94
<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>
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>
103 97
  <table border="0" cellspacing="2" cellpadding="0">
104 98
    <tr><td valign="top"></td><td valign="top"><em>frame</em>&nbsp;</td><td>the last four bits of the frame </td></tr>
105 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>
106 100
  </table>
101
  </dd>
107 102
</dl>
108 103

  
109 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>
110 105

  
111 106
</div>
112
</div><p>
113
<a class="anchor" name="952b4b63982db13f55c02e17c55ab5ac"></a><!-- doxytag: member="PacketGroupHandler::timeout_handler" ref="952b4b63982db13f55c02e17c55ab5ac" args=")(void)" -->
107
</div>
108
<a class="anchor" id="a952b4b63982db13f55c02e17c55ab5ac"></a><!-- doxytag: member="PacketGroupHandler::timeout_handler" ref="a952b4b63982db13f55c02e17c55ab5ac" args=")(void)" -->
114 109
<div class="memitem">
115 110
<div class="memproto">
116 111
      <table class="memname">
117 112
        <tr>
118
          <td class="memname">void(* <a class="el" href="structPacketGroupHandler.html#952b4b63982db13f55c02e17c55ab5ac">PacketGroupHandler::timeout_handler</a>)(void)          </td>
113
          <td class="memname">void(* <a class="el" href="structPacketGroupHandler.html#a952b4b63982db13f55c02e17c55ab5ac">PacketGroupHandler::timeout_handler</a>)(void)</td>
119 114
        </tr>
120 115
      </table>
121 116
</div>
122 117
<div class="memdoc">
118
<p>Called every half second (not in interrupt, but in wl_do). </p>
123 119

  
124
<p>
125
Called every half second (not in interrupt, but in wl_do). 
126 120
<p>Referenced by <a class="el" href="wl__basic_8c_source.html#l00042">wl_basic_register_handler()</a>.</p>
127 121

  
128 122
</div>
129
</div><p>
130
<a class="anchor" name="c03247d5c07e97e35b1f557c0937b0eb"></a><!-- doxytag: member="PacketGroupHandler::unregister" ref="c03247d5c07e97e35b1f557c0937b0eb" args=")(void)" -->
123
</div>
124
<a class="anchor" id="ac03247d5c07e97e35b1f557c0937b0eb"></a><!-- doxytag: member="PacketGroupHandler::unregister" ref="ac03247d5c07e97e35b1f557c0937b0eb" args=")(void)" -->
131 125
<div class="memitem">
132 126
<div class="memproto">
133 127
      <table class="memname">
134 128
        <tr>
135
          <td class="memname">void(* <a class="el" href="structPacketGroupHandler.html#c03247d5c07e97e35b1f557c0937b0eb">PacketGroupHandler::unregister</a>)(void)          </td>
129
          <td class="memname">void(* <a class="el" href="structPacketGroupHandler.html#ac03247d5c07e97e35b1f557c0937b0eb">PacketGroupHandler::unregister</a>)(void)</td>
136 130
        </tr>
137 131
      </table>
138 132
</div>
139 133
<div class="memdoc">
134
<p>Called for any cleanup when the network is turned off. </p>
140 135

  
141
<p>
142
Called for any cleanup when the network is turned off. 
143 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>
144 137

  
145 138
</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 139
</div>
150
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Sep 8 19:59:17 2009 for libwireless by&nbsp;
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 Sun Sep 20 12:12:02 2009 for libwireless by&nbsp;
151 145
<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>
146
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
153 147
</body>
154 148
</html>

Also available in: Unified diff