Export (0) Print
Expand All

NetTcpBinding Class

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

Namespace:  System.ServiceModel
Assemblies:   System.ServiceModel.NetTcp (in System.ServiceModel.NetTcp.dll)
  System.ServiceModel (in System.ServiceModel.dll)

public class NetTcpBinding : Binding

The NetTcpBinding type exposes the following members.

  NameDescription
Public methodSupported in .NET for Windows Store appsNetTcpBinding()Initializes a new instance of the NetTcpBinding class.
Public methodSupported in .NET for Windows Store appsNetTcpBinding(SecurityMode)Initializes a new instance of the NetTcpBinding class with the type of security used specified.
Public methodSupported in .NET for Windows Store appsNetTcpBinding(String)Initializes a new instance of the NetTcpBinding class with a specified configuration name.
Public methodNetTcpBinding(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

  NameDescription
Public propertySupported in .NET for Windows Store appsCloseTimeoutGets or sets the interval of time provided for a connection to close before the transport raises an exception. (Inherited from Binding.)
Public propertySupported in .NET for Windows Store appsEnvelopeVersionGets the version of SOAP that is used for messages processed by this binding.
Public propertyHostNameComparisonModeGets or sets a value that indicates whether the hostname is used to reach the service when matching the URI.
Public propertyListenBacklogGets or sets the maximum number of queued connection requests that can be pending.
Public propertySupported in .NET for Windows Store appsMaxBufferPoolSizeGets or sets the maximum size, in bytes, allowed for a buffer pool that stores TCP messages processed by the binding.
Public propertySupported in .NET for Windows Store appsMaxBufferSizeGets or sets a value that specifies the maximum size, in bytes, of the buffer used to store messages in memory.
Public propertyMaxConnectionsGets 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 propertySupported in .NET for Windows Store appsMaxReceivedMessageSizeGets or sets the maximum size, in bytes, for a received message that is processed by the binding.
Public propertySupported in .NET for Windows Store appsMessageVersionGets the message version used by clients and services configured with the binding. (Inherited from Binding.)
Public propertySupported in .NET for Windows Store appsNameGets or sets the name of the binding. (Inherited from Binding.)
Public propertySupported in .NET for Windows Store appsNamespaceGets or sets the XML namespace of the binding. (Inherited from Binding.)
Public propertySupported in .NET for Windows Store appsOpenTimeoutGets or sets the interval of time provided for a connection to open before the transport raises an exception. (Inherited from Binding.)
Public propertyPortSharingEnabledGets or sets a value that indicates whether TCP port sharing is enabled for the connection configured with this binding.
Public propertySupported in .NET for Windows Store appsReaderQuotasGets or sets constraints on the complexity of SOAP messages that can be processed by endpoints configured with this binding.
Public propertySupported in .NET for Windows Store appsReceiveTimeoutGets 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 propertyReliableSessionGets an object that indicates whether a reliable session is established between channel endpoints.
Public propertySupported in .NET for Windows Store appsSchemeReturns the URI scheme for the transport. (Overrides Binding.Scheme.)
Public propertySupported in .NET for Windows Store appsSecurityGets an object that specifies the type of security used with services configured with this binding.
Public propertySupported in .NET for Windows Store appsSendTimeoutGets or sets the interval of time provided for a write operation to complete before the transport raises an exception. (Inherited from Binding.)
Public propertyTransactionFlowGets or sets a value that determines whether transaction flow is enabled.
Public propertyTransactionProtocolGets or sets the transactions protocol used by the service to flow transactions.
Public propertySupported in .NET for Windows Store appsTransferModeGets or sets a value that indicates whether the service configured with the binding uses streamed or buffered (or both) modes of message transfer.
Top

  NameDescription
Public methodSupported in .NET for Windows Store appsBuildChannelFactory<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 methodSupported in .NET for Windows Store appsBuildChannelFactory<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 methodBuildChannelListener<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 methodBuildChannelListener<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 methodBuildChannelListener<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 methodBuildChannelListener<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 methodBuildChannelListener<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 methodBuildChannelListener<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 methodBuildChannelListener<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 methodBuildChannelListener<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 methodSupported in .NET for Windows Store appsCanBuildChannelFactory<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 methodSupported in .NET for Windows Store appsCanBuildChannelFactory<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 methodCanBuildChannelListener<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 methodCanBuildChannelListener<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 methodSupported in .NET for Windows Store appsCreateBindingElementsCreates a collection with the binding elements for the binding. (Overrides Binding.CreateBindingElements().)
Public methodSupported in .NET for Windows Store appsEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodSupported in .NET for Windows Store appsFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported in .NET for Windows Store appsGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodSupported in .NET for Windows Store appsGetProperty<T>Returns a typed object requested, if present, from the appropriate layer in the binding stack. (Inherited from Binding.)
Public methodSupported in .NET for Windows Store appsGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodSupported in .NET for Windows Store appsMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodShouldSerializeListenBacklogReturns a value that indicates whether the ListenBacklog property has changed from its default value and should be serialized.
Public methodShouldSerializeMaxConnectionsReturns a value that indicates whether the MaxConnections property has changed from its default value and should be serialized.
Public methodShouldSerializeNameReturns whether the name of the binding should be serialized. (Inherited from Binding.)
Public methodShouldSerializeNamespaceReturns whether the namespace of the binding should be serialized. (Inherited from Binding.)
Public methodShouldSerializeReaderQuotasReturns a value that indicates whether the ReaderQuotas property has changed from its default value and should be serialized.
Public methodShouldSerializeReliableSessionReturns a value that indicates whether the ReliableSession property has changed from its default value and should be serialized.
Public methodShouldSerializeSecurityReturns a value that indicates whether the Security property has changed from its default value and should be serialized.
Public methodShouldSerializeTransactionProtocolReturns a value that indicates whether the TransactionProtocol property has changed from its default value and should be serialized.
Public methodSupported in .NET for Windows Store appsToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Explicit interface implemetationPrivate propertyIBindingRuntimePreferences.ReceiveSynchronouslyGets 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 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.

Caution noteCaution

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.

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;

.NET Framework

Supported in: 4.6, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

.NET for Windows Store apps

Supported in: Windows 8

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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.
Show:
© 2014 Microsoft