NetTcpBinding Class

Definition

A secure, reliable binding suitable for cross-machine communication.

public class NetTcpBinding : System.ServiceModel.Channels.Binding, System.ServiceModel.Channels.IBindingRuntimePreferences
Inheritance
NetTcpBinding
Derived
Implements

Examples

This example shows how to create a NetTcpBinding, setting the security mode and transport credential type.

NetTcpBinding binding = new NetTcpBinding();
binding.Security.Mode = SecurityMode.Transport;
binding.Security.Transport.ClientCredentialType = TcpClientCredentialType.Certificate;

Remarks

The NetTcpBinding generates a run-time communication stack by default, which uses transport security, TCP for message delivery, and a binary message encoding. This binding is an appropriate Windows Communication Foundation (WCF) system-provided choice for communicating over an Intranet.

The default configuration for the NetTcpBinding is faster than the configuration provided by the WSHttpBinding, but it is intended only for WCF-to-WCF communication. The security behavior is configurable using the optional securityMode parameter in the constructor. The use of WS-ReliableMessaging is configurable using the optional reliableSessionEnabled parameter. But reliable messaging is off by default. More generally, the HTTP system-provided bindings such as WSHttpBinding and BasicHttpBinding are configured to turn things on by default, whereas the NetTcpBinding binding turns things off by default so that you have to opt-in to get support, for example, for one of the WS-* specifications. This means that the default configuration for TCP is faster at exchanging messages between endpoints than that configured for the HTTP bindings by default.

Warning

The NetTcpBinding uses TCP connection pooling based on the service’s host DNS name and the port number the service is listening on. This works well when a client makes calls to different services on different ports, or services are hosted in a single process and share a port. If a single client calls multiple services sharing a port that are hosted in different processes, or are WAS/IIS hosted, the client side pooling may lead to problems where a connection to Service A is reused for Service B, resulting in an exception being thrown, the connection aborted, and a new channel created. To avoid this problem, use a CustomBinding and specify a different ConnectionPoolSettings.GroupName for each service the client communicates with.

Constructors

NetTcpBinding()

Initializes a new instance of the NetTcpBinding class.

NetTcpBinding(SecurityMode)

Initializes a new instance of the NetTcpBinding class with the type of security used specified.

NetTcpBinding(SecurityMode, Boolean)

Initializes a new instance of the NetTcpBinding class with the type of security used specified and with a value that indicates whether reliable sessions are explicitly enabled.

NetTcpBinding(String)

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

Properties

CloseTimeout

Gets or sets the interval of time provided for a connection to close before the transport raises an exception.

(Inherited from Binding)
EnvelopeVersion

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

HostNameComparisonMode

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

ListenBacklog

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

MaxBufferPoolSize

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

MaxBufferSize

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

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.

MaxReceivedMessageSize

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

MessageVersion

Gets the message version used by clients and services configured with the binding.

(Inherited from Binding)
Name

Gets or sets the name of the binding.

(Inherited from Binding)
Namespace

Gets or sets the XML namespace of the binding.

(Inherited from Binding)
OpenTimeout

Gets or sets the interval of time provided for a connection to open before the transport raises an exception.

(Inherited from Binding)
PortSharingEnabled

Gets or sets a value that indicates whether TCP port sharing is enabled for the connection configured with this binding.

ReaderQuotas

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

ReceiveTimeout

Gets or sets the interval of time that a connection can remain inactive, during which no application messages are received, before it is dropped.

(Inherited from Binding)
ReliableSession

Gets an object that indicates whether a reliable session is established between channel endpoints.

Scheme

Returns the URI scheme for the transport.

Security

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

SendTimeout

Gets or sets the interval of time provided for a write operation to complete before the transport raises an exception.

(Inherited from Binding)
TransactionFlow

Gets or sets a value that determines whether transaction flow is enabled.

TransactionProtocol

Gets or sets the transactions protocol used by the service to flow transactions.

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.

Methods

BuildChannelFactory<TChannel>(BindingParameterCollection)

Builds the channel factory stack on the client that creates a specified type of channel and that satisfies the features specified by a collection of binding parameters.

(Inherited from Binding)
BuildChannelFactory<TChannel>(Object[])

Builds the channel factory stack on the client that creates a specified type of channel and that satisfies the features specified by an object array.

(Inherited from Binding)
BuildChannelListener<TChannel>(BindingParameterCollection)

Builds the channel listener on the service that accepts a specified type of channel and that satisfies the features specified by a collection of binding parameters.

(Inherited from Binding)
BuildChannelListener<TChannel>(Object[])

Builds the channel listener on the service that accepts a specified type of channel and that satisfies the features specified.

(Inherited from Binding)
BuildChannelListener<TChannel>(Uri, BindingParameterCollection)

Builds the channel listener on the service that accepts a specified type of channel and that satisfies the features specified.

(Inherited from Binding)
BuildChannelListener<TChannel>(Uri, Object[])

Builds the channel listener on the service that accepts a specified type of channel and that satisfies the features specified.

(Inherited from Binding)
BuildChannelListener<TChannel>(Uri, String, BindingParameterCollection)

Builds the channel listener on the service that accepts a specified type of channel and that satisfies the features specified.

(Inherited from Binding)
BuildChannelListener<TChannel>(Uri, String, ListenUriMode, BindingParameterCollection)

Builds the channel listener on the service that accepts a specified type of channel and that satisfies the features specified.

(Inherited from Binding)
BuildChannelListener<TChannel>(Uri, String, ListenUriMode, Object[])

Builds the channel listener on the service that accepts a specified type of channel and that satisfies the features specified.

(Inherited from Binding)
BuildChannelListener<TChannel>(Uri, String, Object[])

Builds the channel listener on the service that accepts a specified type of channel and that satisfies the features specified.

(Inherited from Binding)
CanBuildChannelFactory<TChannel>(BindingParameterCollection)

Returns a value that indicates whether the current binding can build a channel factory stack on the client that satisfies the collection of binding parameters specified.

(Inherited from Binding)
CanBuildChannelFactory<TChannel>(Object[])

Returns a value that indicates whether the current binding can build a channel factory stack on the client that satisfies the requirements specified by an object array.

(Inherited from Binding)
CanBuildChannelListener<TChannel>(BindingParameterCollection)

Returns a value that indicates whether the current binding can build a channel listener stack on the service that satisfies the collection of binding parameters specified.

(Inherited from Binding)
CanBuildChannelListener<TChannel>(Object[])

Returns a value that indicates whether the current binding can build a channel listener stack on the service that satisfies the criteria specified in an array of objects.

(Inherited from Binding)
CreateBindingElements()

Creates a collection with the binding elements for the binding.

Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetProperty<T>(BindingParameterCollection)

Returns a typed object requested, if present, from the appropriate layer in the binding stack.

(Inherited from Binding)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ShouldSerializeListenBacklog()

Returns a value that indicates whether the ListenBacklog property has changed from its default value and should be serialized.

ShouldSerializeMaxConnections()

Returns a value that indicates whether the MaxConnections property has changed from its default value and should be serialized.

ShouldSerializeName()

Returns whether the name of the binding should be serialized.

(Inherited from Binding)
ShouldSerializeNamespace()

Returns whether the namespace of the binding should be serialized.

(Inherited from Binding)
ShouldSerializeReaderQuotas()

Returns a value that indicates whether the ReaderQuotas property has changed from its default value and should be serialized.

ShouldSerializeReliableSession()

Returns a value that indicates whether the ReliableSession property has changed from its default value and should be serialized.

ShouldSerializeSecurity()

Returns a value that indicates whether the Security property has changed from its default value and should be serialized.

ShouldSerializeTransactionProtocol()

Returns a value that indicates whether the TransactionProtocol property has changed from its default value and should be serialized.

ToString()

Returns a string that represents the current object.

(Inherited from Object)

Explicit Interface Implementations

IBindingRuntimePreferences.ReceiveSynchronously

Gets a value that indicates whether incoming requests are handled synchronously or asynchronously.

Applies to