nwsServer {nws}R Documentation

Class Representing The Connection to the NetWorkSpaces Server

Description

Class representing nwsServer.

Objects from the Class

Objects can be created by calls of the form
nwsServer(...)
or
new("nwsServer", ...)
where '...' can be one or more of the following named arguments:

serverInfo:
object of type serverInfo or managedServerInfo. If not specified, will get the return value of getServer.

Slots

nwsSocket:
Object of class "ANY" representation of the socket connection to the server.
serverInfo:
Object of class "ANY" representation of the server.

Methods

initialize
signature(.Object = "nwsServer"): nwsServer class constructor.
nwsDeleteWs
signature(.Object = "nwsServer"): delete a netWorkSpace from the server.
nwsListWss
signature(.Object = "nwsServer"): list all netWorkSpaces in the server.
nwsMktempWs
signature(.Object = "nwsServer"): create a unique temporary workspace using the default or specified template.
nwsOpenWs
signature(.Object = "nwsServer"): create and owned a netWorkSpace.
nwsUseWs
signature(.Object = "nwsServer"): connect to a netWorkSpace but does not claim ownership.

Note

The constructor still supports the serverHost and port arguements, but as of release 2.0, they are deprecated and will be removed in 4.0. The legacy descriptions are:

serverHost: server host name. Default value is "localhost".

port: server port number. Default value is 8765.

If the user specifies both one or more deprecated options and a serverInfo object, the deprecated option(s) will be ignored.

See Also

defaultNwsServerOptions

Examples

## Not run: 
# example 1
nwss = nwsServer()
# Or,
nwss = new("nwsServer")

# example 2
nwss = nwsServer(serverInfo=managedServerInfo())

## End(Not run)

[Package nws version 2.0.0.3 Index]