RTPSByteBuffer (jRTPS 1.4.0 API)

java.lang.Object
- net.sf.jrtps.transport.RTPSByteBuffer

```
public class RTPSByteBuffer
extends Object
```
This class is used to marshal and unmarshal data to underlying buffer. Each read and write operation is aligned on their natural boundaries, as specified in formal-02-06-51.pdf: ch. 15.3 CDR Transfer syntax.

Author:

mcr70

Constructor Summary

Constructors
Constructor and Description
`RTPSByteBuffer(byte[] bytes)` Constructs RTPSByteBuffer.
`RTPSByteBuffer(ByteBuffer buffer)` Constructs RTPSByteBuffer.
`RTPSByteBuffer(InputStream is)` Constructs RTPSByteBuffer.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`align(int byteBoundary)` Aligns this buffer to given byteBoundary.
`ByteBuffer`	`getBuffer()` Get the underlying ByteBuffer.
`InputStream`	`getInputStream()` Gets an InputStream reading from the backing ByteBuffer.
`OutputStream`	`getOutputStream()` Gets an OutputStream that writes to this RTPSByteBuffer.
`int`	`position()` Get the position in underlying buffer.
`boolean`	`read_boolean()` Reads a boolean from underlying buffer.
`int`	`read_long()` Reads a long (4 bytes) from underlying buffer
`long`	`read_longlong()` Reads a longlong (8 bytes) from underlying buffer
`byte`	`read_octet()` Reads an octet (1 byte) from underlying buffer.
`int`	`read_short()` Reads a short (2 bytes) from underlying buffer
`String`	`read_string()` Reads a String from underlying buffer
`void`	`read(byte[] bytes)` Reads in bytes(octets) from underlying buffer.
`boolean`	`readBoolean()` Reads a java primitive boolean.
`byte`	`readByte()` Reads a java primitive byte.
`char`	`readChar()` Reads a java primitive char.
`double`	`readDouble()` Reads a java primitive double.
`float`	`readFloat()` Reads a java primitive float.
`int`	`readInt()` Reads a java primitive int.
`long`	`readLong()` Reads a java primitive long.
`short`	`readShort()` Reads a java primitive short.
`String`	`readString()` Reads a String from the buffer.
`String`	`readString(String charsetName)` Reads a String from the buffer.
`void`	`setEndianess(boolean endianessFlag)` Sets the endianness used. see 9.4.5.1.2 flags
`byte[]`	`toArray()` Returns a byte array from the beginning of backing array to current position
`void`	`write_boolean(boolean b)` Writes a boolean to underlying buffer
`void`	`write_long(int a_long)` Writes a long (4 bytes) to underlying buffer
`void`	`write_longlong(long a_longlong)` Writes a longlong (8 bytes) to underlying buffer
`void`	`write_octet(byte an_octet)` Writes an octet (1 byte) to underlying buffer.
`void`	`write_short(int a_short)` Writes a short (2 bytes) to underlying buffer
`void`	`write_string(String s)` Writes a string to underlying buffer
`void`	`write(byte[] bytes)` Writes bytes(octets).
`void`	`writeBoolean(boolean b)` Writes a java primitive boolean.
`void`	`writeByte(byte b)` Writes a java primitive byte.
`void`	`writeChar(char c)` Writes a java primitive char.
`void`	`writeDouble(double d)` Writes a java primitive double.
`void`	`writeFloat(float f)` Writes a java primitive float.
`void`	`writeInt(int i)` Writes a java primitive int.
`void`	`writeLong(long l)` Writes a java primitive long.
`void`	`writeShort(short s)` Writes a java primitive short.
`void`	`writeString(String s)` Writes a String into this buffer.
`void`	`writeString(String s, String charsetName)` Writes a String into this buffer with given charsetName. charsetName is used when getting the bytes of the String.

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

- Constructor Detail
  - RTPSByteBuffer
