io.pkts.buffer

Class InputStreamBuffer

java.lang.Object

io.pkts.buffer.AbstractBuffer

io.pkts.buffer.InputStreamBuffer

All Implemented Interfaces:

Buffer, java.lang.Cloneable

public final class InputStreamBuffer
extends AbstractBuffer

Author:

jonas@jonasborjesson.com

Field Summary

Fields inherited from class io.pkts.buffer.AbstractBuffer

lowerBoundary, markedReaderIndex, readerIndex, upperBoundary, writerIndex

Constructor Summary

Constructors

Constructor and Description
InputStreamBuffer(java.io.InputStream is)
InputStreamBuffer(int initialCapacity, java.io.InputStream is)

Method Summary

Modifier and Type	Method and Description
protected void	checkIndex(int index) Convenience method for checking if we can get the byte at the specified index.
Buffer	clone() Performs a deep clone of this object.
java.lang.String	dumpAsHex() Dump the content of this buffer as a hex dump ala Wireshark.
boolean	equals(java.lang.Object other) Check whether to buffers are considered to be equal.
boolean	equalsIgnoreCase(java.lang.Object other)
byte[]	getArray() Get the backing array.
byte	getByte(int index) Get the byte at the index.
void	getBytes()
void	getBytes(Buffer dst) Same as calling Buffer.getBytes(int, Buffer) where the index is Buffer.getReaderIndex().
void	getBytes(int index, Buffer dst) Transfer this buffer's data to the destination buffer.
int	getInt(int index) Get a 32-bit integer at the specified absolute index.
int	getReadableBytes() Returns the number of available bytes for reading without blocking.
short	getShort(int index)
short	getUnsignedByte(int index)
int	getUnsignedShort(int index)
int	getWritableBytes() Get the number of writable bytes.
int	hashCode()
boolean	hasReadableBytes() Checks whether this buffer has any bytes available for reading without blocking.
boolean	hasWritableBytes() Checks whether this Buffer has any space left for writing.
boolean	isEmpty() Check whether this buffer is empty or not.
byte	peekByte() Peak a head to see what the next byte is.
byte	readByte() Read the next byte, which will also increase the readerIndex by one.
Buffer	readBytes(int length) Read the requested number of bytes and increase the readerIndex with the corresponding number of bytes.
int	readInt() Read an int and will increase the reader index of this buffer by 4
short	readShort()
long	readUnsignedInt() Read an unsigned int and will increase the reader index of this buffer by 4
int	readUnsignedShort()
void	setByte(int index, byte value) Set the byte at given index to a new value
void	setInt(int index, int value)
void	setUnsignedByte(int index, short value)
void	setUnsignedInt(int index, long value)
void	setUnsignedShort(int index, int value)
Buffer	slice(int start, int stop) Get a slice of the buffer starting at start (inclusive) ending at stop (exclusive).
java.lang.String	toString()
void	write(int value)
void	write(long value)
void	writeAsString(int value) Write the integer value to this Buffer as a String.
void	writeAsString(long value) Write the long value to this Buffer as a String.

Methods inherited from class io.pkts.buffer.AbstractBuffer

capacity, checkReadableBytes, checkReadableBytesSafe, checkWritableBytesSafe, checkWriterIndex, getReaderIndex, getWriterIndex, hasWriteSupport, indexOf, indexOf, markReaderIndex, parseToInt, parseToInt, readLine, readUnsignedByte, readUntil, readUntil, readUntilDoubleCRLF, resetReaderIndex, setReaderIndex, slice, slice, write, write, write

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

InputStreamBuffer

public InputStreamBuffer(java.io.InputStream is)

InputStreamBuffer

public InputStreamBuffer(int initialCapacity,
                         java.io.InputStream is)

Parameters:

initialCapacity - the initial size of the internal byte array

is -

Method Detail

slice

public Buffer slice(int start,
                    int stop)

Get a slice of the buffer starting at start (inclusive) ending at stop (exclusive). Hence, the new capacity of the buffer is stop - start

Returns:

readByte

public byte readByte()
              throws java.lang.IndexOutOfBoundsException,
                     java.io.IOException

Read the next byte, which will also increase the readerIndex by one.

Returns:

the next byte

Throws:

java.io.IOException

java.lang.IndexOutOfBoundsException - in case there is nothing left to read

peekByte

