ConnectionOrientedTransportBindingElement ConnectionOrientedTransportBindingElement Class

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

Syntax

Declaration

public abstract class ConnectionOrientedTransportBindingElement : TransportBindingElementPublic MustInherit Class ConnectionOrientedTransportBindingElement
    Inherits TransportBindingElement

Inheritance Hierarchy

Properties summary

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

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.

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

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

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.

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

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

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

Methods summary

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

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

Retrieves properties from the binding stack, if present.

Properties

  • ChannelInitializationTimeout
    ChannelInitializationTimeout

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

    public TimeSpan ChannelInitializationTimeout { get; set; }Public Property ChannelInitializationTimeout As TimeSpan

    Property Value

  • ConnectionBufferSize
    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; }Public Property ConnectionBufferSize As Integer

    Property Value

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

    Exceptions

  • HostNameComparisonMode
    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; }Public Property HostNameComparisonMode As HostNameComparisonMode

    Property Value

    Exceptions

  • MaxBufferSize
    MaxBufferSize

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

    public int MaxBufferSize { get; set; }Public Property MaxBufferSize As Integer

    Property Value

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

    Exceptions

  • MaxOutputDelay
    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; }Public Property MaxOutputDelay As TimeSpan

    Property Value

    • 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.

    Exceptions

  • MaxPendingAccepts
    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; }Public Property MaxPendingAccepts As Integer

    Property Value

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

    Exceptions

  • MaxPendingConnections
    MaxPendingConnections

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

    public int MaxPendingConnections { get; set; }Public Property MaxPendingConnections As Integer

    Property Value

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

    Exceptions

  • TransferMode
    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; }Public Property TransferMode As TransferMode

    Property Value

    Exceptions

Methods

  • CanBuildChannelFactory<TChannel>(BindingContext)
    CanBuildChannelFactory(Of TChannel)(BindingContext)

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

    public override bool CanBuildChannelFactory<TChannel>(BindingContext context)Public Overrides Function CanBuildChannelFactory(Of TChannel)(context As BindingContext) As Boolean

    Parameters

    Returns

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

  • CanBuildChannelListener<TChannel>(BindingContext)
    CanBuildChannelListener(Of 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, IChannelPublic Overrides Function CanBuildChannelListener(Of TChannel As {Class, IChannel})(context As BindingContext) As Boolean

    Parameters

    Returns

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

  • GetProperty<T>(BindingContext)
    GetProperty(Of T)(BindingContext)

    Retrieves properties from the binding stack, if present.

    public override T GetProperty<T>(BindingContext context)where T : classPublic Overrides Function GetProperty(Of T As Class)(context As BindingContext) As T

    Parameters

    Returns

    • T
      T

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

Details

Assembly

Microsoft.ServiceBus.dll