MessageReceiver.OnPeek(TrackingContext, Int64, Int32, TimeSpan) Method

Definition

Executes upon calling the Peek operation.

protected virtual System.Collections.Generic.IEnumerable<Microsoft.ServiceBus.Messaging.BrokeredMessage> OnPeek (Microsoft.ServiceBus.Tracing.TrackingContext trackingContext, long fromSequenceNumber, int messageCount, TimeSpan timeout);
abstract member OnPeek : Microsoft.ServiceBus.Tracing.TrackingContext * int64 * int * TimeSpan -> seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>
override this.OnPeek : Microsoft.ServiceBus.Tracing.TrackingContext * int64 * int * TimeSpan -> seq<Microsoft.ServiceBus.Messaging.BrokeredMessage>

Parameters

trackingContext
TrackingContext

The tracking context.

fromSequenceNumber
Int64

The sequence number from where to peek.

messageCount
Int32

The number of message.

timeout
TimeSpan

The time span the operation waits before it times out.

Returns

The messages peeked.

Applies to