Peek Lock Message Processing Pattern Support

Introduction

Azure Service Bus supports two different patterns of message processing:

1. Receive and Delete - todo: explain this pattern briefly
2. Peek Lock - todo: explain this pattern briefly

In order to leverage the Peek Lock pattern, the Azure Service Bus Transport for Obvs provides a base class provides some additional messaging functionality beyond the base Obvs Framework.

Opt-in to the Peek Lock Messaging Pattern (obsoleted)

The first thing you must do to opt-in to the Peek Lock messaging pattern is to derive your base most message class from PeekLockMessage. The class itself exposes no extra state or functionality. It is, for all intents and purposes, a marker class that let's the Obvs Azure Service Bus Transport know that you require Peek Lock control over your messages.

As of release 0.14.0-beta2 this requirement of inheriting from the base PeekLockMessage class has been removed as has the class itself. See #14 for more information.

Specify MessageReceiveMode.PeekLock when configuring a particular messaging entity

When configuring a messaging entity using the configuration methods such as UsingQueueFor or UsingSubscriptionFor use an overload that takes a MessageReceiveMode parameter and specify the PeekLock option.

Peek Lock Message Control

The framework offers an extension method to your message classes called GetPeekLockControl which returns an IMessagePeekLockControl instance that provides the expected Peek Lock Control methods.