poco/Foundation/include/Poco/PipeStream.h

121 lines
2.5 KiB
C
Raw Normal View History

2012-04-29 20:52:25 +02:00
//
// 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
2012-04-29 20:52:25 +02:00
//
#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;
2022-07-07 11:18:20 +02:00
2012-04-29 20:52:25 +02:00
PipeStreamBuf(const Pipe& pipe, openmode mode);
/// Creates a PipeStreamBuf with the given Pipe.
~PipeStreamBuf();
/// Destroys the PipeStreamBuf.
2022-07-07 11:18:20 +02:00
2012-04-29 20:52:25 +02:00
void close();
/// Closes the pipe.
2022-07-07 11:18:20 +02:00
2012-04-29 20:52:25 +02:00
protected:
int readFromDevice(char* buffer, std::streamsize length);
int writeToDevice(const char* buffer, std::streamsize length);
private:
2022-07-07 11:18:20 +02:00
enum
2012-04-29 20:52:25 +02:00
{
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.
2022-07-07 11:18:20 +02:00
2012-04-29 20:52:25 +02:00
~PipeIOS();
/// Destroys the PipeIOS.
///
/// Flushes the buffer, but does not close the pipe.
2022-07-07 11:18:20 +02:00
2012-04-29 20:52:25 +02:00
PipeStreamBuf* rdbuf();
/// Returns a pointer to the internal PipeStreamBuf.
2022-07-07 11:18:20 +02:00
2012-04-29 20:52:25 +02:00
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