Class HttpRelayTransportElement

Namespace

Microsoft.ServiceBus.Configuration

Assembly

Microsoft.ServiceBus.dll

Represents a configuration element that specifies an HTTP transport for transmitting SOAP messages.

public class HttpRelayTransportElement : TransportElement

Inheritance

object

HttpRelayTransportElement

Derived

HttpsRelayTransportElement

Constructors

HttpRelayTransportElement()

Initializes a new instance of the HttpRelayTransportElement class.

public HttpRelayTransportElement()

Properties

AllowCookies

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

public bool AllowCookies { get; set; }

Property Value

bool

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

BindingElementType

Gets the type of binding. (Overrides BindingElementExtensionElement.BindingElementType.)

public override Type BindingElementType { get; }

Property Value

Type

Returns a Type that contains the binding type.

IsDynamic

Gets or sets whether the relay binding is dynamic.

public bool IsDynamic { get; set; }

Property Value

bool

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

KeepAliveEnabled

Gets or sets a Boolean value from the configuration file that indicates whether to make a persistent connection to the internet resource.

public bool KeepAliveEnabled { get; set; }

Property Value

bool

true if a persistent connection to the internet resource is maintained; otherwise, false.

MaxBufferSize

Gets or sets the maximum size of the buffer pool from the configuration file.

public int MaxBufferSize { get; set; }

Property Value

int

Returns the maximum buffer size. The default value is 65,536.

Properties

Gets a System.Configuration.ConfigurationPropertyCollection instance that contains a collection of ConfigurationProperty objects that can be attributes or ConfigurationElement objects of this configuration element. (Overrides TransportElement.Properties.)

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 a URI in the configuration file that contains the address of the proxy to use for HTTP requests.

public Uri ProxyAddress { get; set; }

Property Value

Uri

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

ProxyAuthenticationScheme

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

public AuthenticationSchemes ProxyAuthenticationScheme { get; set; }

Property Value

AuthenticationSchemes

The authentication scheme used to authenticate client requests that are processed by the HTTP proxy.

RelayClientAuthenticationType

Gets or sets the relay client authentication type stored in the configuration file.

public RelayClientAuthenticationType RelayClientAuthenticationType { get; set; }

Property Value

RelayClientAuthenticationType

Returns a RelayClientAuthenticationType.

TransferMode

Gets or sets a value from the configuration file that specifies 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 specifies whether messages are buffered or streamed on a request or response. By default, the HTTP, TCP/IP, and named pipe transports use buffered message transfers.

UseDefaultWebProxy

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

public bool UseDefaultWebProxy { get; set; }

Property Value

bool

true if the System.Net default proxy settings are used; otherwise, false. The default is true.

Methods

ApplyConfiguration(BindingElement)

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

public override void ApplyConfiguration(BindingElement bindingElement)

Parameters

bindingElement BindingElement

The binding element to update the settings of.

CopyFrom(ServiceModelExtensionElement)

Copies the properties of the specified extension element to this configuration element.

public override void CopyFrom(ServiceModelExtensionElement from)

Parameters

from ServiceModelExtensionElement

The extension element whose properties to copy.

CreateDefaultBindingElement()

Creates a binding element from the settings in this configuration element.

protected override TransportBindingElement CreateDefaultBindingElement()

Returns

TransportBindingElement

Returns a System.ServiceModel.Channels.TransportBindingElement that contains the default binding element.

InitializeFrom(BindingElement)

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

protected override void InitializeFrom(BindingElement bindingElement)

Parameters

bindingElement BindingElement

The binding element to initialize from.