HTTPServerRequest

Represents a HTTP request as received by the server side.

final

class HTTPServerRequest : HTTPRequest {

import std.variant : Variant;;

struct DictionaryList(VALUE, bool case_sensitive = true, size_t NUM_STATIC_FIELDS = 32, bool USE_HASHSUM = false) via import vibe.utils.dictionarylist : DictionaryList;;

NetworkAddress clientAddress;

TLSCertificateInformation clientCertificate;

InetPath requestPath;

string username;

string password;

string queryString;

DictionaryList!(string, true, 8) params;

DictionaryList!(Variant, true, 2) context;

InputStream bodyReader;

Session session;

this(SysTime time, ushort port);

string peer [@property getter];

string path();

CookieValueMap cookies [@property getter];

FormFields query [@property getter];

Json json [@property getter];

FormFields form [@property getter];

FilePartFormFields files [@property getter];

SysTime timeCreated [@property getter];

URL fullURL [@property getter];

string rootDir [@property getter];

}

Constructors

this this(SysTime time, ushort port): Undocumented in source.

Members

Functions

path deprecated string path(): The path part of the URL.

Properties

cookies CookieValueMap cookies [@property getter]: Contains the list of cookies that are stored on the client.
files FilePartFormFields files [@property getter]: Contains information about any uploaded file for a HTML _form request.
form FormFields form [@property getter]: Contains the parsed parameters of a HTML POST form request.
fullURL URL fullURL [@property getter]: The full URL that corresponds to this request.
json Json json [@property getter]: Contains the parsed Json for a JSON request.
peer string peer [@property getter]: The IP address of the client in string form
query FormFields query [@property getter]: Contains all _form fields supplied using the query string.
rootDir string rootDir [@property getter]: The relative path to the root folder.
serverSettings const(HTTPServerSettings) serverSettings [@property getter]: The settings of the server serving this request.
timeCreated SysTime timeCreated [@property getter]: Time when this request started processing.

Variables

bodyReader InputStream bodyReader;: Supplies the request body as a stream.
clientAddress NetworkAddress clientAddress;: The IP address of the client
clientCertificate TLSCertificateInformation clientCertificate;: Information about the TLS certificate provided by the client.
context DictionaryList!(Variant, true, 2) context;: A map of context items for the request.
noLog bool noLog;: Determines if the request should be logged to the access log file.
params DictionaryList!(string, true, 8) params;: A map of general parameters for the request.
password string password;: The password part of the URL, if present.
queryString string queryString;: The _query string part of the URL.
requestPath InetPath requestPath;: The path part of the requested URI.
session Session session;: The current Session object.
tls bool tls;: Determines if the request was issued over an TLS encrypted channel.
username string username;: The user name part of the URL, if present.

Meta

Source

See Implementation