org.mobicents.media.server.spi.clock.Task Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spi Show documentation

There is a newer version: 6.0.23

/*
 * JBoss, Home of Professional Open Source
 * Copyright 2011, Red Hat, Inc. and individual contributors
 * by the @authors tag. See the copyright.txt 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.mobicents.media.server.spi.clock;

/**
 * Represents sporadic task which is executed by Scheduler.
 * 
 * @author kulikov
 */
public interface Task {
    /**
     * Cancels task execution.
     */
    public void cancel();

    /**
     * Indicates is this task is active or canceled.
     * 
     * @return true if this task is still active and false if this task is canceled.
     */
    public boolean isActive();
    
    /**
     * Executes logic of this task.
     * 
     * @return the delay for next run.
     */
    public int perform();
}