Index (structured 0.4.0 API)

A C E F H J P R S T U
All Classes and Interfaces|All Packages|Serialized Form

A

accept(T) - Method in interface com.softwaremill.jox.structured.ThrowingConsumer
ActorRef<T> - Class in com.softwaremill.jox.structured
ActorRef(Sink<ThrowingConsumer<T>>) - Constructor for class com.softwaremill.jox.structured.ActorRef
apply(T) - Method in interface com.softwaremill.jox.structured.ThrowingFunction
apply(T, U) - Method in interface com.softwaremill.jox.structured.ThrowingBiFunction
ask(ThrowingFunction<T, U>) - Method in class com.softwaremill.jox.structured.ActorRef: Send an invocation to the actor and await for the result.

C

cancel() - Method in interface com.softwaremill.jox.structured.CancellableFork: Interrupts the fork, and blocks until it completes with a result.
CancellableFork<T> - Interface in com.softwaremill.jox.structured
cancelNow() - Method in interface com.softwaremill.jox.structured.CancellableFork: Interrupts the fork, and returns immediately, without waiting for the fork to complete.
com.softwaremill.jox.structured - module com.softwaremill.jox.structured
com.softwaremill.jox.structured - package com.softwaremill.jox.structured
create(Scope, T) - Static method in class com.softwaremill.jox.structured.ActorRef: The same as ActorRef.create(Scope, Object, Consumer) but with empty close action.
create(Scope, T, Consumer<T>) - Static method in class com.softwaremill.jox.structured.ActorRef: Creates a new actor ref, that is a fork in the current concurrency scope, which protects a mutable resource (`logic`) and executes invocations on it serially, one after another.

E

equals(Object) - Method in record class com.softwaremill.jox.structured.ExternalRunner: Indicates whether some other object is "equal to" this one.
externalRunner() - Method in class com.softwaremill.jox.structured.Scope: Returns a concurrency-scope-specific runner, which allows scheduling of functions to be run within the current concurrency scope, from the context of arbitrary threads (not necessarily threads that are part of the current concurrency scope).
ExternalRunner - Record Class in com.softwaremill.jox.structured
ExternalRunner(ActorRef<ExternalScheduler>) - Constructor for record class com.softwaremill.jox.structured.ExternalRunner: Creates an instance of a ExternalRunner record class.

F

fork(Callable<T>) - Method in class com.softwaremill.jox.structured.Scope: Starts a fork (logical thread of execution), which is guaranteed to complete before the enclosing Scopes.supervised(Scoped) block completes.
Fork<T> - Interface in com.softwaremill.jox.structured: A fork started using Scope.fork(java.util.concurrent.Callable<T>), Scope.forkUser(java.util.concurrent.Callable<T>), UnsupervisedScope.forkCancellable(java.util.concurrent.Callable<T>) or UnsupervisedScope.forkUnsupervised(java.util.concurrent.Callable<T>), backed by a (virtual) thread.
forkCancellable(Callable<T>) - Method in class com.softwaremill.jox.structured.UnsupervisedScope: Starts a fork (logical thread of execution), which is guaranteed to complete before the enclosing Scopes.supervised(Scoped), or Scopes.unsupervised(ScopedUnsupervised) block completes, and which can be cancelled on-demand.
forkUnsupervised(Callable<T>) - Method in class com.softwaremill.jox.structured.UnsupervisedScope: Starts a fork (logical thread of execution), which is guaranteed to complete before the enclosing Scopes.supervised(Scoped), or Scopes.unsupervised(ScopedUnsupervised) block completes.
forkUser(Callable<T>) - Method in class com.softwaremill.jox.structured.Scope: Starts a fork (logical thread of execution), which is guaranteed to complete before the enclosing Scopes.supervised(Scoped) block completes.

H

hashCode() - Method in record class com.softwaremill.jox.structured.ExternalRunner: Returns a hash code value for this object.

J

join() - Method in interface com.softwaremill.jox.structured.Fork: Blocks until the fork completes with a result.
JoxScopeExecutionException - Exception Class in com.softwaremill.jox.structured
JoxScopeExecutionException(String) - Constructor for exception class com.softwaremill.jox.structured.JoxScopeExecutionException
JoxScopeExecutionException(Throwable) - Constructor for exception class com.softwaremill.jox.structured.JoxScopeExecutionException

P

par(List<Callable<T>>) - Static method in class com.softwaremill.jox.structured.Par: Runs the given computations in parallel.
Par - Class in com.softwaremill.jox.structured
Par() - Constructor for class com.softwaremill.jox.structured.Par
parLimit(int, List<Callable<T>>) - Static method in class com.softwaremill.jox.structured.Par: Runs the given computations in parallel, with at most parallelism running in parallel at the same time.

