server: Server Launcher

Description Usage Arguments Details Value

Description

Launcher for the remoter server.

Usage

1
2
3
server(port = 55555, password = NULL, maxretry = 5,
  secure = has.sodium(), log = TRUE, verbose = FALSE, showmsg = FALSE,
  userpng = TRUE, sync = TRUE)

Arguments

port

The port (number) that will be used for communication between the client and server. The port value for the client and server must agree. If the value is 0, then a random open port will be selected.

password

A password the client must enter before the user can process commands on the server. If the value is NULL, then no password checking takes place.

maxretry

The maximum number of retries for passwords before shutting everything down.

secure

Logical; enables encryption via public key cryptography of the 'sodium' package is available.

log

Logical; enables some basic logging in the server.

verbose

Logical; enables the verbose logger.

showmsg

Logical; if TRUE, messages from the client are logged.

userpng

Logical; if TRUE, rpng is set as the default device for displaying.

sync

Logical; if TRUE, the client will have str()'d versions of server objects recreated in the global environment. This is useful in IDE's like RStudio, but it carries a performance penalty. For terminal users, this is not recommended.

Details

By a 'secure' server, we mean one that encrypts messages it sends and only accepts encrypted messages. Encryption uses public key cryptography, using the 'sodium' package.

If the 'sodium' package is available to the server, then by default the server will be secure. If the package is not available, then you will not be able to start a secure server. If the server is secure, then a client can only connect if the client has the 'sodium' package available.

Value

Returns TRUE invisibly on successful exit.


remoter documentation built on May 2, 2019, 6:12 a.m.