NetTcpRelayBindingBase NetTcpRelayBindingBase Class

The base class for common methods for the NetTcpRelayBinding binding.

Syntax

Declaration

public abstract class NetTcpRelayBindingBase : Binding, IDefaultCommunicationTimeouts, IBindingRuntimePreferencesPublic MustInherit Class NetTcpRelayBindingBase
    Inherits Binding
    Implements IDefaultCommunicationTimeouts, IBindingRuntimePreferences

Inheritance Hierarchy

Inherited Members

, , , , , , , , , ,
BuildChannelListener(Uri, String, System.ServiceModel.Description.ListenUriMode, Object[])
BuildChannelListener(Of TChannel)(Uri, String, System.ServiceModel.Description.ListenUriMode, Object())
,
BuildChannelListener(Uri, String, System.ServiceModel.Description.ListenUriMode, Object[])
BuildChannelListener(Of TChannel)(Uri, String, System.ServiceModel.Description.ListenUriMode, Object())
, , , , , , ,
BuildChannelListener(Uri, String, System.ServiceModel.Description.ListenUriMode, BindingParameterCollection)
BuildChannelListener(Of TChannel)(Uri, String, System.ServiceModel.Description.ListenUriMode, BindingParameterCollection)
,
BuildChannelListener(Uri, String, System.ServiceModel.Description.ListenUriMode, BindingParameterCollection)
BuildChannelListener(Of TChannel)(Uri, String, System.ServiceModel.Description.ListenUriMode, BindingParameterCollection)
, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,

Constructors summary

Initializes a new instance of the NetTcpRelayBindingBase class.

Initializes a new instance of the NetTcpRelayBindingBase class, using the specified security mode and relay authentication type.

Initializes a new instance of theNetTcpRelayBindingBase class, using the specified transport, encoding, and security.

Initializes a new instance of the NetTcpRelayBindingBase class, using the specified configuration name.

Fields summary

The encoding element for the current instance.Along with the security and transport settings, the encoding forms the three core properties of a binding.

The transport element for the current instance.Along with the encoding and security, the transport setting forms the core properties of a binding.

Properties summary

Gets or sets the connection mode: Hybrid or Relayed.

Gets the version of SOAP that is used for messages processed by this binding.

Gets or sets the comparison mode used on the hostname.

Gets or sets whether the relay binding is dynamic.

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

Gets or sets the maximum size allowed for a buffer pool that stores messages processed by the binding.

Gets or sets a value that specifies the maximum size of the buffer used to store messages in memory.

Gets or sets a value that controls the maximum number of connections to be pooled for subsequent reuse on the client and the maximum number of connections allowed to be pending dispatch on the server.

Gets or sets the maximum size for a received message that is processed by the binding.

Gets the message security version.

Gets or sets constraints on the complexity of SOAP messages that can be processed by endpoints configured with this binding. This property cannot be null.

Gets the URI scheme for the transport.

Gets an object that specifies the type of security used with services configured with this binding.

Gets or sets a value that indicates whether the service configured with the binding uses streamed or buffered (or both) modes of message transfer.

Methods summary

Applies the settings from the configuration element that corresponds to the specified name to the current instance of this binding element.

Retrieves an ordered collection of binding elements contained in the current binding.

Creates the security binding element for the current instance.

Determines whether the specified binding elements match the default values of the binding elements in the current instance.

Explicit Interface Implementations summary

