This topic has not yet been rated - Rate this topic

TcpTransportBindingElement Class

Represents the binding element for the TCP transport.

Namespace:  System.ServiceModel.Channels
Assembly:  System.ServiceModel (in System.ServiceModel.dll)
public class TcpTransportBindingElement : ConnectionOrientedTransportBindingElement

The TcpTransportBindingElement type exposes the following members.

  Name Description
Public method TcpTransportBindingElement() Initializes a new instance of the TcpTransportBindingElement class.
Protected method TcpTransportBindingElement(TcpTransportBindingElement) Initializes a new instance of the TcpTransportBindingElement class.
Top
  Name Description
Public property ChannelInitializationTimeout Gets or sets the time limit for initializing a channel to be accepted. (Inherited from ConnectionOrientedTransportBindingElement.)
Public property ConnectionBufferSize Gets or 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 property ConnectionPoolSettings Gets a collection of connection pool settings.
Public property ExtendedProtectionPolicy Gets or sets the current extended protection policy.
Public property HostNameComparisonMode Gets or sets a value that indicates whether the hostname is used to reach the service when matching on the URI. (Inherited from ConnectionOrientedTransportBindingElement.)
Public property ListenBacklog Gets or sets the maximum number of queued connection requests that can be pending.
Public property ManualAddressing Gets or sets a value that indicates whether manual addressing of the message is required. (Inherited from TransportBindingElement.)
Public property MaxBufferPoolSize Gets or sets the maximum size of any buffer pools used by the transport. (Inherited from TransportBindingElement.)
Public property MaxBufferSize Gets or sets the maximum size of the buffer to use. For streamed messages, this value should be at least the maximum possible size of the message headers, which are read in buffered mode. (Inherited from ConnectionOrientedTransportBindingElement.)
Public property MaxOutputDelay Gets 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 property MaxPendingAccepts Gets or sets the maximum number of pending asynchronous accept operations that are available for processing incoming connections to the service. (Inherited from ConnectionOrientedTransportBindingElement.)
Public property MaxPendingConnections Gets or sets the maximum number of connections awaiting dispatch on the service. (Inherited from ConnectionOrientedTransportBindingElement.)
Public property MaxReceivedMessageSize Gets and sets the maximum allowable message size that can be received. (Inherited from TransportBindingElement.)
Public property PortSharingEnabled Gets or sets a value that indicates whether TCP port sharing is enabled for this connection.
Public property Scheme Returns the URI scheme for the transport. (Overrides TransportBindingElement.Scheme.)
Public property TeredoEnabled Gets or sets a Boolean that specifies whether Teredo (a technology for addressing clients that are behind firewalls) is enabled.
Public property TransferMode Gets or sets a value that indicates whether the messages are buffered or streamed with the connection-oriented transport. (Inherited from ConnectionOrientedTransportBindingElement.)
Top
  Name Description
Public method BuildChannelFactory<TChannel> Creates a channel factory that can be used to create a channel. (Overrides BindingElement.BuildChannelFactory<TChannel>(BindingContext).)
Public method BuildChannelListener<TChannel> Creates a channel listener of the specified type. (Overrides BindingElement.BuildChannelListener<TChannel>(BindingContext).)
Public method CanBuildChannelFactory<TChannel> Determines whether a channel factory of the specified type can be built. (Inherited from ConnectionOrientedTransportBindingElement.)
Public method CanBuildChannelListener<TChannel> Determines whether a channel listener of the specified type can be built. (Inherited from ConnectionOrientedTransportBindingElement.)
Public method Clone Creates a copy of the current binding element. (Overrides BindingElement.Clone().)
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> Gets a specified object from the BindingContext. (Overrides ConnectionOrientedTransportBindingElement.GetProperty<T>(BindingContext).)
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 ShouldSerializeExtendedProtectionPolicy Returns an indication that the extended protection policy is not XAML serializable.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
  Name Description
Explicit interface implemetation Private method IPolicyExportExtension.ExportPolicy Exports a custom policy assertion about bindings. (Inherited from ConnectionOrientedTransportBindingElement.)
Explicit interface implemetation Private method IWsdlExportExtension.ExportContract Writes custom Web Services Description Language (WSDL) elements into the generated WSDL for a contract. (Inherited from ConnectionOrientedTransportBindingElement.)
Explicit interface implemetation Private method IWsdlExportExtension.ExportEndpoint Writes custom Web Services Description Language (WSDL) elements into the generated WSDL for an endpoint. (Inherited from ConnectionOrientedTransportBindingElement.)
Top

This transport uses URIs of the form "net.tcp://hostname:port/path". Other URI components are optional.

The TcpTransportBindingElement class is the starting point for creating a custom binding that implements the TCP transport protocol. This transport is optimized for -to- communication.

The service model uses this class to create factory objects that implement the IChannelFactory and IChannelListener interfaces. These factory objects, in turn, create and accept the channels that transmit SOAP messages using the TCP protocol.

You configure the factories that this class creates by setting its properties, such as PortSharingEnabled and LeaseTimeout.

You can also set properties on the base class ConnectionOrientedTransportBindingElement, such as MaxBufferSize, TransferMode, and ConnectionBufferSize. For a complete list of properties, see ConnectionOrientedTransportBindingElement.

Finally, you can set properties on the base class TransportBindingElement, such as ManualAddressing and MaxBufferPoolSize. For a complete list of properties, see TransportBindingElement.

The following example shows how to use this class.


TcpTransportBindingElement bElement =
    new TcpTransportBindingElement();

TcpConnectionPoolSettings connectionPoolSettings =
    bElement.ConnectionPoolSettings;


.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