Table of Contents

Class TcpRelayTransportBindingElement

Namespace
Microsoft.ServiceBus
Assembly
Microsoft.ServiceBus.dll

Represents the binding element for the TCP transport relay.

public class TcpRelayTransportBindingElement : ConnectionOrientedTransportBindingElement, IPolicyExportExtension
Inheritance
TcpRelayTransportBindingElement
Implements
IPolicyExportExtension
Inherited Members

Constructors

TcpRelayTransportBindingElement()

Initializes a new instance of the TcpRelayTransportBindingElement class.

public TcpRelayTransportBindingElement()

TcpRelayTransportBindingElement(RelayClientAuthenticationType)

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

public TcpRelayTransportBindingElement(RelayClientAuthenticationType relayClientAuthenticationType)

Parameters

relayClientAuthenticationType RelayClientAuthenticationType

The relay client authentication type.

TcpRelayTransportBindingElement(TcpRelayTransportBindingElement)

Initializes a new instance of the TcpRelayTransportBindingElement class using the specified relay binding element.

protected TcpRelayTransportBindingElement(TcpRelayTransportBindingElement elementToBeCloned)

Parameters

elementToBeCloned TcpRelayTransportBindingElement

The element to be cloned.

Properties

ConnectionMode

Gets or sets the connection mode.

public TcpRelayConnectionMode ConnectionMode { get; set; }

Property Value

TcpRelayConnectionMode

Returns a TcpRelayConnectionMode that contains the connection mode.

ConnectionPoolSettings

Gets the connection pool settings for the current instance.

public SocketConnectionPoolSettings ConnectionPoolSettings { get; }

Property Value

SocketConnectionPoolSettings

The connection pool settings for the current instance.

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.

RelayClientAuthenticationType

Gets or sets the type of authentication used by the service client.

public RelayClientAuthenticationType RelayClientAuthenticationType { get; set; }

Property Value

RelayClientAuthenticationType

Returns RelayClientAuthenticationType.Contains the authentication type. The default value is RelayAccessToken.

Scheme

Gets the URI scheme for the transport.

public override string Scheme { get; }

Property Value

string

Returns the URI scheme for the transport, which is “TCP”.

Methods

BuildChannelFactory<TChannel>(BindingContext)

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

public override IChannelFactory<TChannel> BuildChannelFactory<TChannel>(BindingContext context)

Parameters

context BindingContext

Describes the bindings, behaviors, contracts, and other information required to create the channel factory.

Returns

IChannelFactory<TChannel>

A channel factory of the specified type.

Type Parameters

TChannel

The type of channel factory.

BuildChannelListener<TChannel>(BindingContext)

Creates a channel listener of the specified type.

public override IChannelListener<TChannel> BuildChannelListener<TChannel>(BindingContext context) where TChannel : class, IChannel

Parameters

context BindingContext

Describes the bindings, behaviors, contracts, and other information required to create the channel factory.

Returns

IChannelListener<TChannel>

A channel listener of the specified type.

Type Parameters

TChannel

The type of channel factory.

Clone()

Creates a copy of the current binding element.

public override BindingElement Clone()

Returns

BindingElement

Returns a System.ServiceModel.Channels.BindingElement that contains a copy of the binding element.

GetProperty<T>(BindingContext)

Returns a specified object from the binding context.

public override T GetProperty<T>(BindingContext context) where T : class

Parameters

context BindingContext

The context.

Returns

T

A binding element that contains the specified object, or null if not found.

Type Parameters

T

The type of object to get.