com.opendxl.databus.serialization.internal

Class RegularMessageStructure

java.lang.Object

com.opendxl.databus.serialization.internal.RegularMessageStructure

All Implemented Interfaces:

MessageStructure

public final class RegularMessageStructure
extends java.lang.Object
implements MessageStructure

Represents a DatabusMessage structure.

Constructor Summary

Constructors

Constructor and Description
RegularMessageStructure(byte[] serializedMessage) Constructor.
RegularMessageStructure(byte magicByte, int version, byte[] payload) Constructor.

Method Summary

Modifier and Type	Method and Description
byte	getMagicByte() Gets the magic byte.
byte[]	getMessage() Gets the message.
byte[]	getPayload() Gets the payload.
int	getVersion() Gets the version.

Methods inherited from class java.lang.Object

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

Constructor Detail

RegularMessageStructure

public RegularMessageStructure(byte[] serializedMessage)

Constructor. Creates a Regular Message Structure based on a serialized message. A regular structure is a byte[] with the following format: |0|0001|payload| Magic Byte: size:1 position:0-0 value: byte 0x0 Version : size:4 position:1-4 value: int 1 Payload : size n position:5-n value: byte[] serialized by the user

Parameters:

serializedMessage - Serialized message as byte array.

RegularMessageStructure

public RegularMessageStructure(byte magicByte,
                               int version,
                               byte[] payload)

Constructor. It creates a Regular Message Structure.

Parameters:

magicByte - The message indicator. See RegularMessageStructure.

version - The message version.

payload - The message payload.

Method Detail

getMagicByte

public byte getMagicByte()

Gets the magic byte.

Specified by:

getMagicByte in interface MessageStructure

Returns:

The magic byte.

getVersion

public int getVersion()

Gets the version.

Specified by:

getVersion in interface MessageStructure

Returns:

The version.

getPayload

public byte[] getPayload()

Gets the payload.

Specified by:

getPayload in interface MessageStructure

Returns:

The payload.

getMessage

public byte[] getMessage()

Gets the message.

Specified by:

getMessage in interface MessageStructure

Returns:

The message.