Class TRALModuleRoutes

Unit

RALServer

Declaration

type TRALModuleRoutes = class(TRALComponent)

Description

Attachment module to allow adding custom route modules for 3rd party components

Hierarchy

• TObject
• TPersistent
• TComponent
• TRALComponent
• TRALModuleRoutes

Overview

Methods

	constructor Create(AOwner: TComponent); override;
	destructor Destroy; override;
	function CanAnswerRoute(ARequest: TRALRequest; AResponse: TRALResponse): TRALRoute; virtual;
	function CreateRoute(const ARoute: StringRAL; AReplyProc: TRALOnReply; const ADescription: StringRAL = ''): TRALRoute; overload;
	function CreateRoute(const ARoute: StringRAL; AReplyProc: TRALOnReplyGen; const ADescription: StringRAL = ''): TRALRoute; overload;
	function GetListRoutes: TList; virtual;
	procedure Notification(AComponent: TComponent; Operation: TOperation); override;
	procedure SetDomain(const AValue: StringRAL); virtual;
	procedure SetServer(AValue: TRALServer); virtual;

Properties

	property Domain: StringRAL read FDomain write SetDomain;
	property OnBeforeAnswer: TRALOnReply read FOnBeforeAnswer write FOnBeforeAnswer;
	property Routes: TRALRoutes read FRoutes write FRoutes;
	property Server: TRALServer read FServer write SetServer;

Description

Methods

	constructor Create(AOwner: TComponent); override;

	destructor Destroy; override;

	function CanAnswerRoute(ARequest: TRALRequest; AResponse: TRALResponse): TRALRoute; virtual;
Inherited method of RALServer

	function CreateRoute(const ARoute: StringRAL; AReplyProc: TRALOnReply; const ADescription: StringRAL = ''): TRALRoute; overload;
Shortcut to create route on the server, similar to RALServer's CreateRoute

	function CreateRoute(const ARoute: StringRAL; AReplyProc: TRALOnReplyGen; const ADescription: StringRAL = ''): TRALRoute; overload;

	function GetListRoutes: TList; virtual;
Inherited method of RALServer

	procedure Notification(AComponent: TComponent; Operation: TOperation); override;

	procedure SetDomain(const AValue: StringRAL); virtual;
Defines the Domain prefix of all the routes of the instance of this class

	procedure SetServer(AValue: TRALServer); virtual;
Defines the handle of the RALServer in which will be registered the routes

Properties

	property Domain: StringRAL read FDomain write SetDomain;

	property OnBeforeAnswer: TRALOnReply read FOnBeforeAnswer write FOnBeforeAnswer;

	property Routes: TRALRoutes read FRoutes write FRoutes;

	property Server: TRALServer read FServer write SetServer;

GitHub Repository

---

Generated by PasDoc 0.16.0.