TcpServerChannel Class


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Implements a server channel for remote calls that uses the TCP protocol to transmit messages.

Namespace:   System.Runtime.Remoting.Channels.Tcp
Assembly:  System.Runtime.Remoting (in System.Runtime.Remoting.dll)


public ref class TcpServerChannel : IChannelReceiver, IChannel, 

System_CAPS_pubmethodTcpServerChannel(IDictionary^, IServerChannelSinkProvider^)

Initializes a new instance of the TcpServerChannel class with the specified channel properties and sink.

System_CAPS_pubmethodTcpServerChannel(IDictionary^, IServerChannelSinkProvider^, IAuthorizeRemotingConnection^)

Initializes a new instance of the TcpServerChannel class with the specified channel properties, sink, and authorization provider.


Initializes a new instance of the TcpServerChannel class that listens on the specified port.

System_CAPS_pubmethodTcpServerChannel(String^, Int32)

Initializes a new instance of the TcpServerChannel class with the given name and that listens on the specified port.

System_CAPS_pubmethodTcpServerChannel(String^, Int32, IServerChannelSinkProvider^)

Initializes a new instance of the TcpServerChannel class with the given name, which listens on the specified port, and uses the specified sink.


Gets channel-specific data.


Gets the name of the current channel.


Gets the priority of the current channel.


Gets or sets a Boolean value that indicates whether the current channel is secure.


Determines whether the specified object is equal to the current object.(Inherited from Object.)


Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)


Returns the URI of the current channel.


Serves as the default hash function. (Inherited from Object.)


Gets the Type of the current instance.(Inherited from Object.)


Returns an array of all the URLs for an object with the specified URI, hosted on the current TcpChannel instance.


Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodParse(String^, String^%)

Extracts the channel URI and the remote well-known object URI from the specified URL.


Instructs the current channel to start listening for requests.


Instructs the current channel to stop listening for requests.


Returns a string that represents the current object.(Inherited from Object.)

Channels transport messages across remoting boundaries (for example, computers or application domains). The TcpServerChannel class transports messages using the TCP protocol.

Channels are used by the .NET Framework remoting infrastructure to transport remote calls. When a client makes a call to a remote object, the call is serialized into a message that is sent by a client channel and received by a server channel. It is then deserialized and processed. Any returned values are transmitted by the server channel and received by the client channel.

To perform additional processing of messages on the server side, you can specify an implementation of the IServerChannelSinkProvider interface through which all messages processed by the TcpServerChannel instance are passed.

The TcpServerChannel instance accepts messages serialized in either binary or SOAP format.

A TcpServerChannel object has associated configuration properties that can be set at run time either in a configuration file (by invoking the static RemotingConfiguration::Configure method) or programmatically (by passing a IDictionary collection to the TcpServerChannel constructor). For a list of these configuration properties, see Channel and Formatter Configuration Properties.


If the server computer is running Windows 95/98/Me, the TcpServerChannel cannot be specified as secure.

The following code example shows the use of a remotable type.

using namespace System;
using namespace System::Runtime::Remoting;

public ref class Remotable: public MarshalByRefObject
   int callCount;

      : callCount( 0 )

   int GetCount()
      return (callCount);

The following code example shows the use of the TcpServerChannel class to expose a remotable type.

#using <System.Runtime.Remoting.dll>
#using <System.dll>
#using <Remotable.dll>

using namespace System;
using namespace System::Runtime::Remoting;
using namespace System::Runtime::Remoting::Channels;
using namespace System::Runtime::Remoting::Channels::Tcp;

int main()
   // Set up a server channel.
   TcpServerChannel^ serverChannel = gcnew TcpServerChannel( 9090 );
   ChannelServices::RegisterChannel( serverChannel );

   // Expose an object for remote calls.
   RemotingConfiguration::RegisterWellKnownServiceType( Remotable::typeid, "Remotable.rem", WellKnownObjectMode::Singleton );

   // Show the name and priority of the channel.
   Console::WriteLine( "Channel Name: {0}", serverChannel->ChannelName );
   Console::WriteLine( "Channel Priority: {0}", serverChannel->ChannelPriority );

   // Show the URIs associated with the channel.
   ChannelDataStore^ data = dynamic_cast<ChannelDataStore^>(serverChannel->ChannelData);
   System::Collections::IEnumerator^ myEnum = data->ChannelUris->GetEnumerator();
   while ( myEnum->MoveNext() )
      String^ uri = safe_cast<String^>(myEnum->Current);
      Console::WriteLine( uri );

   // Wait for method calls.
   Console::WriteLine( "Listening..." );

.NET Framework
Available since 1.1

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

Return to top