Constructors

  • NetTcpRelayBindingBase()
    NetTcpRelayBindingBase()

    Initializes a new instance of the NetTcpRelayBindingBase class.

    protected NetTcpRelayBindingBase()Protected Sub New
  • NetTcpRelayBindingBase(EndToEndSecurityMode, RelayClientAuthenticationType)
    NetTcpRelayBindingBase(EndToEndSecurityMode, RelayClientAuthenticationType)

    Initializes a new instance of the NetTcpRelayBindingBase class, using the specified security mode and relay authentication type.

    protected NetTcpRelayBindingBase(EndToEndSecurityMode securityMode, RelayClientAuthenticationType relayClientAuthenticationType)Protected Sub New(securityMode As EndToEndSecurityMode, relayClientAuthenticationType As RelayClientAuthenticationType)

    Parameters

  • NetTcpRelayBindingBase(TcpRelayTransportBindingElement, BinaryMessageEncodingBindingElement, NetTcpRelaySecurity)
    NetTcpRelayBindingBase(TcpRelayTransportBindingElement, BinaryMessageEncodingBindingElement, NetTcpRelaySecurity)

    Initializes a new instance of theNetTcpRelayBindingBase class, using the specified transport, encoding, and security.

    protected NetTcpRelayBindingBase(TcpRelayTransportBindingElement transport, BinaryMessageEncodingBindingElement encoding, NetTcpRelaySecurity security)Protected Sub New(transport As TcpRelayTransportBindingElement, encoding As BinaryMessageEncodingBindingElement, security As NetTcpRelaySecurity)

    Parameters

  • NetTcpRelayBindingBase(String)
    NetTcpRelayBindingBase(String)

    Initializes a new instance of the NetTcpRelayBindingBase class, using the specified configuration name.

    protected NetTcpRelayBindingBase(string configurationName)Protected Sub New(configurationName As String)

    Parameters

    • configurationName

      The binding configuration name.

Fields

  • encoding
    encoding

    The encoding element for the current instance.Along with the security and transport settings, the encoding forms the three core properties of a binding.

    protected BinaryMessageEncodingBindingElement encodingProtected encoding As BinaryMessageEncodingBindingElement
  • transport
    transport

    The transport element for the current instance.Along with the encoding and security, the transport setting forms the core properties of a binding.

    protected TcpRelayTransportBindingElement transportProtected transport As TcpRelayTransportBindingElement

Properties

  • ConnectionMode
    ConnectionMode

    Gets or sets the connection mode: Hybrid or Relayed.

    public TcpRelayConnectionMode ConnectionMode { get; set; }Public Property ConnectionMode As TcpRelayConnectionMode

    Property Value

  • EnvelopeVersion
    EnvelopeVersion

    Gets the version of SOAP that is used for messages processed by this binding.

    public EnvelopeVersion EnvelopeVersion { get; }Public ReadOnly Property EnvelopeVersion As EnvelopeVersion

    Property Value

  • HostNameComparisonMode
    HostNameComparisonMode

    Gets or sets the comparison mode used on the hostname.

    public HostNameComparisonMode HostNameComparisonMode { get; set; }Public Property HostNameComparisonMode As HostNameComparisonMode

    Property Value

  • IsDynamic
    IsDynamic

    Gets or sets whether the relay binding is dynamic.

    public bool IsDynamic { get; set; }Public Property IsDynamic As Boolean

    Property Value

    • true if the relay binding is dynamic; otherwise, false.

  • ListenBacklog
    ListenBacklog

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

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

    Property Value

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

  • MaxBufferPoolSize
    MaxBufferPoolSize

    Gets or sets the maximum size allowed for a buffer pool that stores messages processed by the binding.

    public long MaxBufferPoolSize { get; set; }Public Property MaxBufferPoolSize As Long

    Property Value

    • Returns the maximum size, in bytes, allowed for a buffer pool that stores messages processed by the binding. The default value is 65,536.

  • MaxBufferSize
    MaxBufferSize

    Gets or sets a value that specifies the maximum size of the buffer used to store messages in memory.

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

    Property Value

    • Returns the maximum size, in bytes, of the buffer used to store messages in memory. The default value is 65,536.

  • MaxConnections
    MaxConnections

    Gets or sets a value that controls the maximum number of connections to be pooled for subsequent reuse on the client and the maximum number of connections allowed to be pending dispatch on the server.

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

    Property Value

    • On the client, returns the maximum number of connections to be pooled for subsequent reuse; on the server, returns the maximum number of connections allowed to be pending dispatch.

  • MaxReceivedMessageSize
    MaxReceivedMessageSize

    Gets or sets the maximum size for a received message that is processed by the binding.

    public long MaxReceivedMessageSize { get; set; }Public Property MaxReceivedMessageSize As Long

    Property Value

    • Returns the maximum size, in bytes, for a received message that is processed by the binding. The default value is 65,536.

  • MessageSecurityVersion
    MessageSecurityVersion

    Gets the message security version.

    protected MessageSecurityVersion MessageSecurityVersion { get; }Protected ReadOnly Property MessageSecurityVersion As MessageSecurityVersion

    Property Value

  • ReaderQuotas
    ReaderQuotas

    Gets or sets constraints on the complexity of SOAP messages that can be processed by endpoints configured with this binding. This property cannot be null.

    public XmlDictionaryReaderQuotas ReaderQuotas { get; set; }Public Property ReaderQuotas As XmlDictionaryReaderQuotas

    Property Value

    Exceptions

  • Scheme
    Scheme

    Gets the URI scheme for the transport.

    public override string Scheme { get; }Public Overrides ReadOnly Property Scheme As String

    Property Value

    • Returns the URI scheme for the transport. The default is “sb”.

  • Security
    Security

    Gets an object that specifies the type of security used with services configured with this binding.

    public NetTcpRelaySecurity Security { get; }Public ReadOnly Property Security As NetTcpRelaySecurity

    Property Value

  • TransferMode
    TransferMode

    Gets or sets a value that indicates whether the service configured with the binding uses streamed or buffered (or both) modes of message transfer.

    public TransferMode TransferMode { get; set; }Public Property TransferMode As TransferMode

    Property Value

    • Returns a TransferMode that indicates whether the service configured with the binding uses streamed or buffered (or both) modes of message transfer. By default, the HTTP, TCP/IP, and named pipe transports use buffered message transfers.

