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" />
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>
11 <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
13 <BaseTypeName>System.Object</BaseTypeName>
17 <InterfaceName>System.Runtime.Remoting.Channels.IChannelSender</InterfaceName>
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>
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>
35 <Member MemberName=".ctor">
36 <MemberSignature Language="C#" Value="public TcpClientChannel ();" />
37 <MemberType>Constructor</MemberType>
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>
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>
51 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
52 <AssemblyVersion>2.0.0.0</AssemblyVersion>
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>
60 <Parameter Name="properties" Type="System.Collections.IDictionary" />
61 <Parameter Name="sinkProvider" Type="System.Runtime.Remoting.Channels.IClientChannelSinkProvider" />
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>
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>
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>
79 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
80 <AssemblyVersion>2.0.0.0</AssemblyVersion>
83 <Member MemberName=".ctor">
84 <MemberSignature Language="C#" Value="public TcpClientChannel (string name, System.Runtime.Remoting.Channels.IClientChannelSinkProvider sinkProvider);" />
85 <MemberType>Constructor</MemberType>
88 <Parameter Name="name" Type="System.String" />
89 <Parameter Name="sinkProvider" Type="System.Runtime.Remoting.Channels.IClientChannelSinkProvider" />
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>
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>
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>
107 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
108 <AssemblyVersion>2.0.0.0</AssemblyVersion>
111 <Member MemberName="ChannelName">
112 <MemberSignature Language="C#" Value="public string ChannelName { get; }" />
113 <MemberType>Property</MemberType>
115 <ReturnType>System.String</ReturnType>
118 <value>To be added: an object of type 'string'</value>
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>
124 <attribution license="cc4" from="Microsoft" modified="false" />
125 <para>Gets the name of the current channel.</para>
129 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
130 <AssemblyVersion>2.0.0.0</AssemblyVersion>
133 <Member MemberName="ChannelPriority">
134 <MemberSignature Language="C#" Value="public int ChannelPriority { get; }" />
135 <MemberType>Property</MemberType>
137 <ReturnType>System.Int32</ReturnType>
140 <value>To be added: an object of type 'int'</value>
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>
146 <attribution license="cc4" from="Microsoft" modified="false" />
147 <para>Gets the priority of the current channel.</para>
151 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
152 <AssemblyVersion>2.0.0.0</AssemblyVersion>
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>
159 <ReturnType>System.Runtime.Remoting.Messaging.IMessageSink</ReturnType>
162 <Parameter Name="url" Type="System.String" />
163 <Parameter Name="remoteChannelData" Type="System.Object" />
164 <Parameter Name="objectURI" Type="System.String&" RefType="out" />
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&'</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>
175 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
176 <AssemblyVersion>2.0.0.0</AssemblyVersion>
179 <Member MemberName="Parse">
180 <MemberSignature Language="C#" Value="public string Parse (string url, out string objectURI);" />
181 <MemberType>Method</MemberType>
183 <ReturnType>System.String</ReturnType>
186 <Parameter Name="url" Type="System.String" />
187 <Parameter Name="objectURI" Type="System.String&" RefType="out" />
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&'</param>
192 <summary>To be added</summary>
193 <returns>To be added: an object of type 'string'</returns>
194 <remarks>To be added</remarks>
197 <AssemblyVersion>1.0.5000.0</AssemblyVersion>
198 <AssemblyVersion>2.0.0.0</AssemblyVersion>