This documentation is archived and is not being maintained.

TcpServerChannel Class

Provides an implementation for a server channel that uses the TCP protocol to transmit messages.

For a list of all members of this type, see TcpServerChannel Members.


[Visual Basic]
Public Class TcpServerChannel
   Implements IChannelReceiver, IChannel
public class TcpServerChannel : IChannelReceiver, IChannel
public __gc class TcpServerChannel : public IChannelReceiver,
public class TcpServerChannel implements IChannelReceiver, IChannel

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.


By default, the TcpServerChannel will accept either binary or SOAP formatted messages.

Channels transport messages between applications across remoting boundaries (for example application domains, processes, and machines). These crossings include both inbound and outbound. The current channel listens on an endpoint for inbound messages. TcpServerChannel converts the messages sent along using the TCP protocol from binary format into message objects.

If there are common language runtimes at both ends of the channel, then a session is created between the two ends, in order to connect the client and server sink chains on either side of the boundary together. The client part of the channel is located at the end of the client context sink chain. The server part of the channel is located at the start of the server context sink chain. Messages are delivered to the client channel, travel through it, and are received by an instance of the TcpServerChannel. The channel then delivers received and deserialized messages to the first server context sink.

IChannel implementations use channel configuration properties to configure the channel at run time. Channel properties can be specified in a configuration file, or programmatically, inside of an IDictionary. In a configuration file all values are represented by strings, but when building a property IDictionary programmatically, value types can be specified with their native values or with strings.

The following table shows the channel configuration properties that can be specified for the current channel.

Property Description
name Indicates the name of the channel. This property is used to retrieve a specific channel when calling GetChannel. If this property is not set, the system defaults to "http". If you want to register more than one HttpChannel, each must have a unique name. Set this property to the Empty string ("") if you want to ignore names, but avoid naming collisions. The system will allow any number of channels with the String.Empty name.
priority An integer representing the priority assigned to this channel. For server channels, the priority controls the order in which the channel data appears in an ObjRef. Clients will try to connect to the server channels in the order that they are listed in the ObjRef. The default priority is 1, and negative numbers are allowed. The default priority is 1, and negative numbers are allowed.
port An integer specifying the port on which the channel will listen. To request that the remoting system choose an open port on your behalf, specify port "0" (zero). This will create a TcpServerChannel instance to listen for requests on the dyamically assigned port. This is typically done on the client to make sure that a TcpServerChannel is listening for callback methods.
supressChannelData true or false. Specifies that the channel will not contribute to the ChannelData.
useIpAddress true or false. Specifies whether the channel will use the IP address in the publication URL instead of the computer name.
rejectRemoteRequests true or false. Specifies whether to refuse requests originating from other computers. Specifying true allows only inter- AppDomain calls on the local computer.
bindTo An IP address resolving to the current computer that specifies which NIC to bind the current channel to.
machineName A string that specifies the machine name used with the current channel. Overrides the useIpAddress configuration property and the machine name channel data.
exclusiveAddressUse true or false. Specifies whether the channel will prevent other applications from reusing the IP address/port combination by setting the SocketOptionName server socket option to SocketOptionName.ExclusiveAddressUse. The default is true.

This property is supported only by the .NET Framework version 1.1 on the following platforms: Windows NT 4.0 with SP4 or later, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family.

This property requires administrator privileges on platforms prior to the Windows Server 2003 family.


Namespace: System.Runtime.Remoting.Channels.Tcp

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

Assembly: System.Runtime.Remoting (in System.Runtime.Remoting.dll)

See Also

TcpServerChannel Members | System.Runtime.Remoting.Channels.Tcp Namespace