ioFilterCommandHandler.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_IOFILTER_COMMAND_HANDLER_BASE_HPP_INCLUDED
#define _Wolframe_IOFILTER_COMMAND_HANDLER_BASE_HPP_INCLUDED
#include "filter/filter.hpp"
#include "langbind/input.hpp"
#include "langbind/output.hpp"
#include "cmdbind/commandHandler.hpp"
#include "system/connectionHandler.hpp"

namespace _Wolframe {
namespace cmdbind {

class IOFilterCommandHandler
        :public CommandHandler
{
public:
        explicit IOFilterCommandHandler()
                :m_writeptr(0)
                ,m_writesize(0)
                ,m_done(false){}
        IOFilterCommandHandler( const std::string& docformat_)
                :m_input(docformat_)
                ,m_writeptr(0)
                ,m_writesize(0)
                ,m_done(false){}

        virtual ~IOFilterCommandHandler(){}

        void setInputFilter( const langbind::InputFilterR& in);

        void setOutputFilter( const langbind::OutputFilterR& out);

        langbind::InputFilterR inputfilter()
        {
                return m_input.inputfilter();
        }

        const langbind::Output& output()
        {
                return m_output;
        }

        const langbind::Input& input()
        {
                return m_input;
        }

        langbind::OutputFilterR outputfilter()
        {
                return m_output.outputfilter();
        }

        virtual Operation nextOperation();

        virtual void putInput( const void* begin, std::size_t bytesTransferred, bool eod);

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

        enum CallResult
        {
                Ok,             //< successful termination of call
                Error,          //< termination of call with error (not completed)
                Yield           //< call interrupted with request for a network operation
        };

        static const char* callResultName( CallResult cr)
        {
                static const char* ar[] = {"Ok","Error","Yield"};
                return ar[ (int)cr];
        }

        virtual CallResult call( const char*& err)=0;

        virtual void setOutputChunkSize( std::size_t outputChunkSize_)
        {
                CommandHandler::setOutputChunkSize( outputChunkSize_);
                m_output.setOutputChunkSize( outputChunkSize_);
        }

private:
        langbind::Input m_input;                        
        langbind::Output m_output;                      
        const void* m_writeptr;                         
        std::size_t m_writesize;                        
        bool m_done;                                    
};
}}
#endif