aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/libs/poco/Foundation/include/Poco/PipeStream.h
blob: d0d3f0095b6ef6f88cde18fadb29e28f2ad9d627 (plain) (blame)
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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
// 
// PipeStream.h 
// 
// Library: Foundation 
// Package: Processes 
// Module:  PipeStream 
// 
// Definition of the PipeStream class. 
// 
// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH. 
// and Contributors. 
// 
// SPDX-License-Identifier:	BSL-1.0 
// 
 
 
#ifndef Foundation_PipeStream_INCLUDED 
#define Foundation_PipeStream_INCLUDED 
 
 
#include "Poco/Foundation.h" 
#include "Poco/Pipe.h" 
#include "Poco/BufferedStreamBuf.h" 
#include <istream> 
#include <ostream> 
 
 
namespace Poco { 
 
 
class Foundation_API PipeStreamBuf: public BufferedStreamBuf 
	/// This is the streambuf class used for reading from and writing to a Pipe. 
{ 
public: 
	typedef BufferedStreamBuf::openmode openmode; 
	 
	PipeStreamBuf(const Pipe& pipe, openmode mode); 
		/// Creates a PipeStreamBuf with the given Pipe. 
 
	~PipeStreamBuf(); 
		/// Destroys the PipeStreamBuf. 
		 
	void close(); 
		/// Closes the pipe. 
		 
protected: 
	int readFromDevice(char* buffer, std::streamsize length); 
	int writeToDevice(const char* buffer, std::streamsize length); 
 
private: 
	enum  
	{ 
		STREAM_BUFFER_SIZE = 1024 
	}; 
 
	Pipe _pipe; 
}; 
 
 
class Foundation_API PipeIOS: public virtual std::ios 
	/// The base class for PipeInputStream and 
	/// PipeOutputStream. 
	/// 
	/// This class is needed to ensure the correct initialization 
	/// order of the stream buffer and base classes. 
{ 
public: 
	PipeIOS(const Pipe& pipe, openmode mode); 
		/// Creates the PipeIOS with the given Pipe. 
		 
	~PipeIOS(); 
		/// Destroys the PipeIOS. 
		/// 
		/// Flushes the buffer, but does not close the pipe. 
		 
	PipeStreamBuf* rdbuf(); 
		/// Returns a pointer to the internal PipeStreamBuf. 
		 
	void close(); 
		/// Flushes the stream and closes the pipe. 
 
protected: 
	PipeStreamBuf _buf; 
}; 
 
 
class Foundation_API PipeOutputStream: public PipeIOS, public std::ostream 
	/// An output stream for writing to a Pipe. 
{ 
public: 
	PipeOutputStream(const Pipe& pipe); 
		/// Creates the PipeOutputStream with the given Pipe. 
 
	~PipeOutputStream(); 
		/// Destroys the PipeOutputStream. 
		/// 
		/// Flushes the buffer, but does not close the pipe. 
}; 
 
 
class Foundation_API PipeInputStream: public PipeIOS, public std::istream 
	/// An input stream for reading from a Pipe. 
	/// 
	/// Using formatted input from a PipeInputStream 
	/// is not recommended, due to the read-ahead behavior of 
	/// istream with formatted reads. 
{ 
public: 
	PipeInputStream(const Pipe& pipe); 
		/// Creates the PipeInputStream with the given Pipe. 
 
	~PipeInputStream(); 
		/// Destroys the PipeInputStream. 
}; 
 
 
} // namespace Poco 
 
 
#endif // Foundation_PipeStream_INCLUDED