cc.redberry.concurrent.InputPort Maven / Gradle / Ivy

Go to download
/*
 * Redberry: symbolic tensor computations.
 *
 * Copyright (c) 2010-2012:
 *   Stanislav Poslavsky   
 *   Bolotin Dmitriy       
 *
 * This file is part of Redberry.
 *
 * Redberry is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Redberry 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Redberry. If not, see .
 */

package cc.redberry.concurrent;

/**
 * Interface for passive objects consumer.


 * Important: read contract for {@link put()} method.
 * 
 * @author Bolotin Dmitriy ([email protected])
 * @param  type of objects consumed
 */
public interface InputPort {
    /**
     * Method to put elements in this input port.

     * Contract: Putting {@code null} is allowed once and this indicates closing of this input port. No invocation of this method allowed after closing.
     *  
     * @param object
     * @throws InterruptedException 
     */
    void put(T object) throws InterruptedException;
}