Scheduler/Console/Server.ih

   1 // $Id$
   2 //
   3 // Copyright (C) 2008
   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 Server internal header */
  25
  26 #ifndef IH_SENF_Scheduler_Console_Server_
  27 #define IH_SENF_Scheduler_Console_Server_ 1
  28
  29 // Custom includes
  30 #include <boost/iostreams/concepts.hpp>
  31 #include <boost/iostreams/stream.hpp>
  32 #include <set>
  33
  34 ///////////////////////////////ih.p////////////////////////////////////////
  35
  36 namespace senf {
  37 namespace console {
  38
  39     class Server;
  40     class Client;
  41
  42 namespace detail {
  43
  44     class ServerManager
  45     {
  46     public:
  47         typedef boost::intrusive_ptr<Server> ptr;
  48
  49     protected:
  50
  51     private:
  52         static void add(ptr server);
  53         static void remove(ptr server);
  54
  55         static ServerManager & instance();
  56
  57         typedef std::set<ptr> Servers;
  58         Servers servers_;
  59
  60         friend class senf::console::Server;
  61     };
  62
  63     /** \brief Internal: Nonblocking boost::iostreams::sink
  64
  65         The sink discards data if the output socket would.
  66
  67         \fixme Don't throw exceptions ... set stream error indicator (if at all)
  68      */
  69     class NonblockingSocketSink
  70         : public boost::iostreams::sink
  71     {
  72     public:
  73         typedef ClientSocketHandle<
  74             senf::MakeSocketPolicy<StreamFramingPolicy,
  75                                    WriteablePolicy,
  76                                    ConnectedCommunicationPolicy>::policy > Handle;
  77
  78         NonblockingSocketSink(Client & client);
  79         std::streamsize write(const char * s, std::streamsize n);
  80
  81         Client & client() const;
  82
  83     private:
  84         Client & client_;
  85     };
  86
  87     typedef boost::iostreams::stream<NonblockingSocketSink> NonblockingSocketOStream;
  88
  89     typedef senf::ServerSocketHandle<
  90         senf::MakeSocketPolicy< senf::TCPv4SocketProtocol::Policy,
  91                                 senf::UnspecifiedAddressingPolicy>::policy > ServerHandle;
  92
  93     /** \brief Internal: Generic client interface
  94
  95         The ClientReader encapsulates the interaction of a single network client with the user: It
  96         manages prompt display and reading an interactive command.
  97      */
  98     class ClientReader
  99     {
 100     public:
 101         typedef ServerHandle::ClientHandle ClientHandle;
 102
 103         virtual ~ClientReader() = 0;
 104
 105         // Called by subclasses to get information from the Client
 106
 107         Client & client() const;
 108         std::string promptString() const;
 109         ClientHandle handle() const;
 110         std::ostream & stream() const;
 111
 112         // Called by subclasses to perform actions in the Client
 113
 114         void stopClient();
 115         std::string::size_type handleInput(std::string const & input, bool incremental=false) const;
 116
 117         // Called by the Client
 118
 119         void disablePrompt();
 120         void enablePrompt();
 121         void translate(std::string & data);
 122
 123     protected:
 124         ClientReader(Client & client);
 125
 126     private:
 127         virtual void v_disablePrompt() = 0;
 128         virtual void v_enablePrompt() = 0;
 129         virtual void v_translate(std::string & data) = 0;
 130
 131         Client & client_;
 132     };
 133
 134     /** \brief Internal: Primitive ClientReader implementation
 135
 136         This implementation uses the cooked telnet mode to read lines from the console. It does not
 137         support explicit line editing or any other advanced features.
 138      */
 139     class DumbClientReader
 140         : public ClientReader
 141     {
 142     public:
 143         DumbClientReader(Client & client);
 144
 145     private:
 146         virtual void v_disablePrompt();
 147         virtual void v_enablePrompt();
 148         virtual void v_translate(std::string & data);
 149
 150         void clientData(senf::ReadHelper<ClientHandle>::ptr helper);
 151         void showPrompt();
 152
 153         std::string tail_;
 154         unsigned promptLen_;
 155         bool promptActive_;
 156     };
 157
 158     /** \brief Internal: Primitive ClientReader implementation
 159
 160         This implementation uses the cooked telnet mode to read lines from the console. It does not
 161         support explicit line editing or any other advanced features.
 162      */
 163     class NoninteractiveClientReader
 164         : public ClientReader
 165     {
 166     public:
 167         NoninteractiveClientReader(Client & client);
 168
 169     private:
 170         virtual void v_disablePrompt();
 171         virtual void v_enablePrompt();
 172         virtual void v_translate(std::string & data);
 173
 174         void newData(int event);
 175
 176         scheduler::FdEvent readevent_;
 177         std::string buffer_;
 178     };
 179
 180 }}}
 181
 182 ///////////////////////////////ih.e////////////////////////////////////////
 183 #endif
 184
 185 \f
 186 // Local Variables:
 187 // mode: c++
 188 // fill-column: 100
 189 // comment-column: 40
 190 // c-file-style: "senf"
 191 // indent-tabs-mode: nil
 192 // ispell-local-dictionary: "american"
 193 // compile-command: "scons -u test"
 194 // End: