WorkQueue.java

/*
 * Copyright (c) 2009, Paul Merlin. All Rights Reserved.
 *
 * 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 http://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.swing.on.steroids.threading;

import org.codeartisans.java.toolbox.async.ErrorCallbackAdapter;

public interface WorkQueue
{

    String NAME = "WorkQueue:name";
    String SIZE = "WorkQueue:size";

    /**
     * WARNING If a RuntimeException occurs inside your Runnable you won't be notified as it will occur in a separate thread.
     *
     * @param runnable Runnable to be run by one of the WorkQueue thread as soon as one is available.
     */
    void enqueue( Runnable runnable );

    /**
     * @param runnable      Runnable to be run by one of the WorkQueue thread as soon as one is available.
     * @param errorCallback Callback called
     */
    void enqueue( Runnable runnable, ErrorCallbackAdapter<RuntimeException> errorCallback );

}