Class BasicHttpRelayBindingElement

Namespace

Microsoft.ServiceBus.Configuration

Assembly

Microsoft.ServiceBus.dll

Represents a configuration element that specifies a binding used to communicate with WS-I Basic Profile 1.1-conformant Web Services like ASMX-based services or to accept messages from ASMX-based clients through the Azure Service Bus.

public class BasicHttpRelayBindingElement : StandardBindingElement

Inheritance

object

BasicHttpRelayBindingElement

Constructors

BasicHttpRelayBindingElement()

Initializes a new instance of the BasicHttpRelayBindingElement class.

public BasicHttpRelayBindingElement()

BasicHttpRelayBindingElement(string)

Initializes a new instance of the BasicHttpRelayBindingElement class using the specified name.

public BasicHttpRelayBindingElement(string name)

Parameters

name string

The name of the binding element.

Properties

AllowCookies

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

public bool AllowCookies { get; set; }

Property Value

bool

true if the client accepts cookies and propagates them on future requests; otherwise, false. The default value is false.

BindingElementType

Gets the type of this binding element.

protected override Type BindingElementType { get; }

Property Value

Type

Returns a Type that contains the binding element type.

IsDynamic

Gets or sets whether the binding element is dynamic.

public bool IsDynamic { get; set; }

Property Value

bool

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

MaxBufferPoolSize

Gets or sets the maximum size for a buffer pool that stores messages processed by the binding.

public long MaxBufferPoolSize { get; set; }

Property Value

long

Returns an long that contains the buffer pool size. The default value is 512*1024 bytes. The minimum value is 0.

MaxBufferSize

Gets or sets the maximum size of a buffer that stores messages while they are processed for an endpoint configured with this binding.

public int MaxBufferSize { get; set; }

Property Value

int

Returns the maximum buffer size. The default value is 65,536 bytes. The minimum value is 1 byte.

MaxReceivedMessageSize

Gets or sets the maximum message size, in bytes, including headers, for a message that can be received on a channel configured with this binding.

public long MaxReceivedMessageSize { get; set; }

Property Value

long

The maximum received message size. The default value is 65,536 bytes. The minimum value is 1 byte.

MessageEncoding

Gets or sets the messaging encoding that indicates whether MTOM or text/XML is used to encode the SOAP message.

public WSMessageEncoding MessageEncoding { get; set; }

Property Value

WSMessageEncoding

Returns a System.ServiceModel.WSMessageEncoding that contains either Text/XML or MTOM. The default value is Text.

Properties

Gets a collection of objects that can be attributes or configuration element objects of this binding configuration element.

protected override ConfigurationPropertyCollection Properties { get; }

Property Value

ConfigurationPropertyCollection

Returns a System.Configuration.ConfigurationPropertyCollection that contains the properties of the current instance.

ProxyAddress

Gets or sets the URI that describes the address of the HTTP proxy.

public Uri ProxyAddress { get; set; }

Property Value

Uri

Returns a System.Uri that contains the URI. The default is null.

ReaderQuotas

Gets or sets an XML value that places constraints on the complexity of SOAP messages that can be processed by endpoints configured with this binding.

public XmlDictionaryReaderQuotasElement ReaderQuotas { get; }

Property Value

XmlDictionaryReaderQuotasElement

Returns a XmlDictionaryReaderQuotasElement that contains the reader quotas.

Security

Gets the type of security to be used for the binding.

public BasicHttpRelaySecurityElement Security { get; }

Property Value

BasicHttpRelaySecurityElement

Returns a BasicHttpRelaySecurityElement that specifies the type of security to be used with the binding. The default value is None.

TextEncoding

Gets or sets the character set encoding to be used for emitting messages on the binding.

[TypeConverter(typeof(EncodingConverter))]
public Encoding TextEncoding { get; set; }

Property Value

Encoding

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

TransferMode

Gets or sets whether messages are buffered or streamed on a request or response.

public TransferMode TransferMode { get; set; }

Property Value

TransferMode

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

UseDefaultWebProxy

Gets or sets a value that indicates whether the auto-configured HTTP proxy of the system should be used, if available.

public bool UseDefaultWebProxy { get; set; }

Property Value

bool

true to use the http proxy; otherwise, false. The default value is true.

Methods

InitializeFrom(Binding)

Initializes this binding configuration element with the content of the specified binding collection.

protected override void InitializeFrom(Binding binding)

Parameters

binding Binding

The Binding to initialize from.

OnApplyConfiguration(Binding)

Applies the settings of this configuration element to the specified binding.

protected override void OnApplyConfiguration(Binding binding)

Parameters

binding Binding

The Binding to apply this configuration to.