CommManagerClass {hera}R Documentation

Comm Manager class

Description

Instance of the CommManagerClass class.

Usage

CommManager

Format

An object of class CommManagerClass (inherits from R6) of length 11.

Methods

Public methods


Method new()

Usage
CommManagerClass$new(..., error_call = caller_env())
Arguments
...

currently unused

error_call

see rlang::args_error_context()


Method register_comm_target()

Usage
CommManagerClass$register_comm_target(
  target_name,
  callback = function(comm, message) {
 }
)
Arguments
target_name

name of the comm target, e.g. "jupyter.widgets"

callback

callback function taking two arguments 'comm' and 'message'.


Method unregister_comm_target()

Usage
CommManagerClass$unregister_comm_target(target_name)
Arguments
target_name

name of the comm target


Method new_comm()

Usage
CommManagerClass$new_comm(target_name, description = "")
Arguments
target_name

name of the target

description

description of the comm


Method comms()

Usage
CommManagerClass$comms()
Returns

the list of currently open comms


Method target_callback()

Usage
CommManagerClass$target_callback(target_name)
Arguments
target_name

name of the comm target

Returns

the callback for that target name


Method preserve()

Usage
CommManagerClass$preserve(comm)
Arguments
comm

Comm instance to preserve


Method release()

Usage
CommManagerClass$release(comm)
Arguments
comm

Comm instance to release


Method get_comm_info()

Usage
CommManagerClass$get_comm_info(target_name = NULL)
Arguments
target_name

name of the target to get info about all comm opens. If NULL, info for comms for all targets are returned.


Method clone()

The objects of this class are cloneable with this method.

Usage
CommManagerClass$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.


[Package hera version 0.1.1 Index]