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

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="TcpClientChannel" FullName="System.Runtime.Remoting.Channels.Tcp.TcpClientChannel">
   3   <TypeSignature Language="C#" Maintainer="auto" Value="public class TcpClientChannel : 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.IChannelSender</InterfaceName>
  18     </Interface>
  19   </Interfaces>
  20   <Docs>
  21     <remarks>
  22       <attribution license="cc4" from="Microsoft" modified="false" />
  23       <para>Channels transport messages across remoting boundaries (for example, computers or application domains). The <see cref="T:System.Runtime.Remoting.Channels.Tcp.TcpClientChannel" /> class transports messages using the TCP protocol.</para>
  24       <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>
  25       <para>To perform additional processing of messages on the client side, you can specify an implementation of the <see cref="T:System.Runtime.Remoting.Channels.IClientChannelSinkProvider" /> interface through which all messages processed by the <see cref="T:System.Runtime.Remoting.Channels.Tcp.TcpClientChannel" /> are passed.</para>
  26       <para>By default, the <see cref="T:System.Runtime.Remoting.Channels.Tcp.TcpClientChannel" /> class uses a binary formatter to serialize all messages.</para>
  27       <para>A <see cref="T:System.Runtime.Remoting.Channels.Tcp.TcpClientChannel" /> 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.TcpClientChannel.#ctor(System.Collections.IDictionary,System.Runtime.Remoting.Channels.IClientChannelSinkProvider)" /> constructor). For a list of these configuration properties, see the documentation for <see cref="M:System.Runtime.Remoting.Channels.Tcp.TcpClientChannel.#ctor(System.Collections.IDictionary,System.Runtime.Remoting.Channels.IClientChannelSinkProvider)" />.</para>
  28     </remarks>
  29     <summary>
  30       <attribution license="cc4" from="Microsoft" modified="false" />
  31       <para>For remote calls, implements a client channel that uses the TCP protocol to transmit messages.</para>
  32     </summary>
  33   </Docs>
  34   <Members>
  35     <Member MemberName=".ctor">
  36       <MemberSignature Language="C#" Value="public TcpClientChannel ();" />
  37       <MemberType>Constructor</MemberType>
  38       <ReturnValue />
  39       <Parameters />
  40       <Docs>
  41         <remarks>
  42           <attribution license="cc4" from="Microsoft" modified="false" />
  43           <para>The configuration properties of the <see cref="T:System.Runtime.Remoting.Channels.Tcp.TcpClientChannel" /> instance returned by this constructor are all set to their default values.</para>
  44         </remarks>
  45         <summary>
  46           <attribution license="cc4" from="Microsoft" modified="false" />
  47           <para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.Channels.Tcp.TcpClientChannel" /> class.</para>
  48         </summary>
  49       </Docs>
  50       <AssemblyInfo>
  51         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  52         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  53       </AssemblyInfo>
  54     </Member>
  55     <Member MemberName=".ctor">
  56       <MemberSignature Language="C#" Value="public TcpClientChannel (System.Collections.IDictionary properties, System.Runtime.Remoting.Channels.IClientChannelSinkProvider sinkProvider);" />
  57       <MemberType>Constructor</MemberType>
  58       <ReturnValue />
  59       <Parameters>
  60         <Parameter Name="properties" Type="System.Collections.IDictionary" />
  61         <Parameter Name="sinkProvider" Type="System.Runtime.Remoting.Channels.IClientChannelSinkProvider" />
  62       </Parameters>
  63       <Docs>
  64         <remarks>
  65           <attribution license="cc4" from="Microsoft" modified="false" />
  66           <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>
  67           <para>If you do not require sink functionality, set the <paramref name="sinkProvider" /> parameter to null.</para>
  68         </remarks>
  69         <summary>
  70           <attribution license="cc4" from="Microsoft" modified="false" />
  71           <para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.Channels.Tcp.TcpClientChannel" /> class with the specified configuration properties and sink.</para>
  72         </summary>
  73         <param name="properties">
  74           <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 channel. </param>
  75         <param name="sinkProvider">
  76           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Runtime.Remoting.Channels.IServerChannelSinkProvider" /> implementation to be used by the channel. </param>
  77       </Docs>
  78       <AssemblyInfo>
  79         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  80         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  81       </AssemblyInfo>
  82     </Member>
  83     <Member MemberName=".ctor">
  84       <MemberSignature Language="C#" Value="public TcpClientChannel (string name, System.Runtime.Remoting.Channels.IClientChannelSinkProvider sinkProvider);" />
  85       <MemberType>Constructor</MemberType>
  86       <ReturnValue />
  87       <Parameters>
  88         <Parameter Name="name" Type="System.String" />
  89         <Parameter Name="sinkProvider" Type="System.Runtime.Remoting.Channels.IClientChannelSinkProvider" />
  90       </Parameters>
  91       <Docs>
  92         <remarks>
  93           <attribution license="cc4" from="Microsoft" modified="false" />
  94           <para>This constructor sets the <see cref="P:System.Runtime.Remoting.Channels.Tcp.TcpClientChannel.ChannelName" /> property by using the <paramref name="name" /> parameter. If you want to register more than one channel, each channel must have a unique name.</para>
  95           <para>If you do not require sink functionality, set the <paramref name="sinkProvider" /> parameter to null.</para>
  96         </remarks>
  97         <summary>
  98           <attribution license="cc4" from="Microsoft" modified="false" />
  99           <para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.Channels.Tcp.TcpClientChannel" /> class with the specified name and sink.</para>
 100         </summary>
 101         <param name="name">
 102           <attribution license="cc4" from="Microsoft" modified="false" />The name of the channel. </param>
 103         <param name="sinkProvider">
 104           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Runtime.Remoting.Channels.IClientChannelSinkProvider" /> implementation to be used by the channel. </param>
 105       </Docs>
 106       <AssemblyInfo>
 107         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 108         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 109       </AssemblyInfo>
 110     </Member>
 111     <Member MemberName="ChannelName">
 112       <MemberSignature Language="C#" Value="public string ChannelName { get; }" />
 113       <MemberType>Property</MemberType>
 114       <ReturnValue>
 115         <ReturnType>System.String</ReturnType>
 116       </ReturnValue>
 117       <Docs>
 118         <value>To be added: an object of type 'string'</value>
 119         <remarks>
 120           <attribution license="cc4" from="Microsoft" modified="false" />
 121           <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)" />.</para>
 122         </remarks>
 123         <summary>
 124           <attribution license="cc4" from="Microsoft" modified="false" />
 125           <para>Gets the name of the current channel.</para>
 126         </summary>
 127       </Docs>
 128       <AssemblyInfo>
 129         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 130         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 131       </AssemblyInfo>
 132     </Member>
 133     <Member MemberName="ChannelPriority">
 134       <MemberSignature Language="C#" Value="public int ChannelPriority { get; }" />
 135       <MemberType>Property</MemberType>
 136       <ReturnValue>
 137         <ReturnType>System.Int32</ReturnType>
 138       </ReturnValue>
 139       <Docs>
 140         <value>To be added: an object of type 'int'</value>
 141         <remarks>
 142           <attribution license="cc4" from="Microsoft" modified="false" />
 143           <para>The priority controls the order in which competing clients connect to a given endpoint; higher priority channels connect before lower priority channels. The default priority is 1; negative priorities are allowed.</para>
 144         </remarks>
 145         <summary>
 146           <attribution license="cc4" from="Microsoft" modified="false" />
 147           <para>Gets the priority of the current channel.</para>
 148         </summary>
 149       </Docs>
 150       <AssemblyInfo>
 151         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 152         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 153       </AssemblyInfo>
 154     </Member>
 155     <Member MemberName="CreateMessageSink">
 156       <MemberSignature Language="C#" Value="public virtual System.Runtime.Remoting.Messaging.IMessageSink CreateMessageSink (string url, object remoteChannelData, out string objectURI);" />
 157       <MemberType>Method</MemberType>
 158       <ReturnValue>
 159         <ReturnType>System.Runtime.Remoting.Messaging.IMessageSink</ReturnType>
 160       </ReturnValue>
 161       <Parameters>
 162         <Parameter Name="url" Type="System.String" />
 163         <Parameter Name="remoteChannelData" Type="System.Object" />
 164         <Parameter Name="objectURI" Type="System.String&amp;" RefType="out" />
 165       </Parameters>
 166       <Docs>
 167         <param name="url">To be added: an object of type 'string'</param>
 168         <param name="remoteChannelData">To be added: an object of type 'object'</param>
 169         <param name="objectURI">To be added: an object of type 'string&amp;'</param>
 170         <summary>To be added</summary>
 171         <returns>To be added: an object of type 'Runtime.Remoting.Messaging.IMessageSink'</returns>
 172         <remarks>To be added</remarks>
 173       </Docs>
 174       <AssemblyInfo>
 175         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 176         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 177       </AssemblyInfo>
 178     </Member>
 179     <Member MemberName="Parse">
 180       <MemberSignature Language="C#" Value="public string Parse (string url, out string objectURI);" />
 181       <MemberType>Method</MemberType>
 182       <ReturnValue>
 183         <ReturnType>System.String</ReturnType>
 184       </ReturnValue>
 185       <Parameters>
 186         <Parameter Name="url" Type="System.String" />
 187         <Parameter Name="objectURI" Type="System.String&amp;" RefType="out" />
 188       </Parameters>
 189       <Docs>
 190         <param name="url">To be added: an object of type 'string'</param>
 191         <param name="objectURI">To be added: an object of type 'string&amp;'</param>
 192         <summary>To be added</summary>
 193         <returns>To be added: an object of type 'string'</returns>
 194         <remarks>To be added</remarks>
 195       </Docs>
 196       <AssemblyInfo>
 197         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 198         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 199       </AssemblyInfo>
 200     </Member>
 201   </Members>
 202 </Type>