src/m_javaloader.h

   1 ///
   2 /// \file       m_javaloader.h
   3 ///             Mode class for the JavaLoader mode
   4 ///
   5
   6 /*
   7     Copyright (C) 2005-2009, Net Direct Inc. (http://www.netdirect.ca/)
   8         Copyright (C) 2008-2009, Nicolas VIVIEN
   9
  10         Some parts are inspired from m_desktop.h
  11
  12     This program is free software; you can redistribute it and/or modify
  13     it under the terms of the GNU General Public License as published by
  14     the Free Software Foundation; either version 2 of the License, or
  15     (at your option) any later version.
  16
  17     This program is distributed in the hope that it will be useful,
  18     but WITHOUT ANY WARRANTY; without even the implied warranty of
  19     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  20
  21     See the GNU General Public License in the COPYING file at the
  22     root directory of this project for more details.
  23 */
  24
  25 #ifndef __BARRY_M_JAVALOADER_H__
  26 #define __BARRY_M_JAVALOADER_H__
  27
  28 #include "dll.h"
  29 #include "socket.h"
  30 #include "record.h"
  31
  32 namespace Barry {
  33
  34 // forward declarations
  35 class Parser;
  36 class Builder;
  37 class Controller;
  38
  39 namespace Mode {
  40
  41 //
  42 // Desktop class
  43 //
  44 /// The main interface class to the device databases.
  45 ///
  46 /// To use this class, use the following steps:
  47 ///
  48 ///     - Create a Controller object (see Controller class for more details)
  49 ///     - Create this Mode::JavaLoader object, passing in the Controller
  50 ///             object during construction
  51 ///     - Call Open() to open database socket and finish constructing.
  52 ///     - Call LoadDatabase() to retrieve and store a database
  53 ///
  54 class BXEXPORT JavaLoader
  55 {
  56 public:
  57         enum CommandType { Unknown, DatabaseAccess };
  58
  59 private:
  60         Controller &m_con;
  61
  62         SocketHandle m_socket;
  63
  64         CommandTable m_commandTable;
  65
  66         uint16_t m_ModeSocket;                  // socket recommended by device
  67                                                 // when mode was selected
  68
  69 protected:
  70
  71 public:
  72         JavaLoader(Controller &con);
  73         ~JavaLoader();
  74
  75         //////////////////////////////////
  76         // primary operations - required before anything else
  77
  78         void Open(const char *password = 0);
  79         void RetryPassword(const char *password);
  80
  81         //////////////////////////////////
  82         // API
  83         void StartStream();
  84         void SendStream(char *buffer, int size);
  85         void StopStream(void);
  86 };
  87
  88 }} // namespace Barry::Mode
  89
  90 #endif
  91