org.sim0mq.message

Class Sim0MQMessage

java.lang.Object

org.sim0mq.message.Sim0MQMessage

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

FederateStartedMessage, RequestStatusMessage, Sim0MQReply, SimRunControlMessage, StartFederateMessage

public abstract class Sim0MQMessage
extends Object
implements Serializable

The abstract body of the message with the first fields of every Sim0MQ message.

Copyright (c) 2016-2017 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See Sim0MQ License.

$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Apr 22, 2017

Author:

Alexander Verbraeck

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Sim0MQMessage.Builder<B extends Sim0MQMessage.Builder<B>> Builder for the Sim0MQMessage.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	VERSION version of the protocol, magic number.

Constructor Summary

Constructors

Constructor and Description
Sim0MQMessage(Object simulationRunId, Object senderId, Object receiverId, Object messageTypeId, long messageId, MessageStatus messageStatus) Encode the object array into a message.

Method Summary

Modifier and Type	Method and Description
static void	check(Object[] fields, int expectedPayloadFields, String expectedMessageType, Object intendedReceiverId) Check the consistency of a message from an Object[] that was received.
abstract byte[]	createByteArray() Create a byte array of the fields.
abstract Object[]	createObjectArray() Create a Sim0MQ object array of the fields.
long	getMessageId()
MessageStatus	getMessageStatus()
Object	getMessageTypeId()
Object	getReceiverId()
Object	getSenderId()
Object	getSimulationRunId()

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

protected static final String VERSION

version of the protocol, magic number.

See Also:

Constant Field Values

Constructor Detail

Sim0MQMessage

public Sim0MQMessage(Object simulationRunId,
                     Object senderId,
                     Object receiverId,
                     Object messageTypeId,
                     long messageId,
                     MessageStatus messageStatus)
              throws Sim0MQException,
                     NullPointerException

Encode the object array into a message.

Parameters:

simulationRunId - the Simulation run ids can be provided in different types. Examples are two 64-bit longs indicating a UUID, or a String with a UUID number, a String with meaningful identification, or a short or an int with a simulation run number.

senderId - The sender id can be used to send back a message to the sender at some later time.

receiverId - The receiver id can be used to check whether the message is meant for us, or should be discarded (or an error can be sent if we receive a message not meant for us).

messageTypeId - Message type ids can be defined per type of simulation, and can be provided in different types. Examples are a String with a meaningful identification, or a short or an int with a message type number.

messageId - The unique message number is meant to confirm with a callback that the message has been received correctly. The number is unique for the sender, so not globally within the federation.

messageStatus - Three different status messages are defined: 1 for new, 2 for change, and 3 for delete. This field is coded as a byte.

Throws:

Sim0MQException - on unknown data type

NullPointerException - when one of the parameters is null

Method Detail

getSimulationRunId

public final Object getSimulationRunId()

Returns:

simulationRunId

getSenderId

public final Object getSenderId()

Returns:

senderId

getReceiverId

public final Object getReceiverId()

Returns:

receiverId

getMessageTypeId

public final Object getMessageTypeId()

Returns:

messageTypeId

getMessageId

public final long getMessageId()

Returns:

messageId

getMessageStatus

public final MessageStatus getMessageStatus()

Returns:

messageStatus

createObjectArray

public abstract Object[] createObjectArray()

Create a Sim0MQ object array of the fields.

Returns:

Object[] a Sim0MQ object array of the fields

createByteArray

public abstract byte[] createByteArray()
                                throws Sim0MQException,
                                       org.djutils.serialization.SerializationException

Create a byte array of the fields.

Returns:

byte[] a Sim0MQ byte array of the content

Throws:

Sim0MQException - on unknown data type as part of the content

org.djutils.serialization.SerializationException - when the byte array cannot be created, e.g. because the number of bytes does not match

check

public static void check(Object[] fields,
                         int expectedPayloadFields,
                         String expectedMessageType,
                         Object intendedReceiverId)
                  throws Sim0MQException

Check the consistency of a message from an Object[] that was received.

Parameters:

fields - Object[]; the fields in the message

expectedPayloadFields - the expected number of payload fields

expectedMessageType - the expected message type

intendedReceiverId - id of the intended receiver

Throws:

Sim0MQException - when errors in the message have been detected