public byte peekByte()
              throws java.lang.IndexOutOfBoundsException,
                     java.io.IOException

Peak a head to see what the next byte is. This method will not change the readerIndex

Returns:

the next byte

Throws:

java.lang.IndexOutOfBoundsException - in case there is nothing left to read

java.io.IOException

readBytes

public Buffer readBytes(int length)
                 throws java.lang.IndexOutOfBoundsException,
                        java.io.IOException

Read the requested number of bytes and increase the readerIndex with the corresponding number of bytes. The new buffer and this buffer both share the same backing array so changing either one of them will affect the other.

Returns:

Throws:

java.io.IOException

java.lang.IndexOutOfBoundsException

getReadableBytes

public int getReadableBytes()

Returns the number of available bytes for reading without blocking. If this returns less than what you want, there may still be more bytes available depending on the underlying implementation. E.g., a Buffer backed by an InputStream may be able to read more off the stream, however, it may not be able to do so without blocking.

Specified by:

getReadableBytes in interface Buffer

Overrides:

getReadableBytes in class AbstractBuffer

Returns:

hasReadableBytes

public boolean hasReadableBytes()

Checks whether this buffer has any bytes available for reading without blocking. This is the same as #readableBytes > 0

Returns:

Throws:

java.io.IOException

java.lang.IndexOutOfBoundsException

isEmpty

public boolean isEmpty()

Check whether this buffer is empty or not. This is the same as !Buffer.hasReadableBytes()

Returns:

getArray

public byte[] getArray()

Get the backing array.

Returns:

getByte

public byte getByte(int index)
             throws java.lang.IndexOutOfBoundsException,
                    java.io.IOException

Get the byte at the index. Note, depending on the underlying implementing buffer, this method may block and try and read the missing bytes off a stream. E.g., the InputStreamBuffer gets its bytes off of a InputStream so let's say you have read 10 bytes off of the stream already but ask to access the byte at index 20, we will try and ready an additional 10 bytes from the InputStream so we can return the byte at index 20.

Returns:

the byte at the specified index

Throws:

java.lang.IndexOutOfBoundsException - in case the index is greater than the capacity of this buffer

java.io.IOException

checkIndex

protected void checkIndex(int index)
                   throws java.lang.IndexOutOfBoundsException

Convenience method for checking if we can get the byte at the specified index. If we can't, then we will try and read the missing bytes off of the underlying InputStream. If that fails, e.g. we don't ready enough bytes off of the stream, then we will eventually throw an IndexOutOfBoundsException

Overrides:

checkIndex in class AbstractBuffer

Parameters:

index - the actual index to check. I.e., this is the actual index in our byte array, irrespective of what the lowerBoundary is set to.

Throws:

java.lang.IndexOutOfBoundsException

java.io.IOException

readUnsignedInt

public long readUnsignedInt()
                     throws java.lang.IndexOutOfBoundsException

Read an unsigned int and will increase the reader index of this buffer by 4

Returns:

a long representing the unsigned int

Throws:

java.lang.IndexOutOfBoundsException - in case there is not 4 bytes left to read

readInt

public int readInt()
            throws java.lang.IndexOutOfBoundsException

Read an int and will increase the reader index of this buffer by 4

Returns:

the int value

Throws:

java.lang.IndexOutOfBoundsException - in case there is not 4 bytes left to read

getInt

public int getInt(int index)
           throws java.lang.IndexOutOfBoundsException

Get a 32-bit integer at the specified absolute index. This method will not modify the readerIndex of this buffer.

Returns:

Throws:

java.lang.IndexOutOfBoundsException - in case there is not 4 bytes left to read

getShort

public short getShort(int index)
               throws java.lang.IndexOutOfBoundsException

Throws:

java.lang.IndexOutOfBoundsException

readUnsignedShort

public int readUnsignedShort()
                      throws java.lang.IndexOutOfBoundsException

Throws:

java.lang.IndexOutOfBoundsException

getUnsignedShort

public int getUnsignedShort(int index)
                     throws java.lang.IndexOutOfBoundsException

Throws:

java.lang.IndexOutOfBoundsException

readShort

public short readShort()
                throws java.lang.IndexOutOfBoundsException

Throws:

java.lang.IndexOutOfBoundsException

getUnsignedByte

public short getUnsignedByte(int index)
                      throws java.lang.IndexOutOfBoundsException

Throws:

java.lang.IndexOutOfBoundsException

