getSharedProperties {SharedObject}R Documentation

get a summary report for a shared object

Description

The function reports the properties related to the shared object. the individual property can be accessed via $ operator.

Usage

getSharedProperties(x, as.list = FALSE)

Arguments

x

A shared object

as.list

Logical, Whether the result should be a list of shared properties even when only one sharedProperty object is reported.

Value

If x is not a shared object, return NULL.

If x is a shared vector and as.list is FALSE, the function returns a sharedProperty object.

Otherwise, the function returns a list of sharedProperty object(s).

See Also

getCopyOnWrite, getSharedSubset, getSharedCopy

Examples

x = share(1:10)
getSharedProperties(x)

[Package SharedObject version 1.0.0 Index]