source: xplcommon/src/xplcommon/BufferedStream.h@ 29:54c2d451f8a0

// 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_BUFFEREDSTREAM_H
#define XPLCOMMON_BUFFEREDSTREAM_H
//------------------------------------------------------------------------------

#include "Failable.h"

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

#if 0 // The public interface of a buffered stream

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

namespace xplcommon {

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

/**
 * Base class for streams on which a waiter can wait and provides a
 * reading and/or a writing buffer.
 */
class BufferedStream : public Failable
{
public:
    /**
     * The default buffer capacity.
     */
    static const size_t DEFAULT_CAPACITY = 4096;

public:
    /**
     * Destroy the buffered stream.
     */
    virtual ~BufferedStream();

    /**
     * Get the reference of the reading buffer. Note, that it can be a
     * 0 reference, if the stream has no reading buffer.
     */
    ReadingBuffer& getReadingBuffer();

    /**
     * Get the reference of the writing buffer. Note, that it can be a
     * 0 reference, if the stream has no writing buffer.
     */
    WritingBuffer& getWritingBuffer();
};

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

} /* namespace xplcommon */

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

#endif // 0, The public interface of a buffered stream

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

#include "config.h"

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

#if TARGET_API_WIN32

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

#include "win32/BufferedStream.h"

namespace xplcommon { typedef win32::BufferedStream BufferedStream; }

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

#else // TARGET_API_WIN32

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

#include "posix/BufferedStream.h"

namespace xplcommon { typedef posix::BufferedStream BufferedStream; }

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

#endif // TARGET_API_WIN32

//------------------------------------------------------------------------------
#endif // XPLCOMMON_BUFFEREDSTREAM_H

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