Methods

  • ApplyConfiguration(String)
    ApplyConfiguration(String)

    Applies the settings from the configuration element that corresponds to the specified name to the current instance of this binding element.

    protected virtual void ApplyConfiguration(string configurationName)Protected Overridable Sub ApplyConfiguration(configurationName As String)

    Parameters

    • configurationName

      The name of the configuration element to take the settings from.

    Exceptions

  • CreateBindingElements()
    CreateBindingElements()

    Retrieves an ordered collection of binding elements contained in the current binding.

    public override BindingElementCollection CreateBindingElements()Public Overrides Function CreateBindingElements As BindingElementCollection

    Returns

  • CreateMessageSecurity()
    CreateMessageSecurity()

    Creates the security binding element for the current instance.

    protected abstract SecurityBindingElement CreateMessageSecurity()Protected MustOverride Function CreateMessageSecurity As SecurityBindingElement

    Returns

  • IsBindingElementsMatch(TcpRelayTransportBindingElement, BinaryMessageEncodingBindingElement)
    IsBindingElementsMatch(TcpRelayTransportBindingElement, BinaryMessageEncodingBindingElement)

    Determines whether the specified binding elements match the default values of the binding elements in the current instance.

    protected bool IsBindingElementsMatch(TcpRelayTransportBindingElement transport, BinaryMessageEncodingBindingElement encoding)Protected Function IsBindingElementsMatch(transport As TcpRelayTransportBindingElement, encoding As BinaryMessageEncodingBindingElement) As Boolean

    Parameters

    Returns

Explicit Interface Implementations

  • IBindingRuntimePreferences.ReceiveSynchronously
    System.ServiceModel.Channels.IBindingRuntimePreferences.ReceiveSynchronously
    bool IBindingRuntimePreferences.ReceiveSynchronously { get; }ReadOnly WriteOnly Property System.ServiceModel.Channels.IBindingRuntimePreferences.ReceiveSynchronously As Boolean Implements IBindingRuntimePreferences.ReceiveSynchronously

    Returns

Details

Assembly

Microsoft.ServiceBus.dll