src/controller.h

   1 ///
   2 /// \file       controller.h
   3 ///             High level BlackBerry API class
   4 ///
   5
   6 /*
   7     Copyright (C) 2005-2008, 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 Desktop;
  40         class IpModem;
  41         class Serial;
  42 }
  43
  44 //
  45 // Controller class
  46 //
  47 /// The main interface class.  This class coordinates the communication to
  48 /// a single handheld.  This class also owns the only Usb::Device object
  49 /// the handheld.  All other classes reference this one for the low level
  50 /// device object.  This class owns the only SocketZero object as well,
  51 /// which is the object that any SocketRoutingQueue is plugged into
  52 /// if constructed that way.
  53 ///
  54 /// To use this class, use the following steps:
  55 ///
  56 ///     - Probe the USB bus for matching devices with the Probe class
  57 ///     - Create an optional SocketRoutingQueue object and create a
  58 ///             read thread for it, or use its default read thread.
  59 ///     - Pass one of the probe results into the Controller constructor
  60 ///             to connect to the USB device.  Pass the routing queue
  61 ///             to the Controller constructor here too, if needed.
  62 ///     - Create the Mode object of your choice.  See m_desktop.h
  63 ///             and m_serial.h for these mode classes.  You pass
  64 ///             your controller object into these mode constructors
  65 ///             to create the mode.
  66 ///
  67 class BXEXPORT Controller
  68 {
  69         friend class Barry::Mode::Desktop;
  70         friend class Barry::Mode::IpModem;
  71         friend class Barry::Mode::Serial;
  72
  73 public:
  74         /// Handheld mode type
  75         enum ModeType {
  76                 Unspecified,            //< default on start up (unused)
  77                 Bypass,                 //< unsupported, unknown
  78                 Desktop,                //< desktop mode required for database
  79                                         //< operation
  80                 JavaLoader,             //< unsupported
  81                 UsbSerData,             //< GPRS modem support over USB
  82                 UsbSerCtrl              //< internally used behind the scenes
  83         };
  84
  85 private:
  86         ProbeResult m_result;
  87         Usb::Device m_dev;
  88         Usb::Interface *m_iface;
  89         uint32_t m_pin;
  90
  91         SocketZero m_zero;
  92         SocketRoutingQueue *m_queue;    //< ptr to external object; no delete
  93
  94 private:
  95         void SetupUsb(const ProbeResult &device);
  96
  97 protected:
  98         uint16_t SelectMode(ModeType mode);     // returns mode socket
  99
 100 public:
 101         explicit Controller(const ProbeResult &device);
 102         Controller(const ProbeResult &device, SocketRoutingQueue &queue);
 103         ~Controller();
 104
 105         bool HasQueue() const { return m_queue; }
 106
 107         const ProbeResult& GetProbeResult() const { return m_result; }
 108 };
 109
 110 } // namespace Barry
 111
 112 #endif
 113