org.apache.beam.sdk.io.solace.broker

Interface MessageReceiver

All Known Implementing Classes:

SolaceMessageReceiver

public interface MessageReceiver

Interface for receiving messages from a Solace broker.

Implementations of this interface are responsible for managing the connection to the broker and for receiving messages from the broker.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the message receiver.
boolean	isClosed() Returns true if the message receiver is closed, false otherwise.
default boolean	isEOF() Test clients may return true to signal that all expected messages have been pulled and the test may complete.
BytesXMLMessage	receive() Receives a message from the broker.
void	start() Starts the message receiver.

Method Detail

start

void start()

Starts the message receiver.

This method is called in the UnboundedSolaceReader.start() method.

isClosed

boolean isClosed()

Returns true if the message receiver is closed, false otherwise.

A message receiver is closed when it is no longer able to receive messages.

receive

BytesXMLMessage receive()
                 throws java.io.IOException

Receives a message from the broker.

This method will block until a message is received.

Throws:

java.io.IOException

close

void close()

Closes the message receiver.

isEOF

default boolean isEOF()

Test clients may return true to signal that all expected messages have been pulled and the test may complete. Real clients should always return false.