Project

General

Profile

Revision 1380

Added by Chris Mar over 14 years ago

fixed doxygen problems in wireless library, added new docs

View differences:

structPacketGroupHandler.html
1 1 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 2 
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 3 
<title>libwireless: PacketGroupHandler Struct Reference</title>
4 
<link href="tabs.css" rel="stylesheet" type="text/css">
4 5 
<link href="doxygen.css" rel="stylesheet" type="text/css">
5 
<link href="tabs.css" rel="stylesheet" type="text/css">
6 6 
</head><body>
7 
<!-- Generated by Doxygen 1.5.3 -->
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 class="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>
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&nbsp;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&nbsp;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&nbsp;Structures</span></a></li>
20 
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
21 
    </ul>
22 
  </div>
15 23 
</div>
16 
<div class="tabs">
17 
  <ul>
18 
    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
19 
    <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
20 
  </ul>
21 
</div>
24 
<div class="contents">
22 25 
<h1>PacketGroupHandler Struct Reference<br>
23 26 
<small>
24 
[<a class="el" href="group__wireless.html">Wireless</a>,&nbsp;<a class="el" href="group__wireless.html">Wireless</a>]</small>
25 
</h1><!-- doxytag: class="PacketGroupHandler" --><code>#include &lt;<a class="el" href="wireless_8h-source.html">wireless.h</a>&gt;</code>
27 
[<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>
26 29 
<p>
27 30 
<table border="0" cellpadding="0" cellspacing="0">
28 31 
<tr><td></td></tr>
......
53 56 

  		




  54
  57
  
    
<p>


  		




  55
  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#l00033">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
  
    

  		




  56
  61
  
    
</div>


  		




  57
  62
  
    
</div><p>


  		




  58
  
  
    
<a class="anchor" name="952b4b63982db13f55c02e17c55ab5ac"></a><!-- doxytag: member="PacketGroupHandler::timeout_handler" ref="952b4b63982db13f55c02e17c55ab5ac" args=")(void)" -->


  		




  
  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
  64
  
    
<div class="memitem">


  		




  60
  65
  
    
<div class="memproto">


  		




  61
  66
  
    
      <table class="memname">


  		




  62
  67
  
    
        <tr>


  		




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


  		




  
  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>


  		




  64
  69
  
    
        </tr>


  		




  65
  70
  
    
      </table>


  		




  66
  71
  
    
</div>


  		




  67
  72
  
    
<div class="memdoc">


  		




  68
  73
  
    

  		




  69
  74
  
    
<p>


  		




  70
  
  
    
Called every half second (not in interrupt, but in wl_do). 


  		




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


  		




  
  79
  
    
    <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
  
    
    <tr><td valign="top"></td><td valign="top"><em>packet</em>&nbsp;</td><td>the packet received </td></tr>


  		




  
  81
  
    
    <tr><td valign="top"></td><td valign="top"><em>length</em>&nbsp;</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#l00033">wl_basic_register_handler()</a>, and <a class="el" href="wireless_8c_source.html#l00390">wl_do()</a>.</p>


  		




  
  86
  
    

  		




  71
  87
  
    
</div>


  		




  72
  88
  
    
</div><p>


  		




  73
  89
  
    
<a class="anchor" name="045939030c6e2f2dd0d53b5718d9f902"></a><!-- doxytag: member="PacketGroupHandler::handle_response" ref="045939030c6e2f2dd0d53b5718d9f902" args=")(int frame, int received)" -->


  		




  ......




  90
  106
  
    
  </table>


  		




  91
  107
  
    
</dl>


  		




  92
  108
  
    

  		




  
  109
  
    
<p>Referenced by <a class="el" href="wl__basic_8c_source.html#l00033">wl_basic_register_handler()</a>, and <a class="el" href="wireless_8c_source.html#l00390">wl_do()</a>.</p>


  		




  
  110
  
    

  		




  93
  111
  
    
</div>


  		




  94
  112
  
    
</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)" -->


  		




  
  113
  
    
<a class="anchor" name="952b4b63982db13f55c02e17c55ab5ac"></a><!-- doxytag: member="PacketGroupHandler::timeout_handler" ref="952b4b63982db13f55c02e17c55ab5ac" args=")(void)" -->


  		




  96
  114
  
    
<div class="memitem">


  		




  97
  115
  
    
<div class="memproto">


  		




  98
  116
  
    
      <table class="memname">


  		




  99
  117
  
    
        <tr>


  		




  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>


  		




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


  		




  101
  119
  
    
        </tr>


  		




  102
  120
  
    
      </table>


  		




  103
  121
  
    
</div>


  		




  104
  122
  
    
<div class="memdoc">


  		




  105
  123
  
    

  		




  106
  124
  
    
<p>


  		




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


  		




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


  		




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


  		




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


  		




  114
  
  
    
  </table>


  		




  115
  
  
    
</dl>


  		




  
  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#l00033">wl_basic_register_handler()</a>.</p>


  		




  116
  127
  
    

  		




  117
  128
  
    
</div>


  		




  118
  129
  
    
</div><p>


  		




  ......




  129
  140
  
    

  		




  130
  141
  
    
<p>


  		




  131
  142
  
    
Called for any cleanup when the network is turned off. 


  		




  
  143
  
    
<p>Referenced by <a class="el" href="wl__basic_8c_source.html#l00033">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
  
    

  		




  132
  145
  
    
</div>


  		




  133
  146
  
    
</div><p>


  		




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


  		




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


  		




  136
  
  
    
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Apr 28 17:49:53 2008 for libwireless by&nbsp;


  		




  
  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 Fri Sep 4 13:14:45 2009 for libwireless by&nbsp;


  		




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


  		




  138
  
  
    
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>


  		




  
  152
  
    
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>


  		




  139
  153
  
    
</body>


  		




  140
  154
  
    
</html>


  		












Also available in:  Unified diff