R

race(Callable<T>, Callable<T>) - Static method in class com.softwaremill.jox.structured.Race: Returns the result of the first computation to complete successfully, or if all fail - throws the first exception.
race(Callable<T>, Callable<T>, Callable<T>) - Static method in class com.softwaremill.jox.structured.Race: Returns the result of the first computation to complete successfully, or if all fail - throws the first exception.
race(List<Callable<T>>) - Static method in class com.softwaremill.jox.structured.Race: Returns the result of the first computation to complete successfully, or if all fail - throws the first exception.
Race - Class in com.softwaremill.jox.structured
Race() - Constructor for class com.softwaremill.jox.structured.Race
raceResult(Callable<T>, Callable<T>) - Static method in class com.softwaremill.jox.structured.Race: Returns the result of the first computation to complete (either successfully or with an exception).
raceResult(Callable<T>, Callable<T>, Callable<T>) - Static method in class com.softwaremill.jox.structured.Race: Returns the result of the first computation to complete (either successfully or with an exception).
raceResult(List<Callable<T>>) - Static method in class com.softwaremill.jox.structured.Race: Returns the result of the first computation to complete (either successfully or with an exception).
run() - Method in interface com.softwaremill.jox.structured.ThrowingRunnable
run(Scope) - Method in interface com.softwaremill.jox.structured.Scoped
run(UnsupervisedScope) - Method in interface com.softwaremill.jox.structured.ScopedUnsupervised
runAsync(ThrowingConsumer<Scope>) - Method in record class com.softwaremill.jox.structured.ExternalRunner: Allows to runs the given function asynchronously, in the scope of the concurrency scope in which this runner was created.

S

scheduler() - Method in record class com.softwaremill.jox.structured.ExternalRunner: Returns the value of the scheduler record component.
Scope - Class in com.softwaremill.jox.structured: Capability granted by an Scopes.supervised(Scoped) or Scopes.unsupervised(ScopedUnsupervised) concurrency scope.
Scoped<T> - Interface in com.softwaremill.jox.structured: A functional interface, capturing a computation which runs using the Scope capability to fork computations.
ScopedUnsupervised<T> - Interface in com.softwaremill.jox.structured: A functional interface, capturing a computation which runs using the ScopedUnsupervised capability to fork computations.
Scopes - Class in com.softwaremill.jox.structured
Scopes() - Constructor for class com.softwaremill.jox.structured.Scopes
supervised(Scoped<T>) - Static method in class com.softwaremill.jox.structured.Scopes: Starts a new concurrency scope, which allows starting forks in the given code block f.

T

tell(ThrowingConsumer<T>) - Method in class com.softwaremill.jox.structured.ActorRef: Send an invocation to the actor that should be processed in the background (fire-and-forget).
ThrowingBiFunction<T,U,R> - Interface in com.softwaremill.jox.structured: BiFunction which can throw an exception.
ThrowingConsumer<T> - Interface in com.softwaremill.jox.structured: Consumer which can throw an exception.
ThrowingFunction<T,R> - Interface in com.softwaremill.jox.structured: Function which can throw an exception.
ThrowingRunnable - Interface in com.softwaremill.jox.structured: Runnable which can throw an exception.
timeout(long, Callable<T>) - Static method in class com.softwaremill.jox.structured.Race: The result of computation f, if it took less than millis ms, and a TimeoutException otherwise.
toString() - Method in record class com.softwaremill.jox.structured.ExternalRunner: Returns a string representation of this record class.

U

uninterruptible(Callable<T>) - Static method in class com.softwaremill.jox.structured.Util: Prevent f from being interrupted.
unsupervised(ScopedUnsupervised<T>) - Static method in class com.softwaremill.jox.structured.Scopes: Starts a new concurrency scope, which allows starting forks in the given code block f.
UnsupervisedScope - Class in com.softwaremill.jox.structured: Capability granted by an Scopes.unsupervised(ScopedUnsupervised) concurrency scope (as well as, via subtyping, by Scopes.supervised(Scoped)).
UnsupervisedScope() - Constructor for class com.softwaremill.jox.structured.UnsupervisedScope
unwrapAndThrow(Class<? extends T>...) - Method in exception class com.softwaremill.jox.structured.JoxScopeExecutionException: If the cause of this JoxScopeExecutionException is an instance of any of the given exceptions, it is thrown.
Util - Class in com.softwaremill.jox.structured
Util() - Constructor for class com.softwaremill.jox.structured.Util

A C E F H J P R S T U
All Classes and Interfaces|All Packages|Serialized Form