HttpClient

Wrapper around the client's request aand response.

final

static if(isWeb)

class HttpClient {

import std.conv : to;;

import vibe.d : HTTPServerRequest, HTTPServerResponse, HTTPStatusException;;

import diamond.authentication;;

import diamond.http.sessions;;

import diamond.http.cookies;;

import diamond.http.method;;

import diamond.http.status;;

import diamond.http.routing;;

import diamond.errors.checks;;

this(HTTPServerRequest request, HTTPServerResponse response);

HTTPServerRequest rawRequest [@property getter];

HTTPServerResponse rawResponse [@property getter];

Route route [@property getter];

Route route [@property setter];

bool isLastRoute [@property getter];

bool isLastRoute [@property setter];

HttpMethod method [@property getter];

HttpSession session [@property getter];

HttpCookies cookies [@property getter];

string ipAddress [@property getter];

auto requestStream [@property getter];

auto responseStream [@property getter];

bool connected [@property getter];

string path [@property getter];

string path [@property setter];

string queryString [@property getter];

auto query [@property getter];

auto httpParams [@property getter];

auto files [@property getter];

auto form [@property getter];

auto fullUrl [@property getter];

auto json [@property getter];

string contentType [@property getter];

string contentTypeParameters [@property getter];

string host [@property getter];

auto headers [@property getter];

bool tls [@property getter];

auto clientAddress [@property getter];

auto clientCertificate [@property getter];

bool redirected [@property getter];

Role role [@property getter];

HttpStatus statusCode [@property getter];

string language [@property getter];

string language [@property setter];

T getModelFromJson(CTORARGS args);

void addContext(string name, T value);

T getContext(string name, T defaultValue);

bool hasContext(string name);

void redirect(string url, HttpStatus status);

void error(HttpStatus status);

void notFound();

void unauthorized();

void login(long loginTime, Role role);

void logout();

void write(string data);

void write(ubyte[] data);

static if(loggingEnabled)

ubyte[] getBody();

}

Constructors

this this(HTTPServerRequest request, HTTPServerResponse response): Createsa new http client.

Members

Functions

addContext void addContext(string name, T value): Adds a generic context value to the client.
error void error(HttpStatus status): Throws a http status exception.
getBody ubyte[] getBody(): Gets the body data from the response stream.
getContext T getContext(string name, T defaultValue): Gets a value from the client's context.
getModelFromJson T getModelFromJson(CTORARGS args): Gets a model from the request's json.
hasContext bool hasContext(string name): Checks whether a value is present n the client's context or not.
login void login(long loginTime, Role role): Logs the client in.
logout void logout(): Logs the client out.
notFound void notFound(): Sends a 404 status.
redirect void redirect(string url, HttpStatus status): Redirects the client.
unauthorized void unauthorized(): Sends an unauthorized error
write void write(string data): Writes data to the response stream.
write void write(ubyte[] data): Writes data to the response stream.

Properties

clientAddress auto clientAddress [@property getter]: Gets the raw client address of the request.
clientCertificate auto clientCertificate [@property getter]: Gets the client certificate from the request.
connected bool connected [@property getter]: Gets a boolean determnining whether the response is connected or not.
contentType string contentType [@property getter]: Gets the content type from the request.
contentTypeParameters string contentTypeParameters [@property getter]: Gets the content type parameters from the request.
cookies HttpCookies cookies [@property getter]: Gets the cookies.
files auto files [@property getter]: Gets the files from the request.
form auto form [@property getter]: Gets the form from the request.
fullUrl auto fullUrl [@property getter]: Gets the full url from the request.
headers auto headers [@property getter]: Gets the headers from the request.
host string host [@property getter]: Gets the host from the request.
httpParams auto httpParams [@property getter]: Gets the generic http parameters.
ipAddress string ipAddress [@property getter]: Gets the ip address.
isLastRoute bool isLastRoute [@property getter]: Gets a boolean determining whether it's the client's last route to handle.
isLastRoute bool isLastRoute [@property setter]: Sets a boolean determining whether it's the client's last route to handle.
json auto json [@property getter]: Gets the json from the request.
language string language [@property getter]: Gets the language of the client.
language string language [@property setter]: Sets the language of the client.
method HttpMethod method [@property getter]: Gets the method.
path string path [@property getter]: Gets the path.
path string path [@property setter]: Sets the path of the client.
query auto query [@property getter]: Gets a mapped query of the query string.
queryString string queryString [@property getter]: Gets the query string.
rawRequest HTTPServerRequest rawRequest [@property getter]: Gets the raw vibe.d request.
rawResponse HTTPServerResponse rawResponse [@property getter]: Gets the raw vibe.d response.
redirected bool redirected [@property getter]: Boolean determining whether the client has been redirected or not.
requestStream auto requestStream [@property getter]: Gets the raw request stream.
responseStream auto responseStream [@property getter]: Gets the raw response stream.
role Role role [@property getter]: Gets the role associated with the client.
route Route route [@property getter]: Gets the route.
route Route route [@property setter]: Sets the route.
session HttpSession session [@property getter]: Gets the session.
statusCode HttpStatus statusCode [@property getter]: Gets the status code of the response.
tls bool tls [@property getter]: Gets a boolean determnining whether the request was done over a secure tls protocol.

Meta

Source

See Implementation

diamond http client classes

HttpClient