MessageSession.OnBeginPeek Method

Definition

Namespace:

Microsoft.ServiceBus.Messaging

Assembly:

Microsoft.ServiceBus.dll

Package:

WindowsAzure.ServiceBus v6.2.2

Executes upon calling the OnPeek or BeginPeek operation.

protected override IAsyncResult OnBeginPeek (Microsoft.ServiceBus.Tracing.TrackingContext trackingContext, long fromSequenceNumber, int messageCount, TimeSpan timeout, AsyncCallback callback, object state);

override this.OnBeginPeek : Microsoft.ServiceBus.Tracing.TrackingContext * int64 * int * TimeSpan * AsyncCallback * obj -> IAsyncResult

Protected Overrides Function OnBeginPeek (trackingContext As TrackingContext, fromSequenceNumber As Long, messageCount As Integer, timeout As TimeSpan, callback As AsyncCallback, state As Object) As IAsyncResult

Parameters

trackingContext

TrackingContext

The context information associated by a transaction tracking this operation.

fromSequenceNumber

Int64

The sequence number to peek from the session.

messageCount

Int32

The number of message in the operation.

timeout

TimeSpan

The time span interval the operation waits before it times out.

callback

AsyncCallback

An AsyncCallback delegate that references the method to invoke when the operation is complete.

state

Object

A user-defined object that contains state information about the asynchronous operation.

Returns

IAsyncResult

AnIAsyncResult that references the asynchronous operation to peek a communication of the message session.