Console/Server.hh

   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 public header */
  25
  26 #ifndef HH_Server_
  27 #define HH_Server_ 1
  28
  29 // Custom includes
  30 #include <set>
  31 #include <boost/utility.hpp>
  32 #include <boost/scoped_ptr.hpp>
  33 #include <boost/shared_ptr.hpp>
  34 #include "../Utils/intrusive_refcount.hh"
  35 #include "../Socket/Protocols/INet/TCPSocketHandle.hh"
  36 #include "../Socket/ServerSocketHandle.hh"
  37 #include "../Scheduler/Scheduler.hh"
  38 #include "../Scheduler/ReadHelper.hh"
  39 #include "Parse.hh"
  40 #include "Executor.hh"
  41 #include "../Socket/Protocols/INet/INetAddressing.hh"
  42 #include "../Utils/Logger.hh"
  43
  44 //#include "Server.mpp"
  45 #include "Server.ih"
  46 ///////////////////////////////hh.p////////////////////////////////////////
  47
  48 namespace senf {
  49 namespace console {
  50
  51     class Client;
  52
  53     /** \brief Interactive console server
  54
  55         This class provides an interactive console TCP server.
  56
  57         \todo Add readline support
  58         \todo Add interactivity detection using timeout
  59         \idea To support blocking commands, we could give the Client 'suspend()' and 'resume()'
  60             members. suspend() would probably throw some kind of exception to transfer control back
  61             to the Client instance. on resume(), the command would be called again, maybe setting
  62             some flag or something. Example for use: Host name resolution: Here we can just built
  63             our own little host-name cache. When the name is not found, we ask the resolver to
  64             resolve it and call 'resume' when the name is found. Since it is in the cache now, the
  65             command will now complete.
  66
  67         \implementation We do \e not provide an \c instance() member so we can easily later extend
  68             the server to allow registering more than one instance, e.g. with each instance on a
  69             differently firewalled port and with different security restrictions.
  70       */
  71     class Server
  72         : boost::noncopyable
  73     {
  74         SENF_LOG_CLASS_AREA();
  75         SENF_LOG_DEFAULT_LEVEL( senf::log::NOTICE );
  76     public:
  77         ///////////////////////////////////////////////////////////////////////////
  78         // Types
  79
  80         typedef senf::ServerSocketHandle<
  81             senf::MakeSocketPolicy< senf::TCPv4SocketProtocol::Policy,
  82                                     senf::UnspecifiedAddressingPolicy>::policy > ServerHandle;
  83
  84         ~Server();
  85
  86         static Server & start(senf::INet4SocketAddress const & address);
  87                                         ///< Start server on given IPv4 address/port
  88         static Server & start(senf::INet6SocketAddress const & address);
  89                                         ///< Start server on given IPv6 address/port
  90         void name(std::string const & name); ///< Set server name
  91                                         /**< This information is used in the prompt string. */
  92
  93     protected:
  94
  95     private:
  96         Server(ServerHandle handle);
  97
  98         static Server & start(ServerHandle handle);
  99         static boost::scoped_ptr<Server> & instancePtr();
 100
 101         void newClient(Scheduler::EventId event);
 102         void removeClient(Client & client);
 103
 104         ServerHandle handle_;
 105
 106         typedef std::set< boost::intrusive_ptr<Client> > Clients;
 107         Clients clients_;
 108         std::string name_;
 109
 110         friend class Client;
 111     };
 112
 113     /** \brief Server client instance
 114
 115         Whenever a new client connects, a new instance of this class is created. This class shows a
 116         command prompt, receives the commands, parses them and then passes (using a CommandParser)
 117         and passes the commands to an Executor instance.
 118
 119         \fixme Fix Client::clientData implementation
 120         \fixme Don't register a new ReadHelper every round
 121      */
 122     class Client
 123         : public senf::intrusive_refcount,
 124           private boost::base_from_member< detail::NonblockingSocketOStream >,
 125           public senf::log::IOStreamTarget
 126     {
 127         typedef boost::base_from_member< detail::NonblockingSocketOStream > out_t;
 128
 129         SENF_LOG_CLASS_AREA();
 130         SENF_LOG_DEFAULT_LEVEL( senf::log::NOTICE );
 131     public:
 132         typedef Server::ServerHandle::ClientSocketHandle ClientHandle;
 133
 134         ~Client();
 135
 136         void stopClient();              ///< Stop the client
 137                                         /**< This will close the client socket. */
 138
 139     protected:
 140
 141     private:
 142         Client(Server & server, ClientHandle handle, std::string const & name);
 143
 144         void clientData(ReadHelper<ClientHandle>::ptr helper);
 145         void showPrompt();
 146
 147         virtual void v_write(boost::posix_time::ptime timestamp, std::string const & stream,
 148                              std::string const & area, unsigned level,
 149                              std::string const & message);
 150
 151         Server & server_;
 152         ClientHandle handle_;
 153         std::string tail_;
 154         CommandParser parser_;
 155         Executor executor_;
 156         std::string name_;
 157         unsigned promptLen_;
 158         std::string lastCommand_;
 159
 160         friend class Server;
 161     };
 162
 163 }}
 164
 165 ///////////////////////////////hh.e////////////////////////////////////////
 166 #include "Server.cci"
 167 //#include "Server.ct"
 168 //#include "Server.cti"
 169 #endif
 170
 171 \f
 172 // Local Variables:
 173 // mode: c++
 174 // fill-column: 100
 175 // comment-column: 40
 176 // c-file-style: "senf"
 177 // indent-tabs-mode: nil
 178 // ispell-local-dictionary: "american"
 179 // compile-command: "scons -u test"
 180 // End: