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
68
69
70
71
72
73
|
// --------------------------------------------------------------------------
//
// File
// Name: IOStream.h
// Purpose: I/O Stream abstraction
// Created: 2003/07/31
//
// --------------------------------------------------------------------------
#ifndef IOSTREAM__H
#define IOSTREAM__H
// --------------------------------------------------------------------------
//
// Class
// Name: IOStream
// Purpose: Abstract interface to streams of data
// Created: 2003/07/31
//
// --------------------------------------------------------------------------
class IOStream
{
public:
IOStream();
virtual ~IOStream();
private:
IOStream(const IOStream &rToCopy); /* forbidden */
IOStream& operator=(const IOStream &rToCopy); /* forbidden */
public:
enum
{
TimeOutInfinite = -1,
SizeOfStreamUnknown = -1
};
enum
{
SeekType_Absolute = 0,
SeekType_Relative = 1,
SeekType_End = 2
};
// Timeout in milliseconds
// Read may return 0 -- does not mean end of stream.
typedef int64_t pos_type;
virtual int Read(void *pBuffer, int NBytes, int Timeout = IOStream::TimeOutInfinite) = 0;
virtual pos_type BytesLeftToRead(); // may return IOStream::SizeOfStreamUnknown (and will for most stream types)
virtual void Write(const void *pBuffer, int NBytes,
int Timeout = IOStream::TimeOutInfinite) = 0;
virtual void Write(const std::string& rBuffer,
int Timeout = IOStream::TimeOutInfinite);
virtual void WriteAllBuffered(int Timeout = IOStream::TimeOutInfinite);
virtual pos_type GetPosition() const;
virtual void Seek(pos_type Offset, int SeekType);
virtual void Close();
// Has all data that can be read been read?
virtual bool StreamDataLeft() = 0;
// Has the stream been closed (writing not possible)
virtual bool StreamClosed() = 0;
// Utility functions
bool ReadFullBuffer(void *pBuffer, int NBytes, int *pNBytesRead, int Timeout = IOStream::TimeOutInfinite);
bool CopyStreamTo(IOStream &rCopyTo, int Timeout = IOStream::TimeOutInfinite, int BufferSize = 1024);
void Flush(int Timeout = IOStream::TimeOutInfinite);
static int ConvertSeekTypeToOSWhence(int SeekType);
virtual std::string ToString() const;
};
#endif // IOSTREAM__H
|
