nwsServer                package:nws                R Documentation

_C_l_a_s_s _R_e_p_r_e_s_e_n_t_i_n_g _T_h_e _C_o_n_n_e_c_t_i_o_n _t_o _t_h_e _N_e_t_W_o_r_k_S_p_a_c_e_s _S_e_r_v_e_r

_D_e_s_c_r_i_p_t_i_o_n:

     Class representing nwsServer.

_O_b_j_e_c_t_s _f_r_o_m _t_h_e _C_l_a_s_s:

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

     '_s_e_r_v_e_r_I_n_f_o': object of type 'serverInfo' or 'managedServerInfo'.
          If not specified, will get the return value of 'getServer'.

_S_l_o_t_s:


     '_n_w_s_S_o_c_k_e_t': Object of class '"ANY"' representation of the socket
          connection to the server.

     '_s_e_r_v_e_r_I_n_f_o': Object of class '"ANY"' representation of the
          server.

_M_e_t_h_o_d_s:


     _i_n_i_t_i_a_l_i_z_e 'signature(.Object = "nwsServer")': nwsServer class
          constructor.

     _n_w_s_D_e_l_e_t_e_W_s 'signature(.Object = "nwsServer")': delete a
          netWorkSpace from the server.

     _n_w_s_L_i_s_t_W_s_s 'signature(.Object = "nwsServer")': list all
          netWorkSpaces in the server.

     _n_w_s_M_k_t_e_m_p_W_s 'signature(.Object = "nwsServer")': create a unique
          temporary workspace using the default or specified template.

     _n_w_s_O_p_e_n_W_s 'signature(.Object = "nwsServer")': create and owned a
          netWorkSpace.

     _n_w_s_U_s_e_W_s 'signature(.Object = "nwsServer")': connect to a
          netWorkSpace but does not claim ownership.

_N_o_t_e:

     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.

_S_e_e _A_l_s_o:

     'defaultNwsServerOptions'

_E_x_a_m_p_l_e_s:

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

     # example 2
     nwss = nwsServer(serverInfo=managedServerInfo())
     ## End(Not run)

