public abstract class Sim0MQReply extends Sim0MQMessage
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.
Modifier and Type | Class and Description |
---|---|
static class |
Sim0MQReply.Builder<B extends Sim0MQMessage.Builder<B>>
Builder for the Sim0MQReply.
|
VERSION
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.
|
Modifier and Type | Method and Description |
---|---|
long |
getReplyToId() |
check, createByteArray, createObjectArray, getMagicNumber, getMessageId, getMessageStatus, getMessageTypeId, getNumberOfPayloadFields, getReceiverId, getSenderId, getSimulationRunId
public Sim0MQReply(Object simulationRunId, Object senderId, Object receiverId, Object messageTypeId, long messageId, MessageStatus messageStatus, long replyToId) throws Sim0MQException, NullPointerException
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.Sim0MQException
- on unknown data typeNullPointerException
- when one of the parameters is nullCopyright © 2016–2019 Delft University of Technology. All rights reserved.