gololang.concurrent.workers

Class WorkerEnvironment

java.lang.Object

gololang.concurrent.workers.WorkerEnvironment

public final class WorkerEnvironment
extends Object

A worker environment is an abstraction over a set of spawned functions that can asynchronously process messages sent through ports.

Each port is internally associated to a worker function and a messages queue. The worker environment maintains an executor that dispatches message processing jobs over its thread pool.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WorkerEnvironment.Builder Worker environment builder objects exist mostly to provide a good-looking API in Golo.

Constructor Summary

Constructors

Constructor and Description
WorkerEnvironment(ExecutorService executor) Creates a new worker environment using an executor.

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(int millis) Waits until all remaining messages have been processed.
boolean	awaitTermination(long millis) Waits until all remaining messages have been processed.
boolean	awaitTermination(long timeout, TimeUnit unit) Waits until all remaining messages have been processed.
static WorkerEnvironment.Builder	builder()
boolean	isShutdown()
boolean	isTerminated()
static WorkerEnvironment	newWorkerEnvironment()
WorkerEnvironment	shutdown() Shutdown the worker environment.
Port	spawn(MethodHandle handle) Spawns a worker function.
Port	spawnWorker(WorkerFunction function) Spawns a worker function.

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkerEnvironment

public WorkerEnvironment(ExecutorService executor)

Creates a new worker environment using an executor.

Parameters:

executor - the executor.

Method Detail

newWorkerEnvironment

public static WorkerEnvironment newWorkerEnvironment()

Returns:

a new worker environment with a cached thread pool.

See Also:

Executors.newCachedThreadPool()

builder

public static WorkerEnvironment.Builder builder()

Returns:

a worker environment builder object.

spawn

public Port spawn(MethodHandle handle)

Spawns a worker function.

Parameters:

handle - the worker target.

Returns:

a port to send messages to handle.

spawnWorker

public Port spawnWorker(WorkerFunction function)

Spawns a worker function.

Parameters:

function - the worker target.

Returns:

a port to send messages to function.

shutdown

public WorkerEnvironment shutdown()

Shutdown the worker environment.

Returns:

the same worker environment object.

See Also:

ExecutorService.shutdown()

awaitTermination

public boolean awaitTermination(int millis)
                         throws InterruptedException

Waits until all remaining messages have been processed.

Parameters:

millis - the delay.

Throws:

InterruptedException

See Also:

ExecutorService.awaitTermination(long, java.util.concurrent.TimeUnit)

awaitTermination

public boolean awaitTermination(long millis)
                         throws InterruptedException

Waits until all remaining messages have been processed.

Parameters:

millis - the delay.

Throws:

InterruptedException

See Also:

ExecutorService.awaitTermination(long, java.util.concurrent.TimeUnit)

awaitTermination

public boolean awaitTermination(long timeout,
                                TimeUnit unit)
                         throws InterruptedException

Waits until all remaining messages have been processed.

Parameters:

timeout - the delay.

unit - the delay time unit.

Throws:

InterruptedException

See Also:

ExecutorService.awaitTermination(long, java.util.concurrent.TimeUnit)

isShutdown

public boolean isShutdown()

See Also:

ExecutorService.isShutdown()

isTerminated

public boolean isTerminated()

See Also:

ExecutorService.isTerminated()