net.openhft.chronicle.core.threads

Class OnDemandEventLoop

java.lang.Object

net.openhft.chronicle.core.threads.OnDemandEventLoop

All Implemented Interfaces:

Closeable, AutoCloseable, QueryCloseable, EventLoop

public class OnDemandEventLoop
extends Object
implements EventLoop

A wrapper for an EventLoop which is created on demand when any of its methods are called.

This can be used to lazily instantiate an EventLoop only when it's actually needed.

Field Summary

Fields inherited from interface net.openhft.chronicle.core.threads.EventLoop

DEBUG_ADDING_HANDLERS

Constructor Summary

Constructors

Constructor and Description
OnDemandEventLoop(@NotNull Supplier<EventLoop> eventLoopSupplier) Constructs an OnDemandEventLoop with the given supplier for creating the actual EventLoop.

Method Summary

Modifier and Type	Method and Description
void	addHandler(EventHandler handler) Adds a handler to the event loop to be executed.
void	close() Closes the EventLoop if it has been created.
boolean	hasEventLoop() Checks if the EventLoop has been created.
boolean	isAlive() Checks if the main thread of the event loop is running.
boolean	isClosed() Checks if this object is closed.
boolean	isStopped() Checks if the event loop is in the stopped state.
String	name() Retrieves the name of the event loop.
void	start() Starts the event loop.
void	stop() Stops executing handlers and blocks until all handlers are complete.
void	unpause() Typically, implementations will unpause the event loop's pauser, if used.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.openhft.chronicle.core.threads.EventLoop

inEventLoop, runsInsideCoreLoop

Methods inherited from interface net.openhft.chronicle.core.io.Closeable

closeQuietly, closeQuietly

Methods inherited from interface net.openhft.chronicle.core.io.QueryCloseable

isClosing

Constructor Detail

OnDemandEventLoop

public OnDemandEventLoop(@NotNull
                         @NotNull Supplier<EventLoop> eventLoopSupplier)

Constructs an OnDemandEventLoop with the given supplier for creating the actual EventLoop.

Parameters:

eventLoopSupplier - The supplier to be used for creating the actual EventLoop on demand.

Method Detail

hasEventLoop

public boolean hasEventLoop()

Checks if the EventLoop has been created.

Returns:

true if the EventLoop has been created, false otherwise.

name

public String name()

Description copied from interface: EventLoop

Retrieves the name of the event loop.

Specified by:

name in interface EventLoop

Returns:

the name of the event loop.

addHandler

public void addHandler(EventHandler handler)

Description copied from interface: EventLoop

Adds a handler to the event loop to be executed. The event loop should execute handlers in order of their priority. Handlers with the same priority have no guarantee of execution order. Handlers will not be executed before EventLoop.start() has been called.

Specified by:

addHandler in interface EventLoop

Parameters:

handler - The handler to be added to the event loop.

start

public void start()

Description copied from interface: EventLoop

Starts the event loop. Once the event loop is started, it begins executing handlers.

Specified by:

start in interface EventLoop

unpause

public void unpause()

Description copied from interface: EventLoop

Typically, implementations will unpause the event loop's pauser, if used. This can be helpful in cases where the event loop was temporarily paused for some reason.

Specified by:

unpause in interface EventLoop

stop

public void stop()

Description copied from interface: EventLoop

Stops executing handlers and blocks until all handlers are complete. It is not expected that event loops can then be restarted.

Specified by:

stop in interface EventLoop

isClosed

public boolean isClosed()

Description copied from interface: QueryCloseable

Checks if this object is closed.

Specified by:

isClosed in interface QueryCloseable

Returns:

true if the close() method has completed, false otherwise

isAlive

public boolean isAlive()

Description copied from interface: EventLoop

Checks if the main thread of the event loop is running.

Specified by:

isAlive in interface EventLoop

Returns:

true if the main thread is running, otherwise false.

isStopped

public boolean isStopped()

Description copied from interface: EventLoop

Checks if the event loop is in the stopped state.

Specified by:

isStopped in interface EventLoop

Returns:

true if the event loop is in the stopped state, otherwise false.

close

public void close()

Closes the EventLoop if it has been created.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface EventLoop

See Also:

AbstractCloseable.performClose()