oracle.kv.impl.async.BytesInput Maven / Gradle / Ivy
/*-
* Copyright (C) 2011, 2018 Oracle and/or its affiliates. All rights reserved.
*
* This file was distributed by Oracle as part of a version of Oracle NoSQL
* Database made available at:
*
* http://www.oracle.com/technetwork/database/database-technologies/nosqldb/downloads/index.html
*
* Please see the LICENSE file included in the top-level directory of the
* appropriate version of Oracle NoSQL Database for a copy of the license and
* additional information.
*/
package oracle.kv.impl.async;
import java.io.EOFException;
/**
* An input that consumes chunks of bytes.
*
* The class provides methods to read from chunks of bytes for {@link
* MessageInput}. It serves as a shared interface for a list of different byte
* buffer implementations (e.g. netty ByteBuf and nio ByteBuffer).
*/
public interface BytesInput {
/**
* Fills the byte array with {@code len} bytes.
*
* @param b byte array
* @param off starting offset to fill the array
* @param len the maximum number of bytes to read
* @throws EOFException if there is not enough data
*/
void readFully(byte[] b, int off, int len) throws EOFException;
/**
* Skips {@code len} bytes.
*
* @param n the maximum number of bytes to skip
* @throws EOFException if there is not enough data
*/
void skipBytes(int n) throws EOFException;
/**
* Reads a byte.
*
* @return the byte read
* @throws EOFException if there is not enough data
*/
byte readByte() throws EOFException;
/**
* Returns the number of remaining bytes.
*
* @return the number of remaining bytes
*/
int remaining();
/**
* Release the resource associated with this input.
*/
void release();
}