org.xbib.io.Session Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of archive

Archive algorithms

The newest version!

package org.xbib.io;

import java.io.IOException;

/**
 * The Session interface is used for being opened, receive
 * operations, and being closed. Sessions must be opened before the first
 * operation and closed after the last operation.
 */
public interface Session {

    enum Mode {

        READ, WRITE, APPEND,CONTROL, DELETE;
    }

    /**
     * Open valve with a given input/output mode
     *
     * @throws java.io.IOException if valve can not be opened
     */
    void open(Mode mode) throws IOException;

    P newPacket();

    P read() throws IOException;

    void write(P packet) throws IOException;

    /**
     * Close valve
     *
     * @throws java.io.IOException if valve can not be closed
     */
    void close() throws IOException;

    /**
     * Checks if this session has been successfully opened.
     *
     * @return true if the session is open
     */
    boolean isOpen();
}