org.sim0mq.message

Class Sim0MQReply

java.lang.Object

org.sim0mq.message.Sim0MQMessage

org.sim0mq.message.Sim0MQReply

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

MC1StatusMessage, MC2AckNakMessage

public abstract class Sim0MQReply
extends Sim0MQMessage

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

Copyright (c) 2016-2019 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	Sim0MQReply.Builder<B extends Sim0MQMessage.Builder<B>> Builder for the Sim0MQReply.

Field Summary

Fields inherited from class org.sim0mq.message.Sim0MQMessage

VERSION

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
long	getReplyToId()

Methods inherited from class org.sim0mq.message.Sim0MQMessage

check, createByteArray, createObjectArray, getMagicNumber, getMessageId, getMessageStatus, getMessageTypeId, getNumberOfPayloadFields, getReceiverId, getSenderId, getSimulationRunId

Methods inherited from class java.lang.Object

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

Constructor Detail

Sim0MQReply

public Sim0MQReply(Object simulationRunId,
                   Object senderId,
                   Object receiverId,
                   Object messageTypeId,
                   long messageId,
                   MessageStatus messageStatus,
                   long replyToId)
            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.

replyToId - The unique message id (Frame 5) of the sender for which this is the reply.

Throws:

Sim0MQException - on unknown data type

NullPointerException - when one of the parameters is null

Method Detail

getReplyToId

public final long getReplyToId()

Returns:

replyToId