Project

General

Profile

Statistics
| Revision:

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

History | View | Annotate | Download (6.59 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: wl_basic.h Source File</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><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
17 
      <li class="current"><a href="files.html"><span>Files</span></a></li>
18 
    </ul>
19 
  </div>
20 
  <div class="tabs">
21 
    <ul>
22 
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
23 
      <li><a href="globals.html"><span>Globals</span></a></li>
24 
    </ul>
25 
  </div>
26 
<h1>wl_basic.h</h1><a href="wl__basic_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001
27 
<a name="l00021"></a>00021 <span class="preprocessor">#ifndef WL_BASIC_H</span>
28 
<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define WL_BASIC_H</span>
29 
<a name="l00023"></a>00023 <span class="preprocessor"></span>
30 
<a name="l00024"></a>00024 <span class="preprocessor">#include &lt;<a class="code" href="wireless_8h.html" title="Contains definitions for the wireless library.">wireless.h</a>&gt;</span>
31 
<a name="l00025"></a>00025
32 
<a name="l00027"></a><a class="code" href="group__wl__basic.html#ga366b705160e22c2a6c4ea2c3c22e3485">00027</a> <span class="preprocessor">#define WL_BASIC_GROUP 8</span>
33 
<a name="l00028"></a>00028 <span class="preprocessor"></span>
34 
<a name="l00030"></a><a class="code" href="group__wl__basic.html#gaf0fa88111d706ef4e8b3bda5bc32596c">00030</a> <a class="code" href="structPacketGroupHandler.html">PacketGroupHandler</a> <a class="code" href="group__wl__basic.html#gaf0fa88111d706ef4e8b3bda5bc32596c" title="PacketGroupHandler struct for Basic Group.">wl_basic_group_handler</a>;
35 
<a name="l00031"></a>00031
36 
<a name="l00035"></a><a class="code" href="structPacketInfo.html">00035</a> <span class="keyword">struct </span><a class="code" href="structPacketInfo.html" title="struct that contains relevant packet information">PacketInfo</a> {
37 
<a name="l00036"></a>00036     <span class="keywordtype">char</span> new_flag;
38 
<a name="l00037"></a>00037     <span class="keywordtype">char</span> type;
39 
<a name="l00038"></a>00038     <span class="keywordtype">int</span> source;
40 
<a name="l00039"></a>00039     <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* data;
41 
<a name="l00040"></a>00040     <span class="keywordtype">int</span> length;
42 
<a name="l00041"></a>00041 };
43 
<a name="l00042"></a>00042
44 
<a name="l00046"></a><a class="code" href="group__wl__basic.html#ga6c9a887fb0b719948025f195efff1af9">00046</a> <span class="keyword">struct </span><a class="code" href="structPacketInfo.html" title="struct that contains relevant packet information">PacketInfo</a> <a class="code" href="group__wl__basic.html#ga6c9a887fb0b719948025f195efff1af9" title="current packet information, correct after wl_basic_do()">current_packet</a>;
45 
<a name="l00047"></a>00047
46 
<a name="l00049"></a>00049 <span class="keywordtype">int</span> <a class="code" href="group__wl__basic.html#gaae4a8ae98cc33955ee20b6e481d47adf" title="init wireless for Basic Group">wl_basic_init</a>( <span class="keywordtype">void</span> (*handle_receive) (<span class="keywordtype">char</span> type, <span class="keywordtype">int</span> source, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* packet, <span class="keywordtype">int</span> length) );
47 
<a name="l00051"></a>00051 <span class="keywordtype">int</span> <a class="code" href="group__wl__basic.html#gae482937c7c29521030a33ecbc5d2dd9d" title="init wireless for Basic Group with default packet handling">wl_basic_init_default</a>( <span class="keywordtype">void</span> );
48 
<a name="l00053"></a>00053 <span class="keywordtype">void</span> <a class="code" href="group__wl__basic.html#gaebc714e1bf382a98ac7a43762bf905c5" title="internal function to register a packet handler function">wl_basic_register_handler</a>( <span class="keywordtype">void</span> (*handle_receive) (<span class="keywordtype">char</span> type, <span class="keywordtype">int</span> source, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* packet, <span class="keywordtype">int</span> length) );
49 
<a name="l00055"></a>00055 <span class="keywordtype">void</span> <a class="code" href="group__wl__basic.html#gad5d7334484e49cc3cb9ebe2cfc323115" title="send a packet to a single robot in Basic Group">wl_basic_send_robot_packet</a>( <span class="keywordtype">char</span> type, <span class="keywordtype">char</span>* data, <span class="keywordtype">int</span> len, <span class="keywordtype">int</span> dest );
50 
<a name="l00057"></a>00057 <span class="keywordtype">void</span> <a class="code" href="group__wl__basic.html#ga72d4f604603ef2541b5f4d3ae467938e" title="send a packet to all robots in Basic Group">wl_basic_send_global_packet</a>( <span class="keywordtype">char</span> type, <span class="keywordtype">char</span>* data, <span class="keywordtype">int</span> len );
51 
<a name="l00059"></a>00059 <span class="keywordtype">void</span> <a class="code" href="group__wl__basic.html#ga0ad976b2b61cca0081123606101c97cd" title="internal default packet handler if none is specified on init">wl_basic_packet_receive_handler</a>( <span class="keywordtype">char</span> type, <span class="keywordtype">int</span> source, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* packet, <span class="keywordtype">int</span> length );
52 
<a name="l00061"></a>00061 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span>* <a class="code" href="group__wl__basic.html#gac3f8a6f5c4d9c258ab9f29f9557632d0" title="wrapper for wl_do() to return packet data buffer">wl_basic_do_default</a>( <span class="keywordtype">int</span> *length ); <span class="comment">// end defgroup</span>
53 
<a name="l00063"></a>00063
54 
<a name="l00064"></a>00064 <span class="preprocessor">#endif</span>
55 
<a name="l00065"></a>00065 <span class="preprocessor"></span>
56 
</pre></div></div>
57 
<hr size="1"/><address style="text-align: right;"><small>Generated on Wed Sep 23 12:51:07 2009 for libwireless by&nbsp;
58 
<a href="http://www.doxygen.org/index.html">
59 
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
60 
</body>
61 
</html>