BlockingStream.h

// Copyright (c) 2013 by István Váradi
 
// This file is part of VSCPL, a simple cross-platform utility library
 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
 
// 1. Redistributions of source code must retain the above copyright notice, this
//    list of conditions and the following disclaimer.
// 2. 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.
 
// 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.
 
// The views and conclusions contained in the software and documentation are those
// of the authors and should not be interpreted as representing official policies,
// either expressed or implied, of the FreeBSD Project.
 
#ifndef HU_VARADIISTVAN_SCPL_IO_BLOCKINGSTREAM_H
#define HU_VARADIISTVAN_SCPL_IO_BLOCKINGSTREAM_H
//------------------------------------------------------------------------------
 
#include "Failable.h"
 
#include "BufferedStream.h"
#include "WaitableEvent.h"
 
#include <cstdlib>
 
//------------------------------------------------------------------------------
 
namespace hu { namespace varadiistvan { namespace scpl { namespace io {
 
//------------------------------------------------------------------------------
 
class BlockingStream : public Failable
{
private:
    BufferedStream& stream;
 
    WaitableEvent event;
 
    bool interrupted;
 
    size_t readingOffset;
 
    bool eof;
 
public:
    BlockingStream(BufferedStream& stream);
 
    operator bool() const;
 
    void interrupt();
 
    bool isInterrupted();
 
    bool read(void* dest, size_t length);
 
    bool skip(size_t length);
 
    bool write(const void* src, size_t length);
 
    bool flush();
 
private:
    bool fill();
 
    bool checkInterrupted();
};
 
//------------------------------------------------------------------------------
// Inline definitions
//------------------------------------------------------------------------------
 
inline BlockingStream::BlockingStream(BufferedStream& stream) :
    stream(stream),
    event(stream.getWaiter()),
    interrupted(false),
    readingOffset(0),
    eof(false)
{
}
 
//------------------------------------------------------------------------------
 
inline BlockingStream::operator bool() const
{
    return !failed() && !interrupted && !eof;
}
 
//------------------------------------------------------------------------------
 
inline void BlockingStream::interrupt()
{
    event.fire();
}
 
//------------------------------------------------------------------------------
 
inline bool BlockingStream::isInterrupted()
{
    return interrupted;
}
 
//------------------------------------------------------------------------------
 
} /* namespace hu::varadiistvan::scpl::io */ } /* namespace hu::varadiistvan::scpl */ } /* namespace hu::varadiistvan */ } /* namespace hu */
 
//------------------------------------------------------------------------------
#endif // HU_VARADIISTVAN_SCPL_IO_BLOCKINGSTREAM_H
 
// Local Variables:
// mode: C++
// c-basic-offset: 4
// indent-tabs-mode: nil
// End: