BinaryMessage (org.macroing.cit.network API)

All Superinterfaces:

org.macroing.cit.messaging.Message
```
public interface BinaryMessage
extends org.macroing.cit.messaging.Message
```
A binary Message that can be sent to a MessageChannel.
It is specifically designed to be transmitted over a network.
Any non-public implementations of this interface may throw an UnsupportedOperationException for any methods not being used. Such implementations should, however, preferably document this behavior.

Since:

1.0.0

Author:

Jörgen Lundgren

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface BinaryMessage.Builder
Builder is used for building BinaryMessage instances.

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`BinaryMessage.Builder` `Builder` is used for building `BinaryMessage` instances.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`int`	`available()` Returns the amount of `byte`s that can be read without blocking.
`byte[]`	`getBytes()` Returns an array of `byte`s.
`int`	`getIdentifier()` Returns the identifier assigned to this `BinaryMessage`.
`boolean`	`isHeadless()` Returns `true` if, and only if, this `BinaryMessage` can be considered head-less, `false` otherwise.
`int`	`length()` Returns the length of this `BinaryMessage` at this time.
`BinaryMessage`	`newIdentifier(int identifier)` Returns a new `BinaryMessage` with the same content, but with a new identifier.
`int`	`readBits(int numberOfBits)` Reads `numberOfBits` bits.
`int`	`readByte()` Reads a `byte` as an `int`.
`int`	`readInt()` Reads an `int`.
`long`	`readLong()` Reads a `long`.
`int`	`readShort()` Reads a `short` as an `int`.
`java.lang.String`	`readString()` Reads a `String` with length `available()`.
`java.lang.String`	`readString(int length)` Reads a `String` with length `length`.

- Method Detail
  - newIdentifier
```
BinaryMessage newIdentifier(int identifier)
```
    Returns a new BinaryMessage with the same content, but with a new identifier.
    
    Parameters:
    
    identifier - the new identifier
    
    Returns:
    
    a new BinaryMessage with the same content, but with a new identifier
  - isHeadless
```
boolean isHeadless()
```
    Returns true if, and only if, this BinaryMessage can be considered head-less, false otherwise.
    A BinaryMessage that is head-less, may very well return an identifier if requested to, but that identifier should not be part of the data being sent to some end-point. That is, there should be no meaning attached to its identifier.
    
    Returns:
    
    true if, and only if, this BinaryMessage can be considered head-less, false otherwise
  - getBytes
```
byte[] getBytes()
```
    Returns an array of bytes.
    This method should never return null.
    
    Returns:
    
    an array of bytes
  - available
```
int available()
```
    Returns the amount of bytes that can be read without blocking.
    
    Returns:
    
    the amount of bytes that can be read without blocking
  - getIdentifier
```
int getIdentifier()
```
    Returns the identifier assigned to this BinaryMessage.
    
    Returns:
    
    the identifier assigned to this BinaryMessage
  - length
```
int length()
```
    Returns the length of this BinaryMessage at this time.
    The length includes all previously read bytes and any available.
    
    Returns:
    
    the length of this BinaryMessage at this time
  - readBits
```
int readBits(int numberOfBits)
```
    Reads numberOfBits bits.
    Returns an int denoting the read value.
    This method may block if no data is currently available.
    
    Parameters:
    
    numberOfBits - the number of bits to read
    
    Returns:
    
    an int denoting the read value
  - readByte
```
int readByte()
```
    Reads a byte as an int.
    Returns an int denoting the read value.
    This method may block if no data is currently available.
    The read offset is increased by 1.
    
    Returns:
    
    an int denoting the read value
  - readInt
```
int readInt()
```
    Reads an int.
    This method may block if no data is currently available.
    The read offset is increased by 4.
    
    Returns:
    
    an int denoting the read value
  - readShort
```
int readShort()
```
    Reads a short as an int.
    Returns an int denoting the read value.
    This method may block if no data is currently available.
    The read offset is increased by 2.
    
    Returns:
    
    an int denoting the read value
  - readLong
```
long readLong()
```
    Reads a long.
    This method may block if no data is currently available.
    The read offset is increased by 8.
    
    Returns:
    
    a long denoting the read value
  - readString
```
java.lang.String readString()
```
    Reads a String with length available().
    The read offset is increased by available().
    
    Returns:
    
    a String denoting the read value
  - readString
```
java.lang.String readString(int length)
```
    Reads a String with length length.
    This method may block if length is greater than available().
    The read offset is increased by length.
    If length is less than 0, an IllegalArgumentException may be thrown. But no guarantees can be made.
    
    Parameters:
    
    length - the length of the String to be read
    
    Returns:
    
    a String denoting the read value
    
    Throws:
    
    java.lang.IllegalArgumentException - thrown if, and only if, length is less than 0

Interface BinaryMessage

Nested Class Summary

Method Summary

Method Detail

newIdentifier

isHeadless

getBytes

available

getIdentifier

length

readBits

readByte

readInt

readShort

readLong

readString

readString