freePort

Find a TCP port that can be opened

Utility functions that enhance the 'parallel' package and support the built-in parallel backends of the 'future' package.  For example, availableCores() gives the number of CPU cores available to your R process as given by the operating system, 'cgroups' and Linux containers, R options, and environment variables, including those set by job schedulers on high-performance compute clusters. If none is set, it will fall back to parallel::detectCores(). Another example is makeClusterPSOCK(), which is backward compatible with parallel::makePSOCKcluster() while doing a better job in setting up remote cluster workers without the need for configuring the firewall to do port-forwarding to your local computer.

Henrik Bengtsson

parallelly

Enhancing the 'parallel' Package

Mike Cheng

freePort function

<dl><dt>ports</dt>
<dd>(integer vector, or character string)
Zero or more TCP ports in [0, 65535] to scan.
If <code>"random"</code>, then a random set of ports is considered.
If <code>"auto"</code>, then the port given by environment variable
<code class="env">R_PARALLEL_PORT</code> is used, which may also specify <code>random</code>.</dd>
<dt>default</dt>
<dd>(integer) <code>NA_integer_</code> or a port to returned if
an available port could not be found.
If <code>"first"</code>, then <code>ports[1]</code>. If <code>"random"</code>, then a random port
among <code>ports</code> is used. If <code>length(ports) == 0</code>, then <code>NA_integer_</code>.</dd>
<dt>randomize</dt>
<dd>(logical) If TRUE, <code>ports</code> is randomly shuffled
before searched. This shuffle does not forward the RNG seed.</dd></dl>

Arguments

Find a TCP port that can be opened — freePort

<dl>

<dt>ports</dt>
<dd>(integer vector, or character string)
Zero or more TCP ports in [0, 65535] to scan.
If <code>"random"</code>, then a random set of ports is considered.
If <code>"auto"</code>, then the port given by environment variable
<code class="env">R_PARALLEL_PORT</code> is used, which may also specify <code>random</code>.</dd>


<dt>default</dt>
<dd>(integer) <code>NA_integer_</code> or a port to returned if
an available port could not be found.
If <code>"first"</code>, then <code>ports[1]</code>. If <code>"random"</code>, then a random port
among <code>ports</code> is used. If <code>length(ports) == 0</code>, then <code>NA_integer_</code>.</dd>


<dt>randomize</dt>
<dd>(logical) If TRUE, <code>ports</code> is randomly shuffled
before searched. This shuffle does not forward the RNG seed.</dd>

</dl>

freePort: Find a TCP port that can be opened

Description

Usage

Value

Arguments