Samples

For a guided introduction to essential NServiceBus concepts start with the NServiceBus step-by-step tutorial.

Skip to the list of samples

The samples are designed to highlight how various features of NServiceBus work and how the extension points plug into other libraries and tooling.

Samples are not production ready

Samples are not meant to be production-ready code or to be used as-is with Particular Platform tools. They are meant to illustrate the use of an API or feature in the simplest way possible. For this reason, these samples make certain assumptions on transport, hosting, etc. See Technology choices for more details.

Samples are not "endpoint drop in" projects

Since the endpoint in samples have to choose specific technologies (transport, serializer, persistence, etc.), before using this code in production ensure the code conforms with any specific technology choices.

Samples are downloadable and runnable

All samples have a download link that allows the sample solution to be downloaded as a zip file. Once opened in Visual Studio, the samples are then runnable. Note some samples may have certain infrastructure requirements, for example a database existing in a local SQL Server.

The full GitHub Repository

The samples are located in GitHub at Particular/docs.particular.net/samples and both issues and pull requests are accepted.

Samples targeting non-supported versions of the platform

Samples that target non-supported versions of NServiceBus have been archived. They are still available for browsing and download

Technology choices

Unless otherwise specified (by an individual sample) the following are the default technology choices.

Visual Studio and .NET

Visual Studio 2017 Update 3 and .NET 4.6.1 are required. If any help is required upgrading to a new version of Visual Studio, raise an issue.

C# language level

All samples target C# 7.1 to take advantage of the new language features. If any help is required in converting to earlier versions of C#, raise an issue.

Transport

NServiceBus version 6 and above

Samples default to the learning transport as it has the least friction for experimentation. The learning transport is not for production use.

NServiceBus version 5 and below

Samples default to the MSMQ transport. See MSMQ configuration to configure MSMQ in a way that is compatible with NServiceBus.

On startup, each sample will create the required queues. The samples use the prefix samples. for all queue names by default. There is no process to clean up these queues; after running samples those queues remain in MSMQ. To clean up these queues manually use a management tool or the native MSMQ API.

For example this PowerShell will delete all queues prefixed with private$\samples..

Add-Type -AssemblyName System.Messaging

foreach ($queue in [System.Messaging.MessageQueue]::GetPrivateQueuesByMachine("."))
{
  if($queue.QueueName.StartsWith("private$\samples."))
  {
    [System.Messaging.MessageQueue]::Delete($queue.Path)
  }
}

Persistence

Samples default to either the learning persistence or the InMemory persistence since both have no requirement on installed infrastructure. The learning persistence is not for production use.

Console hosting

Samples default to self-hosting in a console since it is the most explicit and contains fewer moving pieces. This would not be a suitable choice for a production system and other hosting options should be considered.

Logging

Samples default to logging at the Info level to the console. In production, the preferred approach is some combination of Warning and Error with a combination of targets.

Messages definitions

In many samples, messages are defined in a shared project along with reusable helper and configuration classes. This is done to reduce the number of projects in a solution. In a production solution, message definitions are usually isolated in their own projects.

Message destinations

Many samples make use of SendLocal and send to an endpoint directly by specify the destination using a string in code. This is done to simplify the amount of configuration in samples. In a production solution, most message destinations should be defined via routing configuration.

Dependency injection

Samples default to using the built-in dependency injection since it does not require any external NuGet packages. Switching to external dependency injection will give greater flexibility in customizations.

Samples

  • Azure Samples
  • Azure Service Bus transport samples
  • NServiceBus.Bridge Samples
  • DataBus Samples
  • Dependency Injection Samples
  • Encryption Samples
  • Hosting Samples
  • Logging and Metrics Samples
  • MSMQ Samples
  • NHibernate Persistence Samples
  • Outbox Samples
    • Multi-tenant endpoints
      Configure persistence to support multi-tenant scenarios with database-per-tenant isolation.
    • Using Outbox with SQL
      Integrating SQL Server Transport with SQL Persistence and ADO.net user data store using outbox.
  • Pipeline Samples
  • RabbitMQ Transport Samples
  • RavenDB Persistence Samples
  • Routing Samples
    Sample code related to routing.
  • Saga Samples
  • Scale-out Samples
    Sample code for scaling out NServiceBus endpoints.
  • Scheduling Samples
    • FluentScheduler Usage
      Using FluentScheduler to send messages from within an NServiceBus endpoint.
    • Hangfire Usage
      Using of Hangfire to send messages from within an NServiceBus endpoint.
    • Quartz.NET Usage
      Using of Quartz.NET to send messages from within an NServiceBus endpoint.
    • Scheduler
      A simple example of the NServiceBus scheduler API.
  • Serializer Samples
  • ServiceControl Samples
  • Showcase Samples
    More complex samples showing many features working together.
  • SQL Persistence Samples
  • SQL Server Transport Samples
  • SQS Transport Samples
  • Web Samples
  • NServiceBus.Wormhole Samples

  • Last modified