TcpServerChannel Class

Definition

Namespace:

System.Runtime.Remoting.Channels.Tcp

Assembly:

System.Runtime.Remoting.dll

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

public ref class TcpServerChannel : System::Runtime::Remoting::Channels::IChannelReceiver, System::Runtime::Remoting::Channels::ISecurableChannel

public class TcpServerChannel : System.Runtime.Remoting.Channels.IChannelReceiver, System.Runtime.Remoting.Channels.ISecurableChannel

type TcpServerChannel = class
    interface IChannelReceiver
    interface IChannel
    interface ISecurableChannel

Public Class TcpServerChannel
Implements IChannelReceiver, ISecurableChannel

Inheritance

Object

TcpServerChannel

Implements

IChannel IChannelReceiver ISecurableChannel

Examples

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
{
private:
   int callCount;

public:
   Remotable()
      : callCount( 0 )
   {}

   int GetCount()
   {
      callCount++;
      return (callCount);
   }
};

using System;
using System.Runtime.Remoting;

public class Remotable : MarshalByRefObject
{

    private int callCount = 0;

    public int GetCount()
    {
        callCount++;
        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..." );
   Console::ReadLine();
}

using System;
using System.Runtime.Remoting;
using System.Runtime.Remoting.Channels;
using System.Runtime.Remoting.Channels.Tcp;

public class Server
{
    public static void Main()
    {

        // Set up a server channel.
        TcpServerChannel serverChannel = new TcpServerChannel(9090);
        ChannelServices.RegisterChannel(serverChannel);

        // Expose an object for remote calls.
        RemotingConfiguration.RegisterWellKnownServiceType(
            typeof(Remotable), "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 = (ChannelDataStore) serverChannel.ChannelData;
        foreach (string uri in data.ChannelUris)
        {
            Console.WriteLine(uri);
        }

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

Remarks

Important

Calling methods from this class with untrusted data is a security risk. Call the methods from this class only with trusted data. For more information, see Validate All Inputs.

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.

Constructors

TcpServerChannel(IDictionary, IServerChannelSinkProvider, IAuthorizeRemotingConnection)	Initializes a new instance of the TcpServerChannel class with the specified channel properties, sink, and authorization provider.
TcpServerChannel(IDictionary, IServerChannelSinkProvider)	Initializes a new instance of the TcpServerChannel class with the specified channel properties and sink.
TcpServerChannel(Int32)	Initializes a new instance of the TcpServerChannel class that listens on the specified port.
TcpServerChannel(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.
TcpServerChannel(String, Int32)	Initializes a new instance of the TcpServerChannel class with the given name and that listens on the specified port.

Properties

ChannelData	Gets channel-specific data.
ChannelName	Gets the name of the current channel.
ChannelPriority	Gets the priority of the current channel.
IsSecured	Gets or sets a Boolean value that indicates whether the current channel is secure.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetChannelUri()	Returns the URI of the current channel.
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
GetUrlsForUri(String)	Returns an array of all the URLs for an object with the specified URI, hosted on the current TcpChannel instance.
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
Parse(String, String)	Extracts the channel URI and the remote well-known object URI from the specified URL.
StartListening(Object)	Instructs the current channel to start listening on a channel after the StopListening(Object) method has been called to stop listening on the channel.
StopListening(Object)	Instructs the current channel to stop listening for requests.
ToString()	Returns a string that represents the current object. (Inherited from Object)