TPJPipe.md

TPJPipe class

Project: I/O Utility Classes

Unit: PJPipe

Applies to: ~>1.0

Description

This class provides a wrapper round a Windows un-named pipe.

Pipes can be created with the desired security attributes. Pipes can also have inheritable handles to make them suitable for passing to child processes †.

TPJPipe provides methods to check the number of bytes in a readable pipe, read bytes from a pipe into either a buffer or a stream and write bytes to a pipe from buffers and streams.

Note

† Inheritable handles have a particular use in the Console Application Runner Classes for piping the output or input of console applications to and from the host application.

Methods

Method	Description
AvailableDataSize	Peeks the pipe to get the size of data available for reading.
CloseWriteHandle	Closes the pipe's write handle if it is open.
CopyFromStream	Copies data from a stream into the pipe.
CopyToStream	Copies data from the pipe to a stream.
Create	Various overloaded constructors.
ReadBytes	Reads data from the pipe into a byte array.
ReadData	Reads data from the pipe into a buffer.
WriteBytes	Writes the content of a byte array to the pipe.
WriteData	Writes data from a buffer to the pipe.

Properties

Property	Description
ReadHandle	Windows handle used to read data from the pipe.
WriteHandle	Windows handle used to write data to the pipe.

Events

TPJPipe exposes no events.