```
public RTPSByteBuffer(byte[] bytes)
```
    Constructs RTPSByteBuffer.
    
    Parameters:
    
    bytes - An array of bytes to wrap into this RTPSByteBuffer
  - RTPSByteBuffer
```
public RTPSByteBuffer(ByteBuffer buffer)
```
    Constructs RTPSByteBuffer.
    
    Parameters:
    
    buffer - Underlying ByteBuffer
    
    See Also:
    
    ByteBuffer
  - RTPSByteBuffer
```
public RTPSByteBuffer(InputStream is)
               throws IOException
```
    Constructs RTPSByteBuffer.
    
    Parameters:
    
    is - InputStream used to read bytes from
    
    Throws:
    
    IOException - on IOException
    
    See Also:
    
    InputStream
- Method Detail
  - position
```
public int position()
```
    Get the position in underlying buffer.
    
    Returns:
    
    position
  - read_octet
```
public byte read_octet()
```
    Reads an octet (1 byte) from underlying buffer.
    
    Returns:
    
    octet
  - write_octet
```
public void write_octet(byte an_octet)
```
    Writes an octet (1 byte) to underlying buffer.
    
    Parameters:
    
    an_octet - An octet to write
  - read_short
```
public int read_short()
```
    Reads a short (2 bytes) from underlying buffer
    
    Returns:
    
    a_short
  - write_short
```
public void write_short(int a_short)
```
    Writes a short (2 bytes) to underlying buffer
    
    Parameters:
    
    a_short - a short to write
  - read_long
```
public int read_long()
```
    Reads a long (4 bytes) from underlying buffer
    
    Returns:
    
    long
  - write_long
```
public void write_long(int a_long)
```
    Writes a long (4 bytes) to underlying buffer
    
    Parameters:
    
    a_long - a long to write
  - read_longlong
```
public long read_longlong()
```
    Reads a longlong (8 bytes) from underlying buffer
    
    Returns:
    
    a_longlong
  - write_longlong
```
public void write_longlong(long a_longlong)
```
    Writes a longlong (8 bytes) to underlying buffer
    
    Parameters:
    
    a_longlong - a longlong to write
  - read_boolean
```
public boolean read_boolean()
```
    Reads a boolean from underlying buffer. Internally, an octet is read.
    
    Returns:
    
    boolean
  - write_boolean
```
public void write_boolean(boolean b)
```
    Writes a boolean to underlying buffer
    
    Parameters:
    
    b - boolean to write
  - read_string
```
public String read_string()
```
    Reads a String from underlying buffer
    
    Returns:
    
    String
  - write_string
```
public void write_string(String s)
```
    Writes a string to underlying buffer
    
    Parameters:
    
    s - string to write
  - readInt
```
public int readInt()
```
    Reads a java primitive int.
    
    Returns:
    
    an int
  - writeInt
```
public void writeInt(int i)
```
    Writes a java primitive int.
    
    Parameters:
    
    i - int to write
  - readShort
```
public short readShort()
```
    Reads a java primitive short.
    
    Returns:
    
    a short
  - writeShort
```
public void writeShort(short s)
```
    Writes a java primitive short.
    
    Parameters:
    
    s - a Java short to write
  - readLong
```
public long readLong()
```
    Reads a java primitive long.
    
    Returns:
    
    a long
  - writeLong
```
public void writeLong(long l)
```
    Writes a java primitive long.
    
    Parameters:
    
    l - a Java long to write
  - readFloat
```
public float readFloat()
```
    Reads a java primitive float.
    
    Returns:
    
    a float
  - writeFloat
```
public void writeFloat(float f)
```
    Writes a java primitive float.
    
    Parameters:
    
    f - a Java float to write
  - readDouble
```
public double readDouble()
```
    Reads a java primitive double.
    
    Returns:
    
    a double
  - writeDouble
```
public void writeDouble(double d)
```
    Writes a java primitive double.
    
    Parameters:
    
    d - a Java double to write
  - readChar
```
public char readChar()
```
    Reads a java primitive char.
    
    Returns:
    
    a char
  - writeChar
```
public void writeChar(char c)
```
    Writes a java primitive char.
    
    Parameters:
    
    c - a java char to write
  - readByte
```
public byte readByte()
```
    Reads a java primitive byte.
    
    Returns:
    
    a byte
  - writeByte
```
public void writeByte(byte b)
```
    Writes a java primitive byte.
    
    Parameters:
    
    b - a java byte to write
  - readBoolean
```
public boolean readBoolean()
```
    Reads a java primitive boolean.
    
    Returns:
    
    a boolean
  - writeBoolean
```
public void writeBoolean(boolean b)
```
    Writes a java primitive boolean.
    
    Parameters:
    
    b - a java boolean to write
  - read
```
public void read(byte[] bytes)
```
    Reads in bytes(octets) from underlying buffer.
    
    Parameters:
    
    bytes - byte array
  - write
```
public void write(byte[] bytes)
```
    Writes bytes(octets).
    
    Parameters:
    
    bytes - byte to write
  - writeString
```
public void writeString(String s)
```
    Writes a String into this buffer. This method calls writeString(s, "ISO-8859-1")
    
    Parameters:
    
    s - String to write
  - writeString
```
public void writeString(String s,
                        String charsetName)
```
    Writes a String into this buffer with given charsetName. charsetName is used when getting the bytes of the String.
    
    Parameters:
    
    s - String to write
    
    charsetName - Name of the charset
    
    Throws:
    
    RuntimeException - that wraps UnsupportedEncodingException
  - readString
```
public String readString()
```
    Reads a String from the buffer. This method calls readString("ISO-8859-1")
    
    Returns:
    
    a String
  - readString
```
public String readString(String charsetName)
```
    Reads a String from the buffer.
    
    Parameters:
    
    charsetName - Name of of charset
    
    Returns:
    
    a String
    
    Throws:
    
    RuntimeException - that wraps UnsupportedEncodingException
  - align
```
public int align(int byteBoundary)
```
    Aligns this buffer to given byteBoundary.
    
    Parameters:
    
    byteBoundary - alignement boundary
    
    Returns:
    
    number of bytes that was advanced in order to meet alignment
  - getBuffer
```
public ByteBuffer getBuffer()
```
    Get the underlying ByteBuffer.
    
    Returns:
    
    ByteBuffer
  - setEndianess
```
public void setEndianess(boolean endianessFlag)
```
    Sets the endianness used. see 9.4.5.1.2 flags
    
    Parameters:
    
    endianessFlag - If true, little endian is used. If false, big endian is used.
  - getInputStream
```
public InputStream getInputStream()
```
    Gets an InputStream reading from the backing ByteBuffer. InputStream will start reading from current position of the ByteBuffer.
    
    Returns:
    
    InputStream
  - toArray
```
public byte[] toArray()
```
    Returns a byte array from the beginning of backing array to current position
    
    Returns:
    
    byte array
  - getOutputStream
```
public OutputStream getOutputStream()
```
    Gets an OutputStream that writes to this RTPSByteBuffer. Writing starts at current position.
    
    Returns:
    
    OutputStream

Class RTPSByteBuffer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RTPSByteBuffer

RTPSByteBuffer

RTPSByteBuffer

Method Detail

position

read_octet

write_octet

read_short

write_short

read_long

write_long

read_longlong

write_longlong

read_boolean

write_boolean

read_string

write_string

readInt

writeInt

readShort

writeShort

readLong

writeLong

readFloat

writeFloat

readDouble

writeDouble

readChar

writeChar

readByte

writeByte

readBoolean

writeBoolean

read

write

writeString

writeString

readString

readString

align

getBuffer

setEndianess

getInputStream

toArray

getOutputStream