mcs/class/System.Runtime.Remoting/Documentation/en/System.Runtime.Remoting.Channels.Tcp/TcpChannel.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="TcpChannel" FullName="System.Runtime.Remoting.Channels.Tcp.TcpChannel">
   3   <TypeSignature Language="C#" Maintainer="auto" Value="public class TcpChannel : System.Runtime.Remoting.Channels.IChannelReceiver, System.Runtime.Remoting.Channels.IChannelSender" />
   4   <AssemblyInfo>
   5     <AssemblyName>System.Runtime.Remoting</AssemblyName>
   6     <AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00]</AssemblyPublicKey>
   7     <AssemblyVersion>1.0.3300.0</AssemblyVersion>
   8     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
   9     <AssemblyVersion>2.0.0.0</AssemblyVersion>
  10   </AssemblyInfo>
  11   <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the &lt;link location="node:gtk-sharp/programming/threads"&gt;Gtk# Thread Programming&lt;/link&gt; for details.</ThreadSafetyStatement>
  12   <Base>
  13     <BaseTypeName>System.Object</BaseTypeName>
  14   </Base>
  15   <Interfaces>
  16     <Interface>
  17       <InterfaceName>System.Runtime.Remoting.Channels.IChannelReceiver</InterfaceName>
  18     </Interface>
  19     <Interface>
  20       <InterfaceName>System.Runtime.Remoting.Channels.IChannelSender</InterfaceName>
  21     </Interface>
  22   </Interfaces>
  23   <Docs>
  24     <remarks>
  25       <attribution license="cc4" from="Microsoft" modified="false" />
  26       <para>Channels transport messages across remoting boundaries (for example, between computers on application domains). The <see cref="T:System.Runtime.Remoting.Channels.Tcp.TcpChannel" /> class is a convenience class combining the functionality of the <see cref="T:System.Runtime.Remoting.Channels.Tcp.TcpClientChannel" /> class and the <see cref="T:System.Runtime.Remoting.Channels.Tcp.TcpServerChannel" /> class.</para>
  27       <para>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.</para>
  28       <para>To perform additional processing of messages, you can specify implementations of the <see cref="T:System.Runtime.Remoting.Channels.IClientChannelSinkProvider" /> and <see cref="T:System.Runtime.Remoting.Channels.IServerChannelSinkProvider" /> through which all messages processed by the <see cref="T:System.Runtime.Remoting.Channels.Tcp.TcpChannel" /> are passed.</para>
  29       <para>A <see cref="T:System.Runtime.Remoting.Channels.Tcp.TcpChannel" /> object has associated configuration properties that can be set at run time either in a configuration file (by invoking the static <see cref="M:System.Runtime.Remoting.RemotingConfiguration.Configure(System.String)" /> method) or programmatically (by passing a <see cref="T:System.Collections.IDictionary" /> collection to the <see cref="M:System.Runtime.Remoting.Channels.Tcp.TcpChannel.#ctor" /> constructor). For more information about channel configuration properties, see <format type="text/html"><a href="226ecf74-ebbd-4ea0-a701-dcf4441deefe">Channel and Formatter Configuration Properties</a></format>.</para>
  30       <block subset="none" type="note">
  31         <para>If the server computer is running Windows 95/98/Me, the server <see cref="T:System.Runtime.Remoting.Channels.Tcp.TcpChannel" /> cannot be specified as secure.</para>
  32       </block>
  33     </remarks>
  34     <summary>
  35       <attribution license="cc4" from="Microsoft" modified="false" />
  36       <para>Provides a channel implementation that uses the TCP protocol to transmit messages.</para>
  37     </summary>
  38   </Docs>
  39   <Members>
  40     <Member MemberName=".ctor">
  41       <MemberSignature Language="C#" Value="public TcpChannel ();" />
  42       <MemberType>Constructor</MemberType>
  43       <ReturnValue />
  44       <Parameters />
  45       <Docs>
  46         <remarks>
  47           <attribution license="cc4" from="Microsoft" modified="false" />
  48           <para>The default constructor initializes all fields to their default values. If the default constructor is used, the channel functions only as a client channel, and does not listen on any ports.</para>
  49         </remarks>
  50         <summary>
  51           <attribution license="cc4" from="Microsoft" modified="false" />
  52           <para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.Channels.Tcp.TcpChannel" /> class, activating only a client channel, and not a server channel.</para>
  53         </summary>
  54       </Docs>
  55       <AssemblyInfo>
  56         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  57         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  58       </AssemblyInfo>
  59     </Member>
  60     <Member MemberName=".ctor">
  61       <MemberSignature Language="C#" Value="public TcpChannel (int port);" />
  62       <MemberType>Constructor</MemberType>
  63       <ReturnValue />
  64       <Parameters>
  65         <Parameter Name="port" Type="System.Int32" />
  66       </Parameters>
  67       <Docs>
  68         <remarks>
  69           <attribution license="cc4" from="Microsoft" modified="false" />
  70           <para>To request that the remoting system choose an open port on your behalf, specify port 0 (zero). This will create a <see cref="T:System.Runtime.Remoting.Channels.Tcp.TcpServerChannel" /> instance to listen for requests on the dynamically assigned port. This is typically done on the client to make sure that a <see cref="T:System.Runtime.Remoting.Channels.Tcp.TcpServerChannel" /> is listening for callback methods.</para>
  71           <para>If 0 is passed to the constructor the <see cref="T:System.Runtime.Remoting.Channels.Tcp.TcpChannel" /> is instantiated to use a free port.</para>
  72         </remarks>
  73         <summary>
  74           <attribution license="cc4" from="Microsoft" modified="false" />
  75           <para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.Channels.Tcp.TcpChannel" /> class with a server channel that listens on the specified port.</para>
  76         </summary>
  77         <param name="port">
  78           <attribution license="cc4" from="Microsoft" modified="false" />The port on which the server channel listens. </param>
  79       </Docs>
  80       <AssemblyInfo>
  81         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  82         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  83       </AssemblyInfo>
  84     </Member>
  85     <Member MemberName=".ctor">
  86       <MemberSignature Language="C#" Value="public TcpChannel (System.Collections.IDictionary properties, System.Runtime.Remoting.Channels.IClientChannelSinkProvider clientSinkProvider, System.Runtime.Remoting.Channels.IServerChannelSinkProvider serverSinkProvider);" />
  87       <MemberType>Constructor</MemberType>
  88       <ReturnValue />
  89       <Parameters>
  90         <Parameter Name="properties" Type="System.Collections.IDictionary" />
  91         <Parameter Name="clientSinkProvider" Type="System.Runtime.Remoting.Channels.IClientChannelSinkProvider" />
  92         <Parameter Name="serverSinkProvider" Type="System.Runtime.Remoting.Channels.IServerChannelSinkProvider" />
  93       </Parameters>
  94       <Docs>
  95         <remarks>
  96           <attribution license="cc4" from="Microsoft" modified="false" />
  97           <para>For more information about channel configuration properties, see <format type="text/html"><a href="226ecf74-ebbd-4ea0-a701-dcf4441deefe">Channel and Formatter Configuration Properties</a></format>.</para>
  98           <block subset="none" type="note">
  99             <para>If the server computer is running Windows 95/98/Me, the server <see cref="T:System.Runtime.Remoting.Channels.Tcp.TcpChannel" /> cannot be specified as secure.</para>
 100           </block>
 101           <para>Channel sinks provide a plug-in point that allows access to the underlying messages flowing through the channel as well as the stream used by the transport mechanism to send messages to a remote object. Channel sinks are also responsible for transporting messages between the client and the server. Channel sinks are linked together in a chain, and all channel messages flow through this chain of sinks before the message is finally serialized and transported. If you do not require sink functionality, set the <paramref name="clientSinkProvider" /> and <paramref name="serverSinkProvider" /> parameters to null.</para>
 102         </remarks>
 103         <summary>
 104           <attribution license="cc4" from="Microsoft" modified="false" />
 105           <para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.Channels.Tcp.TcpChannel" /> class with the specified configuration properties and sinks.</para>
 106         </summary>
 107         <param name="properties">
 108           <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Collections.IDictionary" /> collection that specifies values for configuration properties to be used by the client and server channels. </param>
 109         <param name="clientSinkProvider">
 110           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Runtime.Remoting.Channels.IClientChannelSinkProvider" /> implementation to be used by the client channel. </param>
 111         <param name="serverSinkProvider">
 112           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Runtime.Remoting.Channels.IServerChannelSinkProvider" /> implementation to be used by the server channel. </param>
 113       </Docs>
 114       <AssemblyInfo>
 115         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 116         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 117       </AssemblyInfo>
 118     </Member>
 119     <Member MemberName="ChannelData">
 120       <MemberSignature Language="C#" Value="public object ChannelData { get; }" />
 121       <MemberType>Property</MemberType>
 122       <ReturnValue>
 123         <ReturnType>System.Object</ReturnType>
 124       </ReturnValue>
 125       <Docs>
 126         <value>To be added: an object of type 'object'</value>
 127         <remarks>
 128           <attribution license="cc4" from="Microsoft" modified="false" />
 129           <para>Although returned as an instance of <see cref="T:System.Object" />, the value of this property can be cast to an instance of <see cref="T:System.Runtime.Remoting.Channels.ChannelDataStore" /> describing the channel to which the <see cref="T:System.Runtime.Remoting.Channels.Http.HttpServerChannel" /> object listens.</para>
 130         </remarks>
 131         <summary>
 132           <attribution license="cc4" from="Microsoft" modified="false" />
 133           <para>Gets the channel-specific data.</para>
 134         </summary>
 135       </Docs>
 136       <AssemblyInfo>
 137         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 138         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 139       </AssemblyInfo>
 140     </Member>
 141     <Member MemberName="ChannelName">
 142       <MemberSignature Language="C#" Value="public string ChannelName { get; }" />
 143       <MemberType>Property</MemberType>
 144       <ReturnValue>
 145         <ReturnType>System.String</ReturnType>
 146       </ReturnValue>
 147       <Docs>
 148         <value>To be added: an object of type 'string'</value>
 149         <remarks>
 150           <attribution license="cc4" from="Microsoft" modified="false" />
 151           <para>Every registered channel has a unique name. The name is used to retrieve a specific channel when calling <see cref="M:System.Runtime.Remoting.Channels.ChannelServices.GetChannel(System.String)" />. To set the <see cref="P:System.Runtime.Remoting.Channels.Tcp.TcpChannel.ChannelName" /> property, assign the value to the "name" indexed property in the dictionary passed to the <see cref="M:System.Runtime.Remoting.Channels.Tcp.TcpChannel.#ctor(System.Collections.IDictionary,System.Runtime.Remoting.Channels.IClientChannelSinkProvider,System.Runtime.Remoting.Channels.IServerChannelSinkProvider)" /> constructor.</para>
 152         </remarks>
 153         <summary>
 154           <attribution license="cc4" from="Microsoft" modified="false" />
 155           <para>Gets the name of the current channel.</para>
 156         </summary>
 157       </Docs>
 158       <AssemblyInfo>
 159         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 160         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 161       </AssemblyInfo>
 162     </Member>
 163     <Member MemberName="ChannelPriority">
 164       <MemberSignature Language="C#" Value="public int ChannelPriority { get; }" />
 165       <MemberType>Property</MemberType>
 166       <ReturnValue>
 167         <ReturnType>System.Int32</ReturnType>
 168       </ReturnValue>
 169       <Docs>
 170         <value>To be added: an object of type 'int'</value>
 171         <remarks>To be added</remarks>
 172         <summary>
 173           <attribution license="cc4" from="Microsoft" modified="false" />
 174           <para>Gets the priority of the current channel.</para>
 175         </summary>
 176       </Docs>
 177       <AssemblyInfo>
 178         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 179         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 180       </AssemblyInfo>
 181     </Member>
 182     <Member MemberName="CreateMessageSink">
 183       <MemberSignature Language="C#" Value="public System.Runtime.Remoting.Messaging.IMessageSink CreateMessageSink (string url, object remoteChannelData, out string objectURI);" />
 184       <MemberType>Method</MemberType>
 185       <ReturnValue>
 186         <ReturnType>System.Runtime.Remoting.Messaging.IMessageSink</ReturnType>
 187       </ReturnValue>
 188       <Parameters>
 189         <Parameter Name="url" Type="System.String" />
 190         <Parameter Name="remoteChannelData" Type="System.Object" />
 191         <Parameter Name="objectURI" Type="System.String&amp;" RefType="out" />
 192       </Parameters>
 193       <Docs>
 194         <param name="url">To be added: an object of type 'string'</param>
 195         <param name="remoteChannelData">To be added: an object of type 'object'</param>
 196         <param name="objectURI">To be added: an object of type 'string&amp;'</param>
 197         <summary>To be added</summary>
 198         <returns>To be added: an object of type 'Runtime.Remoting.Messaging.IMessageSink'</returns>
 199         <remarks>To be added</remarks>
 200       </Docs>
 201       <AssemblyInfo>
 202         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 203         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 204       </AssemblyInfo>
 205     </Member>
 206     <Member MemberName="GetUrlsForUri">
 207       <MemberSignature Language="C#" Value="public string[] GetUrlsForUri (string uri);" />
 208       <MemberType>Method</MemberType>
 209       <ReturnValue>
 210         <ReturnType>System.String[]</ReturnType>
 211       </ReturnValue>
 212       <Parameters>
 213         <Parameter Name="uri" Type="System.String" />
 214       </Parameters>
 215       <Docs>
 216         <param name="uri">To be added: an object of type 'string'</param>
 217         <remarks>
 218           <attribution license="cc4" from="Microsoft" modified="false" />
 219           <para>This method is used by <see cref="M:System.Runtime.Remoting.Channels.ChannelServices.GetUrlsForObject(System.MarshalByRefObject)" />.</para>
 220         </remarks>
 221         <summary>
 222           <attribution license="cc4" from="Microsoft" modified="false" />
 223           <para>Returns an array of all the URLs for an object with the specified URI, hosted on the current <see cref="T:System.Runtime.Remoting.Channels.Tcp.TcpChannel" />.</para>
 224         </summary>
 225         <returns>
 226           <attribution license="cc4" from="Microsoft" modified="false" />
 227           <para>An array of the URLs for an object with the specified URI, hosted on the current <see cref="T:System.Runtime.Remoting.Channels.Tcp.TcpChannel" />.</para>
 228         </returns>
 229       </Docs>
 230       <AssemblyInfo>
 231         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 232         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 233       </AssemblyInfo>
 234     </Member>
 235     <Member MemberName="Parse">
 236       <MemberSignature Language="C#" Value="public string Parse (string url, out string objectURI);" />
 237       <MemberType>Method</MemberType>
 238       <ReturnValue>
 239         <ReturnType>System.String</ReturnType>
 240       </ReturnValue>
 241       <Parameters>
 242         <Parameter Name="url" Type="System.String" />
 243         <Parameter Name="objectURI" Type="System.String&amp;" RefType="out" />
 244       </Parameters>
 245       <Docs>
 246         <param name="url">To be added: an object of type 'string'</param>
 247         <param name="objectURI">To be added: an object of type 'string&amp;'</param>
 248         <summary>To be added</summary>
 249         <returns>To be added: an object of type 'string'</returns>
 250         <remarks>To be added</remarks>
 251       </Docs>
 252       <AssemblyInfo>
 253         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 254         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 255       </AssemblyInfo>
 256     </Member>
 257     <Member MemberName="StartListening">
 258       <MemberSignature Language="C#" Value="public void StartListening (object data);" />
 259       <MemberType>Method</MemberType>
 260       <ReturnValue>
 261         <ReturnType>System.Void</ReturnType>
 262       </ReturnValue>
 263       <Parameters>
 264         <Parameter Name="data" Type="System.Object" />
 265       </Parameters>
 266       <Docs>
 267         <remarks>
 268           <attribution license="cc4" from="Microsoft" modified="false" />
 269           <para>It is not necessary to call this method to begin listening on a newly initialized channel.</para>
 270           <para>Use this method to restart listening on a channel after the <see cref="M:System.Runtime.Remoting.Channels.Tcp.TcpServerChannel.StopListening(System.Object)" /> method has been called.</para>
 271           <para>If your channel uses a dynamically assigned port number, your port number might change when you restart listening.</para>
 272           <para>The <paramref name="data" /> parameter can be used to pass a specific initialization state to the channel. If you do not want to pass a specific state to the channel, set <paramref name="data" /> to null.</para>
 273         </remarks>
 274         <summary>
 275           <attribution license="cc4" from="Microsoft" modified="false" />
 276           <para>Instructs the current channel to start listening for requests.</para>
 277         </summary>
 278         <param name="data">
 279           <attribution license="cc4" from="Microsoft" modified="false" />Optional initialization information. </param>
 280       </Docs>
 281       <AssemblyInfo>
 282         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 283         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 284       </AssemblyInfo>
 285     </Member>
 286     <Member MemberName="StopListening">
 287       <MemberSignature Language="C#" Value="public void StopListening (object data);" />
 288       <MemberType>Method</MemberType>
 289       <ReturnValue>
 290         <ReturnType>System.Void</ReturnType>
 291       </ReturnValue>
 292       <Parameters>
 293         <Parameter Name="data" Type="System.Object" />
 294       </Parameters>
 295       <Docs>
 296         <remarks>
 297           <attribution license="cc4" from="Microsoft" modified="false" />
 298           <para>Use this method to stop listening on a channel. To restart listening, use the <see cref="M:System.Runtime.Remoting.Channels.Tcp.TcpServerChannel.StartListening(System.Object)" /> method.</para>
 299           <para>If your channel uses a dynamically assigned port number, your port number might change when you restart listening.</para>
 300           <para>The <paramref name="data" /> parameter can be used to pass a specific initialization state to the channel. If you do not want to pass a specific state to the channel, set <paramref name="data" /> to null.</para>
 301         </remarks>
 302         <summary>
 303           <attribution license="cc4" from="Microsoft" modified="false" />
 304           <para>Instructs the current channel to stop listening for requests.</para>
 305         </summary>
 306         <param name="data">
 307           <attribution license="cc4" from="Microsoft" modified="false" />Optional state information for the channel. </param>
 308       </Docs>
 309       <AssemblyInfo>
 310         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 311         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 312       </AssemblyInfo>
 313     </Member>
 314   </Members>
 315 </Type>