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

Class SolaceMessageReceiver

java.lang.Object

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

All Implemented Interfaces:

MessageReceiver

public class SolaceMessageReceiver
extends java.lang.Object
implements MessageReceiver

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_ADVANCE_TIMEOUT_IN_MILLIS

Constructor Summary

Constructors

Constructor and Description
SolaceMessageReceiver(com.solacesystems.jcsmp.FlowReceiver flowReceiver)

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.
com.solacesystems.jcsmp.BytesXMLMessage	receive() Receives a message from the broker.
void	start() Starts the message receiver.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.beam.sdk.io.solace.broker.MessageReceiver

isEOF

Field Detail

DEFAULT_ADVANCE_TIMEOUT_IN_MILLIS

public static final int DEFAULT_ADVANCE_TIMEOUT_IN_MILLIS

See Also:

Constant Field Values

Constructor Detail

SolaceMessageReceiver

public SolaceMessageReceiver(com.solacesystems.jcsmp.FlowReceiver flowReceiver)

Method Detail

start

public void start()

Description copied from interface: MessageReceiver

Starts the message receiver.

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

Specified by:

start in interface MessageReceiver

isClosed

public boolean isClosed()

Description copied from interface: MessageReceiver

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

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

Specified by:

isClosed in interface MessageReceiver

receive

public com.solacesystems.jcsmp.BytesXMLMessage receive()
                                                throws java.io.IOException

Description copied from interface: MessageReceiver

Receives a message from the broker.

This method will block until a message is received.

Specified by:

receive in interface MessageReceiver

Throws:

java.io.IOException

close

public void close()

Description copied from interface: MessageReceiver

Closes the message receiver.

Specified by:

close in interface MessageReceiver