Binding Class

Definition

Namespace:

System.ServiceModel.Channels

Assembly:

System.ServiceModel.Primitives.dll

Package:

System.ServiceModel.Primitives v8.1.0

Source:

Binding.cs

Contains the binding elements that specify the protocols, transports, and message encoders used for communication between clients and services.

public ref class Binding abstract : System::ServiceModel::IDefaultCommunicationTimeouts

public abstract class Binding : System.ServiceModel.IDefaultCommunicationTimeouts

type Binding = class
    interface IDefaultCommunicationTimeouts

Public MustInherit Class Binding
Implements IDefaultCommunicationTimeouts

Inheritance

Object

Binding

Derived

System.ServiceModel.Channels.CustomBinding

System.ServiceModel.HttpBindingBase

System.ServiceModel.MsmqBindingBase

System.ServiceModel.NetNamedPipeBinding

System.ServiceModel.NetPeerTcpBinding

System.ServiceModel.NetTcpBinding

System.ServiceModel.UdpBinding

System.ServiceModel.UnixDomainSocketBinding

System.ServiceModel.WebHttpBinding

System.ServiceModel.WSDualHttpBinding

System.ServiceModel.WSHttpBindingBase

Implements

IDefaultCommunicationTimeouts

Examples

BasicHttpBinding binding = new BasicHttpBinding();

binding.Name = "binding1";

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

// Create a ServiceHost for the CalculatorService type and provide the base address.
using (ServiceHost serviceHost = new ServiceHost(typeof(CalculatorService), baseAddress))
{
    serviceHost.AddServiceEndpoint(typeof(ICalculator), binding, address);

    // 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();
}

Remarks

Represents a collection of binding elements, each of which describes an aspect of how an endpoint communicates with other endpoints and that are built, consistently, into a channel factory on the client and into a channel listener on the service. A binding contains a collection of binding elements that correspond to protocol channels, transport channels, and message encoders. There can be any number of binding elements for protocol channels but one and only one binding element for each the transport and message encoder. There are commonly six layers of binding elements in a binding. Only the transport and encoding binding elements at the bottom of the stack are required. Because an encoding is required for each binding, if an encoding is not specified, Windows Communication Foundation (WCF) adds a default encoding for you. The default is Text/XML for the HTTP and HTTPS transports, and Binary for other transports.

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, MSMQ, Custom	Yes

Each binding element provides the specification for building a channel factory on the client and a channel listener on the service. When the channel factory stack is constructed, for example, there is one channel factory in the stack for each binding element in the binding. The same sort of mapping applies to the channel listeners in the stack on the service. Consistency on the client and service is critical for establishing the channel-based connection between these endpoints. Each factory and listener, in turn, processes the sending and accepting of the corresponding channels in the channel stack that connects them, and these channels can then send and receive the messages used to communicate.

Each instance of a Binding has a Name and Namespace that together uniquely identify it in the metadata of the service. If no name or namespace is specified, WCF adds a default values for you. The default name is null and the default namespace is http://tempuri.org/. This user name for the binding is distinct from the specification of the protocol name, which is specified by the Scheme property. If you want to add more HTTP bindings, for example, you can name them whatever you want and set all of their schemes to "http". There is no inherent application or machine dispatch based on the Scheme. So you avoid the common problem of being unable to register additional handlers for well-known protocols. You can also easily work with multiple versions of a binding side-by-side by giving each version a different name.

The Binding class implements the IDefaultCommunicationTimeouts interface to mitigate Denial of Service (DOS) attacks that rely on tying up resources for extended intervals of time. The implementation specifies the communication timeouts values for opening and closing connections and for the reading and writing operations associated with receiving and sending messages. The properties used to get and set these timeouts and their default values operations are summarized in the following table.

Timeout Property	Default Value
OpenTimeout	1 minute
CloseTimeout	1 minute
SendTimeout	1 minute
ReceiveTimeout	10 minutes

When you create a binding by inheriting from Binding, you must override CreateBindingElements.

In addition, you can define your own binding elements and insert them between any of the defined layers in the preceding table. For more information, see the CustomBinding class.

Constructors

Binding()	Initializes a new instance of the Binding class with a default name and namespace.
Binding(String, String)	Initializes a new instance of the Binding class from a specified binding of the service.

Properties

CloseTimeout	Gets or sets the interval of time provided for a connection to close before the transport raises an exception.
MessageVersion	Gets the message version used by clients and services configured with the binding.
Name	Gets or sets the name of the binding.
Namespace	Gets or sets the XML namespace of the binding.
OpenTimeout	Gets or sets the interval of time provided for a connection to open before the transport raises an exception.
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.
Scheme	When implemented in a derived class, sets the URI scheme that specifies the transport used by the channel and listener factories that are built by the bindings.
SendTimeout	Gets or sets the interval of time provided for a write operation to complete before the transport raises an exception.

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.
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.
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.
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.
CreateBindingElements()	When overridden in a derived class, creates a collection that contains the binding elements that are part of the current 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.
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)