Begin Communication Node

This function starts a communication node at the machine on which it is run. The communication node exists as a message queue running on a separate thread. Received messages are stored in a local queue and may be retrieved via the receive function.

start(address = NULL, port = 0L, threads = getOption("orcv.cores", 4L))

Arguments

address

A character address for the communication node to be reachable by. Leave NULL for localhost.

port

Integer port to bind to.

threads

Number of threads made available to the listening queue. Controlled by the "orcv.cores" option.

Value

An invisible 0L if no error.

See also

receive, send

Examples

##---- Should be DIRECTLY executable !! ----
##-- ==>  Define data, use random,
##--  or do  help(data=index)  for the standard data sets.

## The function is currently defined as
function (address = NULL, port = 0L, threads = getOption("orcv.cores", 
    4L)) 
{
    stopifnot(is.character(address) || is.null(address))
    res <- .Call(C_start, address, as.integer(port), as.integer(threads))
    ORCV_GLOBAL$STARTED <- TRUE
    invisible(res)
  }
#> function (address = NULL, port = 0L, threads = getOption("orcv.cores", 
#>     4L)) 
#> {
#>     stopifnot(is.character(address) || is.null(address))
#>     res <- .Call(C_start, address, as.integer(port), as.integer(threads))
#>     ORCV_GLOBAL$STARTED <- TRUE
#>     invisible(res)
#>   }
#> <environment: 0x55fcec8a7780>