Utils/Termlib/TelnetTerminal.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2009
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     Stefan Bund <g0dil@berlios.de>
   7 //
   8 // This program is free software; you can redistribute it and/or modify
   9 // it under the terms of the GNU General Public License as published by
  10 // the Free Software Foundation; either version 2 of the License, or
  11 // (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 // GNU General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the
  20 // Free Software Foundation, Inc.,
  21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  22
  23 /** \file
  24     \brief TelnetTerminal public header */
  25
  26 #ifndef HH_SENF_Utils_Termlib_TelnetTerminal_
  27 #define HH_SENF_Utils_Termlib_TelnetTerminal_ 1
  28
  29 // Custom includes
  30 #include "Telnet.hh"
  31 #include "AbstractTerminal.hh"
  32
  33 //#include "TelnetTerminal.mpp"
  34 ///////////////////////////////hh.p////////////////////////////////////////
  35
  36 namespace senf {
  37 namespace term {
  38
  39     /** \brief AbstractTerminal interface implementation based on telnet
  40
  41         This class provides a telnet server implementation implementing the AbstractTerminal
  42         interface.
  43
  44         TelnetTerminal provides one additional callback which needs to be implemented in a derived
  45         class: v_setupFailed(). This member will be called, when not all required telnet options are
  46         supported by the telnet client. In this case, the communication will be switched back into
  47         line-oriented mode and v_setupFailed() is called.
  48
  49         \ingroup telnet_group
  50      */
  51     class TelnetTerminal
  52         : public telnethandler::TerminalType,
  53           public telnethandler::NAWS,
  54           public AbstractTerminal
  55     {
  56     public:
  57         TelnetTerminal();
  58
  59         ///\name AbstractTerminal interface implementation
  60         ///\{
  61         virtual void setCallbacks(AbstractTerminal::Callbacks & cb);
  62         virtual std::string terminalType();
  63         virtual unsigned width();
  64         virtual unsigned height();
  65         virtual void write(char ch);
  66         ///\}
  67
  68     protected:
  69
  70 #   ifndef DOXYGEN
  71     private:
  72 #   endif
  73         virtual void v_setupFailed() = 0; ///< Called when the telnet setup has failed
  74
  75     private:
  76         virtual void v_setupComplete();
  77         virtual void v_charReceived(char ch);
  78         virtual void v_windowSizeChanged();
  79
  80         AbstractTerminal::Callbacks * callbacks_;
  81         bool setupFailed_;
  82     };
  83
  84 }}
  85
  86 ///////////////////////////////hh.e////////////////////////////////////////
  87 //#include "TelnetTerminal.cci"
  88 //#include "TelnetTerminal.ct"
  89 //#include "TelnetTerminal.cti"
  90 #endif
  91
  92 \f
  93 // Local Variables:
  94 // mode: c++
  95 // fill-column: 100
  96 // comment-column: 40
  97 // c-file-style: "senf"
  98 // indent-tabs-mode: nil
  99 // ispell-local-dictionary: "american"
 100 // compile-command: "scons -u test"
 101 // End: