nwsOpenWs-methods: Create and Own a netWorkSpace

In nws: R functions for NetWorkSpaces and Sleigh

Description

Create and own a netWorkSpace, if it does not already exist. If the netWorkSpace already exists, but no one owns it, then caller claims ownership of the netWorkspace. If the netWorkSpace already exists and someone already claimed the ownership of it, then caller simply makes connection to the netWorkspace.

Usage

## S4 method for signature 'nwsServer'
nwsOpenWs(.Object, wsName, space=NULL, ...)

Arguments

.Object	a nwsServer class object
wsName	name of the netWorkSpace to be created
space	a netWorkSpace class object
...	optional arguments related to the persistent state of a netWorkSpace

Details

If the space argument is not provided, nwsOpenWs creates a shared netWorkSpace with the name wsName on the server represented by .Object. Otherwise, use the existing netWorkSpace object provided by the space argument.

The optional argument persistent is a logical value indicating whether the shared netWorkSpace is persistent or not. If the netWorkSpace is persisent (persistent=TRUE), then the netWorkSpace is not deleted when the owner of the shared netWorkSpace exits. Otherwise, the netWorkSpace is deleted when its owner exits.

See Also

nwsUseWs

Examples

## Not run: 
# example 1
nwss <- nwsServer()
ws <- nwsOpenWs(nwss, "nws example")

# example 2
xs <- nwsOpenWs(nwss, wsName='nws example', space=ws)

# example 3
ys <- nwsOpenWs(nwss, "persistent space", persistent=TRUE)

## End(Not run)

nws documentation built on May 2, 2019, 8:51 a.m.