ocap {Rserve}

Object Capability (OCAP) Functions

Description

The following functions are only meaningful when used by code that is run inside Rserve in object-capability (OCAP) mode. See Rserve Wiki for details.

ocap registers a function as a capability and returns the reference.

resolve.ocap takes a capability reference and returns the function representing the capability.

Rserve.context retrieves or sets the current context for out-of-band (OOB) messages (see also Rserve.eval for specifying contexts during evaluation).

Usage

ocap(fun, name = deparse(substitute(fun)))
resolve.ocap(ocap)
Rserve.context(what)

Arguments

fun

function to register

name

description of the function, only for informational and logging purposes

ocap

reference previously obtained by a call to ocap

what

if present, sets the context to the supplied value. If missing, the function returns the current context

Value

ocap returns the new capability reference, it will be an object of the class "OCref".

resolve.ocap returns the function corresponding to the reference or NULL if the reference does not exist. It will raise an error if ocap is not a valid "OCref" object.

Rserve.context returns the current context

Author(s)

Simon Urbanek