The NServiceBus.Host

Component: NServiceBus Host
NuGet Package NServiceBus.Host (7.x)
Target NServiceBus Version: 6.x
For endpoints using NServiceBus version 7 and above, it is no longer recommended to use the NServiceBus Host version 8. Use alternative approaches such as Generic Host, NServiceBus Windows Service or NServiceBus Docker Container instead. The host is still supported for existing endpoints to ease the transition phase to the new hosting models, refer to the upgrade guide for further details.

Code walk-through

This sample shows how to host an NServiceBus endpoint using the NServiceBus.Host.

[EndpointName("Samples.NServiceBus.Host")]
public class EndpointConfig :
    IConfigureThisEndpoint
{
    public void Customize(EndpointConfiguration endpointConfiguration)
    {
        endpointConfiguration.EnableInstallers();
        endpointConfiguration.UsePersistence<LearningPersistence>();
        endpointConfiguration.UseTransport<LearningTransport>();
    }
}

Running code at start and stop time

Since the configuration is done via an implementation of IConfigureThisEndpoint and the host controls the startup process there is no regular way to run code at startup and stop of the endpoint. To enable this scenario, there is an interface that is assembly scanned and executed at these times.

public class MessageSender :
    IWantToRunWhenEndpointStartsAndStops
{
    public Task Start(IMessageSession session)
    {
        var myMessage = new MyMessage();
        return session.SendLocal(myMessage);
    }

    public Task Stop(IMessageSession session)
    {
        return Task.CompletedTask;
    }
}

Related Articles

  • Interface lifecycles
    The lifecycles of the various NServiceBus configuration interfaces.
  • NServiceBus Host
    Avoid writing repeat configuration code, host the endpoints in a Windows Service, and change technologies without code.

Last modified