Class ConnectionOrientedTransportBindingElement

Namespace

Microsoft.ServiceBus.Channels

Assembly

Microsoft.ServiceBus.dll

An abstract class that supplements the base System.ServiceModel.Channels.TransportBindingElement with additional properties that are common to connection-oriented transports such as TCP and named pipes.

public abstract class ConnectionOrientedTransportBindingElement : TransportBindingElement

Inheritance

object

ConnectionOrientedTransportBindingElement

Derived

TcpRelayTransportBindingElement

Properties

ChannelInitializationTimeout

Gets or sets the timespan that specifies how long the channel initialization has to complete before timing out.

public TimeSpan ChannelInitializationTimeout { get; set; }

Property Value

TimeSpan

Returns a TimeSpan after which the initialization times out.

ConnectionBufferSize

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

public int ConnectionBufferSize { get; set; }

Property Value

int

The size of the connection buffer. The default value is 8192 bytes.

HostNameComparisonMode

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

public HostNameComparisonMode HostNameComparisonMode { get; set; }

Property Value

HostNameComparisonMode

Returns a System.ServiceModel.HostNameComparisonMode that determines whether the hostname is used to reach the service. The default value is StrongWildCard, which ignores the hostname and port number in the comparison.

MaxBufferSize

Gets or sets the maximum size of the buffer to use.

public int MaxBufferSize { get; set; }

Property Value

int

The maximum number of bytes that are used to buffer incoming messages in memory. The default value is 65,536 bytes.

MaxOutputDelay

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

public TimeSpan MaxOutputDelay { get; set; }

Property Value

TimeSpan

Returns a TimeSpan that specifies the maximum interval of time that a chunk of a message or a full message can remain buffered in memory before being sent out. The default value is 2 seconds. This property is only meaningful if the AllowedOutputBatching property of an outgoing message is set to true. Otherwise, this value is ignored and messages are sent immediately.

MaxPendingAccepts

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

public int MaxPendingAccepts { get; set; }

Property Value

int

The maximum number of connections the service can accept simultaneously. The default value is 1.

MaxPendingConnections

Gets or sets the maximum number of connections awaiting dispatch on the service.

public int MaxPendingConnections { get; set; }

Property Value

int

The maximum number of inbound connections awaiting dispatch on the service. The default value is 10.

TransferMode

Gets or sets a value that specifies whether the messages are buffered or streamed with the connection-oriented transport.

public TransferMode TransferMode { get; set; }

Property Value

TransferMode

Returns a System.ServiceModel.TransferMode which indicates whether a channel uses streamed or buffered modes of message transfer. The default is Buffered.

Methods

CanBuildChannelFactory<TChannel>(BindingContext)

Indicates whether a channel factory of the specified type can be built.

public override bool CanBuildChannelFactory<TChannel>(BindingContext context)

Parameters

context BindingContext

The binding context for the channel.

Returns

bool

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

Type Parameters

TChannel

The type of channel to check.

CanBuildChannelListener<TChannel>(BindingContext)

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

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

Parameters

context BindingContext

The binding context that provides context for the binding element.

Returns

bool

true if the IChannelListener<TChannel> of type IChannel can be built by the binding element; otherwise, false.

Type Parameters

TChannel

The type of channel to check.

GetProperty<T>(BindingContext)

Retrieves properties from the binding stack, if present.

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

Parameters

context BindingContext

The binding context.

Returns

T

An object from the binding stack, if present, or null if not found.

Type Parameters

T

The type of property.