This is a new site that's currently running on alpha code. There are going to be bugs. If you discover any, please report them on the site's issues page (GitHub account required). Thanks.
Warning: Many URLs are going to change. Refer to the README file to discover which library project's documentation has been completed.
Project: I/O Utility Classes
Unit: PJPipeFilters
Applies to: ~>1.0
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.
| 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. |
| 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. |
| Property | Description |
|---|---|
| Pipe | Read only property providing access to the pipe that is being filtered. |
TPJPipeFilter exposes no events.