Export (0) Print
Expand All

TcpServerChannel Class

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

System::Object
  System.Runtime.Remoting.Channels.Tcp::TcpServerChannel

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

public ref class TcpServerChannel : IChannelReceiver, 
	IChannel, ISecurableChannel

The TcpServerChannel type exposes the following members.

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

  NameDescription
Public propertyChannelDataGets channel-specific data.
Public propertyChannelNameGets the name of the current channel.
Public propertyChannelPriorityGets the priority of the current channel.
Public propertyIsSecuredGets or sets a Boolean value that indicates whether the current channel is secure.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetChannelUriReturns the URI of the current channel.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetUrlsForUriReturns an array of all the URLs for an object with the specified URI, hosted on the current TcpChannel instance.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodParseExtracts the channel URI and the remote well-known object URI from the specified URL.
Public methodStartListeningInstructs the current channel to start listening for requests.
Public methodStopListeningInstructs the current channel to stop listening for requests.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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.

NoteNote

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

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

   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();
}

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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