CustomBinding Class

Reference

Definition

Namespace:: System.ServiceModel.Channels

Assembly:: System.ServiceModel.Primitives.dll

Assembly:: System.ServiceModel.dll

Package:: System.ServiceModel.Primitives v8.1.0

Source:: CustomBinding.cs

Source:: CustomBinding.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Defines a binding from a list of binding elements.

public ref class CustomBinding : System::ServiceModel::Channels::Binding

public class CustomBinding : System.ServiceModel.Channels.Binding

[System.Windows.Markup.ContentProperty("Elements")]
public class CustomBinding : System.ServiceModel.Channels.Binding

type CustomBinding = class
    inherit Binding

[<System.Windows.Markup.ContentProperty("Elements")>]
type CustomBinding = class
    inherit Binding

Public Class CustomBinding
Inherits Binding

Inheritance: Object

Binding
CustomBinding

Attributes: ContentPropertyAttribute

Examples

The following example shows how to create a CustomBinding object using a ReliableSessionBindingElement and an HttpTransportBindingElement

Uri baseAddress = new Uri("http://localhost:8000/servicemodelsamples/service");

// Create a ServiceHost for the CalculatorService type and provide the base address.
using (ServiceHost serviceHost = new ServiceHost(typeof(CalculatorService), baseAddress))
{
    // Create a custom binding that contains two binding elements.
    ReliableSessionBindingElement reliableSession = new ReliableSessionBindingElement();
    reliableSession.Ordered = true;

    HttpTransportBindingElement httpTransport = new HttpTransportBindingElement();
    httpTransport.AuthenticationScheme = System.Net.AuthenticationSchemes.Anonymous;
    httpTransport.HostNameComparisonMode = HostNameComparisonMode.StrongWildcard;

    CustomBinding binding = new CustomBinding(reliableSession, httpTransport);

    // Add an endpoint using that binding.
    serviceHost.AddServiceEndpoint(typeof(ICalculator), binding, "");

    // Add a MEX endpoint.
    ServiceMetadataBehavior smb = new ServiceMetadataBehavior();
    smb.HttpGetEnabled = true;
    smb.HttpGetUrl = new Uri("http://localhost:8001/servicemodelsamples");
    serviceHost.Description.Behaviors.Add(smb);

    // Open the ServiceHostBase to create listeners and start listening for messages.
    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 ServiceHostBase to shutdown the service.
    serviceHost.Close();
}

Dim baseAddress As New Uri("http://localhost:8000/servicemodelsamples/service")

' Create a ServiceHost for the CalculatorService type and provide the base address.
Using serviceHost As New ServiceHost(GetType(CalculatorService), baseAddress)
    ' Create a custom binding that contains two binding elements.
    Dim reliableSession As New ReliableSessionBindingElement()
    reliableSession.Ordered = True

    Dim httpTransport As New HttpTransportBindingElement()
    httpTransport.AuthenticationScheme = System.Net.AuthenticationSchemes.Anonymous
    httpTransport.HostNameComparisonMode = HostNameComparisonMode.StrongWildcard

    Dim binding As New CustomBinding(reliableSession, httpTransport)

    ' Add an endpoint using that binding.
    serviceHost.AddServiceEndpoint(GetType(ICalculator), binding, "")

    ' Add a MEX endpoint.
    Dim smb As New ServiceMetadataBehavior()
    smb.HttpGetEnabled = True
    smb.HttpGetUrl = New Uri("http://localhost:8001/servicemodelsamples")
    serviceHost.Description.Behaviors.Add(smb)

    ' Open the ServiceHostBase to create listeners and start listening for messages.
    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 ServiceHostBase to shutdown the service.
    serviceHost.Close()
End Using

Remarks

Use a custom binding when one of the system-provided bindings does not meet the requirements of your service. A custom binding could be used, for example, to enable the use of a new transport or a new encoder at a service endpoint.

A custom binding is constructed using one of the CustomBinding from a collection of binding elements that are "stacked" in a specific order:

At the top is an optional TransactionFlowBindingElement that allows flowing transactions.
Next is an optional ReliableSessionBindingElement that provides a session and ordering mechanism as defined in the WS-ReliableMessaging specification. This notion of a session can cross SOAP and transport intermediaries.
Next is an optional security binding element that provides security features like authorization, authentication, protection, and confidentiality. The following security binding elements are provided by Windows Communication Foundation (WCF):
Next are the optional message-patterns specified by binding elements:
CompositeDuplexBindingElement
Next are the optional transport upgrades/helpers binding elements:
Next is a required message encoding binding element. You can use your own transport or use one of the following message encoding bindings:
At the bottom is a required transport element. You can use your own transport or use one of transport binding elements provided by Windows Communication Foundation (WCF):

The following table summarizes the options for each layer.

Layer	Options	Required
Transaction Flow	TransactionFlowBindingElement	No
Reliability	ReliableSessionBindingElement	No
Security	Symmetric, Asymmetric, Transport-Level	No
Shape Change	CompositeDuplexBindingElement	No
Transport Upgrades	SSL stream, Windows stream, Peer Resolver	No
Encoding	Text, Binary, MTOM, Custom	Yes
Transport	TCP, Named Pipes, HTTP, HTTPS, flavors of MSMQ, Custom	Yes

In addition, you can define your own binding elements and insert them between any of the preceding defined layers.

For a discussion on how to use a custom binding to modify a system-provided binding, see How to: Customize a System-Provided Binding.

Note

When calling a WCF service built with .NET Framework 4.0 or later from a WCF client application built with .NET Framework 3.5 or earlier, the configuration file generated by svcutil.exe or adding a service reference from Visual Studio will contain the validity attribute in the binding configuration. This attribute is not recognized by the .NET Framework 3.5 runtime and the application will thrown an ConfigurationErrorsException with the message "Unrecognized attribute validity". To workaround this problem, remove the validity attribute from the binding configuration.

Constructors

CustomBinding()	Initializes a new instance of the CustomBinding class.
CustomBinding(Binding)	Initializes a new instance of the CustomBinding class from the values of a specified binding.
CustomBinding(BindingElement[])	Initializes a new instance of the CustomBinding class from an array of binding elements.
CustomBinding(IEnumerable<BindingElement>)	Initializes a new instance of the CustomBinding class with the binding elements from a complete channel stack.
CustomBinding(String, String, BindingElement[])	Initializes a new instance of the CustomBinding class from an array of binding elements with a specified name and namespace.
CustomBinding(String)	Initializes a new instance of the CustomBinding class.

Properties

CloseTimeout	Gets or sets the interval of time provided for a connection to close before the transport raises an exception. (Inherited from Binding)
Elements	Gets the binding elements from the custom binding.
MessageVersion	Gets the message version used by clients and services configured with the binding. (Inherited from Binding)
Name	Gets or sets the name of the binding. (Inherited from Binding)
Namespace	Gets or sets the XML namespace of the binding. (Inherited from Binding)
OpenTimeout	Gets or sets the interval of time provided for a connection to open before the transport raises an exception. (Inherited from Binding)
ReceiveTimeout	Gets 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)
Scheme	Gets the URI scheme for transport used by the custom binding.
SendTimeout	Gets or sets the interval of time provided for a write operation to complete before the transport raises an exception. (Inherited from Binding)

Methods

BuildChannelFactory<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)
BuildChannelFactory<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)
BuildChannelListener<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)
BuildChannelListener<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)
BuildChannelListener<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)
BuildChannelListener<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)
BuildChannelListener<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)
BuildChannelListener<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)
BuildChannelListener<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)
BuildChannelListener<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)
CanBuildChannelFactory<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)
CanBuildChannelFactory<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)
CanBuildChannelListener<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)
CanBuildChannelListener<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)
CreateBindingElements()	Returns a generic collection of the binding elements from the custom binding.
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>(BindingParameterCollection)	Returns a typed object requested, if present, from the appropriate layer in the binding stack. (Inherited from Binding)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ShouldSerializeName()	Returns whether the name of the binding should be serialized. (Inherited from Binding)
ShouldSerializeNamespace()	Returns whether the namespace of the binding should be serialized. (Inherited from Binding)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Applies to

Κοινή χρήση μέσω