source: xplcommon/src/xplcommon/win32/StreamBuffer.h@ 23:e6c4c31ce833

// Copyright (c) 2012 by István Váradi

// This file is part of libxplcommon, a common utility library for
// development related to X-Plane

// 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 XPLCOMMON_WIN32_STREAMBUFFER_H
#define XPLCOMMON_WIN32_STREAMBUFFER_H
//------------------------------------------------------------------------------

#include "../Buffer.h"
#include "Completer.h"
#include "../Failable.h"

#include "BufferedStream.h"

//------------------------------------------------------------------------------

namespace xplcommon { namespace win32 {

//------------------------------------------------------------------------------

/**
 * Base class for stream reading and writing buffers.
 */
class StreamBuffer : public ::xplcommon::Buffer, public Completer,
                     public ::xplcommon::FailableReference<StreamBuffer>
{
protected:
    /**
     * Construct the stream buffer with the given capacity and for the
     * given stream.
     */
    StreamBuffer(size_t capacity, BufferedStream* stream);

    /**
     * Get the stream.
     *
     * This just casts the overlappable of the Completer part knowing
     * that it must be a BufferedStream
     */
    BufferedStream& getStream() const;

private:
    /**
     * Get the failable object.
     */
    const ::xplcommon::Failable& getFailable() const;

    /**
     * Get the failable object.
     */
    ::xplcommon::Failable& getFailable();

    friend class FailableReference<StreamBuffer>;
};

//------------------------------------------------------------------------------
// Inline definitions
//------------------------------------------------------------------------------

inline StreamBuffer::StreamBuffer(size_t capacity, BufferedStream* stream) :
    Buffer(capacity),
    Completer(stream)
{
}

//------------------------------------------------------------------------------

inline BufferedStream& StreamBuffer::getStream() const
{
    return static_cast<BufferedStream&>(overlappable);
}

//------------------------------------------------------------------------------

inline const ::xplcommon::Failable& StreamBuffer::getFailable() const
{
    return overlappable;
}

//------------------------------------------------------------------------------

inline ::xplcommon::Failable& StreamBuffer::getFailable()
{
    return overlappable;
}

//------------------------------------------------------------------------------

} /* namespace xplcommon::win32 */ } /* namespace xplcommon */

//------------------------------------------------------------------------------
#endif // XPLCOMMON_WIN32_STREAMBUFFER_H

// Local Variables:
// mode: C++
// c-basic-offset: 4
// indent-tabs-mode: nil
// End: