SALES: 1-800-867-1380

TcpRelayTransportBindingElement Class

Represents the binding element for the TCP transport relay.

Namespace:  Microsoft.ServiceBus
Assembly:  Microsoft.ServiceBus (in Microsoft.ServiceBus.dll)

public class TcpRelayTransportBindingElement : ConnectionOrientedTransportBindingElement, 

The TcpRelayTransportBindingElement type exposes the following members.

Public methodTcpRelayTransportBindingElement()Initializes a new instance of the TcpRelayTransportBindingElement class.
Public methodTcpRelayTransportBindingElement(RelayClientAuthenticationType)Initializes a new instance of the TcpRelayTransportBindingElement class using the specified relay client authentication type.
Protected methodTcpRelayTransportBindingElement(TcpRelayTransportBindingElement)Initializes a new instance of the TcpRelayTransportBindingElement class using the specified relay binding element.

Public propertyChannelInitializationTimeoutGets or sets the timespan that specifies how long the channel initialization has to complete before timing out. (Inherited from ConnectionOrientedTransportBindingElement.)
Public propertyConnectionBufferSizeGets and sets the size of the buffer used to transmit a chunk of the serialized message on the wire from the client or service. (Inherited from ConnectionOrientedTransportBindingElement.)
Public propertyConnectionModeGets or sets the connection mode.
Public propertyConnectionPoolSettingsGets the connection pool settings for the current instance.
Public propertyHostNameComparisonModeGets or sets a value that indicates whether the hostname is used to reach the service when matching on the URI. (Inherited from ConnectionOrientedTransportBindingElement.)
Public propertyIsDynamicGets or sets whether the binding element is dynamic.
Public propertyManualAddressing (Inherited from TransportBindingElement.)
Public propertyMaxBufferPoolSize (Inherited from TransportBindingElement.)
Public propertyMaxBufferSizeGets or sets the maximum size of the buffer to use. (Inherited from ConnectionOrientedTransportBindingElement.)
Public propertyMaxOutputDelayGets 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. (Inherited from ConnectionOrientedTransportBindingElement.)
Public propertyMaxPendingAcceptsGets or sets the maximum number of pending asynchronous accept operations that are available for processing incoming connections to the service. (Inherited from ConnectionOrientedTransportBindingElement.)
Public propertyMaxPendingConnectionsGets or sets the maximum number of connections awaiting dispatch on the service. (Inherited from ConnectionOrientedTransportBindingElement.)
Public propertyMaxReceivedMessageSize (Inherited from TransportBindingElement.)
Public propertyRelayClientAuthenticationTypeGets or sets the type of authentication used by the service client.
Public propertySchemeGets the URI scheme for the transport. (Overrides TransportBindingElement.Scheme.)
Public propertyTransferModeGets or sets a value that specifies whether the messages are buffered or streamed with the connection-oriented transport. (Inherited from ConnectionOrientedTransportBindingElement.)

Public methodBuildChannelFactory<TChannel>Creates a channel factory that can be used to create a channel. (Overrides BindingElement.BuildChannelFactory<TChannel>(BindingContext).)
Public methodBuildChannelListener<TChannel>Creates a channel listener of the specified type. (Overrides BindingElement.BuildChannelListener<TChannel>(BindingContext).)
Public methodCanBuildChannelFactory<TChannel>Indicates whether a channel factory of the specified type can be built. (Inherited from ConnectionOrientedTransportBindingElement.)
Public methodCanBuildChannelListener<TChannel>Returns a value that indicates whether the binding element can build a listener for a specific type of channel. (Inherited from ConnectionOrientedTransportBindingElement.)
Public methodCloneCreates a copy of the current binding element. (Overrides BindingElement.Clone().)
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetProperty<T>Returns a specified object from the binding context. (Overrides ConnectionOrientedTransportBindingElement.GetProperty<T>(BindingContext).)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodToString (Inherited from Object.)

Explicit interface implemetationPrivate methodIPolicyExportExtension.ExportPolicy Exports a custom policy assertion about bindings.

Windows Azure Service Bus supports only Full Trust code access security.

Unlike most types with the word “element” in their name in the Windows Azure Service Bus namespace, TcpRelayTransportBindingElement does not represent an XML element in the App.config file. Nor is it used by the Windows Azure platform Windows Azure to translate information from the App.config file and into a binding. Rather, TcpRelayTransportBindingElement is the starting point for creating an Windows Azure Service Bus binding that implements the TCP transport. Thus, in this context, the word “element” refers to the idea that TcpRelayTransportBindingElement is one of the elements that makes up a binding, rather than an XML configuration element. For more information on creating your own custom binding, see Creating a Custom AppFabric Service Bus Binding.

In particular, the TcpRelayTransportBindingElement is closely aligned with the WCF TcpTransportBindingElement and is the foundation for NetTcpRelayBinding.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

© 2015 Microsoft