Module com.softwaremill.jox.structured

Package com.softwaremill.jox.structured

Class Scope

java.lang.Object

com.softwaremill.jox.structured.UnsupervisedScope

com.softwaremill.jox.structured.Scope

public class Scope
extends UnsupervisedScope

Capability granted by an Scopes.supervised(Scoped) or Scopes.unsupervised(ScopedUnsupervised) concurrency scope.

Represents a capability to fork supervised or unsupervised, asynchronously running computations in a concurrency scope. Such forks can be created using fork(java.util.concurrent.Callable<T>), forkUser(java.util.concurrent.Callable<T>), UnsupervisedScope.forkCancellable(java.util.concurrent.Callable<T>) or UnsupervisedScope.forkUnsupervised(java.util.concurrent.Callable<T>).

See Also:

• ScopedUnsupervised

Method Summary

Modifier and Type	Method	Description
<T> Fork<T>	fork(Callable<T> f)	Starts a fork (logical thread of execution), which is guaranteed to complete before the enclosing Scopes.supervised(Scoped) block completes.
<T> Fork<T>	forkUser(Callable<T> f)	Starts a fork (logical thread of execution), which is guaranteed to complete before the enclosing Scopes.supervised(Scoped) block completes.

Methods inherited from class com.softwaremill.jox.structured.UnsupervisedScope

forkCancellable, forkUnsupervised

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

fork

public <T> Fork<T> fork(Callable<T> f)

Starts a fork (logical thread of execution), which is guaranteed to complete before the enclosing Scopes.supervised(Scoped) block completes.

The fork behaves as a daemon thread. That is, if the body of the scope completes successfully, and all other user forks (created using forkUser(Callable)) complete successfully, the scope will end, cancelling all running forks (including this one, if it's still running). That is, successful completion of this fork isn't required to end the scope.

An exception thrown while evaluating f will cause the fork to fail and the enclosing scope to end (cancelling all other running forks).

For alternate behaviors regarding ending the scope, see forkUser(java.util.concurrent.Callable<T>), UnsupervisedScope.forkCancellable(java.util.concurrent.Callable<T>) and UnsupervisedScope.forkUnsupervised(java.util.concurrent.Callable<T>).

forkUser

public <T> Fork<T> forkUser(Callable<T> f)

Starts a fork (logical thread of execution), which is guaranteed to complete before the enclosing Scopes.supervised(Scoped) block completes.

The fork behaves as a user-level thread. That is, the scope won't end until the body of the scope, and all other user forks (including this one) complete successfully. That is, successful completion of this fork is required to end the scope.

An exception thrown while evaluating f will cause the enclosing scope to end (cancelling all other running forks).

For alternate behaviors regarding ending the scope, see fork(java.util.concurrent.Callable<T>), UnsupervisedScope.forkCancellable(java.util.concurrent.Callable<T>) and UnsupervisedScope.forkUnsupervised(java.util.concurrent.Callable<T>).