Modules · Connectivity · Network

Network

HTTP and WebSocket clients. Network lets your program reach the web reactively: a request such as Network.Web.Client.Get returns a Network.Web.Response held in a STATE LOCKED cell — pending until the reply arrives, then flowing through the rest of your program like any other value. It covers the full range of HTTP methods, form posts, header and cookie handling, URL encoding, and live WebSocket connections. Because every call is reactive, a response re-fetches whenever the URL or inputs it reads change.

Types

Functions

Types

Network.Web.Cookie

A cookie as a name–value pair, parsed from or written to a Set-Cookie header.

Fields

Field	Type	Description
`name`	`Text`	The cookie's name.
`value`	`Text`	The cookie's value.

Definition

TYPE Network.Web.Cookie
  FIELD Text name
  FIELD Text value

A record pairing a cookie name with its value.

Example

LET Network.Web.Cookie session = Network.Web.Cookie "session" token

Builds a session cookie from a name and value.

Network.Web.Header

A single HTTP header as a name–value pair.

Fields

Field	Type	Description
`name`	`Text`	The header field name.
`value`	`Text`	The header field value.

Definition

TYPE Network.Web.Header
  FIELD Text name
  FIELD Text value

A record pairing a header name with its value.

Example

LET Network.Web.Header accept = Network.Web.Header "Accept" "application/json"

A single request header.

Network.Web.Request

A prepared HTTP request: its URL, method, optional headers and body, and reactive reload state.

Fields

Field	Type	Description
`url`	`Text`	The target URL.
`method`	`Text`	The HTTP method, such as GET or POST.
`optionalHeaders`	`Collection.Optional(Collection.Array(Network.Web.Header))`	Headers to send, if any.
`optionalBody`	`Collection.Optional(Text)`	The request body, if any.
`reloadCount`	`Maths.Integer`	How many times the request has reloaded.
`isPolling`	`Logic.Maybe`	Yes when the request re-fetches on a timer.

Definition

TYPE Network.Web.Request
  FIELD Text url
  FIELD Text method
  FIELD Collection.Optional(Collection.Array(Network.Web.Header)) optionalHeaders
  FIELD Collection.Optional(Text) optionalBody
  FIELD Maths.Integer reloadCount
  FIELD Logic.Maybe isPolling

The fields the client fills in before a request is sent.

Example

LET Text target = request.url

Reads the target URL out of a request.

Network.Web.Response

The result of an HTTP request: its status code, headers, and body. It is pending until the reply arrives, so it is usually held in a STATE LOCKED cell.

Fields

Field	Type	Description
`statusCode`	`Maths.Integer`	The HTTP status code, such as 200 or 404.
`headers`	`Collection.Array(Network.Web.Header)`	The response headers.
`responseBody`	`Text`	The response body text.

Definition

TYPE Network.Web.Response
  FIELD Maths.Integer statusCode
  FIELD Collection.Array(Network.Web.Header) headers
  FIELD Text responseBody

A record holding everything returned by a request.

Example

STATE LOCKED Network.Web.Response response = Network.Web.Client.Get "https://api.example.com/data"

A response cell, locked until the request completes.

Network.Web.Url

A parsed URL broken into its protocol, domain, port, path, and optional query and anchor.

Fields

Field	Type	Description
`protocol`	`Text`	The scheme, such as https.
`domain`	`Text`	The host name.
`port`	`Maths.Integer`	The port number.
`path`	`Text`	The path portion of the URL.
`optionalQuery`	`Collection.Optional(Collection.Map(Text))`	The query parameters, if any.
`optionalAnchor`	`Collection.Optional(Text)`	The fragment after #, if any.

Definition

TYPE Network.Web.Url
  FIELD Text protocol
  FIELD Text domain
  FIELD Maths.Integer port
  FIELD Text path
  FIELD Collection.Optional(Collection.Map(Text)) optionalQuery
  FIELD Collection.Optional(Text) optionalAnchor

A URL split into its parts.

Example

LET Text host = url.domain

Reads the domain out of a parsed URL.

Network.Websocket.Message

A single message sent or received over a WebSocket connection.

Fields

Field	Type	Description
`content`	`Text`	The message text.

Definition

TYPE Network.Websocket.Message
  FIELD Text content

A record carrying one WebSocket message.

Example

LET Text text = message.content

Reads the text of a received message.

Functions

Network.Web.Client.Delete

Sends an HTTP DELETE request.

