xml/Microsoft.Azure.ServiceBus.Core/IReceiverClient.xml (305 lines of code) (raw):
<Type Name="IReceiverClient" FullName="Microsoft.Azure.ServiceBus.Core.IReceiverClient">
<TypeSignature Language="C#" Value="public interface IReceiverClient : Microsoft.Azure.ServiceBus.IClientEntity" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IReceiverClient implements class Microsoft.Azure.ServiceBus.IClientEntity" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.ServiceBus.Core.IReceiverClient" />
<TypeSignature Language="VB.NET" Value="Public Interface IReceiverClient
Implements IClientEntity" />
<TypeSignature Language="F#" Value="type IReceiverClient = interface
 interface IClientEntity" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.1.3.0</AssemblyVersion>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.Azure.ServiceBus.IClientEntity</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
An interface used to describe common functionality for receiving messages from <see cref="T:Microsoft.Azure.ServiceBus.IQueueClient" /> and <see cref="T:Microsoft.Azure.ServiceBus.ISubscriptionClient" />.
</summary>
<remarks>Use <see cref="T:Microsoft.Azure.ServiceBus.Core.IMessageReceiver" /> for advanced set of functionality.</remarks>
<altmember cref="T:Microsoft.Azure.ServiceBus.IQueueClient" />
<altmember cref="T:Microsoft.Azure.ServiceBus.ISubscriptionClient" />
<altmember cref="T:Microsoft.Azure.ServiceBus.Core.IMessageReceiver" />
</Docs>
<Members>
<Member MemberName="AbandonAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task AbandonAsync (string lockToken, System.Collections.Generic.IDictionary<string,object> propertiesToModify = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task AbandonAsync(string lockToken, class System.Collections.Generic.IDictionary`2<string, object> propertiesToModify) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.ServiceBus.Core.IReceiverClient.AbandonAsync(System.String,System.Collections.Generic.IDictionary{System.String,System.Object})" />
<MemberSignature Language="VB.NET" Value="Public Function AbandonAsync (lockToken As String, Optional propertiesToModify As IDictionary(Of String, Object) = Nothing) As Task" />
<MemberSignature Language="F#" Value="abstract member AbandonAsync : string * System.Collections.Generic.IDictionary<string, obj> -> System.Threading.Tasks.Task" Usage="iReceiverClient.AbandonAsync (lockToken, propertiesToModify)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="lockToken" Type="System.String" />
<Parameter Name="propertiesToModify" Type="System.Collections.Generic.IDictionary<System.String,System.Object>" />
</Parameters>
<Docs>
<param name="lockToken">The lock token of the corresponding message to abandon.</param>
<param name="propertiesToModify">The properties of the message to modify while abandoning the message.</param>
<summary>
Abandons a <see cref="T:Microsoft.Azure.ServiceBus.Message" /> using a lock token. This will make the message available again for processing.
</summary>
<returns>To be added.</returns>
<remarks>A lock token can be found in <see cref="P:Microsoft.Azure.ServiceBus.Message.SystemPropertiesCollection.LockToken" />,
only when <see cref="P:Microsoft.Azure.ServiceBus.Core.IReceiverClient.ReceiveMode" /> is set to <see cref="F:Microsoft.Azure.ServiceBus.ReceiveMode.PeekLock" />.
Abandoning a message will increase the delivery count on the message.
This operation can only be performed on messages that were received by this receiver.
</remarks>
</Docs>
</Member>
<Member MemberName="CompleteAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task CompleteAsync (string lockToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task CompleteAsync(string lockToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.ServiceBus.Core.IReceiverClient.CompleteAsync(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function CompleteAsync (lockToken As String) As Task" />
<MemberSignature Language="F#" Value="abstract member CompleteAsync : string -> System.Threading.Tasks.Task" Usage="iReceiverClient.CompleteAsync lockToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="lockToken" Type="System.String" />
</Parameters>
<Docs>
<param name="lockToken">The lock token of the corresponding message to complete.</param>
<summary>
Completes a <see cref="T:Microsoft.Azure.ServiceBus.Message" /> using its lock token. This will delete the message from the queue.
</summary>
<returns>To be added.</returns>
<remarks>
A lock token can be found in <see cref="P:Microsoft.Azure.ServiceBus.Message.SystemPropertiesCollection.LockToken" />,
only when <see cref="P:Microsoft.Azure.ServiceBus.Core.IReceiverClient.ReceiveMode" /> is set to <see cref="F:Microsoft.Azure.ServiceBus.ReceiveMode.PeekLock" />.
This operation can only be performed on messages that were received by this receiver.
</remarks>
</Docs>
</Member>
<Member MemberName="DeadLetterAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task DeadLetterAsync (string lockToken, System.Collections.Generic.IDictionary<string,object> propertiesToModify = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task DeadLetterAsync(string lockToken, class System.Collections.Generic.IDictionary`2<string, object> propertiesToModify) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.ServiceBus.Core.IReceiverClient.DeadLetterAsync(System.String,System.Collections.Generic.IDictionary{System.String,System.Object})" />
<MemberSignature Language="VB.NET" Value="Public Function DeadLetterAsync (lockToken As String, Optional propertiesToModify As IDictionary(Of String, Object) = Nothing) As Task" />
<MemberSignature Language="F#" Value="abstract member DeadLetterAsync : string * System.Collections.Generic.IDictionary<string, obj> -> System.Threading.Tasks.Task" Usage="iReceiverClient.DeadLetterAsync (lockToken, propertiesToModify)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="lockToken" Type="System.String" />
<Parameter Name="propertiesToModify" Type="System.Collections.Generic.IDictionary<System.String,System.Object>" />
</Parameters>
<Docs>
<param name="lockToken">The lock token of the corresponding message to deadletter.</param>
<param name="propertiesToModify">The properties of the message to modify while moving to sub-queue.</param>
<summary>
Moves a message to the deadletter sub-queue.
</summary>
<returns>To be added.</returns>
<remarks>
A lock token can be found in <see cref="P:Microsoft.Azure.ServiceBus.Message.SystemPropertiesCollection.LockToken" />,
only when <see cref="P:Microsoft.Azure.ServiceBus.Core.IReceiverClient.ReceiveMode" /> is set to <see cref="F:Microsoft.Azure.ServiceBus.ReceiveMode.PeekLock" />.
In order to receive a message from the deadletter queue, you will need a new <see cref="T:Microsoft.Azure.ServiceBus.Core.IMessageReceiver" />, with the corresponding path.
You can use <see cref="M:Microsoft.Azure.ServiceBus.EntityNameHelper.FormatDeadLetterPath(System.String)" /> to help with this.
This operation can only be performed on messages that were received by this receiver.
</remarks>
</Docs>
</Member>
<Member MemberName="DeadLetterAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task DeadLetterAsync (string lockToken, string deadLetterReason, string deadLetterErrorDescription = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task DeadLetterAsync(string lockToken, string deadLetterReason, string deadLetterErrorDescription) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.ServiceBus.Core.IReceiverClient.DeadLetterAsync(System.String,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function DeadLetterAsync (lockToken As String, deadLetterReason As String, Optional deadLetterErrorDescription As String = Nothing) As Task" />
<MemberSignature Language="F#" Value="abstract member DeadLetterAsync : string * string * string -> System.Threading.Tasks.Task" Usage="iReceiverClient.DeadLetterAsync (lockToken, deadLetterReason, deadLetterErrorDescription)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="lockToken" Type="System.String" />
<Parameter Name="deadLetterReason" Type="System.String" />
<Parameter Name="deadLetterErrorDescription" Type="System.String" />
</Parameters>
<Docs>
<param name="lockToken">The lock token of the corresponding message to deadletter.</param>
<param name="deadLetterReason">The reason for deadlettering the message.</param>
<param name="deadLetterErrorDescription">The error description for deadlettering the message.</param>
<summary>
Moves a message to the deadletter sub-queue.
</summary>
<returns>To be added.</returns>
<remarks>
A lock token can be found in <see cref="P:Microsoft.Azure.ServiceBus.Message.SystemPropertiesCollection.LockToken" />,
only when <see cref="P:Microsoft.Azure.ServiceBus.Core.IReceiverClient.ReceiveMode" /> is set to <see cref="F:Microsoft.Azure.ServiceBus.ReceiveMode.PeekLock" />.
In order to receive a message from the deadletter queue, you will need a new <see cref="T:Microsoft.Azure.ServiceBus.Core.IMessageReceiver" />, with the corresponding path.
You can use <see cref="M:Microsoft.Azure.ServiceBus.EntityNameHelper.FormatDeadLetterPath(System.String)" /> to help with this.
This operation can only be performed on messages that were received by this receiver.
</remarks>
</Docs>
</Member>
<Member MemberName="PrefetchCount">
<MemberSignature Language="C#" Value="public int PrefetchCount { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 PrefetchCount" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.ServiceBus.Core.IReceiverClient.PrefetchCount" />
<MemberSignature Language="VB.NET" Value="Public Property PrefetchCount As Integer" />
<MemberSignature Language="F#" Value="member this.PrefetchCount : int with get, set" Usage="Microsoft.Azure.ServiceBus.Core.IReceiverClient.PrefetchCount" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Prefetch speeds up the message flow by aiming to have a message readily available for local retrieval when and before the application asks for one using Receive.
Setting a non-zero value prefetches PrefetchCount number of messages.
Setting the value to zero turns prefetch off.
Defaults to 0.
</summary>
<value>To be added.</value>
<remarks>
<para>
When Prefetch is enabled, the receiver will quietly acquire more messages, up to the PrefetchCount limit, than what the application
immediately asks for. A single initial Receive/ReceiveAsync call will therefore acquire a message for immediate consumption
that will be returned as soon as available, and the client will proceed to acquire further messages to fill the prefetch buffer in the background.
</para>
<para>
While messages are available in the prefetch buffer, any subsequent ReceiveAsync calls will be immediately satisfied from the buffer, and the buffer is
replenished in the background as space becomes available.If there are no messages available for delivery, the receive operation will drain the
buffer and then wait or block as expected.
</para>
<para>Updates to this value take effect on the next receive call to the service.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="ReceiveMode">
<MemberSignature Language="C#" Value="public Microsoft.Azure.ServiceBus.ReceiveMode ReceiveMode { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Azure.ServiceBus.ReceiveMode ReceiveMode" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.ServiceBus.Core.IReceiverClient.ReceiveMode" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ReceiveMode As ReceiveMode" />
<MemberSignature Language="F#" Value="member this.ReceiveMode : Microsoft.Azure.ServiceBus.ReceiveMode" Usage="Microsoft.Azure.ServiceBus.Core.IReceiverClient.ReceiveMode" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.ServiceBus.ReceiveMode</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the <see cref="T:Microsoft.Azure.ServiceBus.ReceiveMode" /> of the current receiver.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RegisterMessageHandler">
<MemberSignature Language="C#" Value="public void RegisterMessageHandler (Func<Microsoft.Azure.ServiceBus.Message,System.Threading.CancellationToken,System.Threading.Tasks.Task> handler, Microsoft.Azure.ServiceBus.MessageHandlerOptions messageHandlerOptions);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void RegisterMessageHandler(class System.Func`3<class Microsoft.Azure.ServiceBus.Message, valuetype System.Threading.CancellationToken, class System.Threading.Tasks.Task> handler, class Microsoft.Azure.ServiceBus.MessageHandlerOptions messageHandlerOptions) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.ServiceBus.Core.IReceiverClient.RegisterMessageHandler(System.Func{Microsoft.Azure.ServiceBus.Message,System.Threading.CancellationToken,System.Threading.Tasks.Task},Microsoft.Azure.ServiceBus.MessageHandlerOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub RegisterMessageHandler (handler As Func(Of Message, CancellationToken, Task), messageHandlerOptions As MessageHandlerOptions)" />
<MemberSignature Language="F#" Value="abstract member RegisterMessageHandler : Func<Microsoft.Azure.ServiceBus.Message, System.Threading.CancellationToken, System.Threading.Tasks.Task> * Microsoft.Azure.ServiceBus.MessageHandlerOptions -> unit" Usage="iReceiverClient.RegisterMessageHandler (handler, messageHandlerOptions)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="handler" Type="System.Func<Microsoft.Azure.ServiceBus.Message,System.Threading.CancellationToken,System.Threading.Tasks.Task>" />
<Parameter Name="messageHandlerOptions" Type="Microsoft.Azure.ServiceBus.MessageHandlerOptions" />
</Parameters>
<Docs>
<param name="handler">A <see cref="T:System.Func`3" /> that processes messages.</param>
<param name="messageHandlerOptions">The <see cref="T:Microsoft.Azure.ServiceBus.MessageHandlerOptions" /> options used to configure the settings of the pump.</param>
<summary>
Receive messages continuously from the entity. Registers a message handler and begins a new thread to receive messages.
This handler(<see cref="T:System.Func`3" />) is awaited on every time a new message is received by the receiver.
</summary>
<remarks>Enable prefetch to speed up the receive rate.</remarks>
</Docs>
</Member>
<Member MemberName="RegisterMessageHandler">
<MemberSignature Language="C#" Value="public void RegisterMessageHandler (Func<Microsoft.Azure.ServiceBus.Message,System.Threading.CancellationToken,System.Threading.Tasks.Task> handler, Func<Microsoft.Azure.ServiceBus.ExceptionReceivedEventArgs,System.Threading.Tasks.Task> exceptionReceivedHandler);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void RegisterMessageHandler(class System.Func`3<class Microsoft.Azure.ServiceBus.Message, valuetype System.Threading.CancellationToken, class System.Threading.Tasks.Task> handler, class System.Func`2<class Microsoft.Azure.ServiceBus.ExceptionReceivedEventArgs, class System.Threading.Tasks.Task> exceptionReceivedHandler) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.ServiceBus.Core.IReceiverClient.RegisterMessageHandler(System.Func{Microsoft.Azure.ServiceBus.Message,System.Threading.CancellationToken,System.Threading.Tasks.Task},System.Func{Microsoft.Azure.ServiceBus.ExceptionReceivedEventArgs,System.Threading.Tasks.Task})" />
<MemberSignature Language="VB.NET" Value="Public Sub RegisterMessageHandler (handler As Func(Of Message, CancellationToken, Task), exceptionReceivedHandler As Func(Of ExceptionReceivedEventArgs, Task))" />
<MemberSignature Language="F#" Value="abstract member RegisterMessageHandler : Func<Microsoft.Azure.ServiceBus.Message, System.Threading.CancellationToken, System.Threading.Tasks.Task> * Func<Microsoft.Azure.ServiceBus.ExceptionReceivedEventArgs, System.Threading.Tasks.Task> -> unit" Usage="iReceiverClient.RegisterMessageHandler (handler, exceptionReceivedHandler)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="handler" Type="System.Func<Microsoft.Azure.ServiceBus.Message,System.Threading.CancellationToken,System.Threading.Tasks.Task>" />
<Parameter Name="exceptionReceivedHandler" Type="System.Func<Microsoft.Azure.ServiceBus.ExceptionReceivedEventArgs,System.Threading.Tasks.Task>" />
</Parameters>
<Docs>
<param name="handler">A <see cref="T:System.Func`3" /> that processes messages.</param>
<param name="exceptionReceivedHandler">A <see cref="T:System.Func`2" /> that is invoked during exceptions.
<see cref="T:Microsoft.Azure.ServiceBus.ExceptionReceivedEventArgs" /> contains contextual information regarding the exception.</param>
<summary>
Receive messages continuously from the entity. Registers a message handler and begins a new thread to receive messages.
This handler(<see cref="T:System.Func`3" />) is awaited on every time a new message is received by the receiver.
</summary>
<remarks>Enable prefetch to speed up the receive rate.
Use <see cref="M:Microsoft.Azure.ServiceBus.Core.IReceiverClient.RegisterMessageHandler(System.Func{Microsoft.Azure.ServiceBus.Message,System.Threading.CancellationToken,System.Threading.Tasks.Task},Microsoft.Azure.ServiceBus.MessageHandlerOptions)" /> to configure the settings of the pump.</remarks>
</Docs>
</Member>
<Member MemberName="UnregisterMessageHandlerAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task UnregisterMessageHandlerAsync (TimeSpan inflightMessageHandlerTasksWaitTimeout);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task UnregisterMessageHandlerAsync(valuetype System.TimeSpan inflightMessageHandlerTasksWaitTimeout) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.ServiceBus.Core.IReceiverClient.UnregisterMessageHandlerAsync(System.TimeSpan)" />
<MemberSignature Language="VB.NET" Value="Public Function UnregisterMessageHandlerAsync (inflightMessageHandlerTasksWaitTimeout As TimeSpan) As Task" />
<MemberSignature Language="F#" Value="abstract member UnregisterMessageHandlerAsync : TimeSpan -> System.Threading.Tasks.Task" Usage="iReceiverClient.UnregisterMessageHandlerAsync inflightMessageHandlerTasksWaitTimeout" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="inflightMessageHandlerTasksWaitTimeout" Type="System.TimeSpan" />
</Parameters>
<Docs>
<param name="inflightMessageHandlerTasksWaitTimeout"> is the maximum waitTimeout for inflight message handling tasks.</param>
<summary>
Unregister message handler from the receiver if there is an active message handler registered. This operation waits for the completion
of inflight receive and message handling operations to finish and unregisters future receives on the message handler which previously
registered.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>