MsmqTransportBindingElement Class

Definition

Namespace:

System.ServiceModel.Channels

Assembly:

System.ServiceModel.dll

Represents the binding element used to specify the queuing communication properties for a Windows Communication Foundation (WCF) service that uses the native Message Queuing (MSMQ) protocol.

public ref class MsmqTransportBindingElement sealed : System::ServiceModel::Channels::MsmqBindingElementBase

public sealed class MsmqTransportBindingElement : System.ServiceModel.Channels.MsmqBindingElementBase

type MsmqTransportBindingElement = class
    inherit MsmqBindingElementBase

Public NotInheritable Class MsmqTransportBindingElement
Inherits MsmqBindingElementBase

Inheritance

Object

BindingElement

TransportBindingElement

MsmqBindingElementBase

MsmqTransportBindingElement

Examples

string queueName = @".\private$\ServiceModelSamples";

if (!MessageQueue.Exists(queueName))
    MessageQueue.Create(queueName, true);

using (ServiceHost serviceHost = new ServiceHost(typeof(CalculatorService)))
{
    BinaryMessageEncodingBindingElement encodingBindingElement = new BinaryMessageEncodingBindingElement();
    MsmqTransportBindingElement transportBindingElement = new MsmqTransportBindingElement();
    CustomBinding binding = new CustomBinding(encodingBindingElement, transportBindingElement);

    serviceHost.AddServiceEndpoint(
        typeof(IQueueCalculator),
        binding,
        "net.msmq://localhost/private/ServiceModelSamples");

    serviceHost.Open();

    // The service can now be accessed.
    Console.WriteLine("The service is ready.");
    Console.WriteLine("Press <ENTER> to terminate service.");
    Console.WriteLine();
    Console.ReadLine();

    // Close the ServiceHost to shutdown the service.
    serviceHost.Close();

Remarks

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

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

Constructors

MsmqTransportBindingElement()

Initializes a new instance of the MsmqTransportBindingElement class.

Properties

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)
ExactlyOnce	Gets or sets a value that specifies whether messages sent with this binding have exactly once assurances. (Inherited from MsmqBindingElementBase)
ManualAddressing	Gets or sets a value that indicates whether manual addressing of the message is required. (Inherited from TransportBindingElement)
MaxBufferPoolSize	Gets or sets the maximum size, in bytes, of any buffer pools used by the transport. (Inherited from TransportBindingElement)
MaxPoolSize	Gets or sets an integer that specifies the maximum size of the pool that contains internal Message Queuing (MSMQ) message objects.
MaxReceivedMessageSize	Gets or sets the maximum allowable message size, in bytes, that can be received. (Inherited from TransportBindingElement)
MaxRetryCycles	Gets or sets the maximum number of retry cycles to attempt delivery of messages to the receiving application. (Inherited from MsmqBindingElementBase)
MsmqTransportSecurity	Gets the MsmqTransportSecurity that is associated with this binding element. (Inherited from MsmqBindingElementBase)
QueueTransferProtocol	Gets or sets an enumeration value that indicates the queued communication channel transport that this binding uses.
ReceiveContextEnabled	Gets or sets a value that indicates whether the receive context behavior is requested. (Inherited from MsmqBindingElementBase)
ReceiveErrorHandling	Gets or sets an enumeration value that specifies how poison and other messages that cannot be dispatched are handled. (Inherited from MsmqBindingElementBase)
ReceiveRetryCount	Gets or sets the maximum number of times the queue manager should attempt to send a message before transferring it to the retry queue. (Inherited from MsmqBindingElementBase)
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)
Scheme	Returns a String that contains the addressing scheme that is used by this transport binding element.
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 depending on the DeadLetterQueue setting. (Inherited from MsmqBindingElementBase)
TransactedReceiveEnabled	Gets a value that specifies whether a transaction is required to receive messages with this binding. (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 enables or disables the Message Queuing (MSMQ) built-in message tracing facility. (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 the duration a message will be locked by the receive context feature. (Inherited from MsmqBindingElementBase)

Methods

BuildChannelFactory<TChannel>(BindingContext)	Builds a channel factory using the context provided.
BuildChannelListener<TChannel>(BindingContext)	Builds a channel listener using the context provided.
CanBuildChannelFactory<TChannel>(BindingContext)	Returns a Boolean value that indicates whether you can build a channel factory with the context provided.
CanBuildChannelListener<TChannel>(BindingContext)	Returns a Boolean value that indicates whether you can build a channel listener with the context provided.
Clone()	Returns a clone of the binding element.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetProperty<T>(BindingContext)	When overridden in a derived class, retrieves a specified type of object for the binding context provided. (Inherited from MsmqBindingElementBase)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Explicit Interface Implementations

IPolicyExportExtension.ExportPolicy(MetadataExporter, PolicyConversionContext)	Exports custom policy assertions about bindings. (Inherited from MsmqBindingElementBase)
IWsdlExportExtension.ExportContract(WsdlExporter, WsdlContractConversionContext)	Writes custom Web Services Description Language (WSDL) elements into the generated WSDL for a contract. (Inherited from MsmqBindingElementBase)
IWsdlExportExtension.ExportEndpoint(WsdlExporter, WsdlEndpointConversionContext)	Writes custom Web Services Description Language (WSDL) elements into the generated WSDL for an endpoint. (Inherited from MsmqBindingElementBase)