Class RelayedOnewayTransportBindingElement

Namespace

Microsoft.ServiceBus

Assembly

Microsoft.ServiceBus.dll

Represents the transport binding element used for one-way communication.

public class RelayedOnewayTransportBindingElement : TransportBindingElement, IPolicyExportExtension

Inheritance

object

RelayedOnewayTransportBindingElement

Implements

IPolicyExportExtension

Constructors

RelayedOnewayTransportBindingElement()

Initializes a new instance of the RelayedOnewayTransportBindingElement class.

public RelayedOnewayTransportBindingElement()

RelayedOnewayTransportBindingElement(RelayClientAuthenticationType)

Initializes a new instance of the RelayedOnewayTransportBindingElement class, using the specified authentication type.

public RelayedOnewayTransportBindingElement(RelayClientAuthenticationType relayClientAuthenticationType)

Parameters

relayClientAuthenticationType RelayClientAuthenticationType

The relay client authentication type. This can be either RelayAccessToken or None.

RelayedOnewayTransportBindingElement(RelayClientAuthenticationType, RelayedOnewayConnectionMode)

Initializes a new instance of the RelayedOnewayTransportBindingElement class, using the specified authentication type and connection mode.

public RelayedOnewayTransportBindingElement(RelayClientAuthenticationType relayClientAuthenticationType, RelayedOnewayConnectionMode connectionMode)

Parameters

relayClientAuthenticationType RelayClientAuthenticationType

The relay client authentication type. This can be either RelayAccessToken or None.

connectionMode RelayedOnewayConnectionMode

The connection mode. This can be either Unicast or Multicast.

RelayedOnewayTransportBindingElement(RelayedOnewayTransportBindingElement)

Initializes a new instance of the RelayedOnewayTransportBindingElement class, using the specified element.

public RelayedOnewayTransportBindingElement(RelayedOnewayTransportBindingElement elementToClone)

Parameters

elementToClone RelayedOnewayTransportBindingElement

The element to clone.

Properties

ChannelInitializationTimeout

Gets or sets the maximum time a channel can be in the initialization status before being disconnected.

public TimeSpan ChannelInitializationTimeout { get; set; }

Property Value

TimeSpan

The maximum time a channel can be in the initialization status before being disconnected.

ConnectionBufferSize

Gets or sets the size of the buffer used to transmit a part of the serialized message on the wire from the client or service.

public int ConnectionBufferSize { get; set; }

Property Value

int

The size of the buffer used to transmit a part of the serialized message on the wire from the client or service.

ConnectionMode

Gets the connection mode used in this binding element. The connection mode can be one of the RelayedOnewayConnectionMode enumeration values.

public RelayedOnewayConnectionMode ConnectionMode { get; set; }

Property Value

RelayedOnewayConnectionMode

The connection mode used in this binding element.

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.

HostNameComparisonMode

Gets or sets a value that indicates whether the hostname is used to reach the service when matching the URI.

public HostNameComparisonMode HostNameComparisonMode { get; set; }

Property Value

HostNameComparisonMode

ListenBacklog

Gets or sets the maximum number of queued connection requests that can be pending.

public int ListenBacklog { get; set; }

Property Value

int

The maximum number of queued connection.

MaxBufferSize

Gets or sets the maximum size in bytes of the buffer that holds incoming messages that are processed by this binding.

public int MaxBufferSize { get; set; }

Property Value

int

The maximum size in bytes of the buffer that holds incoming messages that are processed by this binding.

MaxOutputDelay

Gets or sets the maximum interval of time that a message or a portion of a message can remain buffered in memory before being sent out.

public TimeSpan MaxOutputDelay { get; set; }

Property Value

TimeSpan

The maximum interval of time that a message or a portion of a message can remain buffered in memory before being sent out.

MaxPendingAccepts

Gets or sets the maximum number of pending asynchronous accept threads that are available for processing incoming connections on the service.

public int MaxPendingAccepts { get; set; }

Property Value

int

The maximum number of pending asynchronous accept threads that are available for processing incoming connections on the service.

MaxPendingConnections

Gets or sets the maximum number of pending connections.

public int MaxPendingConnections { get; set; }

Property Value

int

The maximum number of pending connections.

RelayClientAuthenticationType

Gets or sets the type of Azure Access Control authentication used by this binding element.

public RelayClientAuthenticationType RelayClientAuthenticationType { get; set; }

Property Value

RelayClientAuthenticationType

Returns a RelayClientAuthenticationType that represents the type of authentication used by this binding element.The default value is RelayAccessToken.

Scheme

Gets the URI scheme used by this binding element.

public override string Scheme { get; }

Property Value

string

The URI scheme used by this binding element. The value returned is “sb”.

Methods

BuildChannelFactory<TChannel>(BindingContext)

Creates a channel factory for creating channels of the specified type and that is initialized from the specified binding context.

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

Parameters

context BindingContext

The binding context that provides context for the binding element.

Returns

IChannelFactory<TChannel>

A channel factory for creating channels of the specified type and that is initialized from the specified binding context.

Type Parameters

TChannel

BuildChannelListener<TChannel>(BindingContext)

Creates a channel listener that accepts channels of the specified type and that is initialized from the specified binding context.

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

Parameters

context BindingContext

The binding context that provides context for the binding element.

Returns

IChannelListener<TChannel>

A channel listener that accepts channels of the specified type and that is initialized from the specified binding context.

Type Parameters

TChannel

CanBuildChannelFactory<TChannel>(BindingContext)

Returns a value that indicates whether this binding element can build a channel factory of the specified type.

public override bool CanBuildChannelFactory<TChannel>(BindingContext context)

Parameters

context BindingContext

The binding context that provides context for this binding element.

Returns

bool

true if a channel factory can be built; otherwise false.

Type Parameters

TChannel

CanBuildChannelListener<TChannel>(BindingContext)

Returns a value that indicates whether the binding element can build a channel listener for the specified type of channel.

public override bool CanBuildChannelListener<TChannel>(BindingContext context) where TChannel : class, IChannel

Parameters

context BindingContext

The binding context that provides context for this binding element.

Returns

bool

true if a channel listener can be built for the specified type of channel; otherwise, false.

Type Parameters

TChannel

Clone()

Returns a copy of this instance of the RelayedOnewayTransportBindingElement binding element.

public override BindingElement Clone()

Returns

BindingElement

A binding element that contains a deep clone of this binding element.

GetProperty<T>(BindingContext)

Returns an object of the requested type, if present, from the appropriate layer in the binding stack.

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

Parameters

context BindingContext

The binding context that provides context for this binding element.

Returns

T

The object of the requested type if found; otherwise, returns null.

Type Parameters

T