@spec connect(node(), atom()) :: {:ok, atom()} | {:error, atom()}

Attempt to connect to remote.

This function verifies if remote is a valid Skitter node and tries to connect to it. If the connection is successful, this functions tries to find a bound handler for the local mode. If this works, {:ok, mode} is returned, where mode is the mode of the remote runtime.

If the expected_mode argument is passed, connect/2 only connects to the remote runtime if its mode is equal to expected_mode.

The following errors may be returned if the connection does not succeed:

• {:error, :not_distributed}: the local node is not alive according to Node.alive?/0
• {:error, :not_connected}: it was not possible to connect to the remote runtime
• {:error, :not_skitter}: the remote node is not a Skitter remote
• {:error, :incompatible}: the remote node is running an incompatible version of Skitter
• {:error, :mode_mismatch}: the mode of the remote runtime is not equal to expected_mode
• {:error, :unknown_mode}: the remote or local runtime does not have a handler for the mode of the other runtime.
• The handler of the local mode may return a custom {:error, reason} tuple.

@spec connected?(node()) :: boolean()

Check if the local runtime is connected to the specified remote runtime.

@spec master() :: node()

Get the name of the master node of the cluster.

@spec n_times_on_all_workers(pos_integer(), (-> any())) :: [{node(), [any()]}]

Execute a function n times on every worker runtime.

A list of results will be returned for each worker node. These results will be returned in a keyword list of {worker, result} pairs.

@spec on(node(), (-> any())) :: any()

Execute fun on remote, block until a result is available.

@spec on(node(), module(), atom(), [any()]) :: any()

Execute mod.func(args) on remote, block until a result is available.

@spec on_all_worker_cores((-> any())) :: [{node(), [any()]}]

Execute a function on every core on every worker runtime.

A list of results will be returned for each worker node. These results will be returned in a keyword list of {worker, result} pairs.

@spec on_all_workers((-> any())) :: [{node(), any()}]

Execute a function on every worker runtime.

The result of each worker will be returned in a keyword list of {worker, result} pairs.

@spec on_all_workers(module(), atom(), [any()]) :: [{node(), any()}]

Execute a function on every worker runtime.

The result of each worker will be returned in a keyword list of {worker, result} pairs.

@spec on_many([node()], (-> any())) :: [{node(), any()}]

Execute fun on every specified remote runtime, obtain results in a list.

@spec on_many([node()], module(), atom(), [any()]) :: [{node(), any()}]

Execute mod.func(args) on every specified remote runtime, obtain results in a list.

@spec on_n(pos_integer(), (-> any())) :: [[any()]]

Execute a function n times, distributed over the available workers.

This is handy when you wish to create n workers distributed over the cluster. The work to be done will be divided over the worker nodes in a round robin fashion. This behaviour may change in the future.

@spec on_tagged_worker_cores(tag(), (-> any())) :: [{node(), any()}]

Execute a function on every core on every worker runtime tagged with tag.

The result of each worker will be returned in a keyword list of {worker, result} pairs.

@spec on_tagged_workers(tag(), (-> any())) :: [{node(), any()}]

Execute a function on every worker runtime tagged with tag.

The result of each worker will be returned in a keyword list of {worker, result} pairs.

@spec self() :: node()

Get the name of the current Skitter runtime.

@spec tags(node()) :: [tag()]

Get a list of all the tags of node().

@spec with_tag(tag()) :: [node()]

Get a list of all the worker runtimes tagged with a given tag/0.

@spec workers() :: [node()]

Get a list of the names of all the worker runtimes in the cluster.