mirror of
https://github.com/libretro/scummvm.git
synced 2024-12-12 12:09:15 +00:00
67 lines
2.4 KiB
C++
67 lines
2.4 KiB
C++
/* 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
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
|
|
* 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.
|
|
*
|
|
*/
|
|
|
|
#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).
|
|
*/
|
|
ReadStream *wrapBufferedReadStream(ReadStream *parentStream, uint32 bufSize, DisposeAfterUse::Flag disposeParentStream);
|
|
|
|
/**
|
|
* 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).
|
|
*/
|
|
SeekableReadStream *wrapBufferedSeekableReadStream(SeekableReadStream *parentStream, uint32 bufSize, DisposeAfterUse::Flag disposeParentStream);
|
|
|
|
/**
|
|
* 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
|