Package org.sim0mq.message.heartbeat

Class HB1HeartbeatMessage

java.lang.Object

org.sim0mq.message.Sim0MQMessage

org.sim0mq.message.heartbeat.HB1HeartbeatMessage

All Implemented Interfaces:

Serializable

public class HB1HeartbeatMessage
extends Sim0MQMessage

Heartbeat, HB.1. Request to test if other party is still alive. From FM to FS, LB and MC, or from FS to MC.

Copyright (c) 2019-2024 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	HB1HeartbeatMessage.Builder	Builder for the Heartbeat Message.

Field Summary

Fields inherited from class org.sim0mq.message.Sim0MQMessage

VERSION

Constructor Summary

Constructors

Constructor	Description
HB1HeartbeatMessage(Object[] objectArray)
HB1HeartbeatMessage(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

Methods inherited from class java.lang.Object

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

Constructor Details

HB1HeartbeatMessage

public HB1HeartbeatMessage(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 type

NullPointerException - when one of the parameters is null

HB1HeartbeatMessage

public HB1HeartbeatMessage(Object[] objectArray)
                    throws Sim0MQException,
NullPointerException

Parameters:

objectArray - Object[]; Full message object array

Throws:

Sim0MQException - on unknown data type

NullPointerException - when one of the parameters is null