WebHttpRelayBinding WebHttpRelayBinding Class

Definition

A binding used to configure endpoints for Web services that are exposed through HTTP requests instead of SOAP messages.

public class WebHttpRelayBinding : Binding, IDefaultCommunicationTimeouts, IBindingRuntimePreferencesPublic Class WebHttpRelayBinding
    Inherits Binding
    Implements IDefaultCommunicationTimeouts, IBindingRuntimePreferences
Inheritance
WebHttpRelayBindingWebHttpRelayBinding

Inherited Members

System.ServiceModel.Channels.Binding

BuildChannelListener<TChannel>(Uri, String, System.ServiceModel.Description.ListenUriMode, Object[])BuildChannelListener(Of TChannel)(Uri, String, System.ServiceModel.Description.ListenUriMode, Object())
BuildChannelListener<TChannel>(Uri, String, System.ServiceModel.Description.ListenUriMode, BindingParameterCollection)BuildChannelListener(Of TChannel)(Uri, String, System.ServiceModel.Description.ListenUriMode, BindingParameterCollection)

System.Object

Constructors

WebHttpRelayBinding() WebHttpRelayBinding()

Initializes a new instance of the WebHttpRelayBinding class.

public WebHttpRelayBinding()Public Sub New

WebHttpRelayBinding(EndToEndWebHttpSecurityMode, RelayClientAuthenticationType) WebHttpRelayBinding(EndToEndWebHttpSecurityMode, RelayClientAuthenticationType)

Initializes a new instance of the WebHttpRelayBinding class using the specified type of security and relay client authentication.

public WebHttpRelayBinding(EndToEndWebHttpSecurityMode securityMode, RelayClientAuthenticationType relayClientAuthenticationType)Public Sub New(securityMode As EndToEndWebHttpSecurityMode, relayClientAuthenticationType As RelayClientAuthenticationType)
Parameters
securityMode
EndToEndWebHttpSecurityMode EndToEndWebHttpSecurityMode

The type of security used with the binding.

relayClientAuthenticationType
RelayClientAuthenticationType RelayClientAuthenticationType

The type of client authentication used on the relay.

WebHttpRelayBinding(String) WebHttpRelayBinding(String)

Initializes a new instance of the WebHttpRelayBinding class using the specified configuration name.

public WebHttpRelayBinding(string configurationName)Public Sub New(configurationName As String)
Parameters
configurationName
String String

The configuration to use.

Properties

AllowCookies AllowCookies

Gets or sets a value that specifies whether cookies are allowed in the messages sent via the WebHttpRelayBinding.

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

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

ContentTypeMapper ContentTypeMapper

Gets or sets the content type mapper.

public WebContentTypeMapper ContentTypeMapper { get; set; }Public Property ContentTypeMapper As WebContentTypeMapper
Value
WebContentTypeMapper WebContentTypeMapper

The content type mapper.

EnvelopeVersion EnvelopeVersion

Gets the SOAP envelope version.

public EnvelopeVersion EnvelopeVersion { get; }Public ReadOnly Property EnvelopeVersion As EnvelopeVersion
Value
EnvelopeVersion EnvelopeVersion

Returns a EnvelopeVersion. Since the WebHttpRelayBinding does not use SOAP, this always returns EnvelopeVersion.None.WebHttpRelayBinding is not likely the binding you should be using for SOAP messaging. However, Service Bus does support SOAP.

HostNameComparisonMode HostNameComparisonMode

Gets or sets the comparison mode used on the host name.

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

The comparison mode used on the host name.

IsDynamic IsDynamic

Gets or sets whether the relay binding is dynamic.

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

true if the relay binding is dynamic; otherwise, false.

MaxBufferPoolSize MaxBufferPoolSize

Gets or sets the maximum buffer pool size used by the transport.

public long MaxBufferPoolSize { get; set; }Public Property MaxBufferPoolSize As Long
Value
Int64 Int64

Returns the maximum buffer pool size. The default is 524288 bytes.

MaxBufferSize MaxBufferSize

Gets or sets the maximum buffer size supported by the transport.

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

Returns the max buffer size.

MaxReceivedMessageSize MaxReceivedMessageSize

Gets or sets the maximum allowable message size that can be received.

public long MaxReceivedMessageSize { get; set; }Public Property MaxReceivedMessageSize As Long
Value
Int64 Int64

Returns the maximum allowable message size. The default size is 65,536 bytes.

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
Value
Uri Uri

Returns a Uri that contains the address of the proxy to use for HTTP requests. The default value is null.

ReaderQuotas ReaderQuotas

Gets or sets xml reader quotas on the messages processed.

public XmlDictionaryReaderQuotas ReaderQuotas { get; set; }Public Property ReaderQuotas As XmlDictionaryReaderQuotas
Value
XmlDictionaryReaderQuotas XmlDictionaryReaderQuotas

Returns a XmlDictionaryReaderQuotas that contains the reader quotas.

Scheme Scheme

Gets the scheme for the endpoints used with the binding.

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

Returns the scheme.

Overrides

Security Security

Gets the security settings for the current instance.

public WebHttpRelaySecurity Security { get; }Public ReadOnly Property Security As WebHttpRelaySecurity
Value
WebHttpRelaySecurity WebHttpRelaySecurity

Returns a WebHttpRelaySecurity that contains the security settings.

TransferMode TransferMode

Gets or sets the transfer mode.

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

Returns a TransferMode that contains the transfer mode. The default is Buffered.

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
Value
Boolean Boolean

true if machine-wide proxy settings are used. Otherwise false. The default setting is true.

WriteEncoding WriteEncoding

Gets or sets the character encoding that is used to write the message text.

public Encoding WriteEncoding { get; set; }Public Property WriteEncoding As Encoding
Value
Encoding Encoding

Returns a Encoding that contains the encoding. The default value is utf8encoding.

Methods

CreateBindingElements() CreateBindingElements()

Creates a collection with the binding elements for the binding.

public override BindingElementCollection CreateBindingElements()Public Overrides Function CreateBindingElements As BindingElementCollection
Returns

Returns a BindingElementCollection that contains the ordered stack of binding elements used by the WebHttpRelayBinding.

Overrides

Explicit Interface Implementations

IBindingRuntimePreferences.ReceiveSynchronously System.ServiceModel.Channels.IBindingRuntimePreferences.ReceiveSynchronously

bool IBindingRuntimePreferences.ReceiveSynchronously { get; }ReadOnly WriteOnly Property System.ServiceModel.Channels.IBindingRuntimePreferences.ReceiveSynchronously As Boolean Implements IBindingRuntimePreferences.ReceiveSynchronously
Returns