Comm {hera} | R Documentation |
Comm class
Description
Comm class
Comm class
Active bindings
id
id of the comm. read only.
target_name
name of the target for this comm
Methods
Public methods
Method new()
Usage
Comm$new(xp, description = "")
Arguments
xp
external pointer to an instance of the C++ class 'xeus::xcomm'
description
description of this comm
Method open()
Usage
Comm$open(data = NULL, metadata = NULL)
Arguments
data
data
metadata
metadata
Method close()
Usage
Comm$close(data = NULL, metadata = NULL)
Arguments
data
data
metadata
metadata
Method send()
Usage
Comm$send(data = NULL, metadata = NULL)
Arguments
data
data
metadata
metadata
Method on_close()
Usage
Comm$on_close(handler)
Arguments
handler
function to call when the comm is closed
Method on_message()
Usage
Comm$on_message(handler)
Arguments
handler
function to call when receiving a message
Method print()
Usage
Comm$print()
Returns
information about the comm
Method clone()
The objects of this class are cloneable with this method.
Usage
Comm$clone(deep = FALSE)
Arguments
deep
Whether to make a deep clone.
[Package hera version 0.1.1 Index]