Class FM8KillFederateMessage

  • All Implemented Interfaces:
    Serializable

    public class FM8KillFederateMessage
    extends Sim0MQMessage
    KillFederate, FM.8. Kill the given federate (including termination of the process on the computer / node / processor where the federate is running). This message is sent to the FederateStarter.

    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
    • Constructor Detail

      • FM8KillFederateMessage

        public FM8KillFederateMessage​(Object federationId,
                                      Object senderId,
                                      Object receiverId,
                                      Object messageId,
                                      Object instanceId)
                               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.
        instanceId - String; Id to identify the federate instance that has to be killed
        Throws:
        Sim0MQException - on unknown data type
        NullPointerException - when one of the parameters is null
    • Method Detail

      • getInstanceId

        public Object getInstanceId()
        Returns:
        instanceId