Table of Contents

Class NetTcpRelayBinding

Namespace
Microsoft.ServiceBus
Assembly
Microsoft.ServiceBus.dll

Provides a secure, reliable binding suitable for cross-computer communication.

public class NetTcpRelayBinding : NetTcpRelayBindingBase, IBindingRuntimePreferences
Inheritance
NetTcpRelayBinding
Implements
IBindingRuntimePreferences
Inherited Members

Constructors

NetTcpRelayBinding()

Initializes a new instance of the NetTcpRelayBinding class.

public NetTcpRelayBinding()

NetTcpRelayBinding(EndToEndSecurityMode, RelayClientAuthenticationType)

Initializes a new instance of the NetTcpRelayBinding class with the type of security used and relay client authentication specified.

public NetTcpRelayBinding(EndToEndSecurityMode securityMode, RelayClientAuthenticationType relayClientAuthenticationType)

Parameters

securityMode EndToEndSecurityMode

The type of security used with the binding.

relayClientAuthenticationType RelayClientAuthenticationType

The type of client authentication used on the relay.

NetTcpRelayBinding(EndToEndSecurityMode, RelayClientAuthenticationType, bool)

Initializes a new instance of the NetTcpRelayBinding class with the type of security used, the type of client authentication, and a value that indicates whether reliable sessions are explicitly enabled.

public NetTcpRelayBinding(EndToEndSecurityMode securityMode, RelayClientAuthenticationType relayClientAuthenticationType, bool reliableSessionEnabled)

Parameters

securityMode EndToEndSecurityMode

The type of security used with the Windows Azure Service Bus binding.

relayClientAuthenticationType RelayClientAuthenticationType

The type of client authentication used on the relay.

reliableSessionEnabled bool

true if reliable sessions are enabled; otherwise, false.

NetTcpRelayBinding(TcpRelayTransportBindingElement, BinaryMessageEncodingBindingElement, ReliableSessionBindingElement, NetTcpRelaySecurity)

Initializes a new instance of the NetTcpRelayBinding class using the specified transport, encoding, session information, and security settings.

protected NetTcpRelayBinding(TcpRelayTransportBindingElement transport, BinaryMessageEncodingBindingElement encoding, ReliableSessionBindingElement session, NetTcpRelaySecurity security)

Parameters

transport TcpRelayTransportBindingElement

The transport.

encoding BinaryMessageEncodingBindingElement

The encoding to use.

session ReliableSessionBindingElement

The session.

security NetTcpRelaySecurity

Security settings.

NetTcpRelayBinding(string)

Initializes a new instance of the NetTcpRelayBinding class with a specified XML configuration.

public NetTcpRelayBinding(string configurationName)

Parameters

configurationName string

The configuration to use.

Properties

ReliableSession

Gets an object that indicates whether a reliable session is established between Windows Azure Service Bus channel endpoints.

public OptionalReliableSession ReliableSession { get; }

Property Value

OptionalReliableSession

Returns System.ServiceModel.OptionalReliableSession.Indicates whether a WS-RM reliable session is established between channel endpoints. The default is false.

Methods

ApplyConfiguration(string)

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

protected override void ApplyConfiguration(string configurationName)

Parameters

configurationName string

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

CreateBindingElements()

Creates a collection with the binding elements for the binding.

public override BindingElementCollection CreateBindingElements()

Returns

BindingElementCollection

Returns a System.ServiceModel.Channels.BindingElementCollection that contains the ordered stack of binding elements.

CreateMessageSecurity()

Creates the message security token for the current instance.

protected override SecurityBindingElement CreateMessageSecurity()

Returns

SecurityBindingElement

Returns System.ServiceModel.Channels.SecurityBindingElement.Contains the message security token.

IsBindingElementsMatch(TcpRelayTransportBindingElement, BinaryMessageEncodingBindingElement, ReliableSessionBindingElement)

Returns a value that determines whether the specified objects have matching binding elements.

protected bool IsBindingElementsMatch(TcpRelayTransportBindingElement transport, BinaryMessageEncodingBindingElement encoding, ReliableSessionBindingElement session)

Parameters

transport TcpRelayTransportBindingElement

The transport to match.

encoding BinaryMessageEncodingBindingElement

The encoding to match.

session ReliableSessionBindingElement

The session to match.

Returns

bool

Returns bool.true if the objects match; otherwise, false.