Brook Tardigrade

Unit BrookHTTPServer

Description
Uses
Classes, Interfaces, Objects and Records
Functions and Procedures
Types
Constants
Variables

Description

Contains classes which composes a fast event-driven HTTP(S) server.

Uses

Overview

Classes, Interfaces, Objects and Records

Name Description
Class EBrookHTTPServerSecurity Handles exceptions related to HTTP server security.
Class TBrookHTTPServerSecurity Class which holds the TLS properties for the HTTPS server.
Class EBrookHTTPServer Handles exceptions related to HTTP server.
Class TBrookHTTPServer Fast event-driven HTTP(S) server class.

Types

TBrookHTTPAuthenticateEvent = function(ASender: TObject; AAuthentication: TBrookHTTPAuthentication; ARequest: TBrookHTTPRequest; AResponse: TBrookHTTPResponse): Boolean of object;
TBrookHTTPAuthenticateErrorEvent = procedure(ASender: TObject; AAuthentication: TBrookHTTPAuthentication; ARequest: TBrookHTTPRequest; AResponse: TBrookHTTPResponse; AException: Exception) of object;
TBrookHTTPRequestEvent = procedure(ASender: TObject; ARequest: TBrookHTTPRequest; AResponse: TBrookHTTPResponse) of object;
TBrookHTTPRequestErrorEvent = procedure(ASender: TObject; ARequest: TBrookHTTPRequest; AResponse: TBrookHTTPResponse; AException: Exception) of object;
TBrookHTTPServerClientConnectionEvent = procedure(ASender: TObject; const AClient: Pointer; var AClosed: Boolean) of object;

Constants

SBrookActiveServer = 'Active server.';
SBrookCannotCreateServerHandle = 'Cannot create server handle.';
SBrookTLSNotAvailable = Concat( 'TLS is not available. Please download the Sagui library with ', 'TLS support at: https://github.com/risoflora/libsagui/releases');
SBrookEmptyPrivateKey = 'Private key cannot be empty.';
SBrookEmptyCertificate = 'Certificate cannot be empty.';

Description

Types

TBrookHTTPAuthenticateEvent = function(ASender: TObject; AAuthentication: TBrookHTTPAuthentication; ARequest: TBrookHTTPRequest; AResponse: TBrookHTTPResponse): Boolean of object;

Event signature used by HTTP server to handle the clients authentication.

TBrookHTTPAuthenticateErrorEvent = procedure(ASender: TObject; AAuthentication: TBrookHTTPAuthentication; ARequest: TBrookHTTPRequest; AResponse: TBrookHTTPResponse; AException: Exception) of object;

Event signature used by HTTP server to handle errors in the clients authentication.

TBrookHTTPRequestEvent = procedure(ASender: TObject; ARequest: TBrookHTTPRequest; AResponse: TBrookHTTPResponse) of object;

Event signature used by HTTP server to handle requests.

TBrookHTTPRequestErrorEvent = procedure(ASender: TObject; ARequest: TBrookHTTPRequest; AResponse: TBrookHTTPResponse; AException: Exception) of object;

Event signature used by HTTP server to handle error in the requests.

TBrookHTTPServerClientConnectionEvent = procedure(ASender: TObject; const AClient: Pointer; var AClosed: Boolean) of object;

Event signature used by HTTP server to handle client connection events.

Constants

SBrookActiveServer = 'Active server.';

Error message 'Active server.'.

SBrookCannotCreateServerHandle = 'Cannot create server handle.';

Error message 'Cannot create server handle.'.

SBrookTLSNotAvailable = Concat( 'TLS is not available. Please download the Sagui library with ', 'TLS support at: https://github.com/risoflora/libsagui/releases');

Error message 'TLS is not available.'.

SBrookEmptyPrivateKey = 'Private key cannot be empty.';

Error message 'Private key cannot be empty.'.

SBrookEmptyCertificate = 'Certificate cannot be empty.';

Error message 'Certificate cannot be empty.'.

Generated by PasDoc 0.16.0.