Difference between revisions of "THTTPServerRequest"

From Ultibo.org
Jump to: navigation, search
(Created page with "Return to Unit HTTP __TOC__ === Description === ---- ''To be documented'' === Class definitions === ---- <div class="toccolours mw-collapsible mw-collapse...")
 
Line 36: Line 36:
 
|-
 
|-
 
|colspan="2"|&nbsp;
 
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function GetMimeType:String;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetEncoding:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetContentSize:LongWord;</code>
 +
| &nbsp;
 
|-
 
|-
 
| <code>function GetContentReceived:Boolean;</code>
 
| <code>function GetContentReceived:Boolean;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function GetUserAuthenticator:TAuthenticator;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetSessionAuthenticator:TAuthenticator;</code>
 
| &nbsp;
 
| &nbsp;
 
|-
 
|-
Line 59: Line 76:
 
|-
 
|-
 
| <code>Params:THTTPParams;</code>
 
| <code>Params:THTTPParams;</code>
 +
| &nbsp;
 +
|-
 +
| <code>Cookies:THTTPCookies;</code>
 
| &nbsp;
 
| &nbsp;
 
|-
 
|-
Line 98: Line 118:
 
|-
 
|-
 
|colspan="2"|&nbsp;
 
|colspan="2"|&nbsp;
 +
|-
 +
| <code>property MimeType:String read GetMimeType;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property Encoding:LongWord read GetEncoding;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property ContentSize:LongWord read GetContentSize;</code>
 +
| &nbsp;
 
|-
 
|-
 
| <code>property ContentReceived:Boolean read GetContentReceived;</code>
 
| <code>property ContentReceived:Boolean read GetContentReceived;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>property UserAuthenticator:TAuthenticator read GetUserAuthenticator;</code>
 +
| &nbsp;
 +
|-
 +
| <code>property SessionAuthenticator:TAuthenticator read GetSessionAuthenticator;</code>
 
| &nbsp;
 
| &nbsp;
 
|-
 
|-
Line 106: Line 143:
 
| <code>function GetParam(const AName:String):String;</code>
 
| <code>function GetParam(const AName:String):String;</code>
 
| &nbsp;
 
| &nbsp;
 +
|-
 +
| <code>function GetParamExt(const AName:String; AParams:THTTPParams):String;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>function GetCookie(const AName:String):String;</code>
 +
| &nbsp;
 +
|-
 +
| <code>function GetCookieExt(const AName:String;ACookies:THTTPCookies):String;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 
|-
 
|-
 
| <code>function GetHeader(const AName:String):String;</code>
 
| <code>function GetHeader(const AName:String):String;</code>

Revision as of 00:00, 24 October 2025

Return to Unit HTTP


Description


To be documented

Class definitions



THTTPServerRequest = class(TObject)

public
constructor Create(AThread:TWinsock2TCPServerThread);  
destructor Destroy; override;  
private
FFlags:LongWord;  
FThread:TWinsock2TCPServerThread;  
 
function GetMimeType:String;  
function GetEncoding:LongWord;  
function GetContentSize:LongWord;  
function GetContentReceived:Boolean;  
 
function GetUserAuthenticator:TAuthenticator;  
function GetSessionAuthenticator:TAuthenticator;  
protected
FListener:THTTPListener;  
public
URL:String;  
Method:LongWord;  
Version:LongWord;  
 
Params:THTTPParams;  
Cookies:THTTPCookies;  
Headers:THTTPHeaders;  
 
Protocol:String;  
Host:String;  
Port:String;  
Path:String;  
Query:String;  
 
BasePath:String; The base path of the document or alias matched to this request
BaseHost:String; The base name of the host or alias matched to this request
 
property Flags:LongWord read FFlags;  
property Thread:TWinsock2TCPServerThread read FThread;  
 
property MimeType:String read GetMimeType;  
property Encoding:LongWord read GetEncoding;  
property ContentSize:LongWord read GetContentSize;  
property ContentReceived:Boolean read GetContentReceived;  
 
property UserAuthenticator:TAuthenticator read GetUserAuthenticator;  
property SessionAuthenticator:TAuthenticator read GetSessionAuthenticator;  
 
function GetParam(const AName:String):String;  
function GetParamExt(const AName:String; AParams:THTTPParams):String;  
 
function GetCookie(const AName:String):String;  
function GetCookieExt(const AName:String;ACookies:THTTPCookies):String;  
 
function GetHeader(const AName:String):String;  
function GetHeaderEx(const AName:String):TStringList;  
 
function FindHeader(const AName,AValue:String):Boolean;  
 
function ReadContentStream(AContent:TStream; ASize:LongWord):Boolean;  
function ReadContentString(var AContent:String; ASize:LongWord):Boolean;  


Function declarations



constructor THTTPServerRequest.Create(AThread:TWinsock2TCPServerThread);
Description: To be documented
Note None documented


destructor THTTPServerRequest.Destroy;
Description: To be documented
Note None documented


function THTTPServerRequest.GetContentReceived:Boolean;
Description: To be documented
Note None documented


function THTTPServerRequest.GetParam(const AName:String):String;
Description: To be documented
Note None documented


function THTTPServerRequest.GetHeader(const AName:String):String;
Description: To be documented
Note None documented


function THTTPServerRequest.GetHeaderEx(const AName:String):TStringList;
Description: To be documented
Note None documented


function THTTPServerRequest.FindHeader(const AName,AValue:String):Boolean;
Description: To be documented
Note None documented


function THTTPServerRequest.ReadContentStream(AContent:TStream; ASize:LongWord):Boolean;
Description: To be documented
Note None documented


function THTTPServerRequest.ReadContentString(var AContent:String; ASize:LongWord):Boolean;
Description: To be documented
Note None documented


Return to Unit Reference