protocolHandler.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 _Wolframe_CMDBIND_PROTOCOL_HANDLER_HPP_INCLUDED
#define _Wolframe_CMDBIND_PROTOCOL_HANDLER_HPP_INCLUDED
#include "cmdbind/commandHandler.hpp"
#include "system/connectionEndpoint.hpp"
#include <string>
#include <vector>
#include <boost/shared_ptr.hpp>

namespace _Wolframe {
namespace proc {
class ExecContext;
}//namespace proc
namespace cmdbind {

class ProtocolHandler
{
public:
        enum Operation  {
                READ=cmdbind::CommandHandler::READ,     
                WRITE=cmdbind::CommandHandler::WRITE,   
                CLOSE=cmdbind::CommandHandler::CLOSE    
        };
        ProtocolHandler()
                :m_execContext(0){}

        virtual ~ProtocolHandler(){}

        virtual void setPeer( const net::RemoteEndpointR&){}

        virtual void setLocalEndPoint( const net::LocalEndpointR&){}

        virtual void setInputBuffer( void* buf, std::size_t allocsize)=0;

        virtual void setOutputBuffer( void* buf, std::size_t size, std::size_t pos)=0;

        virtual Operation nextOperation()=0;

        virtual void putInput( const void* begin, std::size_t bytesTransferred)=0;

        virtual void putEOF(){}

        virtual void getInputBlock( void*& begin, std::size_t& maxBlockSize)=0;

        virtual void getOutput( const void*& begin, std::size_t& bytesToTransfer)=0;

        virtual void getDataLeft( const void*& begin, std::size_t& nofBytes)=0;

        const char* lastError() const
        {
                return m_lastError.empty()?0:m_lastError.c_str();
        }

        void setLastError( const std::string& msg)
        {
                m_lastError = msg;
        }

        void setExecContext( proc::ExecContext* c)
        {
                m_execContext = c;
        }

        proc::ExecContext* execContext()
        {
                return m_execContext;
        }

        virtual void setArgumentString( const std::string&){};

        virtual const char* interruptDataSessionMarker() const  {return "";}

private:
        std::string m_lastError;                                //< error operation for the client
        proc::ExecContext* m_execContext;                       //< the reference to the execution context of the connection
};

typedef boost::shared_ptr<ProtocolHandler> ProtocolHandlerR;


class ProtocolHandlerUnit
{
public:
        virtual const char* protocol() const=0;

        virtual ProtocolHandler* createProtocolHandler()=0;
};

typedef boost::shared_ptr<ProtocolHandlerUnit> ProtocolHandlerUnitR;

}}
#endif