Package io.netty.buffer

Class ByteBufInputStream

java.lang.Object

java.io.InputStream

io.netty.buffer.ByteBufInputStream

All Implemented Interfaces:

Closeable, DataInput, AutoCloseable

public class ByteBufInputStream
extends InputStream
implements DataInput

An InputStream which reads data from a ByteBuf.

A read operation against this stream will occur at the readerIndex of its underlying buffer and the readerIndex will increase during the read operation. Please note that it only reads up to the number of readable bytes determined at the moment of construction. Therefore, updating ByteBuf.writerIndex() will not affect the return value of available().

This stream implements DataInput for your convenience. The endianness of the stream is not always big endian but depends on the endianness of the underlying buffer.

See Also:

• ByteBufOutputStream

Field Summary

Fields

Modifier and Type	Field	Description
private final ByteBuf	buffer
private boolean	closed
private final int	endIndex
private StringBuilder	lineBuf
private final boolean	releaseOnClose	To preserve backwards compatibility (which didn't transfer ownership) we support a conditional flag which indicates if buffer should be released when this InputStream is closed.
private final int	startIndex

Constructor Summary

Constructors

Constructor	Description
ByteBufInputStream(ByteBuf buffer)	Creates a new stream which reads data from the specified buffer starting at the current readerIndex and ending at the current writerIndex.
ByteBufInputStream(ByteBuf buffer, boolean releaseOnClose)	Creates a new stream which reads data from the specified buffer starting at the current readerIndex and ending at the current writerIndex.
ByteBufInputStream(ByteBuf buffer, int length)	Creates a new stream which reads data from the specified buffer starting at the current readerIndex and ending at readerIndex + length.
ByteBufInputStream(ByteBuf buffer, int length, boolean releaseOnClose)	Creates a new stream which reads data from the specified buffer starting at the current readerIndex and ending at readerIndex + length.

Method Summary

Modifier and Type	Method	Description
int	available()
private void	checkAvailable(int fieldSize)
void	close()
void	mark(int readlimit)
boolean	markSupported()
int	read()
int	read(byte[] b, int off, int len)
boolean	readBoolean()
byte	readByte()
int	readBytes()	Returns the number of read bytes by this stream so far.
char	readChar()
double	readDouble()
float	readFloat()
void	readFully(byte[] b)
void	readFully(byte[] b, int off, int len)
int	readInt()
String	readLine()
long	readLong()
short	readShort()
int	readUnsignedByte()
int	readUnsignedShort()
String	readUTF()
void	reset()
long	skip(long n)
int	skipBytes(int n)

Methods inherited from class java.io.InputStream

nullInputStream, read, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

buffer

private final ByteBuf buffer

startIndex

private final int startIndex

endIndex

private final int endIndex

closed

private boolean closed

releaseOnClose

private final boolean releaseOnClose

To preserve backwards compatibility (which didn't transfer ownership) we support a conditional flag which indicates if buffer should be released when this InputStream is closed. However in future releases ownership should always be transferred and callers of this class should call ReferenceCounted.retain() if necessary.

lineBuf

private StringBuilder lineBuf

Constructor Details

ByteBufInputStream

public ByteBufInputStream(ByteBuf buffer)

Creates a new stream which reads data from the specified buffer starting at the current readerIndex and ending at the current writerIndex.

Parameters:

buffer - The buffer which provides the content for this InputStream.

ByteBufInputStream

public ByteBufInputStream(ByteBuf buffer,
 int length)

Creates a new stream which reads data from the specified buffer starting at the current readerIndex and ending at readerIndex + length.

Parameters:

buffer - The buffer which provides the content for this InputStream.

length - The length of the buffer to use for this InputStream.

Throws:

IndexOutOfBoundsException - if readerIndex + length is greater than writerIndex

ByteBufInputStream

public ByteBufInputStream(ByteBuf buffer,
 boolean releaseOnClose)

Creates a new stream which reads data from the specified buffer starting at the current readerIndex and ending at the current writerIndex.

Parameters:

buffer - The buffer which provides the content for this InputStream.

releaseOnClose - true means that when close() is called then ReferenceCounted.release() will be called on buffer.

ByteBufInputStream

public ByteBufInputStream(ByteBuf buffer,
 int length,
 boolean releaseOnClose)

Creates a new stream which reads data from the specified buffer starting at the current readerIndex and ending at readerIndex + length.

Parameters:

buffer - The buffer which provides the content for this InputStream.

length - The length of the buffer to use for this InputStream.

releaseOnClose - true means that when close() is called then ReferenceCounted.release() will be called on buffer.

Throws:

IndexOutOfBoundsException - if readerIndex + length is greater than writerIndex

Method Details

readBytes

public int readBytes()

Returns the number of read bytes by this stream so far.

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class InputStream

Throws:

IOException

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

mark

public void mark(int readlimit)

Overrides:

mark in class InputStream

markSupported

public boolean markSupported()

Overrides:

markSupported in class InputStream

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

public int read(byte[] b,
 int off,
 int len)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

reset

public void reset()
           throws IOException

Overrides:

reset in class InputStream

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class InputStream

Throws:

IOException

readBoolean

public boolean readBoolean()
                    throws IOException

Specified by:

readBoolean in interface DataInput

Throws:

IOException

readByte

public byte readByte()
              throws IOException

Specified by:

readByte in interface DataInput

Throws:

IOException

readChar

public char readChar()
              throws IOException

Specified by:

readChar in interface DataInput

Throws:

IOException

readDouble

public double readDouble()
                  throws IOException

Specified by:

readDouble in interface DataInput

Throws:

IOException

readFloat

public float readFloat()
                throws IOException

Specified by:

readFloat in interface DataInput

Throws:

IOException

readFully

public void readFully(byte[] b)
               throws IOException

Specified by:

readFully in interface DataInput

Throws:

IOException

readFully

public void readFully(byte[] b,
 int off,
 int len)
               throws IOException

Specified by:

readFully in interface DataInput

Throws:

IOException

readInt

public int readInt()
            throws IOException

Specified by:

readInt in interface DataInput

Throws:

IOException

readLine

public String readLine()
                throws IOException

Specified by:

readLine in interface DataInput

Throws:

IOException

readLong

public long readLong()
              throws IOException

Specified by:

readLong in interface DataInput

Throws:

IOException

readShort

public short readShort()
                throws IOException

Specified by:

readShort in interface DataInput

Throws:

IOException

readUTF

public String readUTF()
               throws IOException

Specified by:

readUTF in interface DataInput

Throws:

IOException

readUnsignedByte

public int readUnsignedByte()
                     throws IOException

Specified by:

readUnsignedByte in interface DataInput

Throws:

IOException

readUnsignedShort

public int readUnsignedShort()
                      throws IOException

Specified by:

readUnsignedShort in interface DataInput

Throws:

IOException

skipBytes

public int skipBytes(int n)
              throws IOException

Specified by:

skipBytes in interface DataInput

Throws:

IOException

checkAvailable

private void checkAvailable(int fieldSize)
                     throws IOException

Throws:

IOException