mirror of
https://github.com/debauchee/barrier.git
synced 2026-05-11 00:58:14 +08:00
Added doxygen comments for all relevant headers in io.
This commit is contained in:
@@ -3,21 +3,31 @@
|
||||
|
||||
#include "IInputStream.h"
|
||||
|
||||
//! A filtering input stream
|
||||
/*!
|
||||
This class wraps an input stream. Subclasses provide indirect access
|
||||
to the stream, typically performing some filtering.
|
||||
*/
|
||||
class CInputStreamFilter : public IInputStream {
|
||||
public:
|
||||
CInputStreamFilter(IInputStream*, bool adoptStream = true);
|
||||
/*!
|
||||
Create a wrapper around \c stream. Iff \c adoptStream is true then
|
||||
this object takes ownership of the stream and will delete it in the
|
||||
d'tor.
|
||||
*/
|
||||
CInputStreamFilter(IInputStream* stream, bool adoptStream = true);
|
||||
~CInputStreamFilter();
|
||||
|
||||
// manipulators
|
||||
|
||||
// accessors
|
||||
|
||||
// IInputStream overrides
|
||||
virtual void close() = 0;
|
||||
virtual UInt32 read(void*, UInt32 maxCount, double timeout) = 0;
|
||||
virtual UInt32 read(void*, UInt32 n, double timeout) = 0;
|
||||
virtual UInt32 getSize() const = 0;
|
||||
|
||||
protected:
|
||||
//! Get the stream
|
||||
/*!
|
||||
Returns the stream passed to the c'tor.
|
||||
*/
|
||||
IInputStream* getStream() const;
|
||||
|
||||
private:
|
||||
|
||||
Reference in New Issue
Block a user