Parameters

Name	Type	Description
`url`	`Text`	The URL to delete.
`optionalHeaders`	`Collection.Optional(Collection.Array(Network.Web.Header))`	Extra request headers, if any.

Returns

Returns Network.Web.Response — the pending response, locked until the reply arrives.

Network.Web.Client.Get

Fetches a URL with an HTTP GET request.

Parameters

Name	Type	Description
`url`	`Text`	The URL to fetch.
`optionalHeaders`	`Collection.Optional(Collection.Array(Network.Web.Header))`	Extra request headers, if any.

Returns

Returns Network.Web.Response — the pending response, locked until the reply arrives.

Example

STATE LOCKED Network.Web.Response response = Network.Web.Client.Get "https://api.example.com/users"

A GET response, locked until the request completes.

Network.Web.Client.GetPolling

Repeatedly fetches a URL on a fixed interval.

Parameters

Name	Type	Description
`url`	`Text`	The URL to poll.
`intervalMs`	`Maths.Integer`	Milliseconds between fetches.
`optionalHeaders`	`Collection.Optional(Collection.Array(Network.Web.Header))`	Extra request headers, if any.

Returns

Returns Network.Web.Response — the latest response, refreshed each interval.

Example

STATE LOCKED Network.Web.Response feed = Network.Web.Client.GetPolling "https://api.example.com/feed" 5000

Re-fetches every five seconds, updating the locked response.

Network.Web.Client.Head

Sends an HTTP HEAD request, retrieving only the headers.

Parameters

Name	Type	Description
`url`	`Text`	The URL to query.
`optionalHeaders`	`Collection.Optional(Collection.Array(Network.Web.Header))`	Extra request headers, if any.

Returns

Returns Network.Web.Response — the pending response, whose body is empty for a HEAD request.

Network.Web.Client.Options

Sends an HTTP OPTIONS request.

Parameters

Name	Type	Description
`url`	`Text`	The URL to query.
`optionalHeaders`	`Collection.Optional(Collection.Array(Network.Web.Header))`	Extra request headers, if any.

Returns

Returns Network.Web.Response — the pending response describing the server's supported methods.

Network.Web.Client.Patch

Sends an HTTP PATCH request with an optional body.

Parameters

Name	Type	Description
`url`	`Text`	The URL to send to.
`optionalBody`	`Collection.Optional(Text)`	The request body, if any.
`optionalHeaders`	`Collection.Optional(Collection.Array(Network.Web.Header))`	Extra request headers, if any.

Returns

Returns Network.Web.Response — the pending response, locked until the reply arrives.

Network.Web.Client.Post

Sends an HTTP POST request with an optional body.

Parameters

Name	Type	Description
`url`	`Text`	The URL to post to.
`optionalBody`	`Collection.Optional(Text)`	The request body, if any.
`optionalHeaders`	`Collection.Optional(Collection.Array(Network.Web.Header))`	Extra request headers, if any.

Returns

Returns Network.Web.Response — the pending response, locked until the reply arrives.

Example

STATE LOCKED Network.Web.Response result = Network.Web.Client.Post "https://api.example.com/users" body

Posts body and holds the pending response.

Network.Web.Client.PostForm

Posts URL-encoded form fields as an HTTP POST.

Parameters

Name	Type	Description
`url`	`Text`	The URL to post to.
`formFields`	`Collection.Map(Text)`	The form field names and values.

Returns

Returns Network.Web.Response — the pending response; the fields are sent as application/x-www-form-urlencoded.

Example

STATE LOCKED Network.Web.Response result = Network.Web.Client.PostForm "https://example.com/login" fields

Submits fields as a URL-encoded form.

Network.Web.Client.Put

Sends an HTTP PUT request with an optional body.

Parameters

Name	Type	Description
`url`	`Text`	The URL to send to.
`optionalBody`	`Collection.Optional(Text)`	The request body, if any.
`optionalHeaders`	`Collection.Optional(Collection.Array(Network.Web.Header))`	Extra request headers, if any.

Returns

Returns Network.Web.Response — the pending response, locked until the reply arrives.

Network.Web.Cookie.FromHeaderString

Parses a Set-Cookie header value into a cookie.

Parameters

Name	Type	Description
`headerString`	`Text`	The raw Set-Cookie header value.

Returns

Returns Network.Web.Cookie — the name and value parsed from the header.

Example

LET Network.Web.Cookie session = Network.Web.Cookie.FromHeaderString raw

