Interface IncomingDataHandler


  • public interface IncomingDataHandler
    Interface for handlers of incoming data and commands that are not directly processed by the Publisher.

    Copyright (c) 2021-2020=1 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
    BSD-style license. See OpenTrafficSim License.

    Author:
    Alexander Verbraeck, Peter Knoppers
    • Method Detail

      • getId

        String getId()
        Obtain a descriptive name of the IncomingDataHandler.
        Returns:
        String; a descriptive name of the IncomingDataHandler
      • getKey

        String getKey()
        Obtain the key that is used to identify incoming data destined for this IncomingDataHandler, (this key should appear in field 5 of the Sim0MQ messages).
        Returns:
        String; the key that identify incoming data destined for this IncomingDataHandler
      • handleIncomingData

        String handleIncomingData​(Object[] decodedMessage)
        Process incoming data.
        Parameters:
        decodedMessage - Object[]; decoded Sim0MQMessages that has been converted by the createObjectArray method
        Returns:
        String; null on success, nonNull on failure to handle the data