org.agrona.concurrent

Interface Agent

All Known Implementing Classes:

CompositeAgent

public interface Agent

Method Summary

Modifier and Type	Method and Description
int	doWork() An agent should implement this method to do its work.
default void	onClose() To be overridden by Agents that need to do resource cleanup on close.
java.lang.String	roleName() Get the name of this agent's role.

Method Detail

doWork

int doWork()
    throws java.lang.Exception

An agent should implement this method to do its work. The return value is used for implementing a backoff strategy that can be employed when no work is currently available for the agent to process.

Returns:

0 to indicate no work was currently available, a positive value otherwise.

Throws:

java.lang.Exception - if an error has occurred

onClose

default void onClose()

To be overridden by Agents that need to do resource cleanup on close. This method will be called after the agent thread has terminated. It will only be called once by a single thread. Note: Implementations of this method much be idempotent.

roleName

java.lang.String roleName()

Get the name of this agent's role.

Returns:

the name of this agent's role.