host_url: URL Constructors

In mirai: Minimalist Async Evaluation Framework for R

URL Constructors

Description

host_url() constructs a valid host URL (at which daemons may connect) based on the computer's IP address. This may be supplied directly to the url argument of daemons().

local_url() constructs a URL suitable for local daemons, or for use with SSH tunnelling. This may be supplied directly to the url argument of daemons().

Usage

host_url(tls = FALSE, port = 0)

local_url(tcp = FALSE, port = 0)

Arguments

tls	[default FALSE] logical value whether to use TLS in which case the scheme used will be 'tls+tcp://'.
port	[default 0] numeric port to use. 0 is a wildcard value that automatically assigns a free ephemeral port. For host_url, this port should be open to connections from the network addresses the daemons are connecting from. For local_url, is only taken into account if tcp = TRUE.
tcp	[default FALSE] logical value whether to use a TCP connection. This must be used for SSH tunnelling.

Details

host_url() will return a vector of URLs if multiple network adapters are in use, and each will be named by the interface name (adapter friendly name on Windows). If this entire vector is passed to the url argument of functions such as daemons(), the first URL is used. If no suitable IP addresses are detected, the computer's hostname will be used as a fallback.

local_url() generates a random URL for the platform's default inter-process communications transport: abstract Unix domain sockets on Linux, Unix domain sockets on MacOS, Solaris and other POSIX platforms, and named pipes on Windows.

Value

A character vector (comprising a valid URL or URLs), named for host_url().

Examples

host_url()
host_url(tls = TRUE)
host_url(tls = TRUE, port = 5555)

local_url()
local_url(tcp = TRUE)
local_url(tcp = TRUE, port = 5555)

mirai documentation built on June 8, 2025, 12:53 p.m.