com.solace.messaging.receiver

Interface RequestReplyMessageReceiver

All Superinterfaces:

AsyncLifecycleControl, LifecycleControl, ManageableReceiver, MessageReceiver

@ProviderType
public interface RequestReplyMessageReceiver
extends MessageReceiver

An interface for a receiver application in a request-reply messaging use case.

This API expected to be thread safe.

Since:

1.1

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RequestReplyMessageReceiver.FailedReplyEvent A class that encapsulates the details of a failed attempt to publish a reply message.
static interface	RequestReplyMessageReceiver.Replier An interface to perform reply operations for a received request message.
static interface	RequestReplyMessageReceiver.ReplyFailureListener An interface that provides an abstraction for listeners of failed message reply attempts.
static interface	RequestReplyMessageReceiver.RequestMessageHandler An interface to handle a request message and perform a reply or response for the request-reply use case.

Nested classes/interfaces inherited from interface com.solace.messaging.receiver.MessageReceiver

MessageReceiver.FailedReceiveEvent, MessageReceiver.InboundMessageSupplier, MessageReceiver.MessageHandler, MessageReceiver.ReceiveFailureListener

Nested classes/interfaces inherited from interface com.solace.messaging.util.LifecycleControl

LifecycleControl.TerminationEvent, LifecycleControl.TerminationNotificationListener

Nested classes/interfaces inherited from interface com.solace.messaging.util.ManageableReceiver

ManageableReceiver.DirectReceiverInfo, ManageableReceiver.PersistentReceiverInfo

Method Summary

Modifier and Type	Method and Description
void	receiveAsync(RequestReplyMessageReceiver.RequestMessageHandler messageHandler) Request to register an async request message handler.
void	receiveAsync(RequestReplyMessageReceiver.RequestMessageHandler messageHandler, ExecutorService executorService) Request to register an asynchronous request message handler using supplied thread executor for callbacks.
void	receiveMessage(RequestReplyMessageReceiver.RequestMessageHandler messageHandler) Receive the next request message to be processed with a given RequestMessageHandler.
void	receiveMessage(RequestReplyMessageReceiver.RequestMessageHandler messageHandler, long timeOut) Receive the next request message to be processed with a given RequestMessageHandler.
void	setReplyFailureListener(RequestReplyMessageReceiver.ReplyFailureListener listener) Sets the callback for the instance of the publisher.
RequestReplyMessageReceiver	start() Enables service regular duties.
<RequestReplyMessageReceiver> CompletableFuture<RequestReplyMessageReceiver>	startAsync() Asynchronously starts service for consuming/publishing operations.
<RequestReplyMessageReceiver> void	startAsync(CompletionListener<RequestReplyMessageReceiver> startListener) Asynchronously starts service for consuming/publishing operations using a callback for completion notification.

Methods inherited from interface com.solace.messaging.receiver.MessageReceiver

setReceiveFailureListener

Methods inherited from interface com.solace.messaging.util.LifecycleControl

isRunning, isTerminated, isTerminating, setTerminationNotificationListener, terminate

Methods inherited from interface com.solace.messaging.util.AsyncLifecycleControl

terminateAsync, terminateAsync

Methods inherited from interface com.solace.messaging.util.ManageableReceiver

receiverInfo

Method Detail

receiveAsync

void receiveAsync(RequestReplyMessageReceiver.RequestMessageHandler messageHandler)
           throws PubSubPlusClientException

Request to register an async request message handler. This method represents push- based non blocking interface. Callback method of a message handler will be executed on an internal API thread.

Parameters:

messageHandler - the request message handler, to handle an ordered sequence of inbound request messages

Throws:

PubSubPlusClientException - is thrown when messages handler can't be registered

Since:

1.1

receiveAsync

void receiveAsync(RequestReplyMessageReceiver.RequestMessageHandler messageHandler,
                  ExecutorService executorService)
           throws PubSubPlusClientException

Request to register an asynchronous request message handler using supplied thread executor for callbacks. This method represents push- based non blocking interface.

Parameters:

messageHandler - the request message handler to handle the sequence of inbound request messages

executorService - the user-provided instance of thread executor for message scheduling and MessageReceiver.MessageHandler.onMessage(InboundMessage) execution

Important:

The shutdown of the Executor service or any another maintenance work is the responsibility of the developer

When the order of the messages needs to be preserved, a single thread-based executor is required

Throws:

PubSubPlusClientException - if the messages handler cannot be registered

Since:

1.1

receiveMessage

void receiveMessage(RequestReplyMessageReceiver.RequestMessageHandler messageHandler)
             throws PubSubPlusClientException

Receive the next request message to be processed with a given RequestMessageHandler. Response to the received request message can be performed using provided RequestReplyMessageReceiver.Replier. This is a blocking request.

Parameters:

messageHandler - the request message handler.

Throws:

PubSubPlusClientException - if the message could not be received

PubSubPlusClientException.RequestInterruptedException - if the thread is interrupted while waiting for the next message; an interrupted flag is expected to be set on the thread in this case

Since:

1.1

receiveMessage

void receiveMessage(RequestReplyMessageReceiver.RequestMessageHandler messageHandler,
                    long timeOut)
             throws PubSubPlusClientException

Receive the next request message to be processed with a given RequestMessageHandler. Response to the received request message can be performed using provided RequestReplyMessageReceiver.Replier. This is a blocking request.

Parameters:

messageHandler - the request message handler.

timeOut - the timeout (in milliseconds) after the blocking receive exits, values > 0 are expected

Throws:

PubSubPlusClientException - if the message could not be received

PubSubPlusClientException.RequestInterruptedException - if the thread is interrupted while waiting for the next message; an interrupted flag is expected to be set on the thread in this case

Since:

1.1

setReplyFailureListener

void setReplyFailureListener(RequestReplyMessageReceiver.ReplyFailureListener listener)

Sets the callback for the instance of the publisher. Use this method to register a callback that provides a notification about failed reply message publishing attempts.

Parameters:

listener - the callback that listens for message publishing failures

Since:

1.0

start

RequestReplyMessageReceiver start()
                           throws PubSubPlusClientException

Description copied from interface: LifecycleControl

Enables service regular duties. Before this method is called, the service is considered off-duty. To operate normally, this method needs to be called on a receiver or publisher instance. This method is idempotent.

Specified by:

start in interface LifecycleControl

Specified by:

start in interface MessageReceiver

Returns:

an instance of class on which the method was called to support chaining

Throws:

PubSubPlusClientException - if the instance fails to start for some internal reason

startAsync

<RequestReplyMessageReceiver> CompletableFuture<RequestReplyMessageReceiver> startAsync()

Description copied from interface: AsyncLifecycleControl

Asynchronously starts service for consuming/publishing operations. In order to operate normally, this method needs to be called on a service instance. If the service is started or in the process of being started, this operation has no effect.

This method is an idempotent operation when no another connect/disconnect operation is ongoing.

Specified by:

startAsync in interface AsyncLifecycleControl

Specified by:

startAsync in interface MessageReceiver

Returns:

a future state of the start request that can complete successfully or fail.

startAsync

<RequestReplyMessageReceiver> void startAsync(CompletionListener<RequestReplyMessageReceiver> startListener)
                                       throws PubSubPlusClientException,
                                              IllegalStateException

Description copied from interface: AsyncLifecycleControl

Asynchronously starts service for consuming/publishing operations using a callback for completion notification. In order to operate normally, this method needs to be called on a service instance. If the service is started or in the process of being started, this operation has no effect.

Specified by:

startAsync in interface AsyncLifecycleControl

Type Parameters:

RequestReplyMessageReceiver - the type of response returned on a successful start operation

Parameters:

startListener - the callback for future notifications about the completion of the start process

Throws:

PubSubPlusClientException - if the messaging service will not start in the future

IllegalStateException - if the method has been invoked at an illegal or inappropriate time