Home Library Learn Downloads Support Community
Sign in | United States - English | |
2 out of 2 rated this helpful - Rate this topic

NetTcpBinding Class

.NET Framework 4

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

System.Object
  System.ServiceModel.Channels.Binding
    System.ServiceModel.NetTcpBinding
      System.ServiceModel.NetTcpContextBinding

Namespace:  System.ServiceModel
Assembly:  System.ServiceModel (in System.ServiceModel.dll)
C#
C++
F#
VB
Copy 
public class NetTcpBinding : Binding, 
	IBindingRuntimePreferences

The NetTcpBinding type exposes the following members.

  Name Description
Public method NetTcpBinding() Initializes a new instance of the NetTcpBinding class.
Public method NetTcpBinding(SecurityMode) Initializes a new instance of the NetTcpBinding class with the type of security used specified.
Public method NetTcpBinding(String) Initializes a new instance of the NetTcpBinding class with a specified configuration name.
Public method 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.
Top
  Name Description
Public property CloseTimeout Gets or sets the interval of time provided for a connection to close before the transport raises an exception. (Inherited from Binding.)
Public property EnvelopeVersion Gets the version of SOAP that is used for messages processed by this binding.
Public property HostNameComparisonMode Gets or sets a value that indicates whether the hostname is used to reach the service when matching the URI.
Public property ListenBacklog Gets or sets the maximum number of queued connection requests that can be pending.
Public property MaxBufferPoolSize Gets or sets the maximum size allowed for a buffer pool that stores TCP messages processed by the binding.
Public property MaxBufferSize Gets or sets a value that specifies the maximum size, in bytes, of the buffer used to store messages in memory.
Public property 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 property MaxReceivedMessageSize Gets or sets the maximum size for a received message that is processed by the binding.
Public property MessageVersion Gets the message version used by clients and services configured with the binding. (Inherited from Binding.)
Public property Name Gets or sets the name of the binding. (Inherited from Binding.)
Public property Namespace Gets or sets the XML namespace of the binding. (Inherited from Binding.)
Public property OpenTimeout Gets or sets the interval of time provided for a connection to open before the transport raises an exception. (Inherited from Binding.)
Public property PortSharingEnabled Gets or sets a value that indicates whether TCP port sharing is enabled for the connection configured with this binding.
Public property ReaderQuotas Gets or sets constraints on the complexity of SOAP messages that can be processed by endpoints configured with this binding.
Public property 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.)
Public property ReliableSession Gets an object that indicates whether a reliable session is established between channel endpoints.
Public property Scheme Returns the URI scheme for the transport. (Overrides Binding.Scheme.)
Public property Security Gets an object that specifies the type of security used with services configured with this binding.
Public property SendTimeout Gets or sets the interval of time provided for a write operation to complete before the transport raises an exception. (Inherited from Binding.)
Public property TransactionFlow Gets or sets a value that determines whether transaction flow is enabled.
Public property TransactionProtocol Gets or sets the transactions protocol used by the service to flow transactions.
Public property 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.
Top
  Name Description
Public method 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.)
Public method 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.)
Public method 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.)
Public method 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.)
Public method 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.)
Public method 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.)
Public method 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.)
Public method 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.)
Public method 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.)
Public method 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.)
Public method 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.)
Public method 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.)
Public method 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.)
Public method 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.)
Public method CreateBindingElements Creates a collection with the binding elements for the binding. (Overrides Binding.CreateBindingElements().)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetProperty<T> Returns a typed object requested, if present, from the appropriate layer in the binding stack. (Inherited from Binding.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ShouldSerializeName Returns whether the name of the binding should be serialized. (Inherited from Binding.)
Public method ShouldSerializeNamespace Returns whether the namespace of the binding should be serialized. (Inherited from Binding.)
Public method ShouldSerializeReaderQuotas Returns a value that indicates whether the ReaderQuotas property has changed from its default value and should be serialized.
Public method ShouldSerializeReliableSession Returns a value that indicates whether the ReliableSession property has changed from its default value and should be serialized.
Public method ShouldSerializeSecurity Returns a value that indicates whether the Security property has changed from its default value and should be serialized.
Public method ShouldSerializeTransactionProtocol Returns a value that indicates whether the TransactionProtocol property has changed from its default value and should be serialized.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
  Name Description
Explicit interface implemetation Private property IBindingRuntimePreferences.ReceiveSynchronously Gets a value that indicates whether incoming requests are handled synchronously or asynchronously.
Top

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 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 -to- 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.

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

C#
Copy 

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

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ
VB.Net version of the C# example for creating a NetTcpBinding, setting the security mode & transport
This example shows how to create a NetTcpBinding, setting the security mode and transport credential type.

Dim binding As New NetTcpBinding()
binding.Security.Mode = SecurityMode.Transport
binding.Security.Transport.ClientCredentialType = TcpClientCredentialType.Certificate
History
NetTcpBinding pools TCP connections

Load Balancing the Net.TCP Binding

The NetTcpBinding can be load balanced using IP-layer load balancing techniques. However, the NetTcpBinding pools TCP connections by default to reduce connection latency. This is an optimization that interferes with the basic mechanism of load balancing. The primary configuration value for optimizing the NetTcpBinding is the lease timeout, which is part of the Connection Pool Settings. Connection pooling causes client connections to become associated to specific servers within the farm. As the lifetime of those connections increase (a factor controlled by the lease timeout setting), the load distribution across various servers in the farm becomes unbalanced. As a result the average call time increases. So when using theNetTcpBinding in load-balanced scenarios, consider reducing the default lease timeout used by the binding. A 30-second lease timeout is a reasonable starting point for load-balanced scenarios, although the optimal value is application-dependent. For more information about the channel lease timeout and other transport quotas, see Transport Quotas.

For best performance in load-balanced scenarios, consider using NetTcpSecurity (either Transport or TransportWithMessageCredential).
History