Table of Contents

Class ServiceBusPlugin

Namespace
Microsoft.Azure.ServiceBus.Core
Assembly
Microsoft.Azure.ServiceBus.dll

This class provides methods that can be overridden to manipulate messages for custom plugin functionality.

public abstract class ServiceBusPlugin
Inheritance
ServiceBusPlugin
Inherited Members

Constructors

ServiceBusPlugin()

protected ServiceBusPlugin()

Properties

Name

Gets the name of the ServiceBusPlugin.

public abstract string Name { get; }

Property Value

string

Remarks

This name is used to identify the plugin, and prevent a plugin from being registered multiple times.

ShouldContinueOnException

Determines whether or an exception in the plugin should prevent a send or receive operation.

public virtual bool ShouldContinueOnException { get; }

Property Value

bool

Methods

AfterMessageReceive(Message)

This operation is called after a message is received, but before it is returned to the IMessageReceiver.

public virtual Task<Message> AfterMessageReceive(Message message)

Parameters

message Message

The Message to be modified by the plugin

Returns

Task<Message>

The modified Message

BeforeMessageSend(Message)

This operation is called before a message is sent.

public virtual Task<Message> BeforeMessageSend(Message message)

Parameters

message Message

The Message to be modified by the plugin

Returns

Task<Message>

The modified Message