Skip to contents

R6 TLS class.

Source: R/crew_tls.R
crew_class_tls.Rd

R6 class for TLS configuration.

Details

See crew_tls().

See also

Other tls: 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(name)

Arguments

name

Character of length 1 with the mirai compute profile.

Returns

NULL or character vector, depending on the mode.

Examples

crew_tls(mode = "automatic")
#> <crew_class_tls>
#>   Public:
#>     certificates: active binding
#>     client: function () 
#>     initialize: function (mode = NULL, key = NULL, password = NULL, certificates = NULL) 
#>     key: active binding
#>     mode: active binding
#>     password: active binding
#>     validate: function (test = TRUE) 
#>     worker: function (name) 
#>   Private:
#>     .certificates: NULL
#>     .key: NULL
#>     .mode: automatic
#>     .password: NULL
#>     .read_certificates: function () 
#>     .read_files: function (files) 
#>     .read_key: function () 
#>     .validate_mode_automatic: function () 
#>     .validate_mode_custom: function () 

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

crew_tls(mode = "automatic")
#> <crew_class_tls>
#>   Public:
#>     certificates: active binding
#>     client: function () 
#>     initialize: function (mode = NULL, key = NULL, password = NULL, certificates = NULL) 
#>     key: active binding
#>     mode: active binding
#>     password: active binding
#>     validate: function (test = TRUE) 
#>     worker: function (name) 
#>   Private:
#>     .certificates: NULL
#>     .key: NULL
#>     .mode: automatic
#>     .password: NULL
#>     .read_certificates: function () 
#>     .read_files: function (files) 
#>     .read_key: function () 
#>     .validate_mode_automatic: function () 
#>     .validate_mode_custom: function ()