src/m_mode_base.h

   1 ///
   2 /// \file       m_mode_base.h
   3 ///             Base for mode classes
   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_M_MODE_BASE_H__
  23 #define __BARRY_M_MODE_BASE_H__
  24
  25 #include "dll.h"
  26 #include "controller.h"
  27
  28 namespace Barry {
  29
  30 namespace Mode {
  31
  32 //
  33 // Mode class
  34 //
  35 /// Base class for simple mode classes.  Put common code here.
  36 ///
  37 class BXEXPORT Mode
  38 {
  39 protected:
  40         Controller &m_con;
  41         Controller::ModeType m_modetype;
  42         SocketHandle m_socket;
  43
  44         uint16_t m_ModeSocket;                  // socket recommended by device
  45                                                 // when mode was selected
  46
  47 public:
  48         Mode(Controller &con, Controller::ModeType type);
  49         virtual ~Mode();
  50
  51         //////////////////////////////////
  52         // primary operations - required before anything else
  53
  54         void Open(const char *password = 0);
  55         void RetryPassword(const char *password);
  56
  57 protected:
  58         //////////////////////////////////
  59         // overrides
  60
  61         virtual void OnOpen();
  62 };
  63
  64 }} // namespace Barry::Mode
  65
  66 #endif
  67