package leigh.astro.indi.protocol.api;

/*
 * #%L
 * INDI Protocol implementation
 * %%
 * Copyright (C) 2012 - 2014 indiforjava
 * %%
 * This program 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 3 of the
 * License, or (at your option) any later version.
 *
 * This program 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 Lesser Public License for more details.
 *
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program. If not, see
 * <http://www.gnu.org/licenses/lgpl-3.0.html>.
 * #L%
 */

import leigh.astro.indi.protocol.INDIProtocol;

import java.io.Closeable;
import java.io.IOException;

/**
 * INDI Input stream interface to read indi protocol object from a stream.
 *
 * @author Richard van Nieuwenhoven
 * @author Alex Leigh
 */
public interface INDIInputStream extends Closeable {

    /**
     * closes the underlaying input stream.
     *
     * @throws IOException when something went wrong with the underlaying input stream.
     */
    void close() throws IOException;

    /**
     * @return the next indi protocol object from the stream. (blocking till the
     * next is available or null at end of stream)
     * @throws IOException if something went wrong with the desiralisation or the
     *                     underlaying stream.
     */
    INDIProtocol<?> readObject() throws IOException;
}
