aboutsummaryrefslogtreecommitdiff
path: root/src/stable/nullstream.h
blob: 034b0c592c29a878de20e6f2c1bd2b48a9d703c9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
/*
 * Copyright (C) 2007-2012 Xagasoft, All rights reserved.
 *
 * This file is part of the libbu++ library and is released under the
 * terms of the license contained in the file LICENSE.
 */

#ifndef BU_NULL_STREAM_H
#define BU_NULL_STREAM_H

#include "bu/stream.h"

namespace Bu
{
	/**
	 * Works a lot like /dev/null on *nix style systems.  This class allows
	 * infinite reading and writing.  All operatorns "succeed" even if they
	 * don't seem to do anything.  This is great for testing writing code or
	 * doing dry runs.  When reading, it will produce NULL bytes, so any
	 * application that would like the ability to produce null streams as a
	 * snap-in replacement for any other Bu::Stream, this is the right option.
	 *
	 * As an added feature, the NullStream will track how many bytes it was
	 * asked to read and write, allowing you to use it to determine how many
	 * bytes a write opretion would use without actually writing anything.
	 */
	class NullStream : public Bu::Stream
	{
	public:
		NullStream();
		virtual ~NullStream();

		virtual void close();
		virtual Bu::size read( void *pBuf, Bu::size nBytes );
		virtual Bu::String readLine();
		virtual Bu::size write( const void *pBuf, Bu::size nBytes );
		using Bu::Stream::write;
		virtual Bu::size tell();
		virtual void seek( Bu::size offset );
		virtual void setPos( Bu::size pos );
		virtual void setPosEnd( Bu::size pos );
		virtual bool isEos();
		virtual bool isOpen();
		virtual void flush();
		virtual bool canRead();
		virtual bool canWrite();
		virtual bool isReadable();
		virtual bool isWritable();
		virtual bool isSeekable();
		virtual bool isBlocking();
		virtual void setBlocking( bool bBlocking=true );
		virtual void setSize( Bu::size iSize );

		virtual size getSize() const;
		virtual size getBlockSize() const;
		virtual Bu::String getLocation() const;

		Bu::size getBytesRead() { return sRead; }
		Bu::size getByetsWritten() { return sWrote; }

	private:
		Bu::size sRead;
		Bu::size sWrote;
	};
};

#endif