HttpRelayTransportBindingElement HttpRelayTransportBindingElement Class

Represents the binding element used to specify an HTTP transport for transmitting messages on the Azure Service Bus.

Syntax

Declaration

public class HttpRelayTransportBindingElement : TransportBindingElement, IPolicyExportExtension, IWsdlExportExtension, ITransportTokenAssertionProviderPublic Class HttpRelayTransportBindingElement
    Inherits TransportBindingElement
    Implements IPolicyExportExtension, IWsdlExportExtension, ITransportTokenAssertionProvider

Inheritance Hierarchy

Constructors summary

Initializes a new instance of the HttpRelayTransportBindingElement class.

Initializes a new instance of the HttpRelayTransportBindingElement class, using the specified element to be cloned.

Initializes a new instance of the HttpRelayTransportBindingElement class using the specified client authentication type.

Properties summary

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

Gets or sets the comparison mode use in the host name.

Gets or sets whether the binding element is dynamic.

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

Gets or sets the maximum size of the buffer to use.

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

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

Gets or sets the relay client authentication type.

Gets the URI scheme for the transport.

Gets or sets the transfer mode.

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

Methods summary

Creates a channel factory that can be used to create a channel.

Creates a channel listener for channels of the specified generic type.

Determines whether a channel factory of the specified type can be built.

Returns a value that indicates whether the binding element can build a listener for a specific type of channel.

Returns a copy of the binding element object.

Creates a HttpTransportBindingElement for the inner channel.

Gets the specified property from the specified binding context.

Gets the XML element that represents the transport token used in the security binding.

Initializes the specified binding element with the settings from the current instance of theHttpRelayTransportBindingElement binding element.

Explicit Interface Implementations summary

Constructors

  • HttpRelayTransportBindingElement()
    HttpRelayTransportBindingElement()

    Initializes a new instance of the HttpRelayTransportBindingElement class.

    public HttpRelayTransportBindingElement()Public Sub New
  • HttpRelayTransportBindingElement(HttpRelayTransportBindingElement)
    HttpRelayTransportBindingElement(HttpRelayTransportBindingElement)

    Initializes a new instance of the HttpRelayTransportBindingElement class, using the specified element to be cloned.

    protected HttpRelayTransportBindingElement(HttpRelayTransportBindingElement elementToBeCloned)Protected Sub New(elementToBeCloned As HttpRelayTransportBindingElement)

    Parameters

  • HttpRelayTransportBindingElement(RelayClientAuthenticationType)
    HttpRelayTransportBindingElement(RelayClientAuthenticationType)

    Initializes a new instance of the HttpRelayTransportBindingElement class using the specified client authentication type.

    public HttpRelayTransportBindingElement(RelayClientAuthenticationType relayClientAuthenticationType)Public Sub New(relayClientAuthenticationType As RelayClientAuthenticationType)

    Parameters

Properties

  • AllowCookies
    AllowCookies

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

    public bool AllowCookies { get; set; }Public Property AllowCookies As Boolean

    Property Value

    • true if cookies are allowed; otherwise, false. The default is false.

  • HostNameComparisonMode
    HostNameComparisonMode

    Gets or sets the comparison mode use in the host name.

    public HostNameComparisonMode HostNameComparisonMode { get; set; }Public Property HostNameComparisonMode As HostNameComparisonMode

    Property Value

  • IsDynamic
    IsDynamic

    Gets or sets whether the binding element is dynamic.

    public bool IsDynamic { get; set; }Public Property IsDynamic As Boolean

    Property Value

    • true if the binding element is dynamic; otherwise, false.

  • KeepAliveEnabled
    KeepAliveEnabled

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

    public bool KeepAliveEnabled { get; set; }Public Property KeepAliveEnabled As Boolean

    Property Value

    • true if the request to the service endpoint should contain a Connection HTTP header with the value Keep-alive; otherwise, false. The default is true.

  • MaxBufferSize
    MaxBufferSize

    Gets or sets the maximum size of the buffer to use.

    public int MaxBufferSize { get; set; }Public Property MaxBufferSize As Integer

    Property Value

    • Returns the maximum size, in bytes, of the buffer.

  • ProxyAddress
    ProxyAddress

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

    public Uri ProxyAddress { get; set; }Public Property ProxyAddress As Uri

    Property Value

    • Returns a Uri that contains the address for the proxy. The default value is null.

  • ProxyAuthenticationScheme
    ProxyAuthenticationScheme

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

    public AuthenticationSchemes ProxyAuthenticationScheme { get; set; }Public Property ProxyAuthenticationScheme As AuthenticationSchemes

    Property Value

  • RelayClientAuthenticationType
    RelayClientAuthenticationType

    Gets or sets the relay client authentication type.

    public RelayClientAuthenticationType RelayClientAuthenticationType { get; set; }Public Property RelayClientAuthenticationType As RelayClientAuthenticationType

    Property Value

  • Scheme
    Scheme

    Gets the URI scheme for the transport.

    public override string Scheme { get; }Public Overrides ReadOnly Property Scheme As String

    Property Value

  • TransferMode
    TransferMode

    Gets or sets the transfer mode.

    public TransferMode TransferMode { get; set; }Public Property TransferMode As TransferMode

    Property Value

  • UseDefaultWebProxy
    UseDefaultWebProxy

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

    public bool UseDefaultWebProxy { get; set; }Public Property UseDefaultWebProxy As Boolean

    Property Value

    • true if the machine-wide proxy settings are used; otherwise, false. The default is true.

