org.agrona.concurrent

Class AgentRunner

java.lang.Object

org.agrona.concurrent.AgentRunner

All Implemented Interfaces:

java.lang.AutoCloseable, java.lang.Runnable

public class AgentRunner
extends java.lang.Object
implements java.lang.Runnable, java.lang.AutoCloseable

Base agent runner that is responsible for lifecycle of an Agent and ensuring exceptions are handled.

Note: An agent runner should only be once per instance.

Constructor Summary

Constructors

Constructor and Description
AgentRunner(IdleStrategy idleStrategy, ErrorHandler errorHandler, AtomicCounter errorCounter, Agent agent) Create an agent passing in IdleStrategy

Method Summary

Modifier and Type	Method and Description
Agent	agent() The Agent who's lifecycle is being managed.
void	close() Stop the running Agent and cleanup.
void	run() Run an Agent.
static java.lang.Thread	startOnThread(AgentRunner runner) Start the given agent runner on a new thread.
static java.lang.Thread	startOnThread(AgentRunner runner, java.util.concurrent.ThreadFactory threadFactory) Start the given agent runner on a new thread.

Methods inherited from class java.lang.Object

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

Constructor Detail

AgentRunner

public AgentRunner(IdleStrategy idleStrategy,
                   ErrorHandler errorHandler,
                   AtomicCounter errorCounter,
                   Agent agent)

Create an agent passing in IdleStrategy

Parameters:

idleStrategy - to use for Agent run loop

errorHandler - to be called if an Throwable is encountered

errorCounter - for reporting how many exceptions have been seen.

agent - to be run in this thread.

Method Detail

startOnThread

public static java.lang.Thread startOnThread(AgentRunner runner)

Start the given agent runner on a new thread.

Parameters:

runner - the agent runner to start

Returns:

the new thread that has been started.

startOnThread

public static java.lang.Thread startOnThread(AgentRunner runner,
                                             java.util.concurrent.ThreadFactory threadFactory)

Start the given agent runner on a new thread.

Parameters:

runner - the agent runner to start.

threadFactory - the factory to use to create the thread.

Returns:

the new thread that has been started.

agent

public Agent agent()

The Agent who's lifecycle is being managed.

Returns:

Agent who's lifecycle is being managed.

run

public void run()

Run an Agent.

This method does not return until the run loop is stopped via close().

Specified by:

run in interface java.lang.Runnable

close

public final void close()

Stop the running Agent and cleanup. This will wait for the work loop to exit and the Agent performing it Agent.onClose() logic.

The clean up logic will only be performed once even if close is called from multiple concurrent threads.

Specified by:

close in interface java.lang.AutoCloseable