← Back to branch summary

~ubuntu-branches/ubuntu/gutsy/poco/gutsy

« back to all changes in this revision

Viewing changes to Foundation/include/Poco/PipeStream.h

  • Committer: Bazaar Package Importer
  • Author(s): Krzysztof Burghardt
  • Date: 2007-04-27 18:33:48 UTC
  • Revision ID: james.westby@ubuntu.com-20070427183348-xgnpct0qd6a2ip34
Tags: upstream-1.2.9
Import upstream version 1.2.9

Show diffs side-by-side

added added

removed removed

Lines of Context:
Foundation/include/Poco/PipeStream.h
 
1
//
 
2
// PipeStream.h
 
3
//
 
4
// $Id: //poco/1.2/Foundation/include/Poco/PipeStream.h#1 $
 
5
//
 
6
// Library: Foundation
 
7
// Package: Processes
 
8
// Module:  PipeStream
 
9
//
 
10
// Definition of the PipeStream class.
 
11
//
 
12
// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH.
 
13
// and Contributors.
 
14
//
 
15
// Permission is hereby granted, free of charge, to any person or organization
 
16
// obtaining a copy of the software and accompanying documentation covered by
 
17
// this license (the "Software") to use, reproduce, display, distribute,
 
18
// execute, and transmit the Software, and to prepare derivative works of the
 
19
// Software, and to permit third-parties to whom the Software is furnished to
 
20
// do so, all subject to the following:
 
21
// 
 
22
// The copyright notices in the Software and this entire statement, including
 
23
// the above license grant, this restriction and the following disclaimer,
 
24
// must be included in all copies of the Software, in whole or in part, and
 
25
// all derivative works of the Software, unless such copies or derivative
 
26
// works are solely in the form of machine-executable object code generated by
 
27
// a source language processor.
 
28
// 
 
29
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 
30
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 
31
// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
 
32
// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
 
33
// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
 
34
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 
35
// DEALINGS IN THE SOFTWARE.
 
36
//
 
37
 
 
38
 
 
39
#ifndef Foundation_PipeStream_INCLUDED
 
40
#define Foundation_PipeStream_INCLUDED
 
41
 
 
42
 
 
43
#include "Poco/Foundation.h"
 
44
#include "Poco/Pipe.h"
 
45
#include "Poco/BufferedStreamBuf.h"
 
46
#include <istream>
 
47
#include <ostream>
 
48
 
 
49
 
 
50
namespace Poco {
 
51
 
 
52
 
 
53
class Foundation_API PipeStreamBuf: public BufferedStreamBuf
 
54
        /// This is the streambuf class used for reading from and writing to a Pipe.
 
55
{
 
56
public:
 
57
        typedef BufferedStreamBuf::openmode openmode;
 
58
        
 
59
        PipeStreamBuf(const Pipe& pipe, openmode mode);
 
60
                /// Creates a PipeStreamBuf with the given Pipe.
 
61
 
 
62
        ~PipeStreamBuf();
 
63
                /// Destroys the PipeStreamBuf.
 
64
                
 
65
        void close();
 
66
                /// Closes the pipe.
 
67
                
 
68
protected:
 
69
        int readFromDevice(char* buffer, std::streamsize length);
 
70
        int writeToDevice(const char* buffer, std::streamsize length);
 
71
 
 
72
private:
 
73
        enum 
 
74
        {
 
75
                STREAM_BUFFER_SIZE = 1024
 
76
        };
 
77
 
 
78
        Pipe _pipe;
 
79
};
 
80
 
 
81
 
 
82
class Foundation_API PipeIOS: public virtual std::ios
 
83
        /// The base class for PipeInputStream and
 
84
        /// PipeOutputStream.
 
85
        ///
 
86
        /// This class is needed to ensure the correct initialization
 
87
        /// order of the stream buffer and base classes.
 
88
{
 
89
public:
 
90
        PipeIOS(const Pipe& pipe, openmode mode);
 
91
                /// Creates the PipeIOS with the given Pipe.
 
92
                
 
93
        ~PipeIOS();
 
94
                /// Destroys the PipeIOS.
 
95
                ///
 
96
                /// Flushes the buffer, but does not close the pipe.
 
97
                
 
98
        PipeStreamBuf* rdbuf();
 
99
                /// Returns a pointer to the internal PipeStreamBuf.
 
100
                
 
101
        void close();
 
102
                /// Flushes the stream and closes the pipe.
 
103
 
 
104
protected:
 
105
        PipeStreamBuf _buf;
 
106
};
 
107
 
 
108
 
 
109
class Foundation_API PipeOutputStream: public PipeIOS, public std::ostream
 
110
        /// An output stream for writing to a Pipe.
 
111
{
 
112
public:
 
113
        PipeOutputStream(const Pipe& pipe);
 
114
                /// Creates the PipeOutputStream with the given Pipe.
 
115
 
 
116
        ~PipeOutputStream();
 
117
                /// Destroys the PipeOutputStream.
 
118
                ///
 
119
                /// Flushes the buffer, but does not close the pipe.
 
120
};
 
121
 
 
122
 
 
123
class Foundation_API PipeInputStream: public PipeIOS, public std::istream
 
124
        /// An input stream for reading from a Pipe.
 
125
        ///
 
126
        /// Using formatted input from a PipeInputStream
 
127
        /// is not recommended, due to the read-ahead behavior of
 
128
        /// istream with formatted reads.
 
129
{
 
130
public:
 
131
        PipeInputStream(const Pipe& pipe);
 
132
                /// Creates the PipeInputStream with the given Pipe.
 
133
 
 
134
        ~PipeInputStream();
 
135
                /// Destroys the PipeInputStream.
 
136
};
 
137
 
 
138
 
 
139
} // namespace Poco
 
140
 
 
141
 
 
142
#endif // Foundation_PipeStream_INCLUDED