Udostępnij za pośrednictwem

IReceiverClient Interface

  • Reference

Definition

Namespace:
Microsoft.Azure.ServiceBus.Core
Assembly:
Microsoft.Azure.ServiceBus.dll
Package:
Microsoft.Azure.ServiceBus v5.2.0

An interface used to describe common functionality for receiving messages from IQueueClient and ISubscriptionClient.

public interface IReceiverClient : Microsoft.Azure.ServiceBus.IClientEntity
type IReceiverClient = interface
    interface IClientEntity
Public Interface IReceiverClient
Implements IClientEntity
Derived
Implements
IClientEntity

Remarks

Use IMessageReceiver for advanced set of functionality.

Properties

ClientId

Gets the ID to identify this client. This can be used to correlate logs and exceptions.

(Inherited from IClientEntity)
IsClosedOrClosing

Returns true if the client is closed or closing.

(Inherited from IClientEntity)
OperationTimeout

Duration after which individual operations will timeout.

(Inherited from IClientEntity)
OwnsConnection

Returns true if connection is owned and false if connection is shared.

(Inherited from IClientEntity)
Path

Gets the entity path.

(Inherited from IClientEntity)
PrefetchCount

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

Gets the ReceiveMode of the current receiver.
RegisteredPlugins

Gets a list of currently registered plugins for this client.

(Inherited from IClientEntity)
ServiceBusConnection

Connection object to the service bus namespace.

(Inherited from IClientEntity)

Methods

AbandonAsync(String, IDictionary<String,Object>)

Abandons a Message using a lock token. This will make the message available again for processing.
CloseAsync()

Closes the Client. Closes the connections opened by it.

(Inherited from IClientEntity)
CompleteAsync(String)

Completes a Message using its lock token. This will delete the message from the queue.
DeadLetterAsync(String, IDictionary<String,Object>)

Moves a message to the deadletter sub-queue.
DeadLetterAsync(String, String, String)

Moves a message to the deadletter sub-queue.
RegisterMessageHandler(Func<Message,CancellationToken,Task>, Func<ExceptionReceivedEventArgs,Task>)

Receive messages continuously from the entity. Registers a message handler and begins a new thread to receive messages. This handler(Func<T1,T2,TResult>) is awaited on every time a new message is received by the receiver.
RegisterMessageHandler(Func<Message,CancellationToken,Task>, MessageHandlerOptions)

Receive messages continuously from the entity. Registers a message handler and begins a new thread to receive messages. This handler(Func<T1,T2,TResult>) is awaited on every time a new message is received by the receiver.
RegisterPlugin(ServiceBusPlugin)

Registers a ServiceBusPlugin to be used with this client.

(Inherited from IClientEntity)
UnregisterMessageHandlerAsync(TimeSpan)

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.
UnregisterPlugin(String)

Unregisters a ServiceBusPlugin.

(Inherited from IClientEntity)

Applies to

See also