Parses a raw Set-Cookie value into a cookie.

Network.Web.Cookie.OptionalValueByName

Finds the value of a named cookie among Set-Cookie header values.

Parameters

Name	Type	Description
`setCookieValues`	`Collection.Array(Text)`	The raw Set-Cookie header values.
`cookieName`	`Text`	The cookie name to look up.

Returns

Returns Collection.Optional(Text) — the matching cookie's value, or nothing when it is absent.

Network.Web.Cookie.ToHeaderString

Renders a cookie as a name=value header string.

Parameters

Name	Type	Description
`cookie`	`Network.Web.Cookie`	The cookie to render.

Returns

Returns Text — the cookie as name=value.

Network.Web.Header.Emit

Emits one header into the enclosing GatherArray block.

Parameters

Name	Type	Description
`name`	`Text`	The header name.
`value`	`Text`	The header value.

Returns

Returns nothing — it adds one header to the surrounding Network.Web.Header.GatherArray.

Example

Network.Web.Header.Emit "Authorization" token

Adds an Authorization header inside a gather block.

Network.Web.Header.GatherArray

Collects the headers emitted in its block into an array.

Block

An indented block that calls Network.Web.Header.Emit once for each header to include.

Returns

Returns Collection.Array(Network.Web.Header) — every header emitted inside the block.

Example

LET Collection.Array(Network.Web.Header) headers = Network.Web.Header.GatherArray
Network.Web.Header.Emit "Content-Type" "application/json"
Network.Web.Header.Emit "Accept" "application/json"

Gathers the emitted headers into an array.

Network.Web.Header.ValuesByName

All values of headers matching a name, case-insensitively.

Parameters

Name	Type	Description
`headers`	`Collection.Array(Network.Web.Header)`	The headers to search.
`headerName`	`Text`	The header name to match.

Returns

Returns Collection.Array(Text) — every value whose header name matches, ignoring case.

Network.Web.Response.Zero

An empty response with status code zero and no body.

Returns

Returns Network.Web.Response — a blank response, useful as the initial value of a locked cell.

Example

LET Network.Web.Response empty = Network.Web.Response.Zero

A blank response before any request runs.

Network.Web.Url.EncodeString

Percent-encodes text for safe use in a URL.

Parameters

Name	Type	Description
`unencodedString`	`Text`	The text to encode.

Returns

Returns Text — the percent-encoded text.

Example

LET Text safe = Network.Web.Url.EncodeString query

Escapes query for use in a URL.

Network.Websocket.Client.Connection

Opens a live WebSocket connection over its scope.

Parameters

Name	Type	Description
`receivedMessages`	`Collection.Array(Network.Websocket.Message)`	A state cell filled with incoming messages.
`sendMessages`	`Collection.Array(Network.Websocket.Message)`	Messages to send over the connection.
`address`	`Text`	The WebSocket URL, such as wss://…

Returns

Returns nothing — it keeps the connection open while in scope, publishing incoming messages into receivedMessages.

Example

Network.Websocket.Client.Connection received outgoing "wss://chat.example.com"

Opens a connection, filling received with incoming messages.

Network

Contents

Types

Functions

Types

Network.Web.Cookie

Fields

Definition

Example

Network.Web.Header

Fields

Definition

Example

Network.Web.Request

Fields

Definition

Example

Network.Web.Response

Fields

Definition

Example

Network.Web.Url

Fields

Definition

Example

Network.Websocket.Message

Fields

Definition

Example

Functions

Network.Web.Client.Delete

Parameters

Returns

Network.Web.Client.Get

Parameters

Returns

Example

Network.Web.Client.GetPolling

Parameters

Returns

Example

Network.Web.Client.Head

Parameters

Returns

Network.Web.Client.Options

Parameters

Returns

Network.Web.Client.Patch

Parameters

Returns

Network.Web.Client.Post

Parameters

Returns

Example

Network.Web.Client.PostForm

Parameters

Returns

Example

Network.Web.Client.Put

Parameters

Returns

Network.Web.Cookie.FromHeaderString

Parameters

Returns

Example

Network.Web.Cookie.OptionalValueByName

Parameters

Returns

Network.Web.Cookie.ToHeaderString

Parameters

Returns

Network.Web.Header.Emit

Parameters

Returns

Example

Network.Web.Header.GatherArray

Block

Returns

Example

Network.Web.Header.ValuesByName