Brook Tardigrade

Class TBrookURLEntryPoints

Description
Hierarchy
Fields
Methods
Properties

Unit

BrookURLEntryPoints

Declaration

type TBrookURLEntryPoints = class(TBrookHandledComponent)

Description

URL entry-points component.

Hierarchy

Overview

Methods

Public constructor Create(AOwner: TComponent); override;
Public destructor Destroy; override;
Public function GetEnumerator: TBrookURLEntryPointListEnumerator;
Public function Add: TBrookURLEntryPoint; inline;
Public procedure Remove(const AName: string); inline;
Public procedure Clear; inline;
Public procedure Open;
Public procedure Close;
Public procedure Enter(ASender: TObject; const APath: string; ARequest: TBrookHTTPRequest; AResponse: TBrookHTTPResponse); overload; virtual;
Public procedure Enter(ASender: TObject; ARequest: TBrookHTTPRequest; AResponse: TBrookHTTPResponse); overload; virtual;

Properties

Public property Items[AIndex:Integer]: TBrookURLEntryPoint read GetItem write SetItem;
Published property Active: Boolean read FActive write SetActive stored IsActiveStored;
Published property List: TBrookURLEntryPointList read FList write SetList;
Published property OnNotFound: TBrookURLEntryPointsNotFoundEvent read FOnNotFound write FOnNotFound;
Published property OnActivate: TNotifyEvent read FOnActivate write FOnActivate;
Published property OnDeactivate: TNotifyEvent read FOnDeactivate write FOnDeactivate;

Description

Methods

Public constructor Create(AOwner: TComponent); override;

Creates an instance of TBrookURLEntryPoints.

Parameters
AOwner[in]
Owner component.
Public destructor Destroy; override;

Destroys an instance of TBrookURLEntryPoints.

Public function GetEnumerator: TBrookURLEntryPointListEnumerator;

Creates an enumerator to iterate the entry-points though for..in.

Public function Add: TBrookURLEntryPoint; inline;

Adds a new item to the entry-point list.

Returns

Entry-point item.

Public procedure Remove(const AName: string); inline;

Removes an item from the entry-point list by its name.

Parameters
AName[in]
Entry-point name.
Public procedure Clear; inline;

Clears the entry-point list.

Public procedure Open;

Enabled the entry-point component.

Public procedure Close;

Disables the entry-point component.

Public procedure Enter(ASender: TObject; const APath: string; ARequest: TBrookHTTPRequest; AResponse: TBrookHTTPResponse); overload; virtual;

Enters into entry-points routing them.

Parameters
ASender[in]
Sender object.
APath[in]
Entry-point path.
ARequest[in]
Request object to pass to the entry-point found.
AResponse:
Response object to pass to the entry-point found.
Public procedure Enter(ASender: TObject; ARequest: TBrookHTTPRequest; AResponse: TBrookHTTPResponse); overload; virtual;

Enters into entry-points routing them.

Parameters
ASender[in]
Sender object.
ARequest[in]
Request object to pass to the entry-point found.
AResponse:
Response object to pass to the entry-point found.

Properties

Public property Items[AIndex:Integer]: TBrookURLEntryPoint read GetItem write SetItem;

Gets/sets an entry-point from/to the entry-point list by its index.

Published property Active: Boolean read FActive write SetActive stored IsActiveStored;

Enabled/disables the entry-point component.

Published property List: TBrookURLEntryPointList read FList write SetList;

Available entry-point list.

Published property OnNotFound: TBrookURLEntryPointsNotFoundEvent read FOnNotFound write FOnNotFound;

Event triggered when an entry-point is not found.

Published property OnActivate: TNotifyEvent read FOnActivate write FOnActivate;

Event triggered when the component is enabled.

Published property OnDeactivate: TNotifyEvent read FOnDeactivate write FOnDeactivate;

Event triggered when the component is disabled.

Generated by PasDoc 0.16.0.