Http Client¶

1

import "std/net/http-client";

HttpClient struct¶

A blocking HTTP/1.1 client, built on the plain TCP sockets of "std/net/socket".

Every request opens its own connection, announces Connection: close and closes the connection again once the response has been read, so no connection state survives a call. Responses framed by Content-Length, by the chunked transfer coding, or by the connection close of an HTTP/1.0 server are all understood.

https URLs are carried over a TLS connection (see "std/net/tls"), with the server's certificate and host name verified on every request. trustedCaFile points that verification at a specific CA bundle instead of the operating system's default trust store, e.g. to talk to a server with a self-signed certificate in tests.

Fields¶

Constructors¶

ctor¶

1

public p HttpClient.ctor()

Constructs a client with the default timeout, message size limit and redirect budget

Methods¶

setDefaultHeader¶

1

public p HttpClient.setDefaultHeader(string name, string value)

Adds or replaces a header field that is sent with every request

Parameters

get¶

1

public f<Result<HttpResponse>> HttpClient.get(string url)

Performs a GET request

Parameters

Returns: Result<HttpResponse> — The response, or an error describing why the exchange failed

head¶

1

public f<Result<HttpResponse>> HttpClient.head(string url)

Performs a HEAD request, which yields the head of the response without its body

Parameters

Returns: Result<HttpResponse> — The response, or an error describing why the exchange failed

post¶

1

public f<Result<HttpResponse>> HttpClient.post(string url, const String& body, string contentType = CONTENT_TYPE_TEXT)

Performs a POST request

Parameters

Returns: Result<HttpResponse> — The response, or an error describing why the exchange failed

put¶

1

public f<Result<HttpResponse>> HttpClient.put(string url, const String& body, string contentType = CONTENT_TYPE_TEXT)

Performs a PUT request

Parameters

Returns: Result<HttpResponse> — The response, or an error describing why the exchange failed

patch¶

1

public f<Result<HttpResponse>> HttpClient.patch(string url, const String& body, string contentType = CONTENT_TYPE_TEXT)

Performs a PATCH request

Parameters

Returns: Result<HttpResponse> — The response, or an error describing why the exchange failed

delete¶

1

public f<Result<HttpResponse>> HttpClient.delete(string url)

Performs a DELETE request

Parameters

Returns: Result<HttpResponse> — The response, or an error describing why the exchange failed

request¶

1

public f<Result<HttpResponse>> HttpClient.request(HttpMethod method, string url, const String& body, string contentType = CONTENT_TYPE_TEXT)

Performs a request with the given method, following redirects along the way

Parameters

Returns: Result<HttpResponse> — The response, or an error describing why the exchange failed

send¶

1

public f<Result<HttpResponse>> HttpClient.send(const HttpRequest& request, const String& url)

Sends a prepared request to the given URL, following redirects along the way.

The request target, the Host field and the fields of defaultHeaders are filled in from the URL and the client configuration, so the caller only has to provide method, body and any extra header fields it cares about.

Parameters

Returns: Result<HttpResponse> — The response, or an error describing why the exchange failed