This topic has not yet been rated - Rate this topic

HttpTransportBindingElement Class

Represents the binding element used to specify an HTTP transport for transmitting messages.

Namespace:  System.ServiceModel.Channels
Assembly:  System.ServiceModel (in System.ServiceModel.dll)
public class HttpTransportBindingElement : TransportBindingElement, 
	IWsdlExportExtension, IPolicyExportExtension

The HttpTransportBindingElement type exposes the following members.

  Name Description
Public method Supported by Portable Class Library HttpTransportBindingElement() Initializes a new instance of the HttpTransportBindingElement class.
Protected method Supported by Portable Class Library HttpTransportBindingElement(HttpTransportBindingElement) Initializes a new instance of the HttpTransportBindingElement class.
Top
  Name Description
Public property AllowCookies Gets or sets a value that indicates whether the client accepts cookies and propagates them on future requests.
Public property AuthenticationScheme Gets or sets the authentication scheme used to authenticate client requests being processed by an HTTP listener.
Public property BypassProxyOnLocal Gets or sets a value that indicates whether proxies are ignored for local addresses.
Public property DecompressionEnabled Gets or sets whether the process for returning compressed message data to its original size and format is enabled.
Public property ExtendedProtectionPolicy Gets or sets the value of the extended security policy used by the server to validate incoming client connections.
Public property HostNameComparisonMode Gets or sets a value that indicates whether the hostname is used to reach the service when matching on the URI.
Public property KeepAliveEnabled Gets or sets a value that indicates whether to make a persistent connection to a service endpoint.
Public property Supported by Portable Class Library ManualAddressing Gets or sets a value that indicates whether manual addressing of the message is required. (Inherited from TransportBindingElement.)
Public property MaxBufferPoolSize Gets or sets the maximum size of any buffer pools used by the transport. (Inherited from TransportBindingElement.)
Public property Supported by Portable Class Library MaxBufferSize Gets or sets the maximum size of the buffer to use. For buffered messages this value is the same as MaxReceivedMessageSize. For streamed messages, this value is the maximum size of the SOAP headers, which must be read in buffered mode.
Public property Supported by Portable Class Library MaxReceivedMessageSize Gets and sets the maximum allowable message size that can be received. (Inherited from TransportBindingElement.)
Public property ProxyAddress Gets or sets a URI that contains the address of the proxy to use for HTTP requests.
Public property ProxyAuthenticationScheme Gets or sets the authentication scheme used to authenticate client requests being processed by an HTTP proxy.
Public property Realm Gets or sets the authentication realm.
Public property Supported by Portable Class Library Scheme Gets the URI scheme for the transport. (Overrides TransportBindingElement.Scheme.)
Public property TransferMode Gets or sets the transfer mode.
Public property UnsafeConnectionNtlmAuthentication Gets or sets a value that indicates whether Unsafe Connection Sharing is enabled on the server. If enabled, NTLM authentication is performed once on each TCP connection.
Public property UseDefaultWebProxy Gets or sets a value that indicates whether the machine-wide proxy settings are used rather than the user specific settings.
Top
  Name Description
Public method Supported by Portable Class Library BuildChannelFactory<TChannel> Creates a channel factory that can be used to create a channel. (Overrides BindingElement.BuildChannelFactory<TChannel>(BindingContext).)
Public method BuildChannelListener<TChannel> Creates a channel listener of the specified type. (Overrides BindingElement.BuildChannelListener<TChannel>(BindingContext).)
Public method Supported by Portable Class Library CanBuildChannelFactory<TChannel> Determines whether a channel factory of the specified type can be built. (Overrides BindingElement.CanBuildChannelFactory<TChannel>(BindingContext).)
Public method CanBuildChannelListener<TChannel> Determines whether a channel listener of the specified type can be built. (Overrides BindingElement.CanBuildChannelListener<TChannel>(BindingContext).)
Public method Supported by Portable Class Library Clone Creates a copy of the current binding element. (Overrides BindingElement.Clone().)
Public method Supported by Portable Class Library Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Supported by Portable Class Library Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method Supported by Portable Class Library GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method Supported by Portable Class Library GetProperty<T> Gets a property from the specified BindingContext. (Overrides TransportBindingElement.GetProperty<T>(BindingContext).)
Public method Supported by Portable Class Library GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method Supported by Portable Class Library MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ShouldSerializeExtendedProtectionPolicy Returns an indication that it is not possible to Xaml serialize the extended protection policy.
Public method Supported by Portable Class Library ToString Returns a string that represents the current object. (Inherited from Object.)
Top
  Name Description
Explicit interface implemetation Private method IPolicyExportExtension.ExportPolicy Exports a custom policy assertion about bindings.
Explicit interface implemetation Private method IWsdlExportExtension.ExportContract Writes custom Web Services Description Language (WSDL) elements into the generated WSDL for a contract.
Explicit interface implemetation Private method IWsdlExportExtension.ExportEndpoint Writes custom Web Services Description Language (WSDL) elements into the generated WSDL for an endpoint.
Top

The HttpTransportBindingElement class is the starting point for creating a custom binding that implements the HTTP transport protocol. HTTP is the primary transport used for interoperability purposes. This transport is supported by to ensure interoperability with other non- Web services stacks.

The service model uses this class to create factory objects that implement the IChannelFactory and IChannelListener interfaces. These factory objects, in turn, create the channels and listeners that transmit SOAP messages using the HTTP protocol.

You configure the factories that this class creates by setting its properties, such as AuthenticationScheme, HostNameComparisonMode, and MaxBufferSize.

You can also set properties on the base class, TransportBindingElement, such as ManualAddressing, MaxReceivedMessageSize, and MaxBufferPoolSize. For a complete list of properties, see TransportBindingElement.

The following code shows how to imperatively use the 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();
}


HttpTransportBindingElement can also be used in a configuration file as shown in the following configuration.

<bindings>
  <customBinding>
    <binding name="Binding1">
      <reliableSession acknowledgementInterval="00:00:00.2000000" enableFlowControl="true"
                        maxTransferWindowSize="32" inactivityTimeout="00:10:00" maxPendingChannels="128"
                        maxRetryCount="8" ordered="true" />
      <security mode="None"/>
      <httpTransport authenticationScheme="Anonymous" bypassProxyOnLocal="false"
                    hostNameComparisonMode="StrongWildcard" 
                    proxyAuthenticationScheme="Anonymous" realm="" 
                    useDefaultWebProxy="true" />
    </binding>
  </customBinding>
</bindings>

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