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
63 SENF_LOG_CLASS_AREA();
64 SENF_LOG_DEFAULT_LEVEL( senf::log::NOTICE );
66 ///////////////////////////////////////////////////////////////////////////
69 typedef senf::ServerSocketHandle<
70 senf::MakeSocketPolicy< senf::TCPv4SocketProtocol::Policy,
71 senf::UnspecifiedAddressingPolicy>::policy > ServerHandle;
75 static Server & start(senf::INet4SocketAddress const & address);
76 ///< Start server on given IPv4 address/port
77 static Server & start(senf::INet6SocketAddress const & address);
78 ///< Start server on given IPv6 address/port
80 void name(std::string const & name); ///< Set server name
81 /**< This information is used in the prompt string. */
86 Server(ServerHandle handle);
88 static void start(ServerHandle handle);
90 void newClient(Scheduler::EventId event);
91 void removeClient(Client & client);
95 typedef std::set< boost::intrusive_ptr<Client> > Clients;
99 static boost::scoped_ptr<Server> instance_;
104 /** \brief Server client instance
106 Whenever a new client connects, a new instance of this class is created. This class shows a
107 command prompt, receives the commands, parses them and then passes (using a CommandParser)
108 and passes the commands to an Executor instance.
110 \fixme Fix Client::clientData implementation
111 \fixme Don't register a new ReadHelper every round
112 \fixme Ensure, that output errors (or any errors) in the console don't terminate the
116 : public senf::intrusive_refcount,
117 private boost::base_from_member< detail::NonblockingSocketOStream >,
118 public senf::log::IOStreamTarget
120 typedef boost::base_from_member< detail::NonblockingSocketOStream > out_t;
122 SENF_LOG_CLASS_AREA();
123 SENF_LOG_DEFAULT_LEVEL( senf::log::NOTICE );
125 typedef Server::ServerHandle::ClientSocketHandle ClientHandle;
129 void stopClient(); ///< Stop the client
130 /**< This will close the client socket. */
135 Client(ClientHandle handle, std::string const & name);
137 void clientData(ReadHelper<ClientHandle>::ptr helper);
140 virtual void v_write(boost::posix_time::ptime timestamp, std::string const & stream,
141 std::string const & area, unsigned level,
142 std::string const & message);
144 ClientHandle handle_;
146 CommandParser parser_;
150 std::string lastCommand_;
157 ///////////////////////////////hh.e////////////////////////////////////////
158 #include "Server.cci"
159 //#include "Server.ct"
160 //#include "Server.cti"
167 // comment-column: 40
168 // c-file-style: "senf"
169 // indent-tabs-mode: nil
170 // ispell-local-dictionary: "american"
171 // compile-command: "scons -u test"