NettyMessageBuffer (nadron 0.4.1 API)

java.lang.Object
- io.nadron.communication.NettyMessageBuffer

All Implemented Interfaces:

MessageBuffer<io.netty.buffer.ByteBuf>
```
public class NettyMessageBuffer
extends Object
implements MessageBuffer<io.netty.buffer.ByteBuf>
```
This class is an implementation of the MessageBuffer interface. It is a thin wrapper over the the Netty ByteBuf with some additional methods for string and object read write. It does not expose all methods of the ChannelBuffer, instead it has a method getNativeBuffer() which can be used to retrieve the buffer and then call the appropriate method. For writing to the buffer, this class uses ByteBuf implementation.

Author:

Abraham Menacherry

Field Summary

Fields
Modifier and Type Field and Description

private io.netty.buffer.ByteBuf buffer

Fields
Modifier and Type	Field and Description
`private io.netty.buffer.ByteBuf`	`buffer`

Constructor Summary

Constructors
Constructor and Description
`NettyMessageBuffer()`
`NettyMessageBuffer(io.netty.buffer.ByteBuf buffer)` This constructor can be used when trying to read information from a `ByteBuf`.

Method Summary

Methods
Modifier and Type	Method and Description
`byte[]`	`array()` Returns the backing byte array of this buffer.
`void`	`clear()` Clears the contents of this buffer.
`io.netty.buffer.ByteBuf`	`getNativeBuffer()` Returns the actual buffer implementation that is wrapped in this MessageBuffer instance.
`boolean`	`isReadable()`
`int`	`readableBytes()` Gets the number of readable bytes left in the buffer.
`int`	`readByte()` Read a single signed byte from the current `readerIndex` position of the buffer.
`void`	`readBytes(byte[] dst)` Transfers this buffer's data to the specified destination starting at the current `readerIndex` and increases the `readerIndex` by the number of the transferred bytes (= `dst.length`).
`void`	`readBytes(byte[] dst, int dstIndex, int length)` Transfers this buffer's data to the specified destination starting at the current `readerIndex` and increases the `readerIndex` by the number of the transferred bytes (= `length`).
`byte[]`	`readBytes(int length)`
`char`	`readChar()` Gets a 2-byte UTF-16 character at the current `readerIndex` and increases the `readerIndex` by `2` in this buffer.
`double`	`readDouble()` Gets a 64-bit floating point number at the current `readerIndex` and increases the `readerIndex` by `8` in this buffer.
`float`	`readFloat()` Gets a 32-bit floating point number at the current `readerIndex` and increases the `readerIndex` by `4` in this buffer.
`int`	`readInt()` Gets a 32-bit integer at the current `readerIndex` and increases the `readerIndex` by `4` in this buffer.
`long`	`readLong()` Gets a 64-bit integer at the current `readerIndex` and increases the `readerIndex` by `8` in this buffer.
`int`	`readMedium()` Gets a 24-bit medium integer at the current `readerIndex` and increases the `readerIndex` by `3` in this buffer.
`<V> V`	`readObject(Transform<io.netty.buffer.ByteBuf,V> converter)` Reads an object from the underlying buffer and transform the bytes using the supplied transformer to any desired object.
`int`	`readShort()` Gets a 16-bit short integer at the current `readerIndex` and increases the `readerIndex` by `2` in this buffer.
`String`	`readString()`
`String[]`	`readStrings(int numOfStrings)`
`int`	`readUnsignedByte()` Gets an unsigned byte at the current `readerIndex` and increases the `readerIndex` by `1` in this buffer.
`long`	`readUnsignedInt()` Gets an unsigned 32-bit integer at the current `readerIndex` and increases the `readerIndex` by `4` in this buffer.
`int`	`readUnsignedMedium()` Gets an unsigned 24-bit medium integer at the current `readerIndex` and increases the `readerIndex` by `3` in this buffer.
`int`	`readUnsignedShort()` Gets an unsigned 16-bit short integer at the current `readerIndex` and increases the `readerIndex` by `2` in this buffer.
`MessageBuffer<io.netty.buffer.ByteBuf>`	`writeByte(byte b)`
`MessageBuffer<io.netty.buffer.ByteBuf>`	`writeBytes(byte[] src)` Transfers the specified source array's data to this buffer starting at the current `writerIndex` and increases the `writerIndex` by the number of the transferred bytes (= `src.length`).
`MessageBuffer<io.netty.buffer.ByteBuf>`	`writeChar(int value)` Sets the specified 2-byte UTF-16 character at the current `writerIndex` and increases the `writerIndex` by `2` in this buffer.
`MessageBuffer<io.netty.buffer.ByteBuf>`	`writeDouble(double value)` Sets the specified 64-bit floating point number at the current `writerIndex` and increases the `writerIndex` by `8` in this buffer.
`MessageBuffer<io.netty.buffer.ByteBuf>`	`writeFloat(float value)` Sets the specified 32-bit floating point number at the current `writerIndex` and increases the `writerIndex` by `4` in this buffer.
`MessageBuffer<io.netty.buffer.ByteBuf>`	`writeInt(int value)` Sets the specified 32-bit integer at the current `writerIndex` and increases the `writerIndex` by `4` in this buffer.
`MessageBuffer<io.netty.buffer.ByteBuf>`	`writeLong(long value)` Sets the specified 64-bit long integer at the current `writerIndex` and increases the `writerIndex` by `8` in this buffer.
`MessageBuffer<io.netty.buffer.ByteBuf>`	`writeMedium(int value)` Sets the specified 24-bit medium integer at the current `writerIndex` and increases the `writerIndex` by `3` in this buffer.
`<V> MessageBuffer<io.netty.buffer.ByteBuf>`	`writeObject(Transform<V,io.netty.buffer.ByteBuf> converter, V object)` Most implementations will write an object to the underlying buffer after converting the incoming object using the transformer into a byte array.
`MessageBuffer<io.netty.buffer.ByteBuf>`	`writeShort(int value)` Sets the specified 16-bit short integer at the current `writerIndex` and increases the `writerIndex` by `2` in this buffer.
`MessageBuffer<io.netty.buffer.ByteBuf>`	`writeString(String message)`
`MessageBuffer<io.netty.buffer.ByteBuf>`	`writeStrings(String... messages)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - buffer
```
private final io.netty.buffer.ByteBuf buffer
```
- Constructor Detail
  - NettyMessageBuffer
```
public NettyMessageBuffer()
```
  - NettyMessageBuffer
```
public NettyMessageBuffer(io.netty.buffer.ByteBuf buffer)
```
    This constructor can be used when trying to read information from a ByteBuf.
    
    Parameters:
    buffer -
- Method Detail
  - isReadable
```
public boolean isReadable()
```
    Specified by:
    
    isReadable in interface MessageBuffer<io.netty.buffer.ByteBuf>
    
    Returns:
    Returns true if something can be read from this buffer, else false.
  - readableBytes
```
public int readableBytes()
```
    Description copied from interface: MessageBuffer
    
    Gets the number of readable bytes left in the buffer.
    
    Specified by:
    
    readableBytes in interface MessageBuffer<io.netty.buffer.ByteBuf>
    
    Returns:
    an integer containing the remaining readable bytes.
  - array
```
public byte[] array()
```
    Description copied from interface: MessageBuffer
    
    Returns the backing byte array of this buffer.
    
    Specified by:
    
    array in interface MessageBuffer<io.netty.buffer.ByteBuf>
  - clear
```
public void clear()
```
    Description copied from interface: MessageBuffer
    
    Clears the contents of this buffer.
    
    Specified by:
    
    clear in interface MessageBuffer<io.netty.buffer.ByteBuf>
  - getNativeBuffer
```
public io.netty.buffer.ByteBuf getNativeBuffer()
```
    Description copied from interface: MessageBuffer
    
    Returns the actual buffer implementation that is wrapped in this MessageBuffer instance.
    
    Specified by:
    
    getNativeBuffer in interface MessageBuffer<io.netty.buffer.ByteBuf>
    
    Returns:
    This method will return the underlying buffer. For Netty that would be a ByteBuf, for a core java implementation it could be ByteBuffer
  - readByte
```
public int readByte()
```
    Description copied from interface: MessageBuffer
    
    Read a single signed byte from the current readerIndex position of the buffer. It will increment the readerIndex after doing this operation.
    
    Specified by:
    
    readByte in interface MessageBuffer<io.netty.buffer.ByteBuf>
    
    Returns:
    Returns the byte that is read
  - readUnsignedByte
```
public int readUnsignedByte()
```
    Description copied from interface: MessageBuffer
    
    Gets an unsigned byte at the current readerIndex and increases the readerIndex by 1 in this buffer.
    
    Specified by:
    
    readUnsignedByte in interface MessageBuffer<io.netty.buffer.ByteBuf>
  - readBytes
```
public byte[] readBytes(int length)
```
    Specified by:
    
    readBytes in interface MessageBuffer<io.netty.buffer.ByteBuf>
  - readBytes
```
public void readBytes(byte[] dst)
```
    Description copied from interface: MessageBuffer
    
    Transfers this buffer's data to the specified destination starting at the current readerIndex and increases the readerIndex by the number of the transferred bytes (= dst.length).
    
    Specified by:
    
    readBytes in interface MessageBuffer<io.netty.buffer.ByteBuf>
  - readBytes
```
public void readBytes(byte[] dst,
             int dstIndex,
             int length)
```
    Description copied from interface: MessageBuffer
    
    Transfers this buffer's data to the specified destination starting at the current readerIndex and increases the readerIndex by the number of the transferred bytes (= length).
    
    Specified by:
    
    readBytes in interface MessageBuffer<io.netty.buffer.ByteBuf>
    
    dstIndex - the first index of the destination
    length - the number of bytes to transfer
  - readChar
```
public char readChar()
```
    Description copied from interface: MessageBuffer
    
    Gets a 2-byte UTF-16 character at the current readerIndex and increases the readerIndex by 2 in this buffer.
    
    Specified by:
    
    readChar in interface MessageBuffer<io.netty.buffer.ByteBuf>
  - readUnsignedShort
```
public int readUnsignedShort()
```
    Description copied from interface: MessageBuffer
    
    Gets an unsigned 16-bit short integer at the current readerIndex and increases the readerIndex by 2 in this buffer.
    
    Specified by:
    
    readUnsignedShort in interface MessageBuffer<io.netty.buffer.ByteBuf>
  - readShort
```
public int readShort()
```
    Description copied from interface: MessageBuffer
    
    Gets a 16-bit short integer at the current readerIndex and increases the readerIndex by 2 in this buffer.
    
    Specified by:
    
    readShort in interface MessageBuffer<io.netty.buffer.ByteBuf>
  - readUnsignedMedium
```
public int readUnsignedMedium()
```
    Description copied from interface: MessageBuffer
    
    Gets an unsigned 24-bit medium integer at the current readerIndex and increases the readerIndex by 3 in this buffer.
    
    Specified by:
    
    readUnsignedMedium in interface MessageBuffer<io.netty.buffer.ByteBuf>
  - readMedium
```
public int readMedium()
```
    Description copied from interface: MessageBuffer
    
    Gets a 24-bit medium integer at the current readerIndex and increases the readerIndex by 3 in this buffer.
    
    Specified by:
    
    readMedium in interface MessageBuffer<io.netty.buffer.ByteBuf>
  - readUnsignedInt
```
public long readUnsignedInt()
```
    Description copied from interface: MessageBuffer
    
    Gets an unsigned 32-bit integer at the current readerIndex and increases the readerIndex by 4 in this buffer.
    
    Specified by:
    
    readUnsignedInt in interface MessageBuffer<io.netty.buffer.ByteBuf>
  - readInt
```
public int readInt()
```
    Description copied from interface: MessageBuffer
    
    Gets a 32-bit integer at the current readerIndex and increases the readerIndex by 4 in this buffer.
    
    Specified by:
    
    readInt in interface MessageBuffer<io.netty.buffer.ByteBuf>
  - readLong
```
public long readLong()
```
    Description copied from interface: MessageBuffer
    
    Gets a 64-bit integer at the current readerIndex and increases the readerIndex by 8 in this buffer.
    
    Specified by:
    
    readLong in interface MessageBuffer<io.netty.buffer.ByteBuf>
  - readFloat
```
public float readFloat()
```
    Description copied from interface: MessageBuffer
    
    Gets a 32-bit floating point number at the current readerIndex and increases the readerIndex by 4 in this buffer.
    
    Specified by:
    
    readFloat in interface MessageBuffer<io.netty.buffer.ByteBuf>
  - readDouble
```
public double readDouble()
```
    Description copied from interface: MessageBuffer
    
    Gets a 64-bit floating point number at the current readerIndex and increases the readerIndex by 8 in this buffer.
    
    Specified by:
    
    readDouble in interface MessageBuffer<io.netty.buffer.ByteBuf>
  - readString
```
public String readString()
```
    Specified by:
    
    readString in interface MessageBuffer<io.netty.buffer.ByteBuf>
  - readStrings
```
public String[] readStrings(int numOfStrings)
```
    Specified by:
    
    readStrings in interface MessageBuffer<io.netty.buffer.ByteBuf>
  - readObject
```
public <V> V readObject(Transform<io.netty.buffer.ByteBuf,V> converter)
```
    Description copied from interface: MessageBuffer
    
    Reads an object from the underlying buffer and transform the bytes using the supplied transformer to any desired object. This method provide the flexibility to decode the bytes to any type of object.
    
    Specified by:
    
    readObject in interface MessageBuffer<io.netty.buffer.ByteBuf>
    
    Parameters:
    converter - The converter which will transform the bytes to relevant object.
    
    Returns:
    The object of type V, or null if the underlying buffer is null or empty.
  - writeByte
```
public MessageBuffer<io.netty.buffer.ByteBuf> writeByte(byte b)
```
    Specified by:
    
    writeByte in interface MessageBuffer<io.netty.buffer.ByteBuf>
  - writeBytes
```
public MessageBuffer<io.netty.buffer.ByteBuf> writeBytes(byte[] src)
```
    Description copied from interface: MessageBuffer
    
    Transfers the specified source array's data to this buffer starting at the current writerIndex and increases the writerIndex by the number of the transferred bytes (= src.length).
    
    Specified by:
    
    writeBytes in interface MessageBuffer<io.netty.buffer.ByteBuf>
  - writeChar
```
public MessageBuffer<io.netty.buffer.ByteBuf> writeChar(int value)
```
    Description copied from interface: MessageBuffer
    
    Sets the specified 2-byte UTF-16 character at the current writerIndex and increases the writerIndex by 2 in this buffer. The 16 high-order bits of the specified value are ignored.
    
    Specified by:
    
    writeChar in interface MessageBuffer<io.netty.buffer.ByteBuf>
  - writeShort
```
public MessageBuffer<io.netty.buffer.ByteBuf> writeShort(int value)
```
    Description copied from interface: MessageBuffer
    
    Sets the specified 16-bit short integer at the current writerIndex and increases the writerIndex by 2 in this buffer. The 16 high-order bits of the specified value are ignored.
    
    Specified by:
    
    writeShort in interface MessageBuffer<io.netty.buffer.ByteBuf>
  - writeMedium
```
public MessageBuffer<io.netty.buffer.ByteBuf> writeMedium(int value)
```
    Description copied from interface: MessageBuffer
    
    Sets the specified 24-bit medium integer at the current writerIndex and increases the writerIndex by 3 in this buffer.
    
    Specified by:
    
    writeMedium in interface MessageBuffer<io.netty.buffer.ByteBuf>
  - writeInt
```
public MessageBuffer<io.netty.buffer.ByteBuf> writeInt(int value)
```
    Description copied from interface: MessageBuffer
    
    Sets the specified 32-bit integer at the current writerIndex and increases the writerIndex by 4 in this buffer.
    
    Specified by:
    
    writeInt in interface MessageBuffer<io.netty.buffer.ByteBuf>
  - writeLong
```
public MessageBuffer<io.netty.buffer.ByteBuf> writeLong(long value)
```
    Description copied from interface: MessageBuffer
    
    Sets the specified 64-bit long integer at the current writerIndex and increases the writerIndex by 8 in this buffer.
    
    Specified by:
    
    writeLong in interface MessageBuffer<io.netty.buffer.ByteBuf>
  - writeFloat
```
public MessageBuffer<io.netty.buffer.ByteBuf> writeFloat(float value)
```
    Description copied from interface: MessageBuffer
    
    Sets the specified 32-bit floating point number at the current writerIndex and increases the writerIndex by 4 in this buffer.
    
    Specified by:
    
    writeFloat in interface MessageBuffer<io.netty.buffer.ByteBuf>
  - writeDouble
```
public MessageBuffer<io.netty.buffer.ByteBuf> writeDouble(double value)
```
    Description copied from interface: MessageBuffer
    
    Sets the specified 64-bit floating point number at the current writerIndex and increases the writerIndex by 8 in this buffer.
    
    Specified by:
    
    writeDouble in interface MessageBuffer<io.netty.buffer.ByteBuf>
  - writeString
```
public MessageBuffer<io.netty.buffer.ByteBuf> writeString(String message)
```
    Specified by:
    
    writeString in interface MessageBuffer<io.netty.buffer.ByteBuf>
  - writeStrings
```
public MessageBuffer<io.netty.buffer.ByteBuf> writeStrings(String... messages)
```
    Specified by:
    
    writeStrings in interface MessageBuffer<io.netty.buffer.ByteBuf>
  - writeObject
```
public <V> MessageBuffer<io.netty.buffer.ByteBuf> writeObject(Transform<V,io.netty.buffer.ByteBuf> converter,
                                                     V object)
```
    Description copied from interface: MessageBuffer
    
    Most implementations will write an object to the underlying buffer after converting the incoming object using the transformer into a byte array. This method provides the flexibility to encode any type of object, to a byte array or buffer(mostly).
    
    Specified by:
    
    writeObject in interface MessageBuffer<io.netty.buffer.ByteBuf>
    
    Type Parameters:
    V - The object to be converted, mostly to a byte array or relevant buffer implementation.
    Parameters:
    converter - For most implementations, the converter which will transform the object to byte array.
    
    Returns:
    Instance of this class itself.

Class NettyMessageBuffer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

buffer

Constructor Detail

NettyMessageBuffer

NettyMessageBuffer

Method Detail

isReadable

readableBytes

array

clear

getNativeBuffer

readByte

readUnsignedByte

readBytes

readBytes

readBytes

readChar

readUnsignedShort

readShort

readUnsignedMedium

readMedium

readUnsignedInt

readInt

readLong

readFloat

readDouble

readString

readStrings

readObject

writeByte

writeBytes

writeChar

writeShort

writeMedium

writeInt

writeLong

writeFloat

writeDouble

writeString

writeStrings

writeObject