Table of Contents

Class TcpRelayTransportElement

Namespace
Microsoft.ServiceBus.Configuration
Assembly
Microsoft.ServiceBus.dll

Specifies a configuration element that causes a channel to transfer messages on the TCP transport when it is included in a custom binding. This class cannot be inherited.

public sealed class TcpRelayTransportElement : ConnectionOrientedTransportElement
Inheritance
TcpRelayTransportElement
Inherited Members

Constructors

TcpRelayTransportElement()

Initializes a new instance of the TcpRelayTransportElement class.

public TcpRelayTransportElement()

Properties

BindingElementType

Gets the type of this binding element.

public override Type BindingElementType { get; }

Property Value

Type

Returns a Type containing a binding element type.

ConnectionMode

Gets or sets the connection mode stored in the App.config file for this configuration.

public TcpRelayConnectionMode ConnectionMode { get; set; }

Property Value

TcpRelayConnectionMode

Returns a TcpRelayConnectionMode that contains the connection mode. The default setting is Relayed.

ConnectionPoolSettings

Gets or sets an XML value that describes the connection pool settings for the current instance.

public SocketConnectionPoolSettingsElement ConnectionPoolSettings { get; set; }

Property Value

SocketConnectionPoolSettingsElement

Returns a SocketConnectionPoolSettingsElement that contains the connection pool settings used by the binding element that the current instance is applied to.

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.

ListenBacklog

Gets or sets an XML value containing the maximum number of queued connection requests that can be pending.

public int ListenBacklog { get; set; }

Property Value

int

Returns the maximum number of queued connection requests that can be pending. The default is 10.

Properties

Gets the collection of properties.

protected override ConfigurationPropertyCollection Properties { get; }

Property Value

ConfigurationPropertyCollection

RelayClientAuthenticationType

Gets or sets an XML value that contains the relay client authentication type.

public RelayClientAuthenticationType RelayClientAuthenticationType { get; set; }

Property Value

RelayClientAuthenticationType

Returns a RelayClientAuthenticationType that contains the relay client authentication type. The default is RelayClientAuthenticationType.RelayAccessToken.

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 content of the specified configuration element to this configuration element.

public override void CopyFrom(ServiceModelExtensionElement from)

Parameters

from ServiceModelExtensionElement

The configuration elements to be copied.

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.