Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 1.41 KB

TPJPipeFilter.md

File metadata and controls

40 lines (26 loc) · 1.41 KB

TPJPipeFilter class

Project: I/O Utility Classes

Unit: PJPipeFilters

Applies to: ~>1.0

Description

This is an abstract base class for all classes that filter data read from pipes. It defines common methods and properties along with some abstract methods to be overridden in sub classes.

Methods

Protected

Method Description
LeftOverByteCount Abstract. Must return number of bytes of data that cannot be processed yet.
DoFilter Abstract. Performs filtering operation on data.
DoFlush Abstract. Flushes any buffered data.

Public

Method Description
Create Object constructor. Sets up object to filter a specified pipe.
ReadPipe Reads all available data from the pipe.
Flush Flushes any unprocessed buffered data.
HaveUnprocessedData Checks there is currently any buffered, unprocessed, data.

Properties

Property Description
Pipe Read only property providing access to the pipe that is being filtered.

Events

TPJPipeFilter exposes no events.