NetTcpRelayBindingElement NetTcpRelayBindingElement Class

A configuration element that describes a secure, reliable binding suitable for cross-machine communication through the Azure Service Bus relay.

Syntax

Declaration

public class NetTcpRelayBindingElement : StandardBindingElement, IBindingConfigurationElement, IConfigurationContextProviderInternalPublic Class NetTcpRelayBindingElement
    Inherits StandardBindingElement
    Implements IBindingConfigurationElement, IConfigurationContextProviderInternal

Inheritance Hierarchy

Inherited Members

, , , , , , , , , , , , , , , ,
Init()
Init()
,
Init()
Init()
, , , , , , , , , , , , , , , , , , ,
Unmerge(ConfigurationElement, ConfigurationElement, System.Configuration.ConfigurationSaveMode)
Unmerge(ConfigurationElement, ConfigurationElement, System.Configuration.ConfigurationSaveMode)
,
Unmerge(ConfigurationElement, ConfigurationElement, System.Configuration.ConfigurationSaveMode)
Unmerge(ConfigurationElement, ConfigurationElement, System.Configuration.ConfigurationSaveMode)
, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,

Constructors summary

Initializes a new instance of the NetTcpRelayBindingElement class.

Initializes a new instance of the NetTcpRelayBindingElement class with a specified configuration name.

Properties summary

Gets the type of this configuration element. (Overrides StandardBindingElement.BindingElementType.)

Gets or sets the connection mode stored in the App.config file for this configuration.

Gets or sets whether the relay binding is dynamic.

Gets or sets a value in the App.config file that specifies the maximum number of channels that can wait to be accepted on the listener.

Gets or sets a value from the App.config file that contains the maximum size for a buffer pool that stores TCP messages processed by the binding.

Gets or sets a value from the App.config file that specifies the maximum size, in bytes, of the buffer used to store messages in memory.

Gets or sets a value from the App.config file that specifies the maximum number of outbound and inbound connections the service creates and accepts respectively.

Gets or sets a value from the App.config file that contains the maximum size of a message that can be received on a channel configured with this binding.

Gets a ConfigurationPropertyCollection instance that contains a collection of ConfigurationProperty objects that can be attributes or ConfigurationElement objects of this configuration element. (Overrides StandardBindingElement.Properties.)

Gets a value from the App.config file that puts constraints on the complexity of SOAP messages that can be processed by endpoints configured with this binding.

Gets a configuration element that specifies whether reliable sessions are established between channel endpoints.

Gets a value from the App.config file that determines the type of security to be used with this binding.

Gets or sets a value from the App.config file that specifies whether messages are buffered or streamed or a request or response.

Methods summary

Initializes the contents of this binding configuration element from the property values of a specified binding.

Applies the settings of this configuration element to the specified binding element.

Constructors

  • NetTcpRelayBindingElement()
    NetTcpRelayBindingElement()

    Initializes a new instance of the NetTcpRelayBindingElement class.

    public NetTcpRelayBindingElement()Public Sub New
  • NetTcpRelayBindingElement(String)
    NetTcpRelayBindingElement(String)

    Initializes a new instance of the NetTcpRelayBindingElement class with a specified configuration name.

    public NetTcpRelayBindingElement(string name)Public Sub New(name As String)

    Parameters

