doc/www/doxygen/html/controller_8h-source.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">
   3 <title>Barry: controller.h Source File</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.5.6 -->
   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><a href="namespaces.html"><span>Namespaces</span></a></li>
  14       <li><a href="classes.html"><span>Classes</span></a></li>
  15       <li class="current"><a href="files.html"><span>Files</span></a></li>
  16       <li><a href="dirs.html"><span>Directories</span></a></li>
  17     </ul>
  18   </div>
  19   <div class="navpath"><a class="el" href="dir_edc0f428e3eefcfdce9c25befd901c57.html">src</a>
  20   </div>
  21 </div>
  22 <div class="contents">
  23 <h1>controller.h</h1><a href="controller_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">///</span>
  24 <a name="l00002"></a>00002 <span class="comment"></span><span class="comment">/// \file       controller.h</span>
  25 <a name="l00003"></a>00003 <span class="comment"></span><span class="comment">///             High level BlackBerry API class</span>
  26 <a name="l00004"></a>00004 <span class="comment"></span><span class="comment">///</span>
  27 <a name="l00005"></a>00005 <span class="comment"></span>
  28 <a name="l00006"></a>00006 <span class="comment">/*</span>
  29 <a name="l00007"></a>00007 <span class="comment">    Copyright (C) 2005-2011, Net Direct Inc. (http://www.netdirect.ca/)</span>
  30 <a name="l00008"></a>00008 <span class="comment"></span>
  31 <a name="l00009"></a>00009 <span class="comment">    This program is free software; you can redistribute it and/or modify</span>
  32 <a name="l00010"></a>00010 <span class="comment">    it under the terms of the GNU General Public License as published by</span>
  33 <a name="l00011"></a>00011 <span class="comment">    the Free Software Foundation; either version 2 of the License, or</span>
  34 <a name="l00012"></a>00012 <span class="comment">    (at your option) any later version.</span>
  35 <a name="l00013"></a>00013 <span class="comment"></span>
  36 <a name="l00014"></a>00014 <span class="comment">    This program is distributed in the hope that it will be useful,</span>
  37 <a name="l00015"></a>00015 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
  38 <a name="l00016"></a>00016 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span>
  39 <a name="l00017"></a>00017 <span class="comment"></span>
  40 <a name="l00018"></a>00018 <span class="comment">    See the GNU General Public License in the COPYING file at the</span>
  41 <a name="l00019"></a>00019 <span class="comment">    root directory of this project for more details.</span>
  42 <a name="l00020"></a>00020 <span class="comment">*/</span>
  43 <a name="l00021"></a>00021
  44 <a name="l00022"></a>00022 <span class="preprocessor">#ifndef __BARRY_CONTROLLER_H__</span>
  45 <a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define __BARRY_CONTROLLER_H__</span>
  46 <a name="l00024"></a>00024 <span class="preprocessor"></span>
  47 <a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="dll_8h.html" title="Macros for handling DLL/library API visibility.">dll.h</a>"</span>
  48 <a name="l00026"></a>00026 <span class="preprocessor">#include "<a class="code" href="usbwrap_8h.html" title="USB API wrapper.">usbwrap.h</a>"</span>
  49 <a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="socket_8h.html" title="Class wrapper to encapsulate the Blackberry USB logical socket.">socket.h</a>"</span>
  50 <a name="l00028"></a>00028 <span class="preprocessor">#include "<a class="code" href="pin_8h.html" title="class for device PIN notation">pin.h</a>"</span>
  51 <a name="l00029"></a>00029 <span class="preprocessor">#include "<a class="code" href="probe_8h.html" title="USB Blackberry detection routines.">probe.h</a>"</span>
  52 <a name="l00030"></a>00030 <span class="comment"></span>
  53 <a name="l00031"></a>00031 <span class="comment">/// Project namespace, containing all related functions and classes.</span>
  54 <a name="l00032"></a>00032 <span class="comment">/// This is the only namespace applications should be concerned with,</span>
  55 <a name="l00033"></a>00033 <span class="comment">/// for now.</span>
  56 <a name="l00034"></a>00034 <span class="comment"></span><span class="keyword">namespace </span>Barry {
  57 <a name="l00035"></a>00035
  58 <a name="l00036"></a>00036 <span class="comment">// forward declarations</span>
  59 <a name="l00037"></a>00037 <span class="keyword">class </span>SocketRoutingQueue;
  60 <a name="l00038"></a>00038
  61 <a name="l00039"></a>00039 <span class="keyword">namespace </span>Mode {
  62 <a name="l00040"></a>00040         <span class="keyword">class </span>Mode;
  63 <a name="l00041"></a>00041         <span class="keyword">class </span>IpModem;
  64 <a name="l00042"></a>00042         <span class="keyword">class </span>Serial;
  65 <a name="l00043"></a>00043         <span class="keyword">class </span>JavaLoader;
  66 <a name="l00044"></a>00044         <span class="keyword">class </span>JVMDebug;
  67 <a name="l00045"></a>00045         <span class="keyword">class </span>RawChannel;
  68 <a name="l00046"></a>00046 }
  69 <a name="l00047"></a>00047
  70 <a name="l00048"></a>00048 <span class="comment">//</span>
  71 <a name="l00049"></a>00049 <span class="comment">// Controller class</span>
  72 <a name="l00050"></a>00050 <span class="comment">//</span><span class="comment"></span>
  73 <a name="l00051"></a>00051 <span class="comment">/// The main interface class.  This class coordinates the communication to</span>
  74 <a name="l00052"></a>00052 <span class="comment">/// a single handheld.  This class also owns the only Usb::Device object</span>
  75 <a name="l00053"></a>00053 <span class="comment">/// the handheld.  All other classes reference this one for the low level</span>
  76 <a name="l00054"></a>00054 <span class="comment">/// device object.  This class owns the only SocketZero object as well,</span>
  77 <a name="l00055"></a>00055 <span class="comment">/// which is the object that any SocketRoutingQueue is plugged into</span>
  78 <a name="l00056"></a>00056 <span class="comment">/// if constructed that way.</span>
  79 <a name="l00057"></a>00057 <span class="comment">///</span>
  80 <a name="l00058"></a>00058 <span class="comment">/// To use this class, use the following steps:</span>
  81 <a name="l00059"></a>00059 <span class="comment">///</span>
  82 <a name="l00060"></a>00060 <span class="comment">///     - Probe the USB bus for matching devices with the Probe class</span>
  83 <a name="l00061"></a>00061 <span class="comment">///     - Create an optional SocketRoutingQueue object and create a</span>
  84 <a name="l00062"></a>00062 <span class="comment">///             read thread for it, or use its default read thread.</span>
  85 <a name="l00063"></a>00063 <span class="comment">///     - Pass one of the probe results into the Controller constructor</span>
  86 <a name="l00064"></a>00064 <span class="comment">///             to connect to the USB device.  Pass the routing queue</span>
  87 <a name="l00065"></a>00065 <span class="comment">///             to the Controller constructor here too, if needed.</span>
  88 <a name="l00066"></a>00066 <span class="comment">///     - Create the Mode object of your choice.  See m_desktop.h</span>
  89 <a name="l00067"></a>00067 <span class="comment">///             and m_serial.h for these mode classes.  You pass</span>
  90 <a name="l00068"></a>00068 <span class="comment">///             your controller object into these mode constructors</span>
  91 <a name="l00069"></a>00069 <span class="comment">///             to create the mode.</span>
  92 <a name="l00070"></a>00070 <span class="comment">///</span>
  93 <a name="l00071"></a><a class="code" href="classBarry_1_1Controller.html">00071</a> <span class="comment"></span><span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1Controller.html" title="The main interface class.">Controller</a>
  94 <a name="l00072"></a>00072 {
  95 <a name="l00073"></a>00073         <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classBarry_1_1Mode_1_1Mode.html" title="Base class for simple mode classes.">Barry::Mode::Mode</a>;
  96 <a name="l00074"></a>00074         <span class="keyword">friend</span> <span class="keyword">class </span>Barry::Mode::IpModem;
  97 <a name="l00075"></a>00075         <span class="keyword">friend</span> <span class="keyword">class </span>Barry::Mode::Serial;
  98 <a name="l00076"></a>00076         <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classBarry_1_1Mode_1_1JavaLoader.html" title="The main interface class to the java program loader protocol.">Barry::Mode::JavaLoader</a>;
  99 <a name="l00077"></a>00077         <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classBarry_1_1Mode_1_1JVMDebug.html" title="The main interface class to the java program debugger protocol.">Barry::Mode::JVMDebug</a>;
 100 <a name="l00078"></a>00078         <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classBarry_1_1Mode_1_1RawChannel.html" title="The main class for creating a raw channel session.">Barry::Mode::RawChannel</a>;
 101 <a name="l00079"></a>00079
 102 <a name="l00080"></a>00080 <span class="keyword">public</span>:<span class="comment"></span>
 103 <a name="l00081"></a>00081 <span class="comment">        /// Handheld mode type</span>
 104 <a name="l00082"></a><a class="code" href="classBarry_1_1Controller.html#8b40b5d7e285b39375d857e1cea6cb15">00082</a> <span class="comment"></span>        <span class="keyword">enum</span> <a class="code" href="classBarry_1_1Controller.html#8b40b5d7e285b39375d857e1cea6cb15" title="Handheld mode type.">ModeType</a> {
 105 <a name="l00083"></a>00083                 Unspecified,            <span class="comment">//&lt; default on start up (unused)</span>
 106 <a name="l00084"></a>00084                 Bypass,                 <span class="comment">//&lt; unsupported, unknown</span>
 107 <a name="l00085"></a>00085                 Desktop,                <span class="comment">//&lt; desktop mode required for database</span>
 108 <a name="l00086"></a>00086                                         <span class="comment">//&lt; operation</span>
 109 <a name="l00087"></a>00087                 JavaLoader,             <span class="comment">//&lt; experimental</span>
 110 <a name="l00088"></a>00088                 JVMDebug,               <span class="comment">//&lt; experimental</span>
 111 <a name="l00089"></a>00089                 UsbSerData,             <span class="comment">//&lt; GPRS modem support over USB</span>
 112 <a name="l00090"></a>00090                 UsbSerCtrl,             <span class="comment">//&lt; internally used behind the scenes</span>
 113 <a name="l00091"></a>00091                 RawChannel              <span class="comment">//&lt; raw channel</span>
 114 <a name="l00092"></a>00092         };
 115 <a name="l00093"></a>00093
 116 <a name="l00094"></a>00094 <span class="keyword">private</span>:
 117 <a name="l00095"></a>00095         ProbeResult m_result;
 118 <a name="l00096"></a>00096         Usb::Device m_dev;
 119 <a name="l00097"></a>00097         Usb::Interface *m_iface;
 120 <a name="l00098"></a>00098         Pin m_pin;
 121 <a name="l00099"></a>00099
 122 <a name="l00100"></a>00100         SocketZero m_zero;
 123 <a name="l00101"></a>00101         SocketRoutingQueue *m_queue;    <span class="comment">//&lt; ptr to external object; no delete</span>
 124 <a name="l00102"></a>00102
 125 <a name="l00103"></a>00103 <span class="keyword">private</span>:
 126 <a name="l00104"></a>00104         <span class="keywordtype">void</span> SetupUsb(<span class="keyword">const</span> ProbeResult &amp;device);
 127 <a name="l00105"></a>00105
 128 <a name="l00106"></a>00106 <span class="keyword">protected</span>:
 129 <a name="l00107"></a>00107         uint16_t SelectMode(ModeType mode);     <span class="comment">// returns mode socket</span>
 130 <a name="l00108"></a>00108         uint16_t SelectMode(ModeType mode, <span class="keyword">const</span> <span class="keywordtype">char</span> *explicitModeName); <span class="comment">// returns mode socket</span>
 131 <a name="l00109"></a>00109
 132 <a name="l00110"></a>00110 <span class="keyword">public</span>:
 133 <a name="l00111"></a>00111         <span class="keyword">explicit</span> <a class="code" href="classBarry_1_1Controller.html" title="The main interface class.">Controller</a>(<span class="keyword">const</span> ProbeResult &amp;device,
 134 <a name="l00112"></a>00112                 <span class="keywordtype">int</span> default_timeout = USBWRAP_DEFAULT_TIMEOUT);
 135 <a name="l00113"></a>00113         <a class="code" href="classBarry_1_1Controller.html" title="The main interface class.">Controller</a>(<span class="keyword">const</span> ProbeResult &amp;device, SocketRoutingQueue &amp;queue,
 136 <a name="l00114"></a>00114                 <span class="keywordtype">int</span> default_timeout = USBWRAP_DEFAULT_TIMEOUT);
 137 <a name="l00115"></a>00115         ~<a class="code" href="classBarry_1_1Controller.html" title="The main interface class.">Controller</a>();
 138 <a name="l00116"></a>00116
 139 <a name="l00117"></a>00117         <span class="keywordtype">bool</span> HasQueue()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_queue; }
 140 <a name="l00118"></a>00118
 141 <a name="l00119"></a>00119         <span class="keyword">const</span> ProbeResult&amp; GetProbeResult()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_result; }
 142 <a name="l00120"></a>00120 };
 143 <a name="l00121"></a>00121
 144 <a name="l00122"></a>00122 } <span class="comment">// namespace Barry</span>
 145 <a name="l00123"></a>00123
 146 <a name="l00124"></a>00124 <span class="preprocessor">#endif</span>
 147 <a name="l00125"></a>00125 <span class="preprocessor"></span>
 148 </pre></div></div>
 149 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Feb 10 16:13:58 2011 for Barry by&nbsp;
 150 <a href="http://www.doxygen.org/index.html">
 151 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
 152 </body>
 153 </html>