Class TRALClient
Unit
Declaration
type TRALClient = class(TRALComponent)
Description
TRALClient
Hierarchy
- TObject
- TPersistent
- TComponent
- TRALComponent
- TRALClient
Overview
Methods
 |
constructor Create(AOwner: TComponent); override; |
|
destructor Destroy; override; |
|
function Clone(AOwner: TComponent = nil): TRALClient; virtual; |
 |
function CreateClient: TRALClientHTTP; |
|
function ExecuteSingle(ARoute: StringRAL; AMethod: TRALMethod) : TRALResponse; virtual; |
|
procedure Delete(ARoute: StringRAL; var AResponse : TRALResponse); overload; |
|
procedure Delete(ARoute: StringRAL; AOnResponse: TRALThreadClientResponse = nil; AExecBehavior : TRALExecBehavior = ebMultiThread); overload; |
|
procedure Get(ARoute: StringRAL; AOnResponse: TRALThreadClientResponse = nil; AExecBehavior : TRALExecBehavior = ebMultiThread); overload; |
|
procedure Get(ARoute: StringRAL; var AResponse : TRALResponse); overload; |
|
procedure Patch(ARoute: StringRAL; AOnResponse: TRALThreadClientResponse = nil; AExecBehavior : TRALExecBehavior = ebMultiThread); overload; |
|
procedure Patch(ARoute: StringRAL; var AResponse : TRALResponse); overload; |
|
procedure Post(ARoute: StringRAL; AOnResponse: TRALThreadClientResponse = nil; AExecBehavior : TRALExecBehavior = ebMultiThread); overload; |
|
procedure Post(ARoute: StringRAL; var AResponse : TRALResponse); overload; |
|
procedure Put(ARoute: StringRAL; AOnResponse: TRALThreadClientResponse = nil; AExecBehavior: TRALExecBehavior = ebMultiThread); overload; |
|
procedure Put(ARoute: StringRAL; var AResponse : TRALResponse); overload; |
|
procedure CopyProperties(ADest: TRALClient); virtual; |
|
procedure ExecuteThread(ARoute: StringRAL; AMethod: TRALMethod; AOnResponse: TRALThreadClientResponse = nil; AExecBehavior : TRALExecBehavior = ebMultiThread); virtual; |
|
procedure LockSession; |
|
procedure Notification(AComponent: TComponent; Operation: TOperation); override; |
|
procedure OnThreadResponse(Sender: TObject; AResponse: TRALResponse; AException: StringRAL); |
|
procedure SetAuthentication(AValue: TRALAuthClient); |
|
procedure SetBaseURL(AValue: TStrings); |
|
procedure SetConnectTimeout(const AValue: IntegerRAL); virtual; |
|
procedure SetEngineType(AValue: String); |
|
procedure SetKeepAlive(AValue: boolean); virtual; |
|
procedure SetRequestTimeout(AValue: IntegerRAL); virtual; |
|
procedure SetUserAgent(AValue: StringRAL); virtual; |
|
procedure UnLockSession; |
Properties
 |