Properties

  • BindingElementType
    BindingElementType

    Gets the type of this configuration element. (Overrides StandardBindingElement.BindingElementType.)

    protected override Type BindingElementType { get; }Protected Overrides ReadOnly Property BindingElementType As Type

    Property Value

    • Returns a Type that contains the configuration element type.

  • ConnectionMode
    ConnectionMode

    Gets or sets the connection mode stored in the App.config file for this configuration.

    [ConfigurationProperty("connectionMode", DefaultValue = TcpRelayConnectionMode.Relayed)]
    public TcpRelayConnectionMode ConnectionMode { get; set; }<ConfigurationProperty("connectionMode", DefaultValue:=TcpRelayConnectionMode.Relayed)>
    Public Property ConnectionMode As TcpRelayConnectionMode

    Property Value

  • IsDynamic
    IsDynamic

    Gets or sets whether the relay binding is dynamic.

    [ConfigurationProperty("isDynamic", DefaultValue = true)]
    public bool IsDynamic { get; set; }<ConfigurationProperty("isDynamic", DefaultValue:=True)>
    Public Property IsDynamic As Boolean

    Property Value

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

  • ListenBacklog
    ListenBacklog

    Gets or sets a value in the App.config file that specifies the maximum number of channels that can wait to be accepted on the listener.

    [ConfigurationProperty("listenBacklog", DefaultValue = 10)]
    [IntegerValidator(MinValue = 1)]
    public int ListenBacklog { get; set; }<ConfigurationProperty("listenBacklog", DefaultValue:=10)>
    <IntegerValidator(MinValue:=1)>
    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 a value from the App.config file that contains the maximum size for a buffer pool that stores TCP messages processed by the binding.

    [ConfigurationProperty("maxBufferPoolSize", DefaultValue = 524288L)]
    [LongValidator(MinValue = 0L)]
    public long MaxBufferPoolSize { get; set; }<ConfigurationProperty("maxBufferPoolSize", DefaultValue:=524288L)>
    <LongValidator(MinValue:=0L)>
    Public Property MaxBufferPoolSize As Long

    Property Value

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

  • MaxBufferSize
    MaxBufferSize

    Gets or sets a value from the App.config file that specifies the maximum size, in bytes, of the buffer used to store messages in memory.

    [ConfigurationProperty("maxBufferSize", DefaultValue = 65536)]
    [IntegerValidator(MinValue = 1)]
    public int MaxBufferSize { get; set; }<ConfigurationProperty("maxBufferSize", DefaultValue:=65536)>
    <IntegerValidator(MinValue:=1)>
    Public Property MaxBufferSize As Integer

    Property Value

    • The maximum size, in bytes, of the buffer used to store messages in memory.

  • MaxConnections
    MaxConnections

    Gets or sets a value from the App.config file that specifies the maximum number of outbound and inbound connections the service creates and accepts respectively.

    [ConfigurationProperty("maxConnections", DefaultValue = 10)]
    [IntegerValidator(MinValue = 1)]
    public int MaxConnections { get; set; }<ConfigurationProperty("maxConnections", DefaultValue:=10)>
    <IntegerValidator(MinValue:=1)>
    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 a value from the App.config file that contains the maximum size of a message that can be received on a channel configured with this binding.

    [ConfigurationProperty("maxReceivedMessageSize", DefaultValue = 65536L)]
    [LongValidator(MinValue = 1L)]
    public long MaxReceivedMessageSize { get; set; }<ConfigurationProperty("maxReceivedMessageSize", DefaultValue:=65536L)>
    <LongValidator(MinValue:=1L)>
    Public Property MaxReceivedMessageSize As Long

    Property Value

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

  • Properties
    Properties

    Gets a ConfigurationPropertyCollection instance that contains a collection of ConfigurationProperty objects that can be attributes or ConfigurationElement objects of this configuration element. (Overrides StandardBindingElement.Properties.)

    protected override ConfigurationPropertyCollection Properties { get; }Protected Overrides ReadOnly Property Properties As ConfigurationPropertyCollection

    Property Value

  • ReaderQuotas
    ReaderQuotas

    Gets a value from the App.config file that puts constraints on the complexity of SOAP messages that can be processed by endpoints configured with this binding.

    [ConfigurationProperty("readerQuotas")]
    public XmlDictionaryReaderQuotasElement ReaderQuotas { get; }<ConfigurationProperty("readerQuotas")>
    Public ReadOnly Property ReaderQuotas As XmlDictionaryReaderQuotasElement

    Property Value

  • ReliableSession
    ReliableSession

    Gets a configuration element that specifies whether reliable sessions are established between channel endpoints.

    [ConfigurationProperty("reliableSession")]
    public StandardBindingOptionalReliableSessionElement ReliableSession { get; }<ConfigurationProperty("reliableSession")>
    Public ReadOnly Property ReliableSession As StandardBindingOptionalReliableSessionElement

    Property Value

  • Security
    Security

    Gets a value from the App.config file that determines the type of security to be used with this binding.

    [ConfigurationProperty("security")]
    public NetTcpRelaySecurityElement Security { get; }<ConfigurationProperty("security")>
    Public ReadOnly Property Security As NetTcpRelaySecurityElement

    Property Value

    • Returns a NetTcpRelaySecurityElement that contains the security settings for the associated binding. The default value is none.The NetTcpRelaySecurityElement you retrieve from the associated binding is created indirectly with a NetTcpRelayBinding. As such, after the binding is created, you cannot replace this object with a new object unless you also create a new binding. However, many members of WebHttpRelaySecurity can be set through security property. For more information on binding security, see the Security and Protection section. Along with the type of transport and encoding, the Security settings represent one of the three main properties that define this binding.

  • TransferMode
    TransferMode

    Gets or sets a value from the App.config file that specifies whether messages are buffered or streamed or a request or response.

    [ConfigurationProperty("transferMode", DefaultValue = TransferMode.Buffered)]
    public TransferMode TransferMode { get; set; }<ConfigurationProperty("transferMode", DefaultValue:=TransferMode.Buffered)>
    Public Property TransferMode As TransferMode

    Property Value

    • Returns a TransferMode that contains indicates whether the service configured with the binding uses streamed or buffered (or both) modes of message transfer. The possible values are as follows: BufferedStreamedStreamedRequestStreamedResponseThe default value is Buffered.Specifying TransferMode to Streamed implies both StreamedRequest and StreamedResponse.

Methods

  • InitializeFrom(Binding)
    InitializeFrom(Binding)

    Initializes the contents of this binding configuration element from the property values of a specified binding.

    protected override void InitializeFrom(Binding binding)Protected Overrides Sub InitializeFrom(binding As Binding)

    Parameters

  • OnApplyConfiguration(Binding)
    OnApplyConfiguration(Binding)

    Applies the settings of this configuration element to the specified binding element.

    protected override void OnApplyConfiguration(Binding binding)Protected Overrides Sub OnApplyConfiguration(binding As Binding)

    Parameters

Details

Assembly

Microsoft.ServiceBus.dll