Class MessagingFactorySettings

Namespace

Microsoft.ServiceBus.Messaging

Assembly

Microsoft.ServiceBus.dll

Represents the messaging factory settings.

public class MessagingFactorySettings

Inheritance

object

MessagingFactorySettings

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

MessagingFactorySettings()

Initializes a new instance of the MessagingFactorySettings class.

public MessagingFactorySettings()

MessagingFactorySettings(MessagingFactorySettings)

Initializes a new instance of the MessagingFactorySettings class with the specified messaging factory settings for cloning.

public MessagingFactorySettings(MessagingFactorySettings other)

Parameters

other MessagingFactorySettings

The specified messaging factory settings.

Properties

AmqpTransportSettings

Gets or set the transport settings for the Advanced Message Queuing Protocol (AMQP).

public AmqpTransportSettings AmqpTransportSettings { get; set; }

Property Value

AmqpTransportSettings

The transport settings for the Advanced Message Queuing Protocol (AMQP).

DisableEntityLevelPerformanceCounters

public bool DisableEntityLevelPerformanceCounters { get; set; }

Property Value

bool

EnableAdditionalClientTimeout

Gets or sets a value that indicates whether the messaging operation enables additional client timeout.

public bool EnableAdditionalClientTimeout { get; set; }

Property Value

bool

true if the messaging operation enables additional client timeout; otherwise, false.

NetMessagingTransportSettings

Gets or sets the transport settings required for the net messaging.

public NetMessagingTransportSettings NetMessagingTransportSettings { get; set; }

Property Value

NetMessagingTransportSettings

The transport settings required for the net messaging.

OperationTimeout

Gets or sets the TimeSpan that specifies how long the messaging operation has to complete before timing out.

public TimeSpan OperationTimeout { get; set; }

Property Value

TimeSpan

The TimeSpan that specifies how long the messaging operation has to complete before timing out. The default value is one minute.

Exceptions

ArgumentNullException

A null is set; for example, a nullable TimeSpan.

ArgumentOutOfRangeException

A zero or negative TimeSpan is set.

TokenProvider

Gets or sets the token provider of the factory settings.

public TokenProvider TokenProvider { get; set; }

Property Value

TokenProvider

The token provider of the factory settings.

TransportType

Gets or sets the messaging transport type.

public TransportType TransportType { get; set; }

Property Value

TransportType

The messaging transport type.

Methods

Clone()

Creates a copy of MessagingFactorySettings.

public virtual MessagingFactorySettings Clone()

Returns

MessagingFactorySettings

A created copy of MessagingFactorySettings.

OnBeginCreateFactory(IEnumerable<Uri>, AsyncCallback, object)

Executes the asynchronous begin create factory action.

protected virtual IAsyncResult OnBeginCreateFactory(IEnumerable<Uri> uriAddresses, AsyncCallback callback, object state)

Parameters

uriAddresses IEnumerable<Uri>

The collection of uniform resource identifiers.

callback AsyncCallback

An AsyncCallback delegate that references the method to invoke when the operation is complete.

state object

A user-defined object that contains information about the receive operation.

Returns

IAsyncResult

An IAsyncResult that references the asynchronous request to create factory.

OnBeginCreateFactory(Uri, AsyncCallback, object)

Executes the asynchronous begin create factory action.

protected virtual IAsyncResult OnBeginCreateFactory(Uri uri, AsyncCallback callback, object state)

Parameters

uri Uri

The uniform resource identifier.

callback AsyncCallback

An AsyncCallback delegate that references the method to invoke when the operation is complete.

state object

A user-defined object that contains information about the receive operation.

Returns

IAsyncResult

An IAsyncResult that references the asynchronous request to create factory.

OnEndCreateFactory(IAsyncResult)

Ends an asynchronous request to create factory.

protected virtual MessagingFactory OnEndCreateFactory(IAsyncResult result)

Parameters

result IAsyncResult

An IAsyncResult that references the asynchronous request to create factory.

Returns

MessagingFactory

The newly created messaging factory.