/trunk/docs/libwireless/structPacketGroupHandler.html - Annotate - Colony - Robotics Club

19

bcoltin

<!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">

3

<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

<!-- Generated by Doxygen 1.4.6 -->

8

<div class="tabs">

9

  <ul>

10

    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>

11

    <li><a href="modules.html"><span>Modules</span></a></li>

12

    <li id="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>

13

    <li><a href="files.html"><span>Files</span></a></li>

14

  </ul></div>

15

<div class="tabs">

16

  <ul>

17

    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>

18

    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>

19

    <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>

20

  </ul></div>

21

<h1>PacketGroupHandler Struct Reference<br>

22

<small>

23

[<a class="el" href="group__wireless.html">Wireless</a>,&nbsp;<a class="el" href="group__wireless.html">Wireless</a>]</small>

24

</h1><!-- doxytag: class="PacketGroupHandler" --><code>#include &lt;<a class="el" href="wireless_8h-source.html">wireless.h</a>&gt;</code>

25

<p>

26

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

27

<tr><td></td></tr>

28

<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>

29

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

30

31

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

32

33

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

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#5c01636d72de2ddafc734ab754d93104">handle_receive</a> )(char type, int source, unsigned char *packet, int length)</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#c03247d5c07e97e35b1f557c0937b0eb">unregister</a> )(void)</td></tr>

38

39

</table>

40

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

49

        <tr>

50

          <td class="md" nowrap valign="top">unsigned int <a class="el" href="structPacketGroupHandler.html#f0849c643f1b1e257ccfe96110109950">PacketGroupHandler::groupCode</a>          </td>

51

        </tr>

52

      </table>

53

    </td>

54

  </tr>

55

</table>

56

<table cellspacing="5" cellpadding="0" border="0">

57

  <tr>

58

    <td>

59

      &nbsp;

60

    </td>

61

    <td>

62

63

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

72

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

74

        </tr>

75

      </table>

76

    </td>

77

  </tr>

78

</table>

79

<table cellspacing="5" cellpadding="0" border="0">

80

  <tr>

81

    <td>

82

      &nbsp;

83

    </td>

84

    <td>

85

86

<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>&nbsp;</td><td>the packet type </td></tr>

91

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

92

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

93

    <tr><td valign="top"></td><td valign="top"><em>length</em>&nbsp;</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">

104

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

106

        </tr>

107

      </table>

108

    </td>

109

  </tr>

110

</table>

111

<table cellspacing="5" cellpadding="0" border="0">

112

  <tr>

113

    <td>

114

      &nbsp;

115

    </td>

116

    <td>

117

118

<p>

119

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

120

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

121

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

122

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

123

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

124

  </table>

125

</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">

134

        <tr>

135

          <td class="md" nowrap valign="top">void(* <a class="el" href="structPacketGroupHandler.html#952b4b63982db13f55c02e17c55ab5ac">PacketGroupHandler::timeout_handler</a>)(void)          </td>

136

        </tr>

137

      </table>

138

    </td>

139

  </tr>

140

</table>

141

<table cellspacing="5" cellpadding="0" border="0">

142

  <tr>

143

    <td>

144

      &nbsp;

145

    </td>

146

    <td>

147

148

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

157

        <tr>

158

          <td class="md" nowrap valign="top">void(* <a class="el" href="structPacketGroupHandler.html#c03247d5c07e97e35b1f557c0937b0eb">PacketGroupHandler::unregister</a>)(void)          </td>

159

        </tr>

160

      </table>

161

    </td>

162

  </tr>

163

</table>

164

<table cellspacing="5" cellpadding="0" border="0">

165

  <tr>

166

    <td>

167

      &nbsp;

168

    </td>

169

    <td>

170

171

<p>

172

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

173

  </tr>

174

</table>

175

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

176

<li><a class="el" href="wireless_8h-source.html">wireless.h</a></ul>

178

19

bcoltin

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

180

</body>

181

</html>

Project

General

Profile

Colony

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