Package com.microsoft.azure.servicebus

Interface IMessageBrowser

All Known Subinterfaces:

IMessageReceiver, IMessageSession, ITopicClient

All Known Implementing Classes:

MessageSession, TopicClient

public interface IMessageBrowser

Represents a message browser that can browse messages from Azure Service Bus.

Method Summary

Modifier and Type	Method	Description
IMessage	peek()	reads next the active message without changing the state of the receiver or the message source.
IMessage	peek(long fromSequenceNumber)	Reads next the active message without changing the state of the receiver or the message source.
CompletableFuture<IMessage>	peekAsync()	Asynchronously reads the active messages without changing the state of the receiver or the message source.
CompletableFuture<IMessage>	peekAsync(long fromSequenceNumber)	Asynchronously reads next the active message without changing the state of the receiver or the message source.
Collection<IMessage>	peekBatch(int messageCount)	Reads next batch of the active messages without changing the state of the receiver or the message source.
Collection<IMessage>	peekBatch(long fromSequenceNumber, int messageCount)	Reads next batch of the active messages without changing the state of the receiver or the message source.
CompletableFuture<Collection<IMessage>>	peekBatchAsync(int messageCount)	Asynchronously reads the next batch of active messages without changing the state of the receiver or the message source.
CompletableFuture<Collection<IMessage>>	peekBatchAsync(long fromSequenceNumber, int messageCount)	Asynchronously reads the next batch of active messages without changing the state of the receiver or the message source.

Method Detail

peek

IMessage peek()
       throws InterruptedException,
              ServiceBusException

reads next the active message without changing the state of the receiver or the message source. The first call to peek() fetches the first active message for this receiver. Each subsequent call fetches the subsequent message in the entity.

Returns:

Message peeked

Throws:

InterruptedException - if the current thread was interrupted while waiting

ServiceBusException - if peek failed

peek

IMessage peek(long fromSequenceNumber)
       throws InterruptedException,
              ServiceBusException

Reads next the active message without changing the state of the receiver or the message source.

Parameters:

fromSequenceNumber - The sequence number from where to read the message.

Returns:

Message peeked

Throws:

InterruptedException - if the current thread was interrupted while waiting

ServiceBusException - if peek failed

peekBatch

Collection<IMessage> peekBatch(int messageCount)
                        throws InterruptedException,
                               ServiceBusException

Reads next batch of the active messages without changing the state of the receiver or the message source.

Parameters:

messageCount - The number of messages.

Returns:

Batch of Message peeked

Throws:

InterruptedException - if the current thread was interrupted while waiting

ServiceBusException - if peek failed

peekBatch

Collection<IMessage> peekBatch(long fromSequenceNumber,
                               int messageCount)
                        throws InterruptedException,
                               ServiceBusException

Reads next batch of the active messages without changing the state of the receiver or the message source.

Parameters:

fromSequenceNumber - The sequence number from where to read the message.

messageCount - The number of messages.

Returns:

Batch of Message peeked

Throws:

InterruptedException - if the current thread was interrupted while waiting

ServiceBusException - if peek failed

peekAsync

CompletableFuture<IMessage> peekAsync()

Asynchronously reads the active messages without changing the state of the receiver or the message source.

Returns:

Message peeked

peekAsync

CompletableFuture<IMessage> peekAsync(long fromSequenceNumber)

Asynchronously reads next the active message without changing the state of the receiver or the message source.

Parameters:

fromSequenceNumber - The sequence number from where to read the message.

Returns:

CompletableFuture that returns Message peeked.

peekBatchAsync

CompletableFuture<Collection<IMessage>> peekBatchAsync(int messageCount)

Asynchronously reads the next batch of active messages without changing the state of the receiver or the message source.

Parameters:

messageCount - The number of messages.

Returns:

CompletableFuture that returns batch of Message peeked.

peekBatchAsync

CompletableFuture<Collection<IMessage>> peekBatchAsync(long fromSequenceNumber,
                                                       int messageCount)

Asynchronously reads the next batch of active messages without changing the state of the receiver or the message source.

Parameters:

fromSequenceNumber - The sequence number from where to read the message.

messageCount - The number of messages.

Returns:

CompletableFuture that returns batch of Message peeked.