net.dona.doip.InDoipMessage Maven / Gradle / Ivy

Go to download
package net.dona.doip;

import java.util.stream.Stream;

import net.dona.doip.util.InDoipMessageUtil;

/**
 * A DOIP message to be read as input (for example, a response for the client, or a request for the server).
 * It is a stream or iterable of {@link InDoipSegment}s.  Users must call {@link #close()} when processing is complete.
 *
 * See also {@link InDoipMessageUtil}.
 */
public interface InDoipMessage extends Iterable, AutoCloseable {
    /**
     * Returns an stream over elements of type {@link InDoipSegment}.
     *
     * @return a Stream.
     */
    Stream stream();

    @Override
    void close();
}