ae v0.0.3186 (2022-07-03T09:06:15Z)

HttpRequest

ae net http common

HTTP request class

class HttpRequest : HttpMessage {
string method;
string proxy;
this();
this(string url);
string resource [@property getter];
string resource [@property setter];
string host [@property getter];
string host [@property setter];
ushort protocolDefaultPort [@property getter];
ushort port [@property getter];
ushort port [@property setter];
string path [@property getter];
string queryString [@property getter];
string queryString [@property setter];
UrlParameters urlParameters [@property getter];
UrlParameters urlParameters [@property setter];
string root [@property getter];
string url [@property getter];
string baseURL [@property getter];
string proxyHost [@property getter];
ushort proxyPort [@property getter];
void parseRequestLine(string reqLine);
UrlParameters decodePostData();
string[] remoteHosts(string remoteHost);
string[string] getCookies();
}

Constructors

this
this()
Undocumented in source.
this
this(string url)
Undocumented in source.

Members

Functions

decodePostData
UrlParameters decodePostData()

Decodes submitted form data, and returns an AA of values.

getCookies
string[string] getCookies()

Basic cookie parsing

parseRequestLine
void parseRequestLine(string reqLine)

Parse the first line in a HTTP request ("METHOD /resource HTTP/1.x").

remoteHosts
deprecated string[] remoteHosts(string remoteHost)

Get list of hosts as specified in headers (e.g. X-Forwarded-For). First item in returned array is the node furthest away. Duplicates are removed. Specify socket remote address in remoteHost to add it to the list.

Properties

baseURL
string baseURL [@property getter]

Full URL without query parameters or fragment.

host
string host [@property getter]

The hostname, without the port number

host
string host [@property setter]

Sets the hostname (and the "Host" header). Must not include a port number. Does not change the previously-set port number.

path
string path [@property getter]

Path part of request (until the '?').

port
ushort port [@property getter]

Port number, from "Host" header. Defaults to protocolDefaultPort.

port
ushort port [@property setter]

Sets the port number. If it is equal to protocolDefaultPort, then it is not included in the "Host" header.

protocolDefaultPort
ushort protocolDefaultPort [@property getter]

Retrieves the default port number for the currently set protocol.

proxyHost
string proxyHost [@property getter]

The hostname part of the proxy address, if any.

proxyPort
ushort proxyPort [@property getter]

The port number of the proxy address if it specified, otherwise 80.

queryString
string queryString [@property getter]
string queryString [@property setter]

Query string part of request (atfer the '?').

resource
string resource [@property getter]

Resource part of URL (everything after the hostname)

resource
string resource [@property setter]

Set the resource part of the URL, or the entire URL. Setting the resource to a full URL will fill in the Host header, as well.

root
string root [@property getter]

URL without resource (protocol, host and port).

url
string url [@property getter]

Full URL.

urlParameters
UrlParameters urlParameters [@property getter]
UrlParameters urlParameters [@property setter]

The query string parameters.

Variables

method
string method;

HTTP method, e.g., "GET".

proxy
string proxy;

If this request is going through a HTTP proxy server, this should be set to its address.

Inherited Members

From HttpMessage

protocol
string protocol;
Undocumented in source.
protocolVersion
string protocolVersion;
Undocumented in source.
headers
Headers headers;
Undocumented in source.
data
DataVec data;
Undocumented in source.
creationTime
SysTime creationTime;
Undocumented in source.
age
Duration age [@property getter]
Undocumented in source. Be warned that the author may not have intended to support it.

Meta

Source

See Implementation

ae net http common classesenumsfunctionsstructs

Page generated by adrdox