MsmqTransportElement Class

Represents the binding element used to specify the queuing communication properties for a service that uses the native MSMQ protocol.

Namespace:  System.ServiceModel.Configuration
Assembly:  System.ServiceModel (in System.ServiceModel.dll)

public sealed class MsmqTransportElement : MsmqElementBase

The MsmqTransportElement type exposes the following members.

  NameDescription
Public methodMsmqTransportElementInitializes a new instance of the MsmqTransportElement class.
Top

  NameDescription
Public propertyBindingElementTypeGets the binding type. (Overrides BindingElementExtensionElement.BindingElementType.)
Public propertyConfigurationElementNameGets the name of this configuration element. (Inherited from ServiceModelExtensionElement.)
Public propertyCurrentConfigurationGets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to. (Inherited from ConfigurationElement.)
Public propertyCustomDeadLetterQueueGets or sets a URI that contains the location of the per-application dead-letter queue, where messages that have expired or that have failed transfer or delivery are placed. (Inherited from MsmqElementBase.)
Public propertyDeadLetterQueueGets or sets an enumeration value that indicates the type of dead-letter queue to use. (Inherited from MsmqElementBase.)
Public propertyDurableGets or sets a value that indicates whether the messages processed by this binding are durable or volatile. (Inherited from MsmqElementBase.)
Public propertyElementInformationGets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. (Inherited from ConfigurationElement.)
Protected propertyElementPropertyGets the ConfigurationElementProperty object that represents the ConfigurationElement object itself. (Inherited from ConfigurationElement.)
Protected propertyEvaluationContextGets the ContextInformation object for the ConfigurationElement object. (Inherited from ConfigurationElement.)
Public propertyExactlyOnceGets or sets a Boolean value that indicates whether messages processed by this binding will be received exactly once. (Inherited from MsmqElementBase.)
Protected propertyItem[ConfigurationProperty]Gets or sets a property or attribute of this configuration element. (Inherited from ConfigurationElement.)
Protected propertyItem[String]Gets or sets a property, attribute, or child element of this configuration element. (Inherited from ConfigurationElement.)
Public propertyLockAllAttributesExceptGets the collection of locked attributes. (Inherited from ConfigurationElement.)
Public propertyLockAllElementsExceptGets the collection of locked elements. (Inherited from ConfigurationElement.)
Public propertyLockAttributesGets the collection of locked attributes (Inherited from ConfigurationElement.)
Public propertyLockElementsGets the collection of locked elements. (Inherited from ConfigurationElement.)
Public propertyLockItemGets or sets a value indicating whether the element is locked. (Inherited from ConfigurationElement.)
Public propertyManualAddressingGets or sets a Boolean value that specifies whether the user takes control of message addressing. (Inherited from TransportElement.)
Public propertyMaxBufferPoolSizeGets or sets the maximum size of the buffer pool. (Inherited from TransportElement.)
Public propertyMaxPoolSizeGets or sets an integer that specifies the maximum size of the pool that contains internal MSMQ message objects.
Public propertyMaxReceivedMessageSizeGets or sets the maximum allowable message size that can be received. (Inherited from TransportElement.)
Public propertyMaxRetryCyclesGets or sets the maximum number of retry cycles to attempt delivery of messages to the receiving application. (Inherited from MsmqElementBase.)
Public propertyMsmqTransportSecurityGets an MsmqTransportSecurityElement instance that encapsulates the transport security settings for a binding. (Inherited from MsmqElementBase.)
Protected propertyPropertiesGets a ConfigurationPropertyCollection instance that contains a collection of ConfigurationProperty objects that can be attributes or ConfigurationElement objects of this configuration element. (Inherited from MsmqElementBase.)
Public propertyQueueTransferProtocolGets or sets an enumeration value that indicates the queued communication channel transport that this binding uses.
Public propertyReceiveContextEnabledGets or sets a value that specifies if receive context for processing messages in queues is enabled. When this is true, a service can “peek” a message on the queue to begin processing it, and, if anything goes wrong and an exception is thrown, it remains on the queue. Services can also “lock” messages in order to retry processing at a later point in time. ReceiveContext provides a mechanism for “completing” the message once processed so it can be removed from the queue. Messages are no longer being read and re-written to queues over the network, and individual messages aren’t bouncing across different service instances during processing. (Inherited from MsmqElementBase.)
Public propertyReceiveErrorHandlingGets or sets an enumeration value that specifies how poison and nondispatchable messages are handled. (Inherited from MsmqElementBase.)
Public propertyReceiveRetryCountGets or sets the maximum number of times that the queue manager should attempt to send a message before transferring it to the retry queue. (Inherited from MsmqElementBase.)
Public propertyRetryCycleDelayGets or sets a value that indicates the time delay between retry cycles when attempting to deliver a message that could not be delivered immediately. (Inherited from MsmqElementBase.)
Public propertyTimeToLiveGets or sets the interval of time that indicates how long the messages processed by this binding can be in the queue before they expire. (Inherited from MsmqElementBase.)
Public propertyUseActiveDirectoryReturns a Boolean value that indicates whether queue addresses should be converted using Active Directory.
Public propertyUseMsmqTracingGets or sets a Boolean value that indicates whether messages processed by this binding should be traced. (Inherited from MsmqElementBase.)
Public propertyUseSourceJournalGets or sets a Boolean value that indicates whether copies of messages processed by this binding should be stored in the source journal queue. (Inherited from MsmqElementBase.)
Public propertyValidityDurationGets or sets a value that specifies a connection time-out when used with queued channels. (Inherited from MsmqElementBase.)
Top

  NameDescription
Public methodApplyConfigurationApplies the settings of this configuration element to the specified BindingElement binding element. (Overrides MsmqElementBase.ApplyConfiguration(BindingElement).)
Public methodCopyFromCopies the settings from the specified ServiceModelExtensionElement to this configuration element. (Overrides MsmqElementBase.CopyFrom(ServiceModelExtensionElement).)
Protected methodCreateBindingElementCreates a new custom binding element object whose properties are copied from the settings of this configuration element. (Inherited from TransportElement.)
Protected methodCreateDefaultBindingElementReturns a custom binding element object with default values. (Inherited from TransportElement.)
Protected methodDeserializeElementReads XML from the configuration file. (Inherited from ConfigurationElement.)
Public methodEqualsCompares the current ConfigurationElement instance to the specified object. (Inherited from ConfigurationElement.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeGets a unique value representing the current ConfigurationElement instance. (Inherited from ConfigurationElement.)
Protected methodGetTransformedAssemblyStringReturns the transformed version of the specified assembly name. (Inherited from ConfigurationElement.)
Protected methodGetTransformedTypeStringReturns the transformed version of the specified type name. (Inherited from ConfigurationElement.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodInitSets the ConfigurationElement object to its initial state. (Inherited from ConfigurationElement.)
Protected methodInitializeDefaultUsed to initialize a default set of values for the ConfigurationElement object. (Inherited from ConfigurationElement.)
Protected methodInitializeFromInitializes this binding element with the content from the specified binding element. (Inherited from MsmqElementBase.)
Protected methodIsModifiedGets a value that specifies whether this configuration element has been modified. (Inherited from ServiceModelExtensionElement.)
Public methodIsReadOnlyGets a value indicating whether the ConfigurationElement object is read-only. (Inherited from ConfigurationElement.)
Protected methodListErrorsAdds the invalid-property errors in this ConfigurationElement object, and in all subelements, to the passed list. (Inherited from ConfigurationElement.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnDeserializeUnrecognizedAttributeGets a value indicating whether an unknown attribute is encountered during deserialization. (Inherited from ConfigurationElement.)
Protected methodOnDeserializeUnrecognizedElementGets a value indicating whether an unknown element is encountered during deserialization. (Inherited from ConfigurationElement.)
Protected methodOnRequiredPropertyNotFoundThrows an exception when a required property is not found. (Inherited from ConfigurationElement.)
Protected methodPostDeserializeCalled after deserialization. (Inherited from ConfigurationElement.)
Protected methodPreSerializeCalled before serialization. (Inherited from ConfigurationElement.)
Protected methodResetResets the internal state of this configuration element object, including the locks and the properties collections. (Inherited from ServiceModelExtensionElement.)
Protected methodResetModifiedResets the value of the IsModified method to false when implemented in a derived class. (Inherited from ConfigurationElement.)
Protected methodSerializeElementWrites the contents of this configuration element to the configuration file. (Inherited from ServiceModelExtensionElement.)
Protected methodSerializeToXmlElementWrites the outer tags of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement.)
Protected methodSetPropertyValueSets a property to the specified value. (Inherited from ConfigurationElement.)
Protected methodSetReadOnlySets the IsReadOnly property for the ConfigurationElement object and all subelements. (Inherited from ConfigurationElement.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Protected methodUnmergeModifies the ConfigurationElement object to remove all values that should not be saved. (Inherited from ConfigurationElement.)
Top

The MsmqTransportBindingElement enables the user to set the properties of the queued communication channel. The queued communication channel uses MSMQ for its transport.

This binding element is the default binding element used by the MSMQ standard binding (NetMsmqBinding).

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft