Returns a serialization configuration, which may be set on a Socket for custom serialization and unserialization of non-system reference objects, allowing these to be sent and received between different R sessions. Once set, the functions apply to all send and receive operations performed in mode 'serial' over the Socket, or Context created from the Socket.
serial_config(class, sfunc, ufunc, vec = FALSE)a character string (or vector) of the class of object custom
serialization functions are applied to, e.g. 'ArrowTabular' or
c('torch_tensor', 'ArrowTabular').
a function (or list of functions) that accepts a reference
object inheriting from class and returns a raw vector.
a function (or list of functions) that accepts a raw vector and returns a reference object.
do not specify (retained for compatibility only and will be removed).
A list comprising the configuration. This should be set on a Socket
using opt<-() with option name "serial".
This feature utilises the 'refhook' system of R native serialization.
cfg <- serial_config("test_cls", function(x) serialize(x, NULL), unserialize)
cfg
#> [[1]]
#> [1] "test_cls"
#>
#> [[2]]
#> [[2]][[1]]
#> function (x)
#> serialize(x, NULL)
#> <environment: 0x55fd53045c10>
#>
#>
#> [[3]]
#> [[3]][[1]]
#> function (connection, refhook = NULL)
#> {
#> if (typeof(connection) != "raw" && !is.character(connection) &&
#> !inherits(connection, "connection"))
#> stop("'connection' must be a connection")
#> .Internal(unserialize(connection, refhook))
#> }
#> <bytecode: 0x55fd5304dd38>
#> <environment: namespace:base>
#>
#>
cfg <- serial_config(
c("class_one", "class_two"),
list(function(x) serialize(x, NULL), function(x) serialize(x, NULL)),
list(unserialize, unserialize)
)
cfg
#> [[1]]
#> [1] "class_one" "class_two"
#>
#> [[2]]
#> [[2]][[1]]
#> function (x)
#> serialize(x, NULL)
#> <environment: 0x55fd53045c10>
#>
#> [[2]][[2]]
#> function (x)
#> serialize(x, NULL)
#> <environment: 0x55fd53045c10>
#>
#>
#> [[3]]
#> [[3]][[1]]
#> function (connection, refhook = NULL)
#> {
#> if (typeof(connection) != "raw" && !is.character(connection) &&
#> !inherits(connection, "connection"))
#> stop("'connection' must be a connection")
#> .Internal(unserialize(connection, refhook))
#> }
#> <bytecode: 0x55fd5304dd38>
#> <environment: namespace:base>
#>
#> [[3]][[2]]
#> function (connection, refhook = NULL)
#> {
#> if (typeof(connection) != "raw" && !is.character(connection) &&
#> !inherits(connection, "connection"))
#> stop("'connection' must be a connection")
#> .Internal(unserialize(connection, refhook))
#> }
#> <bytecode: 0x55fd5304dd38>
#> <environment: namespace:base>
#>
#>
s <- socket()
opt(s, "serial") <- cfg
# provide an empty list to remove registered functions
opt(s, "serial") <- list()
close(s)