crew_class_tls: 'R6' TLS class.

crew_class_tlsR Documentation

R6 TLS class.

Description

R6 class for TLS configuration.

Details

See crew_tls().

Active bindings

mode

See crew_tls().

key

See crew_tls().

password

See crew_tls().

certificates

See crew_tls().

Methods

Public methods


Method new()

TLS configuration constructor.

Usage
crew_class_tls$new(
  mode = NULL,
  key = NULL,
  password = NULL,
  certificates = NULL
)
Arguments
mode

Argument passed from crew_tls().

key

Argument passed from crew_tls().

password

Argument passed from crew_tls().

certificates

Argument passed from crew_tls().

Returns

An R6 object with TLS configuration.

Examples
crew_tls(mode = "automatic")

Method validate()

Validate the object.

Usage
crew_class_tls$validate(test = TRUE)
Arguments
test

Logical of length 1, whether to test the TLS configuration with nanonext::tls_config().

Returns

NULL (invisibly).


Method client()

TLS credentials for the crew client.

Usage
crew_class_tls$client()
Returns

NULL or character vector, depending on the mode.


Method worker()

TLS credentials for crew workers.

Usage
crew_class_tls$worker(profile)
Arguments
profile

Character of length 1 with the mirai compute profile.

Returns

NULL or character vector, depending on the mode.


Method url()

Form the URL for crew worker connections.

Usage
crew_class_tls$url(host, port)
Arguments
host

Character string with the host name or IP address.

port

Non-negative integer with the port number (0 to let NNG select a random ephemeral port).

Returns

Character string with the URL.

See Also

Other tls: crew_tls()

Examples

crew_tls(mode = "automatic")

## ------------------------------------------------
## Method `crew_class_tls$new`
## ------------------------------------------------

crew_tls(mode = "automatic")

wlandau/crew documentation built on Feb. 8, 2025, 10:12 a.m.