telnet.h

Go to the documentation of this file.

/*
    Copyright (c) 2006-2018, Alexis Royer, http://alexis.royer.free.fr/CLI

    All rights reserved.

    Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

        * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
        * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation
          and/or other materials provided with the distribution.
        * Neither the name of the CLI library project nor the names of its contributors may be used to endorse or promote products derived from this software
          without specific prior written permission.

    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/



#ifndef _CLI_TELNET_H_
#define _CLI_TELNET_H_

#include "cli/namespace.h"
#include "cli/object.h"
#include "cli/non_blocking_io_device.h"
#include "cli/tk.h"


CLI_NS_BEGIN(cli)

    // Forward declarations.
    class ExecutionContext;
    class ExecutionResult;
    class TelnetConnection;


    class TelnetServer : public Object
    {
    public:
        explicit TelnetServer(
            const unsigned int UI_MaxConnections,   
            const unsigned long UL_TcpPort,         
            const ResourceString::LANG E_Lang       
            );

        virtual ~TelnetServer(void);

    private:
        explicit TelnetServer(void);
        TelnetServer(const TelnetServer&);
        TelnetServer& operator=(const TelnetServer&);

    public:
        void StartServer(void);

        void StopServer(void);

    protected:
        virtual ExecutionContext* const OnNewConnection(
            const TelnetConnection& CLI_NewConnection       
            ) = 0;

        virtual void OnCloseConnection(
            const TelnetConnection& CLI_ConnectionClosed,   
            ExecutionContext* const PCLI_Context            
            ) = 0;

    private:
        const bool RunLoop(
            const int I_Milli       
            );

        const bool AcceptConnection(void);

        const bool CloseConnection(
            const int I_ConnectionSocket    
            );

        const bool TerminateServer(void);

    private:
        int m_iServerSocket;
        const unsigned long m_ulTcpPort;
        const ResourceString::LANG m_eLang;
        typedef struct {
            int i_Socket;                       
            TelnetConnection* pcli_Connection;  
            ExecutionContext* pcli_Context;     
        } ConnectionInfo;
        tk::Map<int, ConnectionInfo> m_tkConnections;
        const unsigned int m_uiMaxConnections;

        friend class TelnetConnection; // Let TelnetConnection call RunLoop().
    };


    class TelnetConnection : public NonBlockingIODevice
    {
    public:
        explicit TelnetConnection(
            TelnetServer* const PCLI_Server,    
            const int I_Socket,                 
            const ResourceString::LANG E_Lang,  
            const bool B_AutoDelete             
            );

        virtual ~TelnetConnection(void);

    private:
        explicit TelnetConnection(void);
        TelnetConnection(const TelnetConnection&);
        TelnetConnection& operator=(const TelnetConnection&);

    protected:
        // Inherit doxygen comments from cli::OutputDevice interface documentation.
        virtual const bool OpenDevice(void);
        // Inherit doxygen comments from cli::OutputDevice interface documentation.
        virtual const bool CloseDevice(void);
    protected:
        const bool ReceiveChars(void) const;
        const bool ProcessKeys(void) const;
        const bool CheckUp(void) const;
    public:
        // Inherit doxygen comments from cli::IODevice interface documentation.
        virtual const KEY GetKey(void) const;
        // Inherit doxygen comments from cli::NonBlockingIODevice interface documentation.
        virtual void OnKey(const KEY E_Key) const;
        // Inherit doxygen comments from cli::OutputDevice interface documentation.
        virtual void PutString(const char* const STR_Out) const;
        // Inherit doxygen comments from cli::OutputDevice interface documentation.
        virtual void Beep(void) const;
        // Inherit doxygen comments from cli::OutputDevice interface documentation.
        virtual void CleanScreen(void) const;

    private:
        TelnetServer* const m_pcliServer;
        const int m_iSocket;
        const ResourceString::LANG m_eLang;
        mutable tk::Queue<int> m_qChars;
        mutable bool m_bWaitingForKeys;

        friend class TelnetServer; // Let TelnetServer call ReceiveChars().
    };

CLI_NS_END(cli)

#endif // _CLI_TELNET_H_