Methods

  • BuildChannelFactory<TChannel>(BindingContext)
    BuildChannelFactory(Of TChannel)(BindingContext)

    Creates a channel factory that can be used to create a channel.

    public override IChannelFactory<TChannel> BuildChannelFactory<TChannel>(BindingContext context)Public Overrides Function BuildChannelFactory(Of TChannel)(context As BindingContext) As IChannelFactory(Of TChannel)

    Parameters

    Returns

  • BuildChannelListener<TChannel>(BindingContext)
    BuildChannelListener(Of TChannel)(BindingContext)

    Creates a channel listener for channels of the specified generic type.

    public override IChannelListener<TChannel> BuildChannelListener<TChannel>(BindingContext context)where TChannel : class, IChannelPublic Overrides Function BuildChannelListener(Of TChannel As {Class, IChannel})(context As BindingContext) As IChannelListener(Of TChannel)

    Parameters

    Returns

  • CanBuildChannelFactory<TChannel>(BindingContext)
    CanBuildChannelFactory(Of TChannel)(BindingContext)

    Determines whether a channel factory of the specified type can be built.

    public override bool CanBuildChannelFactory<TChannel>(BindingContext context)Public Overrides Function CanBuildChannelFactory(Of TChannel)(context As BindingContext) As Boolean

    Parameters

    Returns

    • true if a channel factory can be built; otherwise, false.

  • CanBuildChannelListener<TChannel>(BindingContext)
    CanBuildChannelListener(Of TChannel)(BindingContext)

    Returns a value that indicates whether the binding element can build a listener for a specific type of channel.

    public override bool CanBuildChannelListener<TChannel>(BindingContext context)where TChannel : class, IChannelPublic Overrides Function CanBuildChannelListener(Of TChannel As {Class, IChannel})(context As BindingContext) As Boolean

    Parameters

    Returns

    • true if the IChannelListener<TChannel> of type IChannel can be built by the binding element; otherwise, false.

    Exceptions

  • Clone()
    Clone()

    Returns a copy of the binding element object.

    public override BindingElement Clone()Public Overrides Function Clone As BindingElement

    Returns

  • CreateInnerChannelBindingElement()
    CreateInnerChannelBindingElement()

    Creates a HttpTransportBindingElement for the inner channel.

    protected virtual HttpTransportBindingElement CreateInnerChannelBindingElement()Protected Overridable Function CreateInnerChannelBindingElement As HttpTransportBindingElement

    Returns

  • GetProperty<T>(BindingContext)
    GetProperty(Of T)(BindingContext)

    Gets the specified property from the specified binding context.

    public override T GetProperty<T>(BindingContext context)where T : classPublic Overrides Function GetProperty(Of T As Class)(context As BindingContext) As T

    Parameters

    Returns

    • T
      T

      The property from the specified binding context.

  • GetTransportTokenAssertion()
    GetTransportTokenAssertion()

    Gets the XML element that represents the transport token used in the security binding.

    public XmlElement GetTransportTokenAssertion()Public Function GetTransportTokenAssertion As XmlElement

    Returns

  • InitializeInnerChannelBindingElement(HttpTransportBindingElement)
    InitializeInnerChannelBindingElement(HttpTransportBindingElement)

    Initializes the specified binding element with the settings from the current instance of theHttpRelayTransportBindingElement binding element.

    protected virtual void InitializeInnerChannelBindingElement(HttpTransportBindingElement httpTransportElement)Protected Overridable Sub InitializeInnerChannelBindingElement(httpTransportElement As HttpTransportBindingElement)

    Parameters

Explicit Interface Implementations

  • IPolicyExportExtension.ExportPolicy(MetadataExporter, PolicyConversionContext)
    System.ServiceModel.Description.IPolicyExportExtension.ExportPolicy(MetadataExporter, PolicyConversionContext)
    void IPolicyExportExtension.ExportPolicy(MetadataExporter exporter, PolicyConversionContext context)Sub System.ServiceModel.Description.IPolicyExportExtension.ExportPolicy(exporter As MetadataExporter, context As PolicyConversionContext) Implements IPolicyExportExtension.ExportPolicy

    Parameters

  • IWsdlExportExtension.ExportContract(WsdlExporter, WsdlContractConversionContext)
    System.ServiceModel.Description.IWsdlExportExtension.ExportContract(WsdlExporter, WsdlContractConversionContext)
    void IWsdlExportExtension.ExportContract(WsdlExporter exporter, WsdlContractConversionContext context)Sub System.ServiceModel.Description.IWsdlExportExtension.ExportContract(exporter As WsdlExporter, context As WsdlContractConversionContext) Implements IWsdlExportExtension.ExportContract

    Parameters

  • IWsdlExportExtension.ExportEndpoint(WsdlExporter, WsdlEndpointConversionContext)
    System.ServiceModel.Description.IWsdlExportExtension.ExportEndpoint(WsdlExporter, WsdlEndpointConversionContext)
    void IWsdlExportExtension.ExportEndpoint(WsdlExporter exporter, WsdlEndpointConversionContext context)Sub System.ServiceModel.Description.IWsdlExportExtension.ExportEndpoint(exporter As WsdlExporter, context As WsdlEndpointConversionContext) Implements IWsdlExportExtension.ExportEndpoint

    Parameters

Details

Assembly

Microsoft.ServiceBus.dll