4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
6 // Stefan Bund <g0dil@berlios.de>
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.
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.
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.
24 \brief Server public header */
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"
40 #include "Executor.hh"
41 #include "../Socket/Protocols/INet/INetAddressing.hh"
42 #include "../Utils/Logger.hh"
44 //#include "Server.mpp"
46 ///////////////////////////////hh.p////////////////////////////////////////
53 /** \brief Interactive console server
55 This class provides an interactive console TCP server.
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.
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.
74 SENF_LOG_CLASS_AREA();
75 SENF_LOG_DEFAULT_LEVEL( senf::log::NOTICE );
77 ///////////////////////////////////////////////////////////////////////////
80 typedef detail::ServerHandle ServerHandle;
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 void name(std::string const & name); ///< Set server name
89 /**< This information is used in the prompt string. */
94 Server(ServerHandle handle);
96 static Server & start(ServerHandle handle);
97 static boost::scoped_ptr<Server> & instancePtr();
99 void newClient(Scheduler::EventId event);
100 void removeClient(Client & client);
102 ServerHandle handle_;
104 typedef std::set< boost::intrusive_ptr<Client> > Clients;
111 /** \brief Server client instance
113 Whenever a new client connects, a new instance of this class is created. This class shows a
114 command prompt, receives the commands, parses them and then passes (using a CommandParser)
115 and passes the commands to an Executor instance.
117 \fixme Fix Client::clientData implementation
118 \fixme Don't register a new ReadHelper every round
121 : public senf::intrusive_refcount,
122 private boost::base_from_member< detail::NonblockingSocketOStream >,
123 public senf::log::IOStreamTarget
125 typedef boost::base_from_member< detail::NonblockingSocketOStream > out_t;
127 SENF_LOG_CLASS_AREA();
128 SENF_LOG_DEFAULT_LEVEL( senf::log::NOTICE );
131 typedef Server::ServerHandle::ClientSocketHandle ClientHandle;
135 void stop(); ///< Stop the client
136 /**< This will close the client socket. */
141 Client(Server & server, ClientHandle handle, std::string const & name);
143 std::string promptString() const;
144 ClientHandle handle() const;
145 detail::NonblockingSocketOStream & stream();
147 void handleInput(std::string input);
149 virtual void v_write(boost::posix_time::ptime timestamp, std::string const & stream,
150 std::string const & area, unsigned level,
151 std::string const & message);
154 ClientHandle handle_;
155 CommandParser parser_;
158 std::string lastCommand_;
159 boost::scoped_ptr<detail::ClientReader> reader_;
162 friend class detail::ClientReader;
167 ///////////////////////////////hh.e////////////////////////////////////////
168 #include "Server.cci"
169 //#include "Server.ct"
170 //#include "Server.cti"
177 // comment-column: 40
178 // c-file-style: "senf"
179 // indent-tabs-mode: nil
180 // ispell-local-dictionary: "american"
181 // compile-command: "scons -u test"