Export (0) Print
Expand All

MsmqIntegrationBinding Class

The MsmqIntegrationBinding class maps Microsoft Message Queuing (MSMQ) messages to Windows Communication Foundation (WCF) messages.

System.Object
  System.ServiceModel.Channels.Binding
    System.ServiceModel.MsmqBindingBase
      System.ServiceModel.MsmqIntegration.MsmqIntegrationBinding

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

'Declaration
Public Class MsmqIntegrationBinding _
	Inherits MsmqBindingBase

The MsmqIntegrationBinding type exposes the following members.

  NameDescription
Public methodMsmqIntegrationBindingInitializes a new instance of the MsmqIntegrationBinding class.
Public methodMsmqIntegrationBinding(MsmqIntegrationSecurityMode)Initializes a new instance of the MsmqIntegrationBinding class by using the specified MsmqIntegrationSecurityMode.
Public methodMsmqIntegrationBinding(String)Initializes a new instance of the MsmqIntegrationBinding class from the settings of a specified configuration binding element.
Top

  NameDescription
Public propertyCloseTimeoutGets or sets the interval of time provided for a connection to close before the transport raises an exception. (Inherited from Binding.)
Public propertyCustomDeadLetterQueueGets or sets a URI that contains the location of the dead-letter queue for each application, where messages that have expired or that have failed transfer or delivery are placed. (Inherited from MsmqBindingBase.)
Public propertyDeadLetterQueueGets or sets an enumeration value that indicates the type of dead-letter queue to use. (Inherited from MsmqBindingBase.)
Public propertyDurableGets or sets a value that indicates whether the messages processed by this binding are durable or volatile. (Inherited from MsmqBindingBase.)
Public propertyExactlyOnceGets or sets a value that indicates whether messages processed by this binding are received exactly once. (Inherited from MsmqBindingBase.)
Public propertyMaxReceivedMessageSizeGets or sets the maximum size, in bytes, for a message that is processed by this binding. (Inherited from MsmqBindingBase.)
Public propertyMaxRetryCyclesGets or sets the maximum number of retry cycles to attempt delivery of messages to the receiving application. (Inherited from MsmqBindingBase.)
Public propertyMessageVersionGets the message version used by clients and services configured with the binding. (Inherited from Binding.)
Public propertyNameGets or sets the name of the binding. (Inherited from Binding.)
Public propertyNamespaceGets or sets the XML namespace of the binding. (Inherited from Binding.)
Public propertyOpenTimeoutGets or sets the interval of time provided for a connection to open before the transport raises an exception. (Inherited from Binding.)
Public propertyReceiveContextEnabledGets or sets a value that indicates whether the receive context behavior is requested. (Inherited from MsmqBindingBase.)
Public propertyReceiveErrorHandlingGets or sets an enumeration value that specifies how poison messages are handled. (Inherited from MsmqBindingBase.)
Public propertyReceiveRetryCountGets or sets the maximum number of immediate delivery attempts on a message that is read from the application queue. (Inherited from MsmqBindingBase.)
Public propertyReceiveTimeoutGets or sets the interval of time that a connection can remain inactive, during which no application messages are received, before it is dropped. (Inherited from Binding.)
Public propertyRetryCycleDelayGets or sets a value that indicates the time delay between retry cycles when attempting to deliver a message that cannot be delivered immediately. (Inherited from MsmqBindingBase.)
Public propertySchemeReturns the scheme for this binding. (Inherited from MsmqBindingBase.)
Public propertySecurityGets the MsmqIntegrationSecurity that is associated with this binding.
Public propertySendTimeoutGets or sets the interval of time provided for a write operation to complete before the transport raises an exception. (Inherited from Binding.)
Public propertySerializationFormatGets or sets the serialization format to be used to serialize or deserialize the message.
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 MsmqBindingBase.)
Public propertyUseMsmqTracingGets or sets a value that indicates whether messages processed by this binding should be traced. (Inherited from MsmqBindingBase.)
Public propertyUseSourceJournalGets or sets a value that indicates whether copies of messages processed by this binding should be stored in the source journal queue. (Inherited from MsmqBindingBase.)
Public propertyValidityDurationGets or sets a value that specifies the duration a message will be locked by the receive context feature. (Inherited from MsmqBindingBase.)
Top

  NameDescription
Public methodBuildChannelFactory(Of TChannel)(BindingParameterCollection)Builds the channel factory stack on the client that creates a specified type of channel and that satisfies the features specified by a collection of binding parameters. (Inherited from Binding.)
Public methodBuildChannelFactory(Of TChannel)(Object())Builds the channel factory stack on the client that creates a specified type of channel and that satisfies the features specified by an object array. (Inherited from Binding.)
Public methodBuildChannelListener(Of TChannel)(BindingParameterCollection)Builds the channel listener on the service that accepts a specified type of channel and that satisfies the features specified by a collection of binding parameters. (Inherited from Binding.)
Public methodBuildChannelListener(Of TChannel)(Object())Builds the channel listener on the service that accepts a specified type of channel and that satisfies the features specified. (Inherited from Binding.)
Public methodBuildChannelListener(Of TChannel)(Uri, Object())Builds the channel listener on the service that accepts a specified type of channel and that satisfies the features specified. (Inherited from Binding.)
Public methodBuildChannelListener(Of TChannel)(Uri, BindingParameterCollection)Builds the channel listener on the service that accepts a specified type of channel and that satisfies the features specified. (Inherited from Binding.)
Public methodBuildChannelListener(Of TChannel)(Uri, String, Object())Builds the channel listener on the service that accepts a specified type of channel and that satisfies the features specified. (Inherited from Binding.)
Public methodBuildChannelListener(Of TChannel)(Uri, String, BindingParameterCollection)Builds the channel listener on the service that accepts a specified type of channel and that satisfies the features specified. (Inherited from Binding.)
Public methodBuildChannelListener(Of TChannel)(Uri, String, ListenUriMode, Object())Builds the channel listener on the service that accepts a specified type of channel and that satisfies the features specified. (Inherited from Binding.)
Public methodBuildChannelListener(Of TChannel)(Uri, String, ListenUriMode, BindingParameterCollection)Builds the channel listener on the service that accepts a specified type of channel and that satisfies the features specified. (Inherited from Binding.)
Public methodCanBuildChannelFactory(Of TChannel)(BindingParameterCollection)Returns a value that indicates whether the current binding can build a channel factory stack on the client that satisfies the collection of binding parameters specified. (Inherited from Binding.)
Public methodCanBuildChannelFactory(Of TChannel)(Object())Returns a value that indicates whether the current binding can build a channel factory stack on the client that satisfies the requirements specified by an object array. (Inherited from Binding.)
Public methodCanBuildChannelListener(Of TChannel)(BindingParameterCollection)Returns a value that indicates whether the current binding can build a channel listener stack on the service that satisfies the collection of binding parameters specified. (Inherited from Binding.)
Public methodCanBuildChannelListener(Of TChannel)(Object())Returns a value that indicates whether the current binding can build a channel listener stack on the service that satisfies the criteria specified in an array of objects. (Inherited from Binding.)
Public methodCreateBindingElementsReturns the binding elements in the basic profile stack. (Overrides Binding.CreateBindingElements.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
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 methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetProperty(Of T)Returns a typed object requested, if present, from the appropriate layer in the binding stack. (Inherited from Binding.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodShouldSerializeNameReturns whether the name of the binding should be serialized. (Inherited from Binding.)
Public methodShouldSerializeNamespaceReturns whether the namespace of the binding should be serialized. (Inherited from Binding.)
Public methodShouldSerializeSecurityGets a value that specifies whether security information should be serialized.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Explicit interface implemetationPrivate propertyIBindingRuntimePreferences.ReceiveSynchronouslyGets a value that indicates whether incoming requests can be handled more efficiently synchronously or asynchronously. (Inherited from MsmqBindingBase.)
Top

This binding can be used to enable WCF applications to send and receive messages to and from existing MSMQ applications that use COM, native C++ APIs or the types defined in the System.Messaging namespace.

The following configuration file snippet illustrates how to configure the MsmqIntegrationBinding binding on the client:

The following configuration file snippet illustrates how to configure the MsmqIntegrationBinding binding on the service:

<ServiceContract(Namespace:="http:'Microsoft.ServiceModel.Samples")> _
<ServiceKnownType(GetType(PurchaseOrder))> _
Public Interface IOrderProcessor
    <OperationContract(IsOneWay:=True, Action:="*")> _
    Sub SubmitPurchaseOrder(ByVal msg As MsmqMessage(Of PurchaseOrder))
End Interface

The following code illustrates how to use the MsmqIntegrationBinding binding on the service programmatically:

Public Class OrderProcessorService
    Implements IOrderProcessor

    <OperationBehavior(TransactionScopeRequired:=True, TransactionAutoComplete:=True)> _
    Public Sub SubmitPurchaseOrder(ByVal ordermsg As MsmqMessage(Of PurchaseOrder)) Implements IOrderProcessor.SubmitPurchaseOrder
        Dim po As PurchaseOrder = ordermsg.Body
        Dim statusIndexer As New Random()
        po.Status = statusIndexer.Next(3)
        Console.WriteLine("Processing {0} ", po)
    End Sub 
End Class

The following code illustrates how to use the MsmqIntegrationBinding binding on the client programmatically:

Dim binding As New MsmqIntegrationBinding()
Dim address As New EndpointAddress("msmq.formatname:DIRECT=OS:.\\private$\\Orders")
Dim channelFactory As New ChannelFactory(Of IOrderProcessor)(binding, address)
Dim channel As IOrderProcessor = channelFactory.CreateChannel()

Dim po As New PurchaseOrder()
po.customerId = "somecustomer.com"
po.poNumber = Guid.NewGuid().ToString()

Dim lineItem1 As New PurchaseOrderLineItem()
lineItem1.productId = "Blue Widget"
lineItem1.quantity = 54
lineItem1.unitCost = 29.99F

Dim lineItem2 = New PurchaseOrderLineItem()
lineItem2.productId = "Red Widget"
lineItem2.quantity = 890
lineItem2.unitCost = 45.89F

Dim lineItems(2) As PurchaseOrderLineItem
lineItems(0) = lineItem1
lineItems(1) = lineItem2

po.orderLineItems = lineItems

Dim ordermsg As MsmqMessage(Of PurchaseOrder) = New MsmqMessage(Of PurchaseOrder)(po)
Using scope As New TransactionScope(TransactionScopeOption.Required)
    channel.SubmitPurchaseOrder(ordermsg)
    scope.Complete()
End Using
Console.WriteLine("Order has been submitted:{0}", po)

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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.
Show:
© 2014 Microsoft