1 package org.sim0mq.message.heartbeat;
2
3 import org.sim0mq.Sim0MQException;
4 import org.sim0mq.message.Sim0MQMessage;
5
6 /**
7 * Heartbeat, HB.1. Request to test if other party is still alive. From FM to FS, LB and MC, or from FS to MC.
8 * <p>
9 * Copyright (c) 2019-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. <br>
10 * BSD-style license. See <a href="http://sim0mq.org/docs/current/license.html">Sim0MQ License</a>.
11 * </p>
12 * @author <a href="http://www.tbm.tudelft.nl/averbraeck">Alexander Verbraeck</a>
13 */
14 public class HB1HeartbeatMessage extends Sim0MQMessage
15 {
16 /** the unique message id. */
17 private static final String MESSAGETYPE = "HB.1";
18
19 /** */
20 private static final long serialVersionUID = 20190714L;
21
22 /**
23 * @param federationId the federation id can be coded using different types. Examples are two 64-bit longs indicating a
24 * UUID, or a String with a UUID number, a String with meaningful identification, or a short or an int with a
25 * simulation run number.
26 * @param senderId The sender id can be used to send back a message to the sender at some later time.
27 * @param receiverId The receiver id can be used to check whether the message is meant for us, or should be discarded (or an
28 * error can be sent if we receive a message not meant for us).
29 * @param messageId The unique message number is meant to confirm with a callback that the message has been received
30 * correctly. The number is unique for the sender, so not globally within the federation.
31 * @throws Sim0MQException on unknown data type
32 * @throws NullPointerException when one of the parameters is null
33 */
34 @SuppressWarnings("checkstyle:parameternumber")
35 public HB1HeartbeatMessage(final Object federationId, final Object senderId, final Object receiverId,
36 final Object messageId) throws Sim0MQException, NullPointerException
37 {
38 super(true, federationId, senderId, receiverId, MESSAGETYPE, messageId, null);
39 }
40
41 /**
42 * @param objectArray Object[]; Full message object array
43 * @throws Sim0MQException on unknown data type
44 * @throws NullPointerException when one of the parameters is null
45 */
46 public HB1HeartbeatMessage(final Object[] objectArray) throws Sim0MQException, NullPointerException
47 {
48 super(objectArray, 0, MESSAGETYPE);
49 }
50
51 /**
52 * Builder for the Heartbeat Message. Can string setters together, and call build() at the end to build the actual message.
53 * <p>
54 * Copyright (c) 2019-2024 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
55 * <br>
56 * BSD-style license. See <a href="http://sim0mq.org/docs/current/license.html">Sim0MQ License</a>.
57 * </p>
58 * @author <a href="http://www.tbm.tudelft.nl/averbraeck">Alexander Verbraeck</a>
59 */
60 public static class Builder extends Sim0MQMessage.Builder<HB1HeartbeatMessage.Builder>
61 {
62 /**
63 * Empty constructor.
64 */
65 public Builder()
66 {
67 // nothing to do.
68 }
69
70 @Override
71 public HB1HeartbeatMessage build() throws Sim0MQException, NullPointerException
72 {
73 return new HB1HeartbeatMessage(this.federationId, this.senderId, this.receiverId, this.messageId);
74 }
75
76 }
77 }