dumpAsHex

public java.lang.String dumpAsHex()

Dump the content of this buffer as a hex dump ala Wireshark. Mainly for debugging purposes

Returns:

setByte

public void setByte(int index,
                    byte value)
             throws java.lang.IndexOutOfBoundsException

Set the byte at given index to a new value

Parameters:

index - the index

value - the value

Throws:

java.lang.IndexOutOfBoundsException

setUnsignedByte

public void setUnsignedByte(int index,
                            short value)
                     throws java.lang.IndexOutOfBoundsException

Throws:

java.lang.IndexOutOfBoundsException

setUnsignedShort

public void setUnsignedShort(int index,
                             int value)
                      throws java.lang.IndexOutOfBoundsException

Throws:

java.lang.IndexOutOfBoundsException

clone

public Buffer clone()

Description copied from interface: Buffer

Performs a deep clone of this object. I.e., the array that is backed by this buffer will be copied and a new buffer will be returned. Hence, any changes to the backing of this buffer will not affect the cloned buffer.

Specified by:

clone in interface Buffer

Specified by:

clone in class AbstractBuffer

Returns:

equals

public boolean equals(java.lang.Object other)

Check whether to buffers are considered to be equal. To buffers are equal if the underlying visible area of the byte array are equal.

Specified by:

equals in interface Buffer

Specified by:

equals in class AbstractBuffer

equalsIgnoreCase

public boolean equalsIgnoreCase(java.lang.Object other)

hashCode

public int hashCode()

Specified by:

hashCode in interface Buffer

Specified by:

hashCode in class AbstractBuffer

toString

public java.lang.String toString()

Specified by:

toString in interface Buffer

Overrides:

toString in class java.lang.Object

getWritableBytes

public int getWritableBytes()

Description copied from interface: Buffer

Get the number of writable bytes.

Specified by:

getWritableBytes in interface Buffer

Overrides:

getWritableBytes in class AbstractBuffer

Returns:

hasWritableBytes

public boolean hasWritableBytes()

Description copied from interface: Buffer

Checks whether this Buffer has any space left for writing. Same as Buffer.getWritableBytes() > 0

Specified by:

hasWritableBytes in interface Buffer

Overrides:

hasWritableBytes in class AbstractBuffer

Returns:

getBytes

public void getBytes()

getBytes

public void getBytes(Buffer dst)

Description copied from interface: Buffer

Same as calling Buffer.getBytes(int, Buffer) where the index is Buffer.getReaderIndex().

getBytes

public void getBytes(int index,
                     Buffer dst)
              throws java.lang.IndexOutOfBoundsException

Description copied from interface: Buffer

Transfer this buffer's data to the destination buffer. This method does not change the readerIndex or the writerIndex of the src buffer (i.e. this) but will increase the writerIndex of the destination buffer.

Throws:

java.lang.IndexOutOfBoundsException - in case index < 0

setInt

public void setInt(int index,
                   int value)
            throws java.lang.IndexOutOfBoundsException

Throws:

java.lang.IndexOutOfBoundsException

write

public void write(int value)
           throws java.lang.IndexOutOfBoundsException,
                  WriteNotSupportedException

Throws:

java.lang.IndexOutOfBoundsException

WriteNotSupportedException

write

public void write(long value)
           throws java.lang.IndexOutOfBoundsException,
                  WriteNotSupportedException

Throws:

java.lang.IndexOutOfBoundsException

WriteNotSupportedException

writeAsString

public void writeAsString(int value)
                   throws java.lang.IndexOutOfBoundsException,
                          WriteNotSupportedException

Description copied from interface: Buffer

Write the integer value to this Buffer as a String.

Parameters:

value - the value that will be converted to a String before being written to this Buffer.

Throws:

java.lang.IndexOutOfBoundsException

WriteNotSupportedException

writeAsString

public void writeAsString(long value)
                   throws java.lang.IndexOutOfBoundsException,
                          WriteNotSupportedException

Description copied from interface: Buffer

Write the long value to this Buffer as a String.

Parameters:

value - the value that will be converted to a String before being written to this Buffer.

Throws:

java.lang.IndexOutOfBoundsException

WriteNotSupportedException

setUnsignedInt

public void setUnsignedInt(int index,
                           long value)
                    throws java.lang.IndexOutOfBoundsException

Throws:

java.lang.IndexOutOfBoundsException