property Authentication: TRALAuthClient read FAuthentication write SetAuthentication; |
|
property BaseURL: TStrings read FBaseURL write SetBaseURL; |
|
property CompressType: TRALCompressType read FCompressType write FCompressType; |
|
property ConnectTimeout: IntegerRAL read FConnectTimeout write FConnectTimeout default 5000; |
|
property CriptoOptions: TRALCriptoOptions read FCriptoOptions write FCriptoOptions; |
|
property Engine: StringRAL read FEngine; |
|
property EngineType : String read FEngineType write SetEngineType; |
|
property IndexUrl: IntegerRAL read FIndexUrl write FIndexUrl; |
|
property KeepAlive: boolean read FKeepAlive write SetKeepAlive; |
|
property OnResponse: TRALThreadClientResponse read FOnResponse write FOnResponse; |
|
property Request: TRALRequest read FRequest; |
|
property RequestTimeout: IntegerRAL read FRequestTimeout write SetRequestTimeout default 30000; |
|
property UserAgent: StringRAL read FUserAgent write SetUserAgent; |
Description
Methods
|
constructor Create(AOwner: TComponent); override; |
|
destructor Destroy; override; |
|
function Clone(AOwner: TComponent = nil): TRALClient; virtual; |
|
function CreateClient: TRALClientHTTP; |
|
function ExecuteSingle(ARoute: StringRAL; AMethod: TRALMethod) : TRALResponse; virtual; |
|
procedure Delete(ARoute: StringRAL; var AResponse : TRALResponse); overload; |
|
Defines method on the client: Delete. | |
|
procedure Delete(ARoute: StringRAL; AOnResponse: TRALThreadClientResponse = nil; AExecBehavior : TRALExecBehavior = ebMultiThread); overload; |
|
procedure Get(ARoute: StringRAL; AOnResponse: TRALThreadClientResponse = nil; AExecBehavior : TRALExecBehavior = ebMultiThread); overload; |
|
procedure Get(ARoute: StringRAL; var AResponse : TRALResponse); overload; |
|
Defines method on the client: Get. | |
|
procedure Patch(ARoute: StringRAL; AOnResponse: TRALThreadClientResponse = nil; AExecBehavior : TRALExecBehavior = ebMultiThread); overload; |
|
procedure Patch(ARoute: StringRAL; var AResponse : TRALResponse); overload; |
|
Defines method on the client: Patch. | |
|
procedure Post(ARoute: StringRAL; AOnResponse: TRALThreadClientResponse = nil; AExecBehavior : TRALExecBehavior = ebMultiThread); overload; |
|
procedure Post(ARoute: StringRAL; var AResponse : TRALResponse); overload; |
|
Defines method on the client: Post. | |
|
procedure Put(ARoute: StringRAL; AOnResponse: TRALThreadClientResponse = nil; AExecBehavior: TRALExecBehavior = ebMultiThread); overload; |
|
procedure Put(ARoute: StringRAL; var AResponse : TRALResponse); overload; |
|
Defines method on the client: Put. | |
|
procedure CopyProperties(ADest: TRALClient); virtual; |
|
Copy all properties of current TRALClientBase object | |
|
procedure ExecuteThread(ARoute: StringRAL; AMethod: TRALMethod; AOnResponse: TRALThreadClientResponse = nil; AExecBehavior : TRALExecBehavior = ebMultiThread); virtual; |
|
core method of the client. Must override on children. | |
|
procedure LockSession; |
|
procedure Notification(AComponent: TComponent; Operation: TOperation); override; |
|
needed to properly remove assignment in design-time. | |
|
procedure OnThreadResponse(Sender: TObject; AResponse: TRALResponse; AException: StringRAL); |
|
event called when client thread finishes | |
|
procedure SetAuthentication(AValue: TRALAuthClient); |
|
procedure SetBaseURL(AValue: TStrings); |
|
procedure SetConnectTimeout(const AValue: IntegerRAL); virtual; |
|
procedure SetEngineType(AValue: String); |
|
procedure SetKeepAlive(AValue: boolean); virtual; |
|
procedure SetRequestTimeout(AValue: IntegerRAL); virtual; |
|
procedure SetUserAgent(AValue: StringRAL); virtual; |
|
procedure UnLockSession; |
Properties
|
property Authentication: TRALAuthClient read FAuthentication write SetAuthentication; |
|
property BaseURL: TStrings read FBaseURL write SetBaseURL; |
|
property CompressType: TRALCompressType read FCompressType write FCompressType; |
|
property ConnectTimeout: IntegerRAL read FConnectTimeout write FConnectTimeout default 5000; |
|
property CriptoOptions: TRALCriptoOptions read FCriptoOptions write FCriptoOptions; |
|
property Engine: StringRAL read FEngine; |
|
property EngineType : String read FEngineType write SetEngineType; |
|
property IndexUrl: IntegerRAL read FIndexUrl write FIndexUrl; |
|
property KeepAlive: boolean read FKeepAlive write SetKeepAlive; |
|
property OnResponse: TRALThreadClientResponse read FOnResponse write FOnResponse; |
|
property Request: TRALRequest read FRequest; |
|
property RequestTimeout: IntegerRAL read FRequestTimeout write SetRequestTimeout default 30000; |
|
property UserAgent: StringRAL read FUserAgent write SetUserAgent; |
GitHub Repository
Generated by PasDoc 0.16.0.