Comms - connections between the kernel and the frontend — Comm • RKernel

This R6 Class provides for bidirectional communication between the R Kernel and the Jupyter frontend, e.g. a Jupyter notebook

Usage

Comm(...)

Arguments

...: Arguments passed to the inializer

Details

Objects of this class are used to communicate to the frontend via custom messages.

Functions

Comm(): A constructor function for objects of class "CommClass"

Public fields

id: A character string, the comm id
target_name: A character string, the target
handlers: A list of handler functions
data: A list of data

Methods

Public methods

Comm$new()
Comm$open()
Comm$send()
Comm$close()
Comm$clone()

`Comm$new()`

Initialize a 'Comm' object

Usage

Comm$new(target_name, id = uuid(), handlers = list())

Arguments

target_name: A string, the name of the target
id: A string, the comm id
handlers: A list of handler functions
kernel: The relevant kernel

`Comm$open()`

Open a comm

Usage

Comm$open(data, metadata = emptyNamedList, buffers = NULL)

Arguments

data: A named list
metadata: A named list
buffers: A list of raw vectors or NULL

`Comm$send()`

Send data through a comm

Usage

Comm$send(data, metadata = emptyNamedList, buffers = NULL)

Arguments

data: A named list
metadata: A named list
buffers: A list of raw vectors or NULL

`Comm$close()`

Close a comm

Usage

Comm$close(data = emptyNamedList, metadata = emptyNamedList, buffers = NULL)

Arguments

data: A named list
metadata: A named list
buffers: A list of raw vectors or NULL

`Comm$clone()`

The objects of this class are cloneable with this method.

Usage

Comm$clone(deep = FALSE)

Arguments

deep: Whether to make a deep clone.