netWorkSpace-class {nws}R Documentation

Class "netWorkSpace"

Description

Class representing netWorkSpace

Objects from the Class

Objects can be created by calls of the form new("netWorkSpace", wsName, serverHost, port, useUse, serverWrap, ...).

  • {bf wsName:} name of the netWorkSpace to be created.
  • {bf serverHost:} host name of the server this netWorkSpace will be connected to. By default, local machine is used.
  • {bf port:} port number of the server this netWorkSpace will be connected to. Default port number is 8765.
  • {bf useUse:} a boolean value indicating whether ownership will be claimed for this netWorkSpace. By default, useUse=FALSE, which means ownership will be claimed.
  • {bf serverWrap:} a netWorkSpaces server object. Reuse an existing server connection, instead of creating a new server connection.
  • Slots

    server:
    Object of class "nwsServer" representation of the server that this netWorkSpace connects to.
    wsName:
    Object of class "character" representation of this netWorkSpace's name.

    Methods

    initialize
    signature(.Object = "netWorkSpace"): netWorkSpace class constructor.
    nwsClose
    signature(.Object = "netWorkSpace"): close connection to the shared netWorkSpace server.
    nwsDeclare
    signature(.Object = "netWorkSpace"): declare a mode for a variable in the shared netWorkSpace.
    nwsDeleteVar
    signature(.Object = "netWorkSpace"): delete a variable from the shared netWorkSpace.
    nwsFetch
    signature(.Object = "netWorkSpace"): fetch something from the shared netWorkSpace.
    nwsFetchTry
    signature(.Object = "netWorkSpace"): attempt to fetch something from the shared netWorkSpace; a non-blocking version of fetch.
    nwsFind
    signature(.Object = "netWorkSpace"): find something from the shared netWorkSpace.
    nwsFindTry
    signature(.Object = "netWorkSpace"): attempt to find something from the shared netWorkSpace.
    nwsListVars
    signature(.Object = "netWorkSpace"): list variables in a netWorkSpace.
    nwsStore
    signature(.Object = "netWorkSpace"): store something to the shared netWorkSpace.
    nwsWsName
    signature(.Object = "netWorkSpace"): return the name of a netWorkSpace.

    Examples

    ## Not run: 
    # To create a new workspace with the name "my space" use:
    ws = new('netWorkSpace', 'my space')
    
    # To create a new workspace called "my space2" on nws server 
    # running on port 8245 on machine zeus:
    ws2 = new('netWorkSpace', wsName='my space2', serverHost='zeus', port=8245)
    ## End(Not run)
    

    [Package nws version 1.2.3 Index]