Share via

IMessageBrowser Interface

  • Reference
Package:
com.microsoft.azure.servicebus

public interface IMessageBrowser

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

Method Summary

Modifier and Type Method and Description
IMessage peek()

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.
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 Details

peek

public IMessage peek()

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

public IMessage peek(long fromSequenceNumber)

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

peekAsync

public CompletableFuture peekAsync()

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

Returns:

Message peeked

peekAsync

public CompletableFuture 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.

peekBatch

public Collection peekBatch(int messageCount)

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

public Collection peekBatch(long fromSequenceNumber, int messageCount)

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

peekBatchAsync

public CompletableFuture> 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

public CompletableFuture> 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.

Applies to