Package org.opentrafficsim.sim0mq.publisher

Interface ReturnWrapper

All Known Implementing Classes:

ReturnWrapperImpl

public interface ReturnWrapper

The ReturnWrapper interface enforces implementation of the encodeReplyAndTransmit method

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

$LastChangedDate: 2020-02-13 11:08:16 +0100 (Thu, 13 Feb 2020) $, @version $Revision: 6383 $, by $Author: pknoppers $,

Author:

Alexander Verbraeck, Peter Knoppers

Method Summary

Modifier and Type	Method	Description
default void	ack(String payload)	Signal successful execution of a request.
void	encodeReplyAndTransmit(Boolean status, Object[] payload)	Encode a String reply and transmit it while patching the message type id field by adding a vertical bar and a suffix.
default void	encodeReplyAndTransmit(Boolean status, String payload)	Encode a String reply and transmit it.
default void	encodeReplyAndTransmit(Object[] payload)	Encode a String reply and transmit it.
default void	encodeReplyAndTransmit(String payload)	Encode a String reply and transmit it.
default void	nack(String payload)	Signal failure of execution of a request.

Method Detail

encodeReplyAndTransmit

void encodeReplyAndTransmit(Boolean status,
                            Object[] payload)
                     throws Sim0MQException,
                            SerializationException

Encode a String reply and transmit it while patching the message type id field by adding a vertical bar and a suffix.

Parameters:

status - Boolean; if null, the payload is transmitted as is; if true, a boolean true is prepended to the payload; if false, a boolean false is prepended to the payload

payload - Object []; payload of the reply message

Throws:

Sim0MQException - not sure if that can happen

SerializationException - when an object in payload cannot be serialized

encodeReplyAndTransmit

default void encodeReplyAndTransmit(String payload)
                             throws Sim0MQException,
                                    SerializationException

Encode a String reply and transmit it.

Parameters:

payload - String; payload of the reply message

Throws:

Sim0MQException - not sure if that can happen

SerializationException - when an object in payload cannot be serialized

encodeReplyAndTransmit

default void encodeReplyAndTransmit(Object[] payload)
                             throws Sim0MQException,
                                    SerializationException

Encode a String reply and transmit it.

Parameters:

payload - Object[]; payload of the reply message

Throws:

Sim0MQException - not sure if that can happen

SerializationException - when an object in payload cannot be serialized

encodeReplyAndTransmit

default void encodeReplyAndTransmit(Boolean status,
                                    String payload)
                             throws Sim0MQException,
                                    SerializationException

Encode a String reply and transmit it.

Parameters:

status - Boolean; if null, the payload is transmitted as is; if true, a boolean true is prepended to the payload; if false, a boolean false is prepended to the payload

payload - String; payload of the reply message

Throws:

Sim0MQException - not sure if that can happen

SerializationException - when an object in payload cannot be serialized

ack

default void ack(String payload)
          throws Sim0MQException,
                 SerializationException

Signal successful execution of a request.

Parameters:

payload - String; additional description of the result

Throws:

Sim0MQException - not sure if that can happen

SerializationException - when an object in payload cannot be serialized

nack

default void nack(String payload)
           throws Sim0MQException,
                  SerializationException

Signal failure of execution of a request.

Parameters:

payload - String; additional description of the failure

Throws:

Sim0MQException - not sure if that can happen

SerializationException - when an object in payload cannot be serialized