R Interface

YggInterface

Create an object for sending/receiving messages to/from an yggdrasil channel.

Description

This function wraps functions from yggdrasil’s Python interface, so refer to that documentation for additional details.

Usage

YggInterface(type, ...)

Arguments

Argument

Description

type

The name of the Python interface that should be called (e.g. YggInput, YggOutput, YggRpcClient, YggRpcServer, YggTimesync)

...

Additional parameters will be passed to the Python interface function.

Value

A Python comm that can be used to send/receive messages via send/recv methods.

Examples

in_channel = YggInterface('YggInput', 'input_channel_name')
# Use zeallot '%<-%' syntax to expand multiple variables
c(flag, input) %<-% in_channel$recv()

out_channel = YggInterface('YggOutput', 'output_channel_name')
flag <- out_channel$send(output1, output2, ...)