C# Class NServiceBus.HostInfoSettings

Configuration class for HostInformation settings.
Exibir arquivo Open project: Particular/NServiceBus

Public Methods

Method Description
UsingCustomDisplayName ( string displayName ) : HostInfoSettings

Allows to override the display name.

UsingCustomIdentifier ( System.Guid id ) : HostInfoSettings

In this mode, the host id is fully managed by the user.

This mode is only recommended if you know what you are doing. The id should be the same across endpoint restarts unless physical host has changed.

UsingInstalledFilePath ( ) : HostInfoSettings

In this mode, the host id is derived from the installed file path and the current machine name.

This mode is only recommended if upgrades are deployed always to the same path. When using Octopus Deploy do not use this mode, instead use UsingNames.

UsingNames ( string instanceName, string hostName ) : HostInfoSettings

In this mode, a host id will be generated from instanceName and hostName.

This mode is recommended when deploying in Azure roles or UsingInstalledFilePath is not appropriate.

Private Methods

Method Description
HostInfoSettings ( EndpointConfiguration config ) : System

Method Details

UsingCustomDisplayName() public method

Allows to override the display name.
public UsingCustomDisplayName ( string displayName ) : HostInfoSettings
displayName string
return HostInfoSettings

UsingCustomIdentifier() public method

In this mode, the host id is fully managed by the user.
This mode is only recommended if you know what you are doing. The id should be the same across endpoint restarts unless physical host has changed.
public UsingCustomIdentifier ( System.Guid id ) : HostInfoSettings
id System.Guid
return HostInfoSettings

UsingInstalledFilePath() public method

In this mode, the host id is derived from the installed file path and the current machine name.
This mode is only recommended if upgrades are deployed always to the same path. When using Octopus Deploy do not use this mode, instead use UsingNames.
public UsingInstalledFilePath ( ) : HostInfoSettings
return HostInfoSettings

UsingNames() public method

In this mode, a host id will be generated from instanceName and hostName.
This mode is recommended when deploying in Azure roles or UsingInstalledFilePath is not appropriate.
public UsingNames ( string instanceName, string hostName ) : HostInfoSettings
instanceName string
hostName string
return HostInfoSettings