src/controller.h

   1 ///
   2 /// \file       controller.h
   3 ///             High level BlackBerry API class
   4 ///
   5
   6 /*
   7     Copyright (C) 2005-2009, Net Direct Inc. (http://www.netdirect.ca/)
   8
   9     This program is free software; you can redistribute it and/or modify
  10     it under the terms of the GNU General Public License as published by
  11     the Free Software Foundation; either version 2 of the License, or
  12     (at your option) any later version.
  13
  14     This program is distributed in the hope that it will be useful,
  15     but WITHOUT ANY WARRANTY; without even the implied warranty of
  16     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  17
  18     See the GNU General Public License in the COPYING file at the
  19     root directory of this project for more details.
  20 */
  21
  22 #ifndef __BARRY_CONTROLLER_H__
  23 #define __BARRY_CONTROLLER_H__
  24
  25 #include "dll.h"
  26 #include "usbwrap.h"
  27 #include "socket.h"
  28 #include "probe.h"
  29
  30 /// Project namespace, containing all related functions and classes.
  31 /// This is the only namespace applications should be concerned with,
  32 /// for now.
  33 namespace Barry {
  34
  35 // forward declarations
  36 class SocketRoutingQueue;
  37
  38 namespace Mode {
  39         class Mode;
  40         class IpModem;
  41         class Serial;
  42         class JavaLoader;
  43 }
  44
  45 //
  46 // Controller class
  47 //
  48 /// The main interface class.  This class coordinates the communication to
  49 /// a single handheld.  This class also owns the only Usb::Device object
  50 /// the handheld.  All other classes reference this one for the low level
  51 /// device object.  This class owns the only SocketZero object as well,
  52 /// which is the object that any SocketRoutingQueue is plugged into
  53 /// if constructed that way.
  54 ///
  55 /// To use this class, use the following steps:
  56 ///
  57 ///     - Probe the USB bus for matching devices with the Probe class
  58 ///     - Create an optional SocketRoutingQueue object and create a
  59 ///             read thread for it, or use its default read thread.
  60 ///     - Pass one of the probe results into the Controller constructor
  61 ///             to connect to the USB device.  Pass the routing queue
  62 ///             to the Controller constructor here too, if needed.
  63 ///     - Create the Mode object of your choice.  See m_desktop.h
  64 ///             and m_serial.h for these mode classes.  You pass
  65 ///             your controller object into these mode constructors
  66 ///             to create the mode.
  67 ///
  68 class BXEXPORT Controller
  69 {
  70         friend class Barry::Mode::Mode;
  71         friend class Barry::Mode::IpModem;
  72         friend class Barry::Mode::Serial;
  73         friend class Barry::Mode::JavaLoader;
  74
  75 public:
  76         /// Handheld mode type
  77         enum ModeType {
  78                 Unspecified,            //< default on start up (unused)
  79                 Bypass,                 //< unsupported, unknown
  80                 Desktop,                //< desktop mode required for database
  81                                         //< operation
  82                 JavaLoader,             //< experimental
  83                 UsbSerData,             //< GPRS modem support over USB
  84                 UsbSerCtrl              //< internally used behind the scenes
  85         };
  86
  87 private:
  88         ProbeResult m_result;
  89         Usb::Device m_dev;
  90         Usb::Interface *m_iface;
  91         uint32_t m_pin;
  92
  93         SocketZero m_zero;
  94         SocketRoutingQueue *m_queue;    //< ptr to external object; no delete
  95
  96 private:
  97         void SetupUsb(const ProbeResult &device);
  98
  99 protected:
 100         uint16_t SelectMode(ModeType mode);     // returns mode socket
 101
 102 public:
 103         explicit Controller(const ProbeResult &device);
 104         Controller(const ProbeResult &device, SocketRoutingQueue &queue);
 105         ~Controller();
 106
 107         bool HasQueue() const { return m_queue; }
 108
 109         const ProbeResult& GetProbeResult() const { return m_result; }
 110 };
 111
 112 } // namespace Barry
 113
 114 #endif
 115