Skip to content

Latest commit

 

History

History
37 lines (23 loc) · 1.89 KB

API.md

File metadata and controls

37 lines (23 loc) · 1.89 KB

Stream Extension Classes Programmers' Guide

Applies to: ~>3.0

Introduction

This section of the Stream Extension Classes documentation describes the API exposed by the classes to programmers.

Contents

Units

The project consists of two units:

Unit Description
PJStreamWrapper Provides the core base class for all other classes that "wrap" a TStream instance to provide a filter or to add functionality.
PJIStreams Contains stream wrapper classes that provide various implementations of the IStream interface.

Classes

The following classes are provided by the library:

Class Unit Description
TPJStreamWrapper PJStreamWrapper This is a base class for descendant classes that "wrap" a TStream class to filter the data or add functionality. The wrapped TStream is used to perform the required reads, writes and seeks. TStreamWrapper simply replicates the facilities in the wrapped stream - it is for descendant classes to add functionality.
TPJIStreamWrapper PJIStreams Implements the IStream interface for a wrapped TStream object.
TPJHandleIStreamWrapper PJIStreams Implements an IStream interface for a wrapped THandleStream object. Acts in a similar way to TPJIStreamWrapper except that file date stamps can be access.
TPJFileIStream PJIStreams Implements an IStream interface on a file stream.

Conventions

This documentation complies with these conventions.

Links