connectionHandler.hpp

Go to the documentation of this file.

/************************************************************************

 Copyright (C) 2011 - 2014 Project Wolframe.
 All rights reserved.

 This file is part of Project Wolframe.

 Commercial Usage
    Licensees holding valid Project Wolframe Commercial licenses may
    use this file in accordance with the Project Wolframe
    Commercial License Agreement provided with the Software or,
    alternatively, in accordance with the terms contained
    in a written agreement between the licensee and Project Wolframe.

 GNU General Public License Usage
    Alternatively, you can redistribute this file and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    Wolframe is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with Wolframe.  If not, see <http://www.gnu.org/licenses/>.

 If you have questions regarding the use of this file, please contact
 Project Wolframe.

************************************************************************/

#ifndef _CONNECTION_HANDLER_HPP_INCLUDED
#define _CONNECTION_HANDLER_HPP_INCLUDED

#include <string>
#include <cstddef>
#include <cstring>

#include "system/connectionEndpoint.hpp"

#include <boost/noncopyable.hpp>

namespace _Wolframe {
namespace net {

class NetworkOperation
{
        template< typename T > friend class ConnectionBase;

protected:
        enum Operation  {
                READ,
                WRITE,
                CLOSE,
                NOOP
        };

        explicit NetworkOperation( Operation op, void* d = NULL, std::size_t s = 0,
                                   unsigned to = 0 )
        { operation_ = op,  data_ = d; size_ = s; timeout_ = to; }

        unsigned timeout() const        { return timeout_; }
        const void* data() const        { return (const void*)data_; }
        void* buffer()                  { return data_; }
        std::size_t size() const        { return size_; }
        Operation operation() const     { return operation_; }

private:
        Operation       operation_;
        unsigned        timeout_;
        void*           data_;
        std::size_t     size_;
};

class ReadData : public NetworkOperation
{
public:
        explicit ReadData( void* d, std::size_t s, unsigned to = 0 )
                : NetworkOperation( READ, d, s, to )    {}
};

class SendData : public NetworkOperation
{
public:
        explicit SendData( const void* d, std::size_t s, unsigned to = 0 )
                : NetworkOperation( WRITE, const_cast<void*>( d ), s, to )      {}
};

class SendString : public NetworkOperation
{
public:
        explicit SendString( const std::string& s, unsigned to = 0 )
                : NetworkOperation( WRITE, const_cast<char*>( s.c_str() ), s.length(), to )     {}
        explicit SendString( const char *s, unsigned to = 0 )
                : NetworkOperation( WRITE, const_cast<char*>( s ), strlen( s ), to )    {}
};

class CloseConnection : public NetworkOperation
{
public:
        CloseConnection() : NetworkOperation( CLOSE )   {}
};

class NoOp : public NetworkOperation
{
public:
        NoOp() : NetworkOperation( NOOP )       {}
};

class ConnectionHandler
{
        template< typename socketType > friend class ConnectionBase;
protected:
        ConnectionHandler()             {}
        virtual ~ConnectionHandler()    {}

private:
        ConnectionHandler( const ConnectionHandler& );
        ConnectionHandler& operator = ( const ConnectionHandler& );

public:
        enum NetworkSignal      {
                TIMEOUT,
                TERMINATE,
                END_OF_FILE,
                OPERATION_CANCELLED,
                BROKEN_PIPE,
                CONNECTION_RESET,
                UNKNOWN_ERROR
        };


        virtual void networkInput( const void* buffer, std::size_t bytesTransferred ) = 0;

        virtual const NetworkOperation nextOperation() = 0;


        virtual void signalOccured( NetworkSignal )     {}

        virtual void setPeer( const RemoteEndpointR& remote ) = 0;
};

} // namespace net


struct  HandlerConfiguration;
namespace module { class ModulesDirectory; }

class ServerHandler : private boost::noncopyable
{
public:
        ServerHandler( const HandlerConfiguration* conf,
                       const module::ModulesDirectory* modules );
        ~ServerHandler();

        net::ConnectionHandler* newConnection( const net::LocalEndpointR& local );

private:
        class ServerHandlerImpl;
        ServerHandlerImpl *m_impl;
};

} // namespace _Wolframe

#endif // _CONNECTION_HANDLER_HPP_INCLUDED