Difference between revisions of "THTTPServerRequest"
From Ultibo.org
(Created page with "Return to Unit HTTP __TOC__ === Description === ---- ''To be documented'' === Class definitions === ---- <div class="toccolours mw-collapsible mw-collapse...") |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 36: | Line 36: | ||
|- | |- | ||
|colspan="2"| | |colspan="2"| | ||
| + | |- | ||
| + | | <code>function GetMimeType:String;</code> | ||
| + | | | ||
| + | |- | ||
| + | | <code>function GetEncoding:LongWord;</code> | ||
| + | | | ||
| + | |- | ||
| + | | <code>function GetContentSize:LongWord;</code> | ||
| + | | | ||
|- | |- | ||
| <code>function GetContentReceived:Boolean;</code> | | <code>function GetContentReceived:Boolean;</code> | ||
| + | | | ||
| + | |- | ||
| + | |colspan="2"| | ||
| + | |- | ||
| + | | <code>function GetUserAuthenticator:TAuthenticator;</code> | ||
| + | | | ||
| + | |- | ||
| + | | <code>function GetSessionAuthenticator:TAuthenticator;</code> | ||
| | | | ||
|- | |- | ||
| Line 59: | Line 76: | ||
|- | |- | ||
| <code>Params:THTTPParams;</code> | | <code>Params:THTTPParams;</code> | ||
| + | | | ||
| + | |- | ||
| + | | <code>Cookies:THTTPCookies;</code> | ||
| | | | ||
|- | |- | ||
| Line 98: | Line 118: | ||
|- | |- | ||
|colspan="2"| | |colspan="2"| | ||
| + | |- | ||
| + | | <code>property MimeType:String read GetMimeType;</code> | ||
| + | | | ||
| + | |- | ||
| + | | <code>property Encoding:LongWord read GetEncoding;</code> | ||
| + | | | ||
| + | |- | ||
| + | | <code>property ContentSize:LongWord read GetContentSize;</code> | ||
| + | | | ||
|- | |- | ||
| <code>property ContentReceived:Boolean read GetContentReceived;</code> | | <code>property ContentReceived:Boolean read GetContentReceived;</code> | ||
| + | | | ||
| + | |- | ||
| + | |colspan="2"| | ||
| + | |- | ||
| + | | <code>property UserAuthenticator:TAuthenticator read GetUserAuthenticator;</code> | ||
| + | | | ||
| + | |- | ||
| + | | <code>property SessionAuthenticator:TAuthenticator read GetSessionAuthenticator;</code> | ||
| | | | ||
|- | |- | ||
| Line 106: | Line 143: | ||
| <code>function GetParam(const AName:String):String;</code> | | <code>function GetParam(const AName:String):String;</code> | ||
| | | | ||
| + | |- | ||
| + | | <code>function GetParamExt(const AName:String; AParams:THTTPParams):String;</code> | ||
| + | | | ||
| + | |- | ||
| + | |colspan="2"| | ||
| + | |- | ||
| + | | <code>function GetCookie(const AName:String):String;</code> | ||
| + | | | ||
| + | |- | ||
| + | | <code>function GetCookieExt(const AName:String;ACookies:THTTPCookies):String;</code> | ||
| + | | | ||
| + | |- | ||
| + | |colspan="2"| | ||
|- | |- | ||
| <code>function GetHeader(const AName:String):String;</code> | | <code>function GetHeader(const AName:String):String;</code> | ||
| Line 148: | Line 198: | ||
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;"> | <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;"> | ||
<pre style="border: 0; padding-bottom:0px;">destructor THTTPServerRequest.Destroy;</pre> | <pre style="border: 0; padding-bottom:0px;">destructor THTTPServerRequest.Destroy;</pre> | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div> | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;" | ||
| + | |- | ||
| + | ! Note | ||
| + | | None documented | ||
| + | |- | ||
| + | |} | ||
| + | </div></div> | ||
| + | <br /> | ||
| + | <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;"> | ||
| + | <pre style="border: 0; padding-bottom:0px;">function THTTPServerRequest.GetMimeType:String;</pre> | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div> | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;" | ||
| + | |- | ||
| + | ! Note | ||
| + | | None documented | ||
| + | |- | ||
| + | |} | ||
| + | </div></div> | ||
| + | <br /> | ||
| + | <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;"> | ||
| + | <pre style="border: 0; padding-bottom:0px;">function THTTPServerRequest.GetEncoding:LongWord;</pre> | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div> | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;" | ||
| + | |- | ||
| + | ! Note | ||
| + | | None documented | ||
| + | |- | ||
| + | |} | ||
| + | </div></div> | ||
| + | <br /> | ||
| + | <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;"> | ||
| + | <pre style="border: 0; padding-bottom:0px;">function THTTPServerRequest.GetContentSize:LongWord;</pre> | ||
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div> | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div> | ||
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
| Line 160: | Line 246: | ||
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;"> | <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;"> | ||
<pre style="border: 0; padding-bottom:0px;">function THTTPServerRequest.GetContentReceived:Boolean;</pre> | <pre style="border: 0; padding-bottom:0px;">function THTTPServerRequest.GetContentReceived:Boolean;</pre> | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div> | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;" | ||
| + | |- | ||
| + | ! Note | ||
| + | | None documented | ||
| + | |- | ||
| + | |} | ||
| + | </div></div> | ||
| + | <br /> | ||
| + | <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;"> | ||
| + | <pre style="border: 0; padding-bottom:0px;">function THTTPServerRequest.GetUserAuthenticator:TAuthenticator;</pre> | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div> | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;" | ||
| + | |- | ||
| + | ! Note | ||
| + | | None documented | ||
| + | |- | ||
| + | |} | ||
| + | </div></div> | ||
| + | <br /> | ||
| + | <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;"> | ||
| + | <pre style="border: 0; padding-bottom:0px;">function THTTPServerRequest.GetSessionAuthenticator:TAuthenticator;</pre> | ||
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div> | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div> | ||
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
| Line 172: | Line 282: | ||
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;"> | <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;"> | ||
<pre style="border: 0; padding-bottom:0px;">function THTTPServerRequest.GetParam(const AName:String):String;</pre> | <pre style="border: 0; padding-bottom:0px;">function THTTPServerRequest.GetParam(const AName:String):String;</pre> | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div> | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;" | ||
| + | |- | ||
| + | ! Note | ||
| + | | None documented | ||
| + | |- | ||
| + | |} | ||
| + | </div></div> | ||
| + | <br /> | ||
| + | <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;"> | ||
| + | <pre style="border: 0; padding-bottom:0px;">function THTTPServerRequest.GetParamExt(const AName:String; AParams:THTTPParams):String;</pre> | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div> | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;" | ||
| + | |- | ||
| + | ! Note | ||
| + | | None documented | ||
| + | |- | ||
| + | |} | ||
| + | </div></div> | ||
| + | <br /> | ||
| + | <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;"> | ||
| + | <pre style="border: 0; padding-bottom:0px;">function THTTPServerRequest.GetCookie(const AName:String):String;</pre> | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div> | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;" | ||
| + | |- | ||
| + | ! Note | ||
| + | | None documented | ||
| + | |- | ||
| + | |} | ||
| + | </div></div> | ||
| + | <br /> | ||
| + | <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;"> | ||
| + | <pre style="border: 0; padding-bottom:0px;">function THTTPServerRequest.GetCookieExt(const AName:String; ACookies:THTTPCookies):String;</pre> | ||
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div> | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div> | ||
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
Latest revision as of 02:41, 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.GetMimeType:String;
Description: To be documented
| Note | None documented |
|---|
function THTTPServerRequest.GetEncoding:LongWord;
Description: To be documented
| Note | None documented |
|---|
function THTTPServerRequest.GetContentSize:LongWord;
Description: To be documented
| Note | None documented |
|---|
function THTTPServerRequest.GetContentReceived:Boolean;
Description: To be documented
| Note | None documented |
|---|
function THTTPServerRequest.GetUserAuthenticator:TAuthenticator;
Description: To be documented
| Note | None documented |
|---|
function THTTPServerRequest.GetSessionAuthenticator:TAuthenticator;
Description: To be documented
| Note | None documented |
|---|
function THTTPServerRequest.GetParam(const AName:String):String;
Description: To be documented
| Note | None documented |
|---|
function THTTPServerRequest.GetParamExt(const AName:String; AParams:THTTPParams):String;
Description: To be documented
| Note | None documented |
|---|
function THTTPServerRequest.GetCookie(const AName:String):String;
Description: To be documented
| Note | None documented |
|---|
function THTTPServerRequest.GetCookieExt(const AName:String; ACookies:THTTPCookies):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