IODevice.h

/*
 * Copyright (C) 2006-2013 Marc Boris Duerner
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * As a special exception, you may use this file as part of a free
 * software library without restriction. Specifically, if other files
 * instantiate templates or use macros or inline functions from this
 * file, or you compile this file and link it with other files to
 * produce an executable, this file does not by itself cause the
 * resulting executable to be covered by the GNU General Public
 * License. This exception does not however invalidate any other
 * reasons why the executable file might be covered by the GNU Library
 * General Public License.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
 
#ifndef Pt_System_IODevice_h
#define Pt_System_IODevice_h
 
#include <Pt/System/Api.h>
#include <Pt/System/IOError.h>
#include <Pt/System/Selectable.h>
#include <Pt/Types.h>
#include <Pt/Signal.h>
#include <ios>
 
namespace Pt {
 
namespace System {

class PT_SYSTEM_API IODevice : public Selectable
{
    public:
        typedef std::char_traits<char>::pos_type pos_type;
        typedef std::char_traits<char>::off_type off_type;
        typedef std::ios_base::seekdir seekdir;
 
    public:
        virtual ~IODevice();

        void close();

        void setTimeout(std::size_t timeout);

        void beginRead(char* buffer, std::size_t n);

        std::size_t endRead();

        std::size_t read(char* buffer, std::size_t n);

        void beginWrite(const char* buffer, std::size_t n);

        std::size_t endWrite();

        std::size_t write(const char* buffer, std::size_t n);

        bool seekable() const;

        pos_type seek(off_type offset, seekdir sd);

        std::size_t peek(char* buffer, std::size_t n);

        void sync();

        pos_type position();

        bool isEof() const;

        Signal<IODevice&>& inputReady()
        { return _inputReady; }

        Signal<IODevice&>& outputReady()
        { return _outputReady; }

        bool isReading() const
        { return _rbuf != 0; }

        bool isWriting() const
        { return _wbuf != 0; }
 
        char* rbuf() const
        { return _rbuf; }
 
        std::size_t rbuflen() const
        { return _rbuflen; }
 
        std::size_t ravail() const
        { return _ravail; }
 
        const char* wbuf() const
        { return _wbuf; }
 
        std::size_t wbuflen() const
        { return _wbuflen; }
 
        std::size_t wavail() const
        { return _wavail; }

        EventLoop* loop() const
         { return parent(); }
 
    protected:
        IODevice();
 
        virtual void onClose() = 0;
 
        virtual void onSetTimeout(std::size_t timeout) = 0;
 
        virtual std::size_t onBeginRead(EventLoop& loop, char* buffer, std::size_t n, bool& eof) = 0;
 
        virtual std::size_t onEndRead(EventLoop& loop, char* buffer, std::size_t n, bool& eof) = 0;
 
        virtual std::size_t onRead(char* buffer, std::size_t count, bool& eof) = 0;
 
        virtual std::size_t onBeginWrite(EventLoop& loop, const char* buffer, std::size_t n) = 0;
 
        virtual std::size_t onEndWrite(EventLoop& loop, const char* buffer, std::size_t n) = 0;
 
        virtual std::size_t onWrite(const char* buffer, std::size_t count) = 0;
 
        virtual std::size_t onPeek(char*, std::size_t)
        { return 0; }
 
        virtual bool onSeekable() const
        { return false; }
 
        virtual pos_type onSeek(off_type, std::ios::seekdir)
        { throw IOError("Could not seek on device"); }
 
        virtual void onSync() const
        { }
 
        void setEof(bool eof);
 
        virtual void onCancel();
 
    protected:
        char* _rbuf;
        std::size_t _rbuflen;
        std::size_t _ravail;
        const char* _wbuf;
        std::size_t _wbuflen;
        std::size_t _wavail;
        Signal<IODevice&> _inputReady;
        Signal<IODevice&> _outputReady;
        Pt::varint_t _reserved;
 
    private:
        bool _eof;
};
 
} // namespace System
 
} // namespace Pt
 
#endif // Pt_System_IODevice_h