Class FM5RequestStatus
- java.lang.Object
-
- org.sim0mq.message.Sim0MQMessage
-
- org.sim0mq.message.federationmanager.FM5RequestStatus
-
- All Implemented Interfaces:
Serializable
public class FM5RequestStatus extends Sim0MQMessage
RequestStatus, FM.5. Message sent by the Federation Manager to enquire the status of the simulation. The answer to this message is MC.1 "Status". Since the message type id clarifies the function of this message and no information exchange is necessary, the payload field can be empty.Copyright (c) 2019-2020 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See Sim0MQ License.- Author:
- Alexander Verbraeck
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
FM5RequestStatus.Builder
Builder for the RequestStatus Message.
-
Field Summary
-
Fields inherited from class org.sim0mq.message.Sim0MQMessage
VERSION
-
-
Constructor Summary
Constructors Constructor Description FM5RequestStatus(Object[] objectArray)
FM5RequestStatus(Object federationId, Object senderId, Object receiverId, Object messageId)
-
Method Summary
-
Methods inherited from class org.sim0mq.message.Sim0MQMessage
check, createByteArray, createObjectArray, decode, decodeToArray, encodeReplyUTF16, encodeReplyUTF8, encodeUTF16, encodeUTF8, getFederationId, getMagicNumber, getMessageId, getMessageTypeId, getNumberOfPayloadFields, getReceiverId, getSenderId, isBigEndian, listPayload, print
-
-
-
-
Constructor Detail
-
FM5RequestStatus
public FM5RequestStatus(Object federationId, Object senderId, Object receiverId, Object messageId) throws Sim0MQException, NullPointerException
- Parameters:
federationId
- the federation id can be coded using 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).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.- Throws:
Sim0MQException
- on unknown data typeNullPointerException
- when one of the parameters is null
-
FM5RequestStatus
public FM5RequestStatus(Object[] objectArray) throws Sim0MQException, NullPointerException
- Parameters:
objectArray
- Object[]; Full message object array- Throws:
Sim0MQException
- on unknown data typeNullPointerException
- when one of the parameters is null
-
-