src/m_serial.h

   1 ///
   2 /// \file       m_serial.h
   3 ///             Mode class for serial / GPRS modem mode
   4 ///
   5
   6 /*
   7     Copyright (C) 2005-2007, 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_M_SERIAL_H__
  23 #define __BARRY_M_SERIAL_H__
  24
  25 #include "dll.h"
  26 #include "socket.h"
  27 #include "data.h"
  28
  29 namespace Barry {
  30
  31 // forward declarations
  32 class Controller;
  33
  34 namespace Mode {
  35
  36 class BXEXPORT Serial
  37 {
  38 public:
  39         typedef void (*DeviceDataCallback)(void *context, const unsigned char *data, int len);
  40
  41 private:
  42         Controller &m_con;
  43
  44         SocketHandle m_data;
  45         SocketHandle m_ctrl;
  46
  47         uint16_t m_ModeSocket;                  // socket recommended by device
  48                                                 // when mode was selected
  49         uint16_t m_CtrlSocket;
  50
  51         // UsbSerData cache
  52         Data m_writeCache;
  53 //      Data m_readCache;
  54
  55         // external callbacks
  56         DeviceDataCallback m_callback;
  57         void *m_callback_context;
  58
  59 protected:
  60         static void DataCallback(void *context, Data *data);
  61
  62 public:
  63         Serial(Controller &con, DeviceDataCallback callback, void *callback_context);
  64         ~Serial();
  65
  66         //////////////////////////////////
  67         // general operations
  68         void Open(const char *password = 0);    // FIXME password needed?
  69         void RetryPassword(const char *password);
  70
  71         //////////////////////////////////
  72         // UsbSerData mode - modem specific
  73
  74 //      void Read(Data &data, int timeout); // can be called from separate thread
  75         void Write(const Data &data);
  76 };
  77
  78 }} // namespace Barry::Mode
  79
  80 #endif
  81