Server.ih

Go to the documentation of this file.

//
// Copyright (c) 2020 Fraunhofer Institute for Applied Information Technology (FIT)
//                    Network Research Group (NET)
//                    Schloss Birlinghoven, 53754 Sankt Augustin, GERMANY
//                    Contact: support@wiback.org
//
// This file is part of the SENF code tree.
// It is licensed under the 3-clause BSD License (aka New BSD License).
// See LICENSE.txt in the top level directory for details or visit
// https://opensource.org/licenses/BSD-3-Clause
//


/** \file
    \brief Server internal header */

#ifndef IH_SENF_Scheduler_Console_Server_
#define IH_SENF_Scheduler_Console_Server_ 1

// Custom includes
#include <boost/iostreams/concepts.hpp>
#include <boost/iostreams/stream.hpp>
#include <senf/Scheduler/ReadHelper.hh>
#include <senf/Socket/Protocols/INet/TCPSocketHandle.hh>
#include <senf/Utils/Logger/SenfLog.hh>

//-/////////////////////////////////////////////////////////////////////////////////////////////////

namespace senf {
namespace console {

    class Server;
    class Client;

namespace detail {

    class ServerManager
    {
    public:
        typedef boost::intrusive_ptr<Server> ptr;

    protected:

    private:
        static void add(ptr server);
        static void remove(ptr server);

        static ServerManager & instance();

        typedef std::set<ptr> Servers;
        Servers servers_;

        friend class senf::console::Server;
    };

    /** \brief Internal: Nonblocking boost::iostreams::sink

        The sink discards data if the output socket would.

        \fixme Don't throw exceptions ... set stream error indicator (if at all)
     */
    class SocketStreamSink
        : public boost::iostreams::sink
    {
    public:
        SocketStreamSink(Client & client);
        std::streamsize write(const char * s, std::streamsize n);

        Client & client() const;

    private:
        Client & client_;
    };

    typedef boost::iostreams::stream<SocketStreamSink> SocketStreamOStream;

    typedef senf::ServerSocketHandle<
        senf::MakeSocketPolicy< senf::TCPv4SocketProtocol::Policy,
                                senf::BSDAddressingPolicy>::policy > ServerHandle;

    /** \brief Internal: Generic client interface

        The ClientReader encapsulates the interaction of a single network client with the user: It
        manages prompt display and reading an interactive command.
     */
    class ClientReader
    {
    public:
        SENF_LOG_CLASS_AREA();

        typedef ServerHandle::ClientHandle ClientHandle;

        virtual ~ClientReader() = 0;

        // Called by subclasses to get information from the Client

        Client & client() const;
        std::string promptString() const;
        ClientHandle handle() const;
        std::ostream & stream() const;

        // Called by subclasses to perform actions in the Client

        void stopClient();
        std::string::size_type handleInput(std::string const & input, bool incremental=false) const;

        // Called by the Client

        void disablePrompt();
        void enablePrompt();
        void write(std::string const & data);
        unsigned width() const;

    protected:
        ClientReader(Client & client);

    private:
        virtual void v_disablePrompt() = 0;
        virtual void v_enablePrompt() = 0;
        virtual void v_write(std::string const & data) = 0;
        virtual unsigned v_width() const = 0;

        Client & client_;
    };

    /** \brief Internal: Primitive ClientReader implementation

        This implementation uses the cooked telnet mode to read lines from the console. It does not
        support explicit line editing or any other advanced features.
     */
    class DumbClientReader
        : public ClientReader
    {
    public:
        DumbClientReader(Client & client);

    private:
        virtual void v_disablePrompt();
        virtual void v_enablePrompt();
        virtual void v_write(std::string const & data);
        virtual unsigned v_width() const;

        void clientData(senf::ReadHelper<ClientHandle>::ptr helper);
        void showPrompt();

        std::string tail_;
        unsigned promptLen_;
        bool promptActive_;
    };

    /** \brief Internal: Primitive ClientReader implementation

        This implementation uses the cooked telnet mode to read lines from the console. It does not
        support explicit line editing or any other advanced features.
     */
    class NoninteractiveClientReader
        : public ClientReader
    {
    public:
        NoninteractiveClientReader(Client & client);

        typedef std::vector<char> SendQueue;

        void streamBufferMaxSize(SendQueue::size_type size);
        SendQueue::size_type streamBufferMaxSize() const;

    private:
        virtual void v_disablePrompt();
        virtual void v_enablePrompt();
        virtual void v_write(std::string const & data);
        virtual unsigned v_width() const;

        void newData(int event);
        void writeHandler( int event);

        SendQueue::size_type streamBufferMaxSize_;
        SendQueue sendQueue_;
        scheduler::FdEvent readevent_;
        scheduler::FdEvent writeevent_;
        std::string buffer_;
    };

}}}

//-/////////////////////////////////////////////////////////////////////////////////////////////////
#endif


// Local Variables:
// mode: c++
// fill-column: 100
// comment-column: 40
// c-file-style: "senf"
// indent-tabs-mode: nil
// ispell-local-dictionary: "american"
// compile-command: "scons -u test"
// End: