net.openhft.chronicle.core.threads

Class DelegatingEventLoop

java.lang.Object

net.openhft.chronicle.core.threads.DelegatingEventLoop

All Implemented Interfaces:

Closeable, AutoCloseable, QueryCloseable, EventLoop

public class DelegatingEventLoop
extends Object
implements EventLoop

This class is an implementation of the EventLoop interface that delegates all calls to an underlying EventLoop instance.

This can be used as a base class for implementations that need to override or add behavior to an existing EventLoop instance without modifying the original class.

Field Summary

Fields

Modifier and Type	Field and Description
@NotNull EventLoop	inner

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

DEBUG_ADDING_HANDLERS

Constructor Summary

Constructors

Constructor and Description
DelegatingEventLoop(@NotNull EventLoop eventLoop) Constructs a new DelegatingEventLoop instance that delegates to the specified 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() Stops the event loop and then closes any resources being held.
boolean	isAlive() Checks if the main thread of the event loop is running.
boolean	isClosed() Checks if this object is closed.
boolean	isClosing() Checks if this object is in the process of closing.
boolean	isStopped() Checks if the event loop is in the stopped state.
String	name() Retrieves the name of the event loop.
boolean	runsInsideCoreLoop() Checks if the current thread is the core thread of this event loop, or if this information cannot be determined.
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

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

closeQuietly, closeQuietly

Field Detail

inner

@NotNull
public final @NotNull EventLoop inner

Constructor Detail

DelegatingEventLoop

public DelegatingEventLoop(@NotNull
                           @NotNull EventLoop eventLoop)

Constructs a new DelegatingEventLoop instance that delegates to the specified EventLoop.

Parameters:

eventLoop - the underlying EventLoop to which this object delegates all calls.

Method Detail

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.

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

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.

isClosing

public boolean isClosing()

Description copied from interface: QueryCloseable

Checks if this object is in the process of closing.

This method should always return true if QueryCloseable.isClosed() returns true.

Specified by:

isClosing in interface QueryCloseable

Returns:

true if the close() method has been called (but not necessarily completed)

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.

close

public void close()

Description copied from interface: EventLoop

Stops the event loop and then closes any resources being held. Blocks until all the handlers are stopped and closed.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface EventLoop

See Also:

AbstractCloseable.performClose()

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.

runsInsideCoreLoop

public boolean runsInsideCoreLoop()

Description copied from interface: EventLoop

Checks if the current thread is the core thread of this event loop, or if this information cannot be determined. If the current thread is not the core event thread but any other, this method returns false.

Specified by:

runsInsideCoreLoop in interface EventLoop

Returns:

true unless the current thread is not the core event thread.