MessagingFactorySettings MessagingFactorySettings Class

Definition

Represents the messaging factory settings.

public class MessagingFactorySettingsPublic Class MessagingFactorySettings
Inheritance
MessagingFactorySettingsMessagingFactorySettings

Inherited Members

System.Object

Constructors

MessagingFactorySettings() MessagingFactorySettings()

Initializes a new instance of the MessagingFactorySettings class.

public MessagingFactorySettings()Public Sub New

MessagingFactorySettings(MessagingFactorySettings) MessagingFactorySettings(MessagingFactorySettings)

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

public MessagingFactorySettings(MessagingFactorySettings other)Public Sub New(other As MessagingFactorySettings)
Parameters
other
MessagingFactorySettings MessagingFactorySettings

The specified messaging factory settings.

Properties

AmqpTransportSettings AmqpTransportSettings

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

public AmqpTransportSettings AmqpTransportSettings { get; set; }Public Property AmqpTransportSettings As AmqpTransportSettings
Value
AmqpTransportSettings AmqpTransportSettings

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

DisableEntityLevelPerformanceCounters DisableEntityLevelPerformanceCounters

Gets or sets a value to indicate if entity level perf counters should be collected in memory. Note that this only affect entity level counters, and namespace level counters are always collected.

public bool DisableEntityLevelPerformanceCounters { get; set; }Public Property DisableEntityLevelPerformanceCounters As Boolean

Remarks

By default this is set to false - meaning by default we do collect entity level perf counters. Setting this value will not affect existing collected counters, and will only stop counters from new entity being collected.

EnableAdditionalClientTimeout EnableAdditionalClientTimeout

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

public bool EnableAdditionalClientTimeout { get; set; }Public Property EnableAdditionalClientTimeout As Boolean
Value
Boolean Boolean

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

NetMessagingTransportSettings NetMessagingTransportSettings

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

public NetMessagingTransportSettings NetMessagingTransportSettings { get; set; }Public Property NetMessagingTransportSettings As NetMessagingTransportSettings
Value
NetMessagingTransportSettings NetMessagingTransportSettings

The transport settings required for the net messaging.

OperationTimeout OperationTimeout

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

public TimeSpan OperationTimeout { get; set; }Public Property OperationTimeout As TimeSpan
Value
TimeSpan TimeSpan

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

Exceptions

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

TokenProvider TokenProvider

Gets or sets the token provider of the factory settings.

public TokenProvider TokenProvider { get; set; }Public Property TokenProvider As TokenProvider
Value
TokenProvider TokenProvider

The token provider of the factory settings.

TransportType TransportType

Gets or sets the messaging transport type.

public TransportType TransportType { get; set; }Public Property TransportType As TransportType
Value
TransportType TransportType

The messaging transport type.

Methods

Clone() Clone()

Creates a copy of MessagingFactorySettings.

public virtual MessagingFactorySettings Clone()Public Overridable Function Clone As MessagingFactorySettings
Returns

OnBeginCreateFactory(IEnumerable<Uri>, AsyncCallback, Object) OnBeginCreateFactory(IEnumerable(Of Uri), AsyncCallback, Object)

Executes the asynchronous begin create factory action.

protected virtual IAsyncResult OnBeginCreateFactory(IEnumerable<Uri> uriAddresses, AsyncCallback callback, object state)Protected Overridable Function OnBeginCreateFactory(uriAddresses As IEnumerable(Of Uri), callback As AsyncCallback, state As Object) As IAsyncResult
Parameters
uriAddresses
IEnumerable<Uri> IEnumerable(Of Uri)

The collection of uniform resource identifiers.

callback
AsyncCallback AsyncCallback

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

state
Object Object

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

Returns

An IAsyncResult that references the asynchronous request to create factory.

OnBeginCreateFactory(Uri, AsyncCallback, Object) OnBeginCreateFactory(Uri, AsyncCallback, Object)

Executes the asynchronous begin create factory action.

protected virtual IAsyncResult OnBeginCreateFactory(Uri uri, AsyncCallback callback, object state)Protected Overridable Function OnBeginCreateFactory(uri As Uri, callback As AsyncCallback, state As Object) As IAsyncResult
Parameters
uri
Uri Uri

The uniform resource identifier.

callback
AsyncCallback AsyncCallback

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

state
Object Object

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

Returns

An IAsyncResult that references the asynchronous request to create factory.

OnEndCreateFactory(IAsyncResult) OnEndCreateFactory(IAsyncResult)

Ends an asynchronous request to create factory.

protected virtual MessagingFactory OnEndCreateFactory(IAsyncResult result)Protected Overridable Function OnEndCreateFactory(result As IAsyncResult) As MessagingFactory
Parameters
result
IAsyncResult IAsyncResult

An IAsyncResult that references the asynchronous request to create factory.

Returns

The newly created messaging factory.