Class SendAvailabilityPairedNamespaceOptions

Namespace

Microsoft.ServiceBus.Messaging

Assembly

Microsoft.ServiceBus.dll

Represents the options for the sending the availability of paired namespace.

public sealed class SendAvailabilityPairedNamespaceOptions : PairedNamespaceOptions

Inheritance

object

PairedNamespaceOptions

SendAvailabilityPairedNamespaceOptions

Inherited Members

PairedNamespaceOptions.SecondaryNamespaceManager

PairedNamespaceOptions.SecondaryMessagingFactory

PairedNamespaceOptions.FailoverInterval

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

SendAvailabilityPairedNamespaceOptions(NamespaceManager, MessagingFactory)

Initializes a new instance of the SendAvailabilityPairedNamespaceOptions class.

public SendAvailabilityPairedNamespaceOptions(NamespaceManager secondaryNamespaceManager, MessagingFactory messagingFactory)

Parameters

secondaryNamespaceManager NamespaceManager

The secondary namespace manager.

messagingFactory MessagingFactory

The messaging factory.

SendAvailabilityPairedNamespaceOptions(NamespaceManager, MessagingFactory, int)

Initializes a new instance of the SendAvailabilityPairedNamespaceOptions class.

public SendAvailabilityPairedNamespaceOptions(NamespaceManager secondaryNamespaceManager, MessagingFactory messagingFactory, int backlogQueueCount)

Parameters

secondaryNamespaceManager NamespaceManager

The secondary namespace manager.

messagingFactory MessagingFactory

The messaging factory.

backlogQueueCount int

The number of backlog queue.

SendAvailabilityPairedNamespaceOptions(NamespaceManager, MessagingFactory, int, TimeSpan, bool)

Initializes a new instance of the SendAvailabilityPairedNamespaceOptions class.

public SendAvailabilityPairedNamespaceOptions(NamespaceManager secondaryNamespaceManager, MessagingFactory messagingFactory, int backlogQueueCount, TimeSpan failoverInterval, bool enableSyphon)

Parameters

secondaryNamespaceManager NamespaceManager

The secondary namespace manager.

messagingFactory MessagingFactory

The messaging factory.

backlogQueueCount int

The number of backlog queue.

failoverInterval TimeSpan

The fail over interval.

enableSyphon bool

true to enable syphon; otherwise, false.

Properties

BacklogQueueCount

Gets or sets the number of backlog queues.

public int BacklogQueueCount { get; }

Property Value

int

The number of backlog queues.

EnableSyphon

Gets or sets whether the syphon is enabled for this instance.

public bool EnableSyphon { get; }

Property Value

bool

true if the syphon is enabled for this instance; otherwise, false.

PingPrimaryInterval

Gets or sets the interval of pings.

public TimeSpan PingPrimaryInterval { get; set; }

Property Value

TimeSpan

The interval of pings.

Methods

ClearPairing()

Dissolves the pairing of the paired namespace.

protected override void ClearPairing()

MarkPathHealthy(string)

Marks a path as healthy.

public void MarkPathHealthy(string path)

Parameters

path string

The path to be marked.

OnNotifyPrimarySendResult(string, bool)

Notifies the primary messaging on sending the result.

protected override void OnNotifyPrimarySendResult(string path, bool success)

Parameters

path string

The string of the path.

success bool

true if the results successfully send; otherwise, false.