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 internal header */
26 #ifndef IH_SENF_Scheduler_Console_Server_
27 #define IH_SENF_Scheduler_Console_Server_ 1
30 #include <boost/iostreams/concepts.hpp>
31 #include <boost/iostreams/stream.hpp>
34 ///////////////////////////////ih.p////////////////////////////////////////
47 typedef boost::intrusive_ptr<Server> ptr;
52 static void add(ptr server);
53 static void remove(ptr server);
55 static ServerManager & instance();
57 typedef std::set<ptr> Servers;
60 friend class senf::console::Server;
63 /** \brief Internal: Nonblocking boost::iostreams::sink
65 The sink discards data if the output socket would.
67 \fixme Don't throw exceptions ... set stream error indicator (if at all)
69 class NonblockingSocketSink
70 : public boost::iostreams::sink
73 NonblockingSocketSink(Client & client);
74 std::streamsize write(const char * s, std::streamsize n);
76 Client & client() const;
82 typedef boost::iostreams::stream<NonblockingSocketSink> NonblockingSocketOStream;
84 typedef senf::ServerSocketHandle<
85 senf::MakeSocketPolicy< senf::TCPv4SocketProtocol::Policy,
86 senf::BSDAddressingPolicy>::policy > ServerHandle;
88 /** \brief Internal: Generic client interface
90 The ClientReader encapsulates the interaction of a single network client with the user: It
91 manages prompt display and reading an interactive command.
96 typedef ServerHandle::ClientHandle ClientHandle;
98 virtual ~ClientReader() = 0;
100 // Called by subclasses to get information from the Client
102 Client & client() const;
103 std::string promptString() const;
104 ClientHandle handle() const;
105 std::ostream & stream() const;
107 // Called by subclasses to perform actions in the Client
110 std::string::size_type handleInput(std::string const & input, bool incremental=false) const;
112 // Called by the Client
114 void disablePrompt();
116 void write(std::string const & data);
119 ClientReader(Client & client);
122 virtual void v_disablePrompt() = 0;
123 virtual void v_enablePrompt() = 0;
124 virtual void v_write(std::string const & data) = 0;
129 /** \brief Internal: Primitive ClientReader implementation
131 This implementation uses the cooked telnet mode to read lines from the console. It does not
132 support explicit line editing or any other advanced features.
134 class DumbClientReader
135 : public ClientReader
138 DumbClientReader(Client & client);
141 virtual void v_disablePrompt();
142 virtual void v_enablePrompt();
143 virtual void v_write(std::string const & data);
145 void clientData(senf::ReadHelper<ClientHandle>::ptr helper);
153 /** \brief Internal: Primitive ClientReader implementation
155 This implementation uses the cooked telnet mode to read lines from the console. It does not
156 support explicit line editing or any other advanced features.
158 class NoninteractiveClientReader
159 : public ClientReader
162 NoninteractiveClientReader(Client & client);
165 virtual void v_disablePrompt();
166 virtual void v_enablePrompt();
167 virtual void v_write(std::string const & data);
169 void newData(int event);
171 scheduler::FdEvent readevent_;
177 ///////////////////////////////ih.e////////////////////////////////////////
184 // comment-column: 40
185 // c-file-style: "senf"
186 // indent-tabs-mode: nil
187 // ispell-local-dictionary: "american"
188 // compile-command: "scons -u test"