Search packages:
 Sourcecode: scummvm version 0.11.10.11.1-10.13.00.13.0-10.13.10.13.1-10.7.10.7.1-10.8.00.8.0-1ubuntu10.9.10.9.1-10.9.1-1build11.0.0-11.0.0-21.0.0-31.0.0-41.0.0~rc1-11.0.0~rc1-1-11.1.0-11.1.0-21.1.1-11.2.0-11.2.0-21.2.1-2ubuntu11.3.0-11.3.1-11.3.1-1build1

# bufferedstream.h

/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License

* This program 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 this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* $URL$
* $Id$
*
*/

#ifndef COMMON_BUFFEREDSTREAM_H
#define COMMON_BUFFEREDSTREAM_H

#include "common/stream.h"
#include "common/types.h"

namespace Common {

/**
* Take an arbitrary ReadStream and wrap it in a custom stream which
* transparently provides buffering.
* Users can specify how big the buffer should be, and whether the wrapped
* stream should be disposed when the wrapper is disposed.
*
* It is safe to call this with a NULL parameter (in this case, NULL is
* returned).
*/

/**
* Take an arbitrary SeekableReadStream and wrap it in a custom stream which
* transparently provides buffering.
* Users can specify how big the buffer should be, and whether the wrapped
* stream should be disposed when the wrapper is disposed.
*
* It is safe to call this with a NULL parameter (in this case, NULL is
* returned).
*/

/**
* Take an arbitrary WriteStream and wrap it in a custom stream which
* transparently provides buffering.
* Users can specify how big the buffer should be. Currently, the
* parent stream is \em always disposed when the wrapper is disposed.
*
* It is safe to call this with a NULL parameter (in this case, NULL is
* returned).
*/
WriteStream *wrapBufferedWriteStream(WriteStream *parentStream, uint32 bufSize);

}     // End of namespace Common

#endif


Generated by  Doxygen 1.6.0   Back to index