org.jboss.threads.TaskNotifier Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jboss-threads Show documentation

There is a newer version: 3.8.0.Final

/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2009, Red Hat Middleware LLC, and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.jboss.threads;

/**
 * A notifier which is called when tasks start, stop, or fail.
 *
 * @param  the task type
 * @param  the attachment type
 */
public interface TaskNotifier {

    /**
     * A task was started.
     *
     * @param runnable the task
     * @param attachment the attachment
     */
    void started(R runnable, A attachment);

    /**
     * A task has failed.
     *
     * @param runnable the task
     * @param reason the reason for the failure
     * @param attachment the attachment
     */
    void failed(R runnable, Throwable reason, A attachment);

    /**
     * A task has completed.
     *
     * @param runnable the task
     * @param attachment the attachment
     */
    void finished(R runnable, A attachment);
}