public interface ExecController extends AutoCloseable
The instance for an application can be obtained via the server registry.
Modifier and Type | Method and Description |
---|---|
void |
close()
Shuts down this controller, terminating the event loop and blocking threads.
|
static Optional<ExecController> |
current()
Returns the execution controller bound to the current thread, if this is a Ratpack managed compute thread.
|
ExecutorService |
getBlockingExecutor() |
ExecControl |
getControl()
A singleton that can be used from any managed thread to perform asynchronous or blocking operations.
|
EventLoopGroup |
getEventLoopGroup()
The event loop group used by Netty for this application.
|
ScheduledExecutorService |
getExecutor()
The event loop (i.e.
|
int |
getNumThreads()
The number of threads that will be used for computation.
|
boolean |
isManagedThread()
Indicates whether the current thread is managed by this execution controller.
|
static ExecController |
require()
Returns the execution controller bound to the current thread, or throws an exception if called on a non Ratpack managed compute thread.
|
static Optional<ExecController> current()
If called on a non Ratpack compute thread, the returned optional will be empty.
static ExecController require() throws UnmanagedThreadException
If called on a non Ratpack compute thread, the returned optional will be empty.
UnmanagedThreadException
- when called from a non Ratpack managed threadboolean isManagedThread()
This will return true
if the current thread is either part of the event loop thread pool or blocking thread pool of the
application that is backed by this execution controller.
ExecControl getControl()
The control is typically used by services that are not inherently tied to any specific execution to perform execution operations such as blocking and forking.
If you are using the Guice integration, an instance of this type can be injected.
ScheduledExecutorService getExecutor()
This executor wraps Netty's event loop executor to provide callback features by way of Guava's executor extensions.
It is generally preferable to use ExecControl.exec()
to submit computation work rather than this method,
which properly initialises Ratpack's execution infrastructure.
ExecutorService getBlockingExecutor()
EventLoopGroup getEventLoopGroup()
Generally there is no need to access this unless you are doing something directly with Netty.
int getNumThreads()
This is determined by the ServerConfig.getThreads()
value of the launch config that created this controller.
void close()
This method returns immediately, not waiting for the actual shutdown to occur.
Generally, the only time it is necessary to call this method is when using an exec controller directly during testing.
Calling RatpackServer.stop()
will inherently call this method.
close
in interface AutoCloseable