Index (swim-concurrent 4.0.0 API)

A B C D E F G H I M N P R S T U W
All Classes All Packages

A

AbstractTask - Class in swim.concurrent: Skeletal implementation of a stateful Task.
AbstractTask() - Constructor for class swim.concurrent.AbstractTask
AbstractTimer - Class in swim.concurrent: Skeletal implementation of a stateful Timer.
AbstractTimer() - Constructor for class swim.concurrent.AbstractTimer
add(T, float) - Method in class swim.concurrent.ConcurrentTrancheQueue
async(Cont<T>, T) - Static method in interface swim.concurrent.Cont: Returns a Runnable that, when executed, invokes the given continuation with the provided constant value.
await() - Method in class swim.concurrent.Sync: Waits an unbounded amount of time for this Sync continuation to complete.
await(long) - Method in class swim.concurrent.Sync: Waits a maximum of timeout milliseconds for this Sync continuation to complete.

B

bind(T) - Method in interface swim.concurrent.Call: Completes this Call with a value by eventually invoking the bind(T) method of this Call's Continuation.
bind(T) - Method in interface swim.concurrent.Cont: Invoked when the asynchronous operation completes with a value.
bind(T) - Method in class swim.concurrent.Sync
block() - Method in class swim.concurrent.Sync

C

call(Cont<T>) - Method in class swim.concurrent.SideStage
call(Cont<T>) - Method in interface swim.concurrent.Stage: Returns a Call that completes the continuation.
call(Cont<T>) - Method in class swim.concurrent.Theater
Call<T> - Interface in swim.concurrent: Handle used to eventually complete an asynchronous operation by invoking a Continuation.
callDidBind(Cont<?>, T) - Method in class swim.concurrent.Theater: Introspection callback invoked immediately after a call to cont.bind(value) returns nominally.
callDidFail(Cont<?>, Throwable) - Method in class swim.concurrent.Theater: Introspection callback invoked immediately after a call to cont.bind(T) fails by throwing an error.
callDidTrap(Cont<?>, Throwable) - Method in class swim.concurrent.Theater: Introspection callback invoked immediately after a call to cont.trap(error) returns nominally.
callWillBind(Cont<T>, T) - Method in class swim.concurrent.Theater: Introspection callback invoked immediately before a call to cont.bind(value).
callWillCue(Cont<?>) - Method in class swim.concurrent.Theater: Introspection callback invoked before a cont call is cued for execution.
callWillTrap(Cont<?>, Throwable) - Method in class swim.concurrent.Theater: Introspection callback invoked immediately before a call to cont.trap(error).
cancel() - Method in class swim.concurrent.AbstractTask: Cancels this task to prevent it from executing.
cancel() - Method in class swim.concurrent.AbstractTimer: Cancels this timer to prevent it from executing.
cancel() - Method in interface swim.concurrent.TaskContext: Cancels the task to prevent it from executing.
cancel() - Method in interface swim.concurrent.TaskRef: Cancels the task to prevent it from executing.
cancel() - Method in interface swim.concurrent.TimerContext: Cancels the timer to prevent it from executing.
cancel() - Method in interface swim.concurrent.TimerRef: Cancels the timer to prevent it from executing.
Clock - Class in swim.concurrent: Hashed wheel timer Schedule.
Clock() - Constructor for class swim.concurrent.Clock: Constructs a new Clock with a timer resolution of Clock.TICK_MILLIS milliseconds, and a clock period of Clock.TICK_COUNT ticks per revolution.
Clock(int, int) - Constructor for class swim.concurrent.Clock: Constructs a new Clock with a timer resolution of tickMillis milliseconds, and a clock period of tickCount ticks per revolution.
Clock(ClockDef) - Constructor for class swim.concurrent.Clock: Constructs a new Clock with the timer resolution and clock period specified by the given clockDef.
ClockDef - Class in swim.concurrent
ClockDef(int, int) - Constructor for class swim.concurrent.ClockDef
clockForm() - Static method in class swim.concurrent.ClockDef
ConcurrentTrancheQueue<T> - Class in swim.concurrent
ConcurrentTrancheQueue(int) - Constructor for class swim.concurrent.ConcurrentTrancheQueue
constant(Cont<T>, T) - Static method in interface swim.concurrent.Cont: Returns a Continuation that, when completed successfully, completes the given continuation with the provided constant value; and when failed with an error, fails the given continuation with the error.
cont() - Method in interface swim.concurrent.Call: Returns the Continuation that this Call completes.
Cont<T> - Interface in swim.concurrent: Continuation of an asynchronous operation.
ContException - Exception in swim.concurrent: Thrown when performing an invalid operation on a Call or Continuation.
ContException() - Constructor for exception swim.concurrent.ContException
ContException(String) - Constructor for exception swim.concurrent.ContException
ContException(String, Throwable) - Constructor for exception swim.concurrent.ContException
ContException(Throwable) - Constructor for exception swim.concurrent.ContException
copy(int, int) - Method in class swim.concurrent.ClockDef
copy(String, int, ScheduleDef) - Method in class swim.concurrent.TheaterDef
cue() - Method in class swim.concurrent.AbstractTask: Schedules this task to execute as a sequential process.
cue() - Method in interface swim.concurrent.TaskContext: Schedules the task to execute as a sequential process.
cue() - Method in interface swim.concurrent.TaskRef: Schedules the task to execute as a sequential process.

D

debug(Output<T>) - Method in class swim.concurrent.ClockDef
debug(Output<T>) - Method in class swim.concurrent.TheaterDef
didFail(Throwable) - Method in class swim.concurrent.Clock: Lifecycle callback invoked if the timer thread throws a fatal error.
didFail(Throwable) - Method in class swim.concurrent.Theater: Lifecycle callback invoked if this Theater encounters an internal error.
didStart() - Method in class swim.concurrent.Clock: Lifecycle callback invoked after the clock thread starts.
didStart() - Method in class swim.concurrent.Theater: Lifecycle callback invoked before the thread pool starts up.
didStop() - Method in class swim.concurrent.Clock: Lifecycle callback invoked after the clock thread stops.
didStop() - Method in class swim.concurrent.Theater: Lifecycle callback invoked after the thread pool shuts down.
didTick(long, long) - Method in class swim.concurrent.Clock: Introspection callback invoked after each tick of the clock.
drop(Throwable) - Method in interface swim.concurrent.PullRequest
drop(Throwable) - Method in class swim.concurrent.PushRequest
DropException - Exception in swim.concurrent: Used to trap a continuation when a PullRequest drops.
DropException() - Constructor for exception swim.concurrent.DropException
DropException(String) - Constructor for exception swim.concurrent.DropException
DropException(String, Throwable) - Constructor for exception swim.concurrent.DropException
DropException(Throwable) - Constructor for exception swim.concurrent.DropException

E

equals(Object) - Method in class swim.concurrent.ClockDef
equals(Object) - Method in class swim.concurrent.TheaterDef
execute(Runnable) - Method in class swim.concurrent.SideStage
execute(Runnable) - Method in interface swim.concurrent.Stage: Schedules a runnable for concurrent execution.
execute(Runnable) - Method in class swim.concurrent.Theater

F

fillInStackTrace() - Method in exception swim.concurrent.DropException
form() - Static method in interface swim.concurrent.ScheduleDef
form() - Static method in interface swim.concurrent.StageDef

G

get() - Method in class swim.concurrent.PushRequest

H

hashCode() - Method in class swim.concurrent.ClockDef
hashCode() - Method in class swim.concurrent.TheaterDef

I

ignore() - Static method in interface swim.concurrent.Cont: Returns a Cont continuation that, when completed successfully, does nothing; and when failed with an exception, throws the exception.
isCued() - Method in class swim.concurrent.AbstractTask: Returns true if the task is currently scheduled for execution.
isCued() - Method in interface swim.concurrent.TaskContext: Returns true if the task is currently scheduled for execution.
isCued() - Method in interface swim.concurrent.TaskRef: Returns true if the task is currently scheduled for execution.
isNonFatal(Throwable) - Static method in interface swim.concurrent.Cont: Returns true if throwable is a recoverable exception; returns false if throwable cannot be recovered from.
isPreemptive() - Method in interface swim.concurrent.Preemptive: Returns true if callers can safely invoke this function object concurrently.
isReleasable() - Method in class swim.concurrent.Sync
isScheduled() - Method in class swim.concurrent.AbstractTimer: Returns true if this timer is currently scheduled to execute.
isScheduled() - Method in interface swim.concurrent.TimerContext: Returns true if the timer is currently scheduled to execute.
isScheduled() - Method in interface swim.concurrent.TimerRef: Returns true if the timer is currently scheduled to execute.

M

MainStage - Interface in swim.concurrent: Stage that can be started and stopped.

N

name() - Method in class swim.concurrent.Theater
name() - Method in class swim.concurrent.TheaterDef
name(String) - Method in class swim.concurrent.TheaterDef
nanoTime() - Method in class swim.concurrent.Clock: Returns the current time, in nanoseconds, with arbitrary origin.

P

parallelism() - Method in class swim.concurrent.Theater
parallelism() - Method in class swim.concurrent.TheaterDef
parallelism(int) - Method in class swim.concurrent.TheaterDef
peek() - Method in class swim.concurrent.ConcurrentTrancheQueue
poll() - Method in class swim.concurrent.ConcurrentTrancheQueue
Preemptive - Interface in swim.concurrent: Function interface that callers can optionally invoke concurrently.
prio() - Method in interface swim.concurrent.PullRequest
prio() - Method in class swim.concurrent.PushRequest
pull(PullContext<? super T>) - Method in interface swim.concurrent.PullRequest
pull(PullContext<? super T>) - Method in class swim.concurrent.PushRequest
PullContext<T> - Interface in swim.concurrent
PullRequest<T> - Interface in swim.concurrent
push(T) - Method in interface swim.concurrent.PullContext
PushRequest<T> - Class in swim.concurrent
PushRequest(T) - Constructor for class swim.concurrent.PushRequest
PushRequest(T, float) - Constructor for class swim.concurrent.PushRequest

R

reschedule(long) - Method in class swim.concurrent.AbstractTimer: Schedules this timer to execute after millis milliseconds has elapsed.
reschedule(long) - Method in interface swim.concurrent.TimerContext: Schedules the timer to execute after millis milliseconds has elapsed.
reschedule(long) - Method in interface swim.concurrent.TimerRef: Schedules the timer to execute after millis milliseconds has elapsed.
runTask() - Method in class swim.concurrent.AbstractTask
runTask() - Method in interface swim.concurrent.Task: Executes this sequential process.
runTask() - Method in interface swim.concurrent.TaskFunction: Executes this sequential process.
runTimer() - Method in class swim.concurrent.AbstractTimer
runTimer() - Method in interface swim.concurrent.Timer: Executes scheduled logic when this Timer fires.
runTimer() - Method in interface swim.concurrent.TimerFunction: Executes scheduled logic when this timer fires.
runTimer(TimerFunction, Runnable) - Method in class swim.concurrent.Clock: Invokes timer.runTimer(), or arranges for the asynchronous execution of the provided runnable, which will itself invoke timer.runTimer().
runTimer(TimerFunction, Runnable) - Method in class swim.concurrent.StageClock: Schedules the runnable to invoke timer.runTimer() on the execution StageClock.stage.

S

schedule() - Method in class swim.concurrent.AbstractTimer: Returns the Schedule to which this timer is bound.
schedule() - Method in class swim.concurrent.Theater
schedule() - Method in interface swim.concurrent.TimerContext: Returns the Schedule to which the timer is bound.
Schedule - Interface in swim.concurrent: Timetable for executing timers at their scheduled times.
scheduleDef() - Method in class swim.concurrent.TheaterDef
scheduleDef(ScheduleDef) - Method in class swim.concurrent.TheaterDef
ScheduleDef - Interface in swim.concurrent: Marker interface for a Schedule definition.
ScheduleException - Exception in swim.concurrent: Thrown when a Schedule encounters an error.
ScheduleException() - Constructor for exception swim.concurrent.ScheduleException
ScheduleException(String) - Constructor for exception swim.concurrent.ScheduleException
ScheduleException(String, Throwable) - Constructor for exception swim.concurrent.ScheduleException
ScheduleException(Throwable) - Constructor for exception swim.concurrent.ScheduleException
setSchedule(Schedule) - Method in class swim.concurrent.Theater
setTaskContext(TaskContext) - Method in class swim.concurrent.AbstractTask
setTaskContext(TaskContext) - Method in interface swim.concurrent.Task: Sets the context used to managed this Task.
setTimer(long, TimerFunction) - Method in class swim.concurrent.Clock
setTimer(long, TimerFunction) - Method in interface swim.concurrent.Schedule: Schedules timer to execute after millis milliseconds have elapsed.
setTimer(long, TimerFunction) - Method in class swim.concurrent.SideStage
setTimer(long, TimerFunction) - Method in class swim.concurrent.Theater
setTimerContext(TimerContext) - Method in class swim.concurrent.AbstractTimer
setTimerContext(TimerContext) - Method in interface swim.concurrent.Timer: Sets the context used to manage this Timer.
SideStage - Class in swim.concurrent: Stage wrapper that prevents its underlying stage from being started and stopped.
SideStage(Stage) - Constructor for class swim.concurrent.SideStage
size() - Method in class swim.concurrent.ConcurrentTrancheQueue
skip() - Method in interface swim.concurrent.PullContext
sleep(long) - Method in class swim.concurrent.Clock: Parks the current thread for the specified number of millis.
stage - Variable in class swim.concurrent.SideStage
stage - Variable in class swim.concurrent.StageClock: Stage on which to execute timer functions.
stage() - Method in class swim.concurrent.AbstractTask: Returns the execution Stage to which this task is bound.
stage() - Method in class swim.concurrent.StageClock: Returns the stage on which to execute timer functions.
stage() - Method in interface swim.concurrent.TaskContext: Returns the execution Stage to which the task is bound.
Stage - Interface in swim.concurrent: An execution context in which to schedule tasks, create continuation calls, and set timers.
StageClock - Class in swim.concurrent: Clock that invokes timer functions on an execution Stage, rather than on the clock thread.
StageClock(Stage) - Constructor for class swim.concurrent.StageClock: Constructs a new StageClock with a timer resolution of Clock.TICK_MILLIS milliseconds, and a clock period of Clock.TICK_COUNT ticks per revolution, that executes timer functions on the given stage.
StageClock(Stage, int, int) - Constructor for class swim.concurrent.StageClock: Constructs a new StageClock with a timer resolution of tickMillis milliseconds, and a clock period of tickCount ticks per revolution, that executes timer functions on the given stage.
StageClock(Stage, ClockDef) - Constructor for class swim.concurrent.StageClock: Constructs a new StageClock, with the timer resolution and clock period specified by the given clockDef, that executes timer functions on the given stage.
StageDef - Interface in swim.concurrent: Marker interface for a Stage definition.
standard() - Static method in class swim.concurrent.ClockDef
standard() - Static method in class swim.concurrent.TheaterDef
start() - Method in class swim.concurrent.Clock: Ensures that this Clock is up and running, starting up the clock thread if it has not yet been started.
start() - Method in interface swim.concurrent.MainStage: Ensures that this Stage is up and running.
start() - Method in class swim.concurrent.Theater: Ensures that this Theater is up and running.
stay(StayContext, int) - Method in interface swim.concurrent.PullRequest
stay(StayContext, int) - Method in class swim.concurrent.PushRequest
stay(StayContext, int) - Method in interface swim.concurrent.Stay: Invoked when the asynchronous operation needs to wait before proceeding.
Stay<T> - Interface in swim.concurrent: Backpressure aware continuation.
StayContext - Interface in swim.concurrent: Source that can delay continuations.
stop() - Method in class swim.concurrent.Clock: Ensures that this Clock has been permanently stopped, shutting down the clock thread, if it's currently running.
stop() - Method in interface swim.concurrent.MainStage: Ensures that this Stage has been permanently stopped.
stop() - Method in class swim.concurrent.Theater: Ensures that this Theater has been permanently stopped, shutting down the thread pool, if it's currently running.
swim.concurrent - module swim.concurrent: Timer, task, and continuation passing style interfaces, with lightweight scheduler and execution stage implementations.
swim.concurrent - package swim.concurrent: Timer, task, and continuation passing style interfaces, with lightweight scheduler and execution stage implementations.
Sync<T> - Class in swim.concurrent: A Continuation whose completion can be synchronously awaited.
Sync() - Constructor for class swim.concurrent.Sync: Constructs a new Sync continuation that awaits a value of type T.
SyncException - Exception in swim.concurrent: Thrown when awaiting a Sync continuation times out.
SyncException() - Constructor for exception swim.concurrent.SyncException
SyncException(String) - Constructor for exception swim.concurrent.SyncException
SyncException(String, Throwable) - Constructor for exception swim.concurrent.SyncException
SyncException(Throwable) - Constructor for exception swim.concurrent.SyncException

T

task(TaskFunction) - Method in class swim.concurrent.SideStage
task(TaskFunction) - Method in interface swim.concurrent.Stage: Returns an uncued TaskRef bound to the task, which can later be used to cue the task.
task(TaskFunction) - Method in class swim.concurrent.Theater
Task - Interface in swim.concurrent: Stateful TaskFunction to invoke as a sequential process on a concurrent execution Stage, with lifecycle callbacks, and a TaskContext for self-management.
taskContext - Variable in class swim.concurrent.AbstractTask: Context used to manage this Task; null if this Task is not bound to an execution Stage.
taskContext() - Method in class swim.concurrent.AbstractTask
taskContext() - Method in interface swim.concurrent.Task: Returns the context used to managed this Task.
TaskContext - Interface in swim.concurrent: Internal context that binds a Task to an execution Stage.
taskDidCancel() - Method in class swim.concurrent.AbstractTask
taskDidCancel() - Method in interface swim.concurrent.Task: Lifecycle callback invoked after this Task is explicitly cancelled.
taskDidCancel(TaskFunction) - Method in class swim.concurrent.Theater: Introspection callback invoked after a cued task is canceled.
taskDidFail(TaskFunction, Throwable) - Method in class swim.concurrent.Theater: Introspection callback invoked immediately after task.runTask() fails by throwing an error.
taskDidRun(TaskFunction) - Method in class swim.concurrent.Theater: Introspection callback invoked immediately after task.runTask() returns nominally.
TaskException - Exception in swim.concurrent: Thrown when performing an invalid operation on a TaskFunction.
TaskException() - Constructor for exception swim.concurrent.TaskException
TaskException(String) - Constructor for exception swim.concurrent.TaskException
TaskException(String, Throwable) - Constructor for exception swim.concurrent.TaskException
TaskException(Throwable) - Constructor for exception swim.concurrent.TaskException
TaskFunction - Interface in swim.concurrent: Function to invoke as a sequential process on a concurrent execution Stage.
TaskRef - Interface in swim.concurrent: External handle to a TaskFunction bound to an execution Stage.
taskWillBlock() - Method in class swim.concurrent.AbstractTask
taskWillBlock() - Method in interface swim.concurrent.Task: Returns true if this Task might block its thread of execution when running; returns false if this Task will never block.
taskWillCue() - Method in class swim.concurrent.AbstractTask
taskWillCue() - Method in interface swim.concurrent.Task: Lifecycle callback invoked before this Task is scheduled for execution.
taskWillCue(TaskFunction) - Method in class swim.concurrent.Theater: Introspection callback invoked before a task is cued for execution.
taskWillRun(TaskFunction) - Method in class swim.concurrent.Theater: Introspection callback invoked immediately before task.runTask() is executed.
Theater - Class in swim.concurrent: Stage that executes timers, tasks, and continuations on a ForkJoinPool.
Theater() - Constructor for class swim.concurrent.Theater
Theater(int) - Constructor for class swim.concurrent.Theater
Theater(int, Schedule) - Constructor for class swim.concurrent.Theater
Theater(String) - Constructor for class swim.concurrent.Theater
Theater(String, int) - Constructor for class swim.concurrent.Theater
Theater(String, int, Schedule) - Constructor for class swim.concurrent.Theater
Theater(String, Schedule) - Constructor for class swim.concurrent.Theater
Theater(Schedule) - Constructor for class swim.concurrent.Theater
Theater(TheaterDef) - Constructor for class swim.concurrent.Theater
TheaterDef - Class in swim.concurrent
TheaterDef(String, int, ScheduleDef) - Constructor for class swim.concurrent.TheaterDef
theaterForm() - Static method in class swim.concurrent.TheaterDef
theaterForm(Form<ScheduleDef>) - Static method in class swim.concurrent.TheaterDef
tick() - Method in class swim.concurrent.Clock: Returns the tick sequence number of the lowest clock tick that has yet to finish executing.
TICK_COUNT - Static variable in class swim.concurrent.Clock: Default number of ticks per clock revolution, used by the no-arg Clock() constructor.
TICK_MILLIS - Static variable in class swim.concurrent.Clock: Default number of milliseconds between clock ticks, used by the no-arg Clock() constructor.
tickCount() - Method in class swim.concurrent.ClockDef
tickCount(int) - Method in class swim.concurrent.ClockDef
tickMillis() - Method in class swim.concurrent.ClockDef
tickMillis(int) - Method in class swim.concurrent.ClockDef
timer(TimerFunction) - Method in class swim.concurrent.Clock
timer(TimerFunction) - Method in interface swim.concurrent.Schedule: Returns an unscheduled TimerRef bound to timer, which can later be used to schedule timer.
timer(TimerFunction) - Method in class swim.concurrent.SideStage
timer(TimerFunction) - Method in class swim.concurrent.Theater
Timer - Interface in swim.concurrent: Stateful TimerFunction to invoke at a scheduled time, with lifecycle callbacks, and a TimerContext for self-management.
timerContext - Variable in class swim.concurrent.AbstractTimer: Context used to manage this Timer; null if this Timer is not bound to a Schedule.
timerContext() - Method in class swim.concurrent.AbstractTimer
timerContext() - Method in interface swim.concurrent.Timer: Returns the context used to manage this Timer.
TimerContext - Interface in swim.concurrent: Internal context that binds a Timer to a Schedule.
timerDidCancel() - Method in class swim.concurrent.AbstractTimer
timerDidCancel() - Method in interface swim.concurrent.Timer: Lifecycle callback invoked after this Timer is explicitly cancelled.
timerDidCancel(TimerFunction) - Method in class swim.concurrent.Clock: Introspection callback invoked after a timer has been explicitly cancelled; not invoked when a timer is implicitly cancelled, such as when rescheduling an already scheduled timer.
timerDidFail(TimerFunction, Throwable) - Method in class swim.concurrent.Clock: Introspection callback invoked after a timer execution fails by throwing an error.
timerDidRun(TimerFunction) - Method in class swim.concurrent.Clock: Introspection callback invoked after a timer executes nominally.
TimerException - Exception in swim.concurrent: Thrown when performing an invalid operation on a TimerFunction.
TimerException() - Constructor for exception swim.concurrent.TimerException
TimerException(String) - Constructor for exception swim.concurrent.TimerException
TimerException(String, Throwable) - Constructor for exception swim.concurrent.TimerException
TimerException(Throwable) - Constructor for exception swim.concurrent.TimerException
TimerFunction - Interface in swim.concurrent: Function to invoke at a scheduled time.
TimerRef - Interface in swim.concurrent: External handle to a TimerFunction bound to a Schedule.
timerWillRun(TimerFunction) - Method in class swim.concurrent.Clock: Introspection callback invoked before a timer is executed.
timerWillSchedule(long) - Method in class swim.concurrent.AbstractTimer
timerWillSchedule(long) - Method in interface swim.concurrent.Timer: Lifecycle callback invoked before this Timer is scheduled for execution.
timerWillSchedule(TimerFunction, long) - Method in class swim.concurrent.Clock: Introspection callback invoked before a timer is scheduled for execution with a delay of millis milliseconds.
toString() - Method in class swim.concurrent.ClockDef
toString() - Method in class swim.concurrent.TheaterDef
trap(Throwable) - Method in interface swim.concurrent.Call: Completes this Call with an error by eventually invoking the trap(Throwable) method of this Call's Continuation.
trap(Throwable) - Method in interface swim.concurrent.Cont: Invoked when the asynchronous operation fails with an error.
trap(Throwable) - Method in class swim.concurrent.Sync
tryBind(T) - Method in interface swim.concurrent.Call: Tries to complete this Call with a value, returning true if this operation caused the completion of the Call; returns false if this Call was already completed.
tryTrap(Throwable) - Method in interface swim.concurrent.Call: Tries to complete this Call with an error, returning true if this operation caused the completion of the Call; returns false if this Call was already completed.

U

uncaughtException(Thread, Throwable) - Method in class swim.concurrent.Theater

W

willStart() - Method in class swim.concurrent.Clock: Lifecycle callback invoked before the clock thread starts.
willStop() - Method in class swim.concurrent.Clock: Lifecycle callback invoked before the clock thread stops.

A B C D E F G H I M N P R S T U W
All Classes All Packages