org.agrona.concurrent.Agent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of agrona-agent Show documentation
High performance primitives and utility library.
The newest version!
/*
 * Copyright 2014-2025 Real Logic Limited.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.agrona.concurrent;

/**
 * An Agent is scheduled to do work on a thread on a duty cycle. Each Agent should have a defined role in a system.
 * 
 * {@link #onStart()}, {@link #doWork()}, and {@link #onClose()} will all be called by the same thread and in a
 * threadsafe manner if the agent runs successfully. {@link #onClose()} will be called if the agent fails to run.
 */
public interface Agent
{
    /**
     * To be overridden by Agents that need to do resource init on start.
     * 

     * This method will be called by the agent thread once on start.
     */
    default void onStart()
    {
        // default to do nothing unless you want to handle the notification.
    }

    /**
     * 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.
     * 

     * If the Agent wished to terminate and close then a {@link AgentTerminationException} can be thrown.
     *
     * @return 0 to indicate no work was currently available, a positive value otherwise.
     * @throws java.lang.Exception if an error has occurred
     */
    int doWork() throws Exception;

    /**
     * To be overridden by Agents that need to do resource cleanup on close.
     * 
     * This method will be called after the agent thread has terminated or if the agent is closed before it runs.
     */
    default void onClose()
    {
        // default to do nothing unless you want to handle the notification.
    }

    /**
     * Get the name of this agent's role.
     *
     * @return the name of this agent's role.
     */
    String roleName();
}