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 detail::ServerHandle ServerHandle;
  81
  82         ~Server();
  83
  84         static Server & start(senf::INet4SocketAddress const & address);
  85                                         ///< Start server on given IPv4 address/port
  86         static Server & start(senf::INet6SocketAddress const & address);
  87                                         ///< Start server on given IPv6 address/port
  88         Server & name(std::string const & name); ///< Set server name
  89                                         /**< This information is used in the prompt string. */
  90
  91         void stop();                    ///< Stop the server
  92                                         /**< All clients will be closed */
  93
  94     protected:
  95
  96     private:
  97         Server(ServerHandle handle);
  98
  99         static Server & start(ServerHandle handle);
 100         static boost::scoped_ptr<Server> & instancePtr();
 101
 102         void newClient(Scheduler::EventId event);
 103         void removeClient(Client & client);
 104
 105         ServerHandle handle_;
 106
 107         typedef std::set< boost::intrusive_ptr<Client> > Clients;
 108         Clients clients_;
 109         std::string name_;
 110
 111         friend class Client;
 112     };
 113
 114     /** \brief Server client instance
 115
 116         Whenever a new client connects, a new instance of this class is created. This class shows a
 117         command prompt, receives the commands, parses them and then passes (using a CommandParser)
 118         and passes the commands to an Executor instance.
 119      */
 120     class Client
 121         : public senf::intrusive_refcount,
 122           private boost::base_from_member< detail::NonblockingSocketOStream >,
 123           public senf::log::IOStreamTarget
 124     {
 125         typedef boost::base_from_member< detail::NonblockingSocketOStream > out_t;
 126
 127         SENF_LOG_CLASS_AREA();
 128         SENF_LOG_DEFAULT_LEVEL( senf::log::NOTICE );
 129
 130     public:
 131         typedef Server::ServerHandle::ClientSocketHandle ClientHandle;
 132
 133         ~Client();
 134
 135         void stop();                    ///< Stop the client
 136                                         /**< This will close the client socket. */
 137
 138         std::string const & name() const;
 139         ClientHandle handle() const;
 140         std::ostream & stream();
 141         std::string promptString() const;
 142
 143         static Client & get(std::ostream & os);
 144
 145     protected:
 146
 147     private:
 148         Client(Server & server, ClientHandle handle, std::string const & name);
 149
 150         void translate(std::string & data);
 151         void handleInput(std::string input);
 152         virtual void v_write(boost::posix_time::ptime timestamp, std::string const & stream,
 153                              std::string const & area, unsigned level,
 154                              std::string const & message);
 155
 156         Server & server_;
 157         ClientHandle handle_;
 158         CommandParser parser_;
 159         Executor executor_;
 160         std::string name_;
 161         std::string lastCommand_;
 162         boost::scoped_ptr<detail::ClientReader> reader_;
 163
 164         friend class Server;
 165         friend class detail::ClientReader;
 166         friend class detail::NonblockingSocketSink;
 167     };
 168
 169 }}
 170
 171 ///////////////////////////////hh.e////////////////////////////////////////
 172 #include "Server.cci"
 173 //#include "Server.ct"
 174 //#include "Server.cti"
 175 #endif
 176
 177 \f
 178 // Local Variables:
 179 // mode: c++
 180 // fill-column: 100
 181 // comment-column: 40
 182 // c-file-style: "senf"
 183 // indent-tabs-mode: nil
 184 // ispell-local-dictionary: "american"
 185 // compile-command: "scons -u test"
 186 // End: