NetMsmqBindingElement Class

Definition

Represents a queued binding that is suitable for cross-machine communication.

public ref class NetMsmqBindingElement : System::ServiceModel::Configuration::MsmqBindingElementBase
public class NetMsmqBindingElement : System.ServiceModel.Configuration.MsmqBindingElementBase
type NetMsmqBindingElement = class
    inherit MsmqBindingElementBase
Public Class NetMsmqBindingElement
Inherits MsmqBindingElementBase
Inheritance
Inheritance

Remarks

The NetMsmqBinding binding provides support for queuing by leveraging Microsoft Message Queuing (MSMQ) as a transport and enables support for loosely coupled applications, failure isolation, load leveling and disconnected operations. For a discussion of these features, see Queues Overview.

This is one of the standard bindings provided by Windows Communication Foundation (WCF). The recommended procedure is to define the binding using configuration values and not to use a code-based approach, except in certain advanced scenarios in which configuration values must be set when a service is initialized.

Constructors

NetMsmqBindingElement()

Initializes a new instance of the NetMsmqBindingElement class.

NetMsmqBindingElement(String)

Initializes a new instance of the NetMsmqBindingElement class from the settings of a specified configuration binding element.

Properties

BindingElementType

Gets the Type of this binding.

CloseTimeout

Gets or sets the interval of time provided for a close operation to complete.

(Inherited from StandardBindingElement)
CurrentConfiguration

Gets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to.

(Inherited from ConfigurationElement)
CustomDeadLetterQueue

Gets or sets a Uri that identifies a custom dead-letter queue where expired messages or messages that failed to be delivered are sent.

(Inherited from MsmqBindingElementBase)
DeadLetterQueue

Gets or sets the DeadLetterQueue setting for this binding.

(Inherited from MsmqBindingElementBase)
Durable

Gets or sets a value that specifies whether messages sent with this binding are durable or volatile.

(Inherited from MsmqBindingElementBase)
ElementInformation

Gets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object.

(Inherited from ConfigurationElement)
ElementProperty

Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself.

(Inherited from ConfigurationElement)
EvaluationContext

Gets the ContextInformation object for the ConfigurationElement object.

(Inherited from ConfigurationElement)
ExactlyOnce

Gets or sets a value that specifies whether messages sent with this binding have exactly-once assurances.

(Inherited from MsmqBindingElementBase)
HasContext

Gets a value that indicates whether the CurrentConfiguration property is null.

(Inherited from ConfigurationElement)
Item[ConfigurationProperty]

Gets or sets a property or attribute of this configuration element.

(Inherited from ConfigurationElement)
Item[String]

Gets or sets a property, attribute, or child element of this configuration element.

(Inherited from ConfigurationElement)
LockAllAttributesExcept

Gets the collection of locked attributes.

(Inherited from ConfigurationElement)
LockAllElementsExcept

Gets the collection of locked elements.

(Inherited from ConfigurationElement)
LockAttributes

Gets the collection of locked attributes.

(Inherited from ConfigurationElement)
LockElements

Gets the collection of locked elements.

(Inherited from ConfigurationElement)
LockItem

Gets or sets a value indicating whether the element is locked.

(Inherited from ConfigurationElement)
MaxBufferPoolSize

Gets or sets the maximum amount of memory that is allocated for use by the message buffer manager that receives messages from the channel.

MaxReceivedMessageSize

Gets or sets a value that indicates the maximum size, in bytes, allowed for a message.

(Inherited from MsmqBindingElementBase)
MaxRetryCycles

Gets or sets the maximum number of retry cycles to attempt delivery of messages to the receiving application.

(Inherited from MsmqBindingElementBase)
Name

Gets or sets the name of the binding.

(Inherited from StandardBindingElement)
OpenTimeout

Gets or sets the interval of time provided for an open operation to complete.

(Inherited from StandardBindingElement)
Properties

Gets the ConfigurationPropertyCollection that is associated with this binding.

QueueTransferProtocol

Gets or sets an enumeration value that indicates the queued communication channel transport that this binding uses.

ReaderQuotas

Gets or sets the XmlDictionaryReaderQuotas object that is associated with this binding.

ReceiveContextEnabled

Gets or sets a value that indicates whether receive context for processing messages in queues is enabled.

(Inherited from MsmqBindingElementBase)
ReceiveErrorHandling

Gets or sets an enumeration value that specifies how poison and messages that cannot be dispatched are handled.

(Inherited from MsmqBindingElementBase)
ReceiveRetryCount

Gets or sets the maximum number of immediate retries that the queue manager should attempt if transmission of a message from the application queue to the application fails.

(Inherited from MsmqBindingElementBase)
ReceiveTimeout

Gets or sets the interval of time provided for a receive operation to complete.

(Inherited from StandardBindingElement)
RetryCycleDelay

Gets or sets a value that specifies how long to wait before attempting another retry cycle when attempting to deliver a message that could not be delivered.

(Inherited from MsmqBindingElementBase)
Security

Gets the NetMsmqSecurity that is associated with this binding.

SendTimeout

Gets or sets the interval of time provided for a send operation to complete.

(Inherited from StandardBindingElement)
TimeToLive

Gets or sets a value that specifies how long messages are valid. When this time has elapsed, the message is placed in a dead-letter queue (if available).

(Inherited from MsmqBindingElementBase)
UseActiveDirectory

Returns a Boolean value that indicates whether queue addresses should be converted using Active Directory.

UseMsmqTracing

Gets or sets a value that indicates whether the Message Queuing (also known as MSMQ) built-in message tracing facility is used.

(Inherited from MsmqBindingElementBase)
UseSourceJournal

Gets or sets a value that indicates whether copies of messages processed by this binding should be stored in the source journal queue.

(Inherited from MsmqBindingElementBase)
ValidityDuration

Gets or sets a value that specifies a connection time-out when used with queued channels.

(Inherited from MsmqBindingElementBase)

Methods

ApplyConfiguration(Binding)

Applies the content of the specified binding to this binding configuration element.

(Inherited from StandardBindingElement)
DeserializeElement(XmlReader, Boolean)

Reads XML from the configuration file.

(Inherited from ConfigurationElement)
Equals(Object)

Compares the current ConfigurationElement instance to the specified object.

(Inherited from ConfigurationElement)
GetHashCode()

Gets a unique value representing the current ConfigurationElement instance.

(Inherited from ConfigurationElement)
GetTransformedAssemblyString(String)

Returns the transformed version of the specified assembly name.

(Inherited from ConfigurationElement)
GetTransformedTypeString(String)

Returns the transformed version of the specified type name.

(Inherited from ConfigurationElement)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
Init()

Sets the ConfigurationElement object to its initial state.

(Inherited from ConfigurationElement)
InitializeDefault()

Used to initialize a default set of values for the ConfigurationElement object.

(Inherited from ConfigurationElement)
InitializeFrom(Binding)

Initializes this binding configuration section with the content of the specified binding element.

IsModified()

Indicates whether this configuration element has been modified since it was last saved or loaded, when implemented in a derived class.

(Inherited from ConfigurationElement)
IsReadOnly()

Gets a value indicating whether the ConfigurationElement object is read-only.

(Inherited from ConfigurationElement)
ListErrors(IList)

Adds the invalid-property errors in this ConfigurationElement object, and in all subelements, to the passed list.

(Inherited from ConfigurationElement)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
OnApplyConfiguration(Binding)

Applies the specified binding to the configuration element.

OnDeserializeUnrecognizedAttribute(String, String)

Gets a value indicating whether an unknown attribute is encountered during deserialization.

(Inherited from ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)

Gets a value indicating whether an unknown element is encountered during deserialization.

(Inherited from ConfigurationElement)
OnRequiredPropertyNotFound(String)

Throws an exception when a required property is not found.

(Inherited from ConfigurationElement)
PostDeserialize()

Called after deserialization.

(Inherited from ConfigurationElement)
PreSerialize(XmlWriter)

Called before serialization.

(Inherited from ConfigurationElement)
Reset(ConfigurationElement)

Resets the internal state of this configuration element object, including the locks and the properties collections.

(Inherited from StandardBindingElement)
ResetModified()

Resets the value of the IsModified() method to false when implemented in a derived class.

(Inherited from ConfigurationElement)
SerializeElement(XmlWriter, Boolean)

Writes the contents of this configuration element to the configuration file when implemented in a derived class.

(Inherited from ConfigurationElement)
SerializeToXmlElement(XmlWriter, String)

Writes the outer tags of this configuration element to the configuration file when implemented in a derived class.

(Inherited from ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)

Sets a property to the specified value.

(Inherited from ConfigurationElement)
SetPropertyValueIfNotDefaultValue<T>(String, T)

Sets the property value for the configuration element if the value is not the default value.

(Inherited from ServiceModelConfigurationElement)
SetReadOnly()

Sets the IsReadOnly() property for the ConfigurationElement object and all subelements.

(Inherited from ConfigurationElement)
ToString()

Returns a string that represents the current object.

(Inherited from Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)

Modifies the ConfigurationElement object to remove all values that should not be saved.

(Inherited from ConfigurationElement)

Applies to

See also