Windows apps
Collapse the table of content
Expand the table of content

HttpTransportBindingElement Class

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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

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

System.Object
  System.ServiceModel.Channels.BindingElement
    System.ServiceModel.Channels.TransportBindingElement
      System.ServiceModel.Channels.HttpTransportBindingElement
        System.ServiceModel.Channels.HttpsTransportBindingElement

public class HttpTransportBindingElement : TransportBindingElement, 
	IWsdlExportExtension, IPolicyExportExtension

NameDescription
System_CAPS_pubmethodHttpTransportBindingElement()

Initializes a new instance of the HttpTransportBindingElement class.

System_CAPS_protmethodHttpTransportBindingElement(HttpTransportBindingElement)

Initializes a new instance of the HttpTransportBindingElement class using another binding element.

NameDescription
System_CAPS_pubpropertyAllowCookies

Gets or sets a value that indicates whether the client accepts cookies and propagates them on future requests.

System_CAPS_pubpropertyAuthenticationScheme

Gets or sets the authentication scheme used to authenticate client requests being processed by an HTTP listener.

System_CAPS_pubpropertyBypassProxyOnLocal

Gets or sets a value that indicates whether proxies are ignored for local addresses.

System_CAPS_pubpropertyDecompressionEnabled

Gets or sets whether the process for returning compressed message data to its original size and format is enabled.

System_CAPS_pubpropertyExtendedProtectionPolicy

Gets or sets the value of the extended security policy used by the server to validate incoming client connections.

System_CAPS_pubpropertyHostNameComparisonMode

Gets or sets a value that indicates whether the hostname is used to reach the service when matching on the URI.

System_CAPS_pubpropertyKeepAliveEnabled

Gets or sets a value that indicates whether to make a persistent connection to a service endpoint.

System_CAPS_pubpropertyManualAddressing

Gets or sets a value that indicates whether manual addressing of the message is required.(Inherited from TransportBindingElement.)

System_CAPS_pubpropertyMaxBufferPoolSize

Gets or sets the maximum size, in bytes, of any buffer pools used by the transport. (Inherited from TransportBindingElement.)

System_CAPS_pubpropertyMaxBufferSize

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.

System_CAPS_pubpropertyMaxPendingAccepts

Gets or sets the maximum number of connections the service can accept simultaneously.

System_CAPS_pubpropertyMaxReceivedMessageSize

Gets and sets the maximum allowable message size, in bytes, that can be received.(Inherited from TransportBindingElement.)

System_CAPS_pubpropertyMessageHandlerFactory

Gets or sets the Http transport message handler factory.

System_CAPS_pubpropertyProxyAddress

Gets or sets a URI that contains the address of the proxy to use for HTTP requests.

System_CAPS_pubpropertyProxyAuthenticationScheme

Gets or sets the authentication scheme used to authenticate client requests being processed by an HTTP proxy.

System_CAPS_pubpropertyRealm

Gets or sets the authentication realm.

System_CAPS_pubpropertyRequestInitializationTimeout

Gets or sets the requested initialization time out.

System_CAPS_pubpropertyScheme

Gets the URI scheme for the transport.(Overrides TransportBindingElement.Scheme.)

System_CAPS_pubpropertyTransferMode

Gets or sets the transfer mode.

System_CAPS_pubpropertyUnsafeConnectionNtlmAuthentication

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.

System_CAPS_pubpropertyUseDefaultWebProxy

Gets or sets a value that indicates whether the machine-wide proxy settings are used rather than the user specific settings.

System_CAPS_pubpropertyWebSocketSettings

Gets or sets the web socket configuration of the binding element.

NameDescription
System_CAPS_pubmethodBuildChannelFactory<TChannel>(BindingContext)

Creates a channel factory that can be used to create a channel.(Overrides BindingElement.BuildChannelFactory<TChannel>(BindingContext).)

System_CAPS_pubmethodBuildChannelListener<TChannel>(BindingContext)

Creates a channel listener of the specified type.(Overrides BindingElement.BuildChannelListener<TChannel>(BindingContext).)

System_CAPS_pubmethodCanBuildChannelFactory<TChannel>(BindingContext)

Determines whether a channel factory of the specified type can be built.(Overrides BindingElement.CanBuildChannelFactory<TChannel>(BindingContext).)

System_CAPS_pubmethodCanBuildChannelListener<TChannel>(BindingContext)

Determines whether a channel listener of the specified type can be built.(Overrides BindingElement.CanBuildChannelListener<TChannel>(BindingContext).)

System_CAPS_pubmethodClone()

Creates a new instance that is a copy of the current binding element.(Overrides BindingElement.Clone().)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetProperty<T>(BindingContext)

Gets a property from the specified BindingContext.(Overrides TransportBindingElement.GetProperty<T>(BindingContext).)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodShouldSerializeExtendedProtectionPolicy()

Returns a valueindicating that it is not possible to XAML serialize the extended protection policy.

System_CAPS_pubmethodShouldSerializeMessageHandlerFactory()

Determines whether the message handler factory should be serialized.

System_CAPS_pubmethodShouldSerializeWebSocketSettings()

Determines whether the web socket settings should be serialized.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_protmethodUpdateAuthenticationSchemes(BindingContext)

Updates the transport authentication schemes that contains the binding context.

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIPolicyExportExtension.ExportPolicy(MetadataExporter, PolicyConversionContext)

Exports a custom policy assertion about bindings.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIWsdlExportExtension.ExportContract(WsdlExporter, WsdlContractConversionContext)

Writes custom Web Services Description Language (WSDL) elements into the generated WSDL for a contract.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIWsdlExportExtension.ExportEndpoint(WsdlExporter, WsdlEndpointConversionContext)

Writes custom Web Services Description Language (WSDL) elements into the generated WSDL for an endpoint.

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 Windows Communication Foundation (WCF) to ensure interoperability with other non-WCF Web services stacks.

The WCF 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>

Universal Windows Platform
Available since 8
.NET Framework
Available since 3.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2017 Microsoft