com.solace.messaging.receiver

Interface MessageReceiver

All Superinterfaces:

AsyncLifecycleControl, LifecycleControl, ManageableReceiver

All Known Subinterfaces:

DirectMessageReceiver, MessageQueueBrowser, PersistentMessageReceiver, RequestReplyMessageReceiver

@ProviderType
public interface MessageReceiver
extends LifecycleControl, AsyncLifecycleControl, ManageableReceiver

An interface for receiving messages; it is the base interface for all receivers.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MessageReceiver.FailedReceiveEvent A class that encapsulates details of a failed attempt to receive a message.
static interface	MessageReceiver.InboundMessageSupplier An interface for message supplier functionality used for alternative message receiver methods.
static interface	MessageReceiver.MessageHandler An interface for the listener of message handlers for inbound messages.
static interface	MessageReceiver.ReceiveFailureListener An interface for a listener for failures during the receipt of messages from a broker.

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	setReceiveFailureListener(MessageReceiver.ReceiveFailureListener receiveFailureListener) Sets ReceiveFailureListener for the given instance of the receiver.
MessageReceiver	start() Enables service regular duties.
<MessageReceiver> CompletableFuture<MessageReceiver>	startAsync() Asynchronously starts service for consuming/publishing operations.

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

isRunning, isTerminated, isTerminating, setTerminationNotificationListener, terminate

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

startAsync, terminateAsync, terminateAsync

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

receiverInfo

Method Detail

setReceiveFailureListener

void setReceiveFailureListener(MessageReceiver.ReceiveFailureListener receiveFailureListener)

Sets ReceiveFailureListener for the given instance of the receiver. It is used to notify about failures during the message receipt.

Parameters:

receiveFailureListener - the listener that will be used to process message receipt failures

Since:

1.0

start

MessageReceiver start()
               throws PubSubPlusClientException,
                      IllegalStateException

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

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

IllegalStateException - if the instance was previously terminated, being terminated, or the method has been invoked at an illegal or at an inappropriate time for some another reason

startAsync

<MessageReceiver> CompletableFuture<MessageReceiver> startAsync()
                                                         throws PubSubPlusClientException,
                                                                IllegalStateException

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

Returns:

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

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