mono/linux-packaging-mono
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Imported Upstream version 3.6.0

Browse Source 
Former-commit-id: da6be194a6b1221998fc28233f2503bd61dd9d14
This commit is contained in:
Jo Shields
2014-08-13 10:39:27 +01:00
commit a575963da9
50588 changed files with 8155799 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
mcs/class/System.Runtime.Remoting/Assembly/AssemblyInfo.cs Normal file
View File

@@ -0,0 +1,68 @@
//
// AssemblyInfo.cs
//
// Author:
// Andreas Nahr (ClassDevelopment@A-SoftTech.com)
//
// (C) 2003 Ximian, Inc. http://www.ximian.com
//
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
using System;
using System.Reflection;
using System.Resources;
using System.Security;
using System.Diagnostics;
using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;
// General Information about the System.Runtime.Remoting assembly
#if NET_2_0
[assembly: AssemblyTitle ("System.Runtime.Remoting.dll")]
[assembly: AssemblyDescription ("System.Runtime.Remoting.dll")]
[assembly: AssemblyDefaultAlias ("System.Runtime.Remoting.dll")]
[assembly: AssemblyCompany (Consts.MonoCompany)]
[assembly: AssemblyProduct (Consts.MonoProduct)]
[assembly: AssemblyCopyright (Consts.MonoCopyright)]
[assembly: AssemblyInformationalVersion (Consts.FxFileVersion)]
#endif
[assembly: AssemblyVersion (Consts.FxVersion)]
[assembly: SatelliteContractVersion (Consts.FxVersion)]
[assembly: NeutralResourcesLanguage ("en-US")]
[assembly: ComCompatibleVersion (1, 0, 3300, 0)]
#if !TARGET_JVM
[assembly: AssemblyDelaySign (true)]
[assembly: AssemblyKeyFile("../ecma.pub")]
#endif
[assembly: AssemblyFileVersion (Consts.FxFileVersion)]
[assembly: CLSCompliant (false)]
[assembly: ComVisible (false)]
[assembly: CompilationRelaxations (CompilationRelaxations.NoStringInterning)]
[assembly: TypeLibVersion (2, 0)]

17
mcs/class/System.Runtime.Remoting/Assembly/ChangeLog Normal file
View File

@@ -0,0 +1,17 @@
2008-08-09 Gert Driesen <drieseng@users.sourceforge.net>
* AssemblyInfo.cs: ComVisible attribute only applies to 2.0 profile.
2008-04-23 Andreas Nahr <ClassDevelopment@A-SoftTech.com>
* AssemblyInfo.cs: Added missing attributes
2004-05-13 Lluis Sanchez Gual <lluis@ximian.com>
* AssemblyInfo.cs: Removed CLSCompliant attribute.
2004-03-31 Andreas Nahr <ClassDevelopment@A-SoftTech.com>
* AssemblyInfo.cs: Added
* ChangeLog: Added
* Locale.cs: Added

231
mcs/class/System.Runtime.Remoting/ChangeLog Normal file
View File

@@ -0,0 +1,231 @@
2010-02-26 Robert Jordan <robertj@gmx.net>
* Remove MonoHttp (NET_1_1) from the build.
2008-09-19 Michael Hutchinson <mhutchinson@novell.com>
* System.Runtime.Remoting_test.dll.sources: add HttpBugtests.cs.
2008-08-09 Gert Driesen <drieseng@users.sourceforge.net>
* System.Runtime.Remoting.dll.sources: add SocketCachePolicy.cs.
2008-01-25 Gert Driesen <drieseng@users.sourceforge.net>
* System.Runtime.Remoting_test.dll.sources: add TcpChannelTest.cs.
2007-05-19 Robert Jordan <robertj@gmx.net>
* System.Runtime.Remoting_test.dll.sources: add IpcChannelTest.cs
2007-01-09 Robert Jordan <robertj@gmx.net>
* System.Runtime.Remoting_test.dll.sources: add GenericTest.cs.
2005-11-16 Vladislav Spivak <spivak@mainsoft.com>
* Added net_1_1_java source includes and excludes
2005-11-05 Robert Jordan <robertj@gmx.net>
* System.Runtime.Remoting.dll.sources: Added Channels/IAuthorizeRemotingConnection.cs
2005-11-06 Svetlana Zholkovsky <svetlanaz@mainsoft.com>
* Add System.Runtime.Remoting.vmwcsproj and System.Runtime.Remoting.sln
* AssemblyInfo.cs: only TARGET_JVM changes
2005-11-05 Robert Jordan <robertj@gmx.net>
* System.Runtime.Remoting.dll.sources: Removed Ipc/IpcChannelFactory.cs
2005-10-19 Robert Jordan <robertj@gmx.net>
* System.Runtime.Remoting.dll.sources: Added S.R.R.Channels.Ipc*
* System.Runtime.Remoting_test.dll.sources: Added IpcCalls.cs
2005-10-16 Robert Jordan <robertj@gmx.net>
* Added System.Runtime.Remoting.Channels.Ipc* for NET_2_0
2005-01-14 Lluis Sanchez Gual <lluis@novell.com>
* System.Runtime.Remoting_test.dll.sources: Added:
System.Runtime.Remoting.Channels/RemotingThreadPool.cs
2004-10-25 Zoltan Varga <vargaz@freemail.hu>
* Makefile: Add '.' to MONO_PATH during test. Fixes #68377.
2004-09-27 Lluis Sanchez Gual <lluis@novell.com>
* System.Runtime.Remoting_test.dll.sources: Added RemotingServicesTest.cs.
2004-06-23 Lluis Sanchez Gual <lluis@ximian.com>
* System.Runtime.Remoting_test.dll.sources: Added ActivationTests.cs.
2004-05-13 Lluis Sanchez Gual <lluis@ximian.com>
* System.Runtime.Remoting.dll.sources: Added:
System.Runtime.Remoting.Channels.Http/AggregateDictionary.cs,
System.Runtime.Remoting.Services/RemotingClientProxy.cs,
System.Runtime.Remoting.Services/RemotingService.cs
2004-04-29 Lluis Sanchez Gual <lluis@ximian.com>
* Makefile: Removed unneeded System.Web.Services dependency.
2004-03-31 Andreas Nahr <ClassDevelopment@A-SoftTech.com>
* System.Runtime.Remoting.dll.sources: Added:
AssemblyInfo and Locale
2003-12-03 Atsushi Enomoto <ginga@kit.hi-ho.ne.jp>
* Makefile : added reference to System.Web.Services.dll
2003-12-03 Lluis Sanchez Gual <lluis@ximian.com>
* System.Runtime.Remoting.dll.sources: Added:
System.Runtime.Remoting.MetadataServices/MetaDataExporter.cs
System.Runtime.Remoting.MetadataServices/MetaDataCodeGenerator.cs
* Makefile: Added new assembly references.
2003-11-16 Lluis Sanchez Gual <lluis@ximian.com>
* System.Runtime.Remoting.dll.sources: Added:
System.Runtime.Remoting.Channels/BinaryCore.cs
System.Runtime.Remoting.Channels/ChannelCore.cs
System.Runtime.Remoting.Channels/SoapCore.cs
2003-11-13 Lluis Sanchez Gual <lluis@ximian.com>
* System.Runtime.Remoting.dll.sources: Removed HttpThread.cs
2003-11-11 Lluis Sanchez Gual <lluis@ximian.com>
* System.Runtime.Remoting_test.dll.sources: Added CrossDomainCalls.cs test file.
2003-09-14 Lluis Sanchez Gual <lluis@ximian.com>
* TcpClientChannel.cs: Fixed constructor.
2003-08-22 Lluis Sanchez Gual <lluis@ximian.com>
* System.Runtime.Remoting_test.dll.sources: Added DelegateCalls.cs test file.
2003-08-20 Lluis Sanchez Gual <lluis@ximian.com>
* TcpConnectionPool.cs: Check if a connection is alive before reusing
it. Added some properties to support this.
2003-08-20 Lluis Sanchez Gual <lluis@ximian.com>
* System.Runtime.Remoting_test.dll.sources: Added new test files.
2003-08-18 Lluis Sanchez Gual <lluis@ximian.com>
* HttpClientChannel.cs, HttpServerChannel.cs: Fixed bug #47703
2003-07-23 Lluis Sanchez Gual <lluis@ximian.com>
* Makefile: added dll extension to System.Runtime.Remoting reference
2003-07-23 Lluis Sanchez Gual <lluis@ximian.com>
* System.Runtime.Remoting_test.dll.sources: Added.
* Makefile: added test support.
2003-06-21 Lluis Sanchez Gual <lluis@ximian.com>
* HttpChannel.cs, HttpClientChannel.cs, HttpHelper.cs, HttpServer.cs,
HttpServerChannel.cs, HttpThread.cs: added new implementation of the HttpChannel
by Ahmad Tantawy, Ahmad Kadry and Hussein Mehanna.
* unix.args: added HttpHelper.cs,HttpServer.cs,HttpThread.cs.
2003-05-13 Lluis Sanchez Gual <lluis@ideary.com>
* BinaryServerFormatterSink.cs: The uri of the target object is now assigned
to the message through the HeaderHandler delegate.
2003-04-27 Lluis Sanchez Gual <lluis@ideary.com>
* TcpChannel.cs: The port property may not be an string. Fixed.
* TcpServerChannel.cs: Added some fixes by Jerome Laban. Implemented
some channel properties.
2003-04-03 Lluis Sanchez Gual <lluis@ideary.com>
* TcpMessageIO.cs: Changed header format to match MS.NET. Based on the patch
sent by Jose Luís Martín.
* TcpClientTransportSink.cs: Improved support for OneWay messages.
* BinaryClientFormatterSink.cs: Added Content-Type header.
2003-03-25 Martin Willemoes Hansen <mwh@sysrq.dk>
* Stubed System.Runtime.Remoting.MetadataServices
2003-03-22 Martin Willemoes Hansen <mwh@sysrq.dk>
* Stubed System.Runtime.Remoting.Channels.Http
2003-02-05 Alvaro del Castillo <acs@barrapunto.com>
* System.Runtime.Remoting.Channels.Tcp/TcpClientTransportSink.cs:
* System.Runtime.Remoting.Channels.Tcp/TcpMessageIO.cs:
* System.Runtime.Remoting.Channels.Tcp/TcpServerChannel.cs:
Change MessageType to MessageStatus so the code is
more clear
2002-12-29 Lluis Sanchez Gual <lluis@ideary.com>
* TcpServerChannel.cs: Changed management of listener threads.
* TcpConnectionPool.cs: Add shutdown method.
* TcpChannel.cs: Corrected shutdown method.
2002-12-29 Lluis Sanchez Gual <lluis@ideary.com>
* TcpServerChannel.cs: Changed default formatter sink to BinaryFormatterSink
* TcpMessageIO.cs: warning corrected.
* TcpConnectionPool.cs: changed default value of MaxOpenConnections.
* TcpClientTransportSink.cs: implemented support for one way calls.
* TcpClientChannel.cs: Changed default formatter sink to BinaryFormatterSink.
* TcpChannel.cs: corrected Parse method. Now can parse channel uris.
* BinaryServerFormatterSink.cs: Implemented.
* BinaryClientFormatterSink.cs: Implemented.
2002-12-29 Lluis Sanchez Gual <lluis@ideary.com>
* CommonTransportKeys.cs: Implemented and added to CVS
* TcpChannel.cs: Added. It is a more ore less complete implementation
of the tcp channel, although not yet compatible with MS TcpChannel.
* TcpClientChannel.cs: Added
* TcpClientTransportSink.cs: Added
* TcpClientTransportSinkProvider.cs: Added
* TcpConnectionPool.cs: Added
* TcpMessageIO.cs: Added
* TcpServerChannel.cs: Added
* TcpServerTransportSink.cs: Added
* SimpleWireFormat.cs: Corrected a bug in method SerializeObject
* SimpleServerFormatterSink.cs: Some small corrections
* SimpleClientFormatterSink.cs: Some small corrections
2002-09-03 Dietmar Maurer <dietmar@ximian.com>
* System.Runtime.Remoting.Channels.CORBA/CORBAChannel.cs:
impl. the channel wrapper.
* System.Runtime.Remoting.Channels.Simple/SimpleChannel.cs:
impl. the channel wrapper.
* System.Runtime.Remoting.Channels.Simple/SimpleServerChannel.cs
(GetUrlsForUri): use all available channel uris.
2002-08-30 Dietmar Maurer <dietmar@ximian.com>
* System.Runtime.Remoting.Channels.Simple/SimpleWireFormat.cs: add
more types.
2002-08-14 Rodrigo Moya <rodrigo@ximian.com>
* TcpChannel.cs: new classes.

563
mcs/class/System.Runtime.Remoting/Documentation/System.Runtime.Remoting.xml Executable file
View File

File diff suppressed because it is too large Load Diff

467
mcs/class/System.Runtime.Remoting/Documentation/en/System.Runtime.Remoting.Channels.Http/HttpChannel.xml Normal file
View File

@@ -0,0 +1,467 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="HttpChannel" FullName="System.Runtime.Remoting.Channels.Http.HttpChannel">
<TypeSignature Language="C#" Maintainer="auto" Value="public class HttpChannel : System.Runtime.Remoting.Channels.BaseChannelWithProperties, System.Runtime.Remoting.Channels.IChannelReceiver, System.Runtime.Remoting.Channels.IChannelReceiverHook, System.Runtime.Remoting.Channels.IChannelSender" />
<AssemblyInfo>
<AssemblyName>System.Runtime.Remoting</AssemblyName>
<AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00]</AssemblyPublicKey>
<AssemblyVersion>1.0.3300.0</AssemblyVersion>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<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>
<Base>
<BaseTypeName>System.Runtime.Remoting.Channels.BaseChannelWithProperties</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.Runtime.Remoting.Channels.IChannelReceiver</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.Runtime.Remoting.Channels.IChannelReceiverHook</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.Runtime.Remoting.Channels.IChannelSender</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName>System.Reflection.DefaultMember("Item")</AttributeName>
</Attribute>
</Attributes>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Channels transport messages across remoting boundaries (for example, between computers or application domains). The <see cref="T:System.Runtime.Remoting.Channels.Http.HttpChannel" /> class transports messages using the HTTP protocol.</para>
<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>
<para>A <see cref="T:System.Runtime.Remoting.Channels.Http.HttpChannel" /> 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.Http.HttpChannel.#ctor" /> constructor). For a list of these configuration properties, see <format type="text/html"><a href="226ecf74-ebbd-4ea0-a701-dcf4441deefe">Channel and Formatter Configuration Properties</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Implements a client channel for remote calls that uses the HTTP protocol to transmit messages.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public HttpChannel ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The configuration properties of the <see cref="T:System.Runtime.Remoting.Channels.Http.HttpChannel" /> instance returned by this constructor are all set to their default values.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.Channels.Http.HttpChannel" /> class.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public HttpChannel (int port);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="port" Type="System.Int32" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When this constructor is used the default <see cref="T:System.Runtime.Remoting.Channels.IClientChannelSinkProvider" /> used is the <see cref="T:System.Runtime.Remoting.Channels.SoapClientFormatterSinkProvider" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.Channels.Http.HttpChannel" /> class with a server channel that listens on the specified port.</para>
</summary>
<param name="port">
<attribution license="cc4" from="Microsoft" modified="false" />The port on which the server channel listens.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public HttpChannel (System.Collections.IDictionary properties, System.Runtime.Remoting.Channels.IClientChannelSinkProvider clientSinkProvider, System.Runtime.Remoting.Channels.IServerChannelSinkProvider serverSinkProvider);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="properties" Type="System.Collections.IDictionary" />
<Parameter Name="clientSinkProvider" Type="System.Runtime.Remoting.Channels.IClientChannelSinkProvider" />
<Parameter Name="serverSinkProvider" Type="System.Runtime.Remoting.Channels.IServerChannelSinkProvider" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
<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>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.Channels.Http.HttpChannel" /> class with the specified configuration properties and sinks.</para>
</summary>
<param name="properties">
<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>
<param name="clientSinkProvider">
<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>
<param name="serverSinkProvider">
<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>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="AddHookChannelUri">
<MemberSignature Language="C#" Value="public void AddHookChannelUri (string channelUri);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="channelUri" Type="System.String" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Code should not call the AddHookChannelUri method directly.</para>
<para>The data object can be used to pass a specific initialization state to the channel.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Adds a URI on which the channel hook should listen.</para>
</summary>
<param name="channelUri">
<attribution license="cc4" from="Microsoft" modified="false" />Should always be a null reference (Nothing in Visual Basic) for <see cref="T:System.Runtime.Remoting.Channels.Http.HttpChannel" /> </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ChannelData">
<MemberSignature Language="C#" Value="public object ChannelData { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<value>To be added: an object of type 'object'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The current property is used when <see cref="Overload:System.Runtime.Remoting.RemotingServices.Marshal" /> is called and a <see cref="T:System.Runtime.Remoting.ObjRef" /> is created.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the channel-specific data.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ChannelName">
<MemberSignature Language="C#" Value="public string ChannelName { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added: an object of type 'string'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the name of the current channel.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ChannelPriority">
<MemberSignature Language="C#" Value="public int ChannelPriority { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<value>To be added: an object of type 'int'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the priority of the current channel.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ChannelScheme">
<MemberSignature Language="C#" Value="public string ChannelScheme { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added: an object of type 'string'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The value of the current property is not case-sensitive.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the type of listener to hook into (for example, "http").</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ChannelSinkChain">
<MemberSignature Language="C#" Value="public System.Runtime.Remoting.Channels.IServerChannelSink ChannelSinkChain { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Runtime.Remoting.Channels.IServerChannelSink</ReturnType>
</ReturnValue>
<Docs>
<value>To be added: an object of type 'Runtime.Remoting.Channels.IServerChannelSink'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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 linked together in a chain of channel sink providers and all channel messages flow through this chain of sinks before the message is finally serialized and transported.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the channel sink chain that the current channel is using.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CreateMessageSink">
<MemberSignature Language="C#" Value="public System.Runtime.Remoting.Messaging.IMessageSink CreateMessageSink (string url, object remoteChannelData, out string objectURI);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Runtime.Remoting.Messaging.IMessageSink</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="url" Type="System.String" />
<Parameter Name="remoteChannelData" Type="System.Object" />
<Parameter Name="objectURI" Type="System.String&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="url">To be added: an object of type 'string'</param>
<param name="remoteChannelData">To be added: an object of type 'object'</param>
<param name="objectURI">To be added: an object of type 'string&amp;'</param>
<summary>To be added</summary>
<returns>To be added: an object of type 'Runtime.Remoting.Messaging.IMessageSink'</returns>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetUrlsForUri">
<MemberSignature Language="C#" Value="public string[] GetUrlsForUri (string objectURI);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String[]</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="objectURI" Type="System.String" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method is used by <see cref="M:System.Runtime.Remoting.Channels.ChannelServices.GetUrlsForObject(System.MarshalByRefObject)" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<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.Http.HttpChannel" />.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>An array of the URLs for an object with the specified URI, hosted on the current <see cref="T:System.Runtime.Remoting.Channels.Http.HttpChannel" />.</para>
</returns>
<param name="objectURI">
<attribution license="cc4" from="Microsoft" modified="false" />The URI of the object for which URL's are required. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Item">
<MemberSignature Language="C#" Value="public override object this[object key] { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="key" Type="System.Object" />
</Parameters>
<Docs>
<param name="key">To be added: an object of type 'object'</param>
<summary>To be added</summary>
<value>To be added: an object of type 'object'</value>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Keys">
<MemberSignature Language="C#" Value="public override System.Collections.ICollection Keys { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Collections.ICollection</ReturnType>
</ReturnValue>
<Docs>
<value>To be added: an object of type 'Collections.ICollection'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Channel properties are used to configure the channel at run time. For a list of possible channel properties and an example, see <format type="text/html"><a href="226ecf74-ebbd-4ea0-a701-dcf4441deefe">Channel and Formatter Configuration Properties</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a <see cref="T:System.Collections.ICollection" /> of keys that the channel properties are associated with.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Parse">
<MemberSignature Language="C#" Value="public string Parse (string url, out string objectURI);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="url" Type="System.String" />
<Parameter Name="objectURI" Type="System.String&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="url">To be added: an object of type 'string'</param>
<param name="objectURI">To be added: an object of type 'string&amp;'</param>
<summary>To be added</summary>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Properties">
<MemberSignature Language="C#" Value="public override System.Collections.IDictionary Properties { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Collections.IDictionary</ReturnType>
</ReturnValue>
<Docs>
<value>To be added: an object of type 'Collections.IDictionary'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Channels properties are used to configure the channel at run time. The Properties property returns channel properties of the underlying <see cref="T:System.Runtime.Remoting.Channels.Http.HttpServerChannel" /> and <see cref="T:System.Runtime.Remoting.Channels.Http.HttpClientChannel" />. For a list of possible channel properties and an example, see <format type="text/html"><a href="226ecf74-ebbd-4ea0-a701-dcf4441deefe">Channel and Formatter Configuration Properties</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a <see cref="T:System.Collections.IDictionary" /> of the channel properties associated with the current channel.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="StartListening">
<MemberSignature Language="C#" Value="public void StartListening (object data);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="data" Type="System.Object" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The data object can be used to pass a specific initialization state to the channel.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Instructs the current channel to start listening for requests.</para>
</summary>
<param name="data">
<attribution license="cc4" from="Microsoft" modified="false" />Should always be a null reference (Nothing in Visual Basic) for <see cref="T:System.Runtime.Remoting.Channels.Http.HttpChannel" />. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="StopListening">
<MemberSignature Language="C#" Value="public void StopListening (object data);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="data" Type="System.Object" />
</Parameters>
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Instructs the current channel to stop listening for requests.</para>
</summary>
<param name="data">
<attribution license="cc4" from="Microsoft" modified="false" />The channel URI on which the channel hook is listening.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="WantsToListen">
<MemberSignature Language="C#" Value="public bool WantsToListen { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<value>To be added: an object of type 'bool'</value>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a Boolean value that indicates whether the current instance wants to be hooked into the outside listener service.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

248
mcs/class/System.Runtime.Remoting/Documentation/en/System.Runtime.Remoting.Channels.Http/HttpClientChannel.xml Normal file
View File

@@ -0,0 +1,248 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="HttpClientChannel" FullName="System.Runtime.Remoting.Channels.Http.HttpClientChannel">
<TypeSignature Language="C#" Maintainer="auto" Value="public class HttpClientChannel : System.Runtime.Remoting.Channels.BaseChannelWithProperties, System.Runtime.Remoting.Channels.IChannelSender" />
<AssemblyInfo>
<AssemblyName>System.Runtime.Remoting</AssemblyName>
<AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00]</AssemblyPublicKey>
<AssemblyVersion>1.0.3300.0</AssemblyVersion>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<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>
<Base>
<BaseTypeName>System.Runtime.Remoting.Channels.BaseChannelWithProperties</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.Runtime.Remoting.Channels.IChannelSender</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName>System.Reflection.DefaultMember("Item")</AttributeName>
</Attribute>
</Attributes>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Channels transport messages across remoting boundaries (for example, between computers or application domains). The <see cref="T:System.Runtime.Remoting.Channels.Http.HttpClientChannel" /> class transports messages using the HTTP protocol.</para>
<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>
<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" /> through which all messages processed by the <see cref="T:System.Runtime.Remoting.Channels.Http.HttpClientChannel" /> are passed.</para>
<para>By default, the <see cref="T:System.Runtime.Remoting.Channels.Http.HttpServerChannel" /> uses a SOAP formatter to serialize all messages.</para>
<para>A <see cref="T:System.Runtime.Remoting.Channels.Http.HttpClientChannel" /> 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.Http.HttpClientChannel.#ctor" /> constructor). For a list of these configuration properties, see <format type="text/html"><a href="226ecf74-ebbd-4ea0-a701-dcf4441deefe">Channel and Formatter Configuration Properties</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Implements a client channel for remote calls that uses the HTTP protocol to transmit messages.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public HttpClientChannel ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The configuration properties of the <see cref="T:System.Runtime.Remoting.Channels.Http.HttpClientChannel" /> instance returned by this constructor are all set to their default values.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.Channels.Http.HttpClientChannel" /> class.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public HttpClientChannel (System.Collections.IDictionary properties, System.Runtime.Remoting.Channels.IClientChannelSinkProvider sinkProvider);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="properties" Type="System.Collections.IDictionary" />
<Parameter Name="sinkProvider" Type="System.Runtime.Remoting.Channels.IClientChannelSinkProvider" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
<para>If you do not require sink functionality, set the <paramref name="sinkProvider" /> parameter to null.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.Channels.Http.HttpClientChannel" /> class with the specified configuration properties and sink.</para>
</summary>
<param name="properties">
<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>
<param name="sinkProvider">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Runtime.Remoting.Channels.IClientChannelSinkProvider" /> implementation to be used by the channel. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public HttpClientChannel (string name, System.Runtime.Remoting.Channels.IClientChannelSinkProvider sinkProvider);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="sinkProvider" Type="System.Runtime.Remoting.Channels.IClientChannelSinkProvider" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This constructor sets the <see cref="P:System.Runtime.Remoting.Channels.Http.HttpServerChannel.ChannelName" /> property using the <paramref name="name" /> parameter.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.Channels.Http.HttpClientChannel" /> class with the specified name and sink.</para>
</summary>
<param name="name">
<attribution license="cc4" from="Microsoft" modified="false" />The name of the new instance of the <see cref="T:System.Runtime.Remoting.Channels.Http.HttpClientChannel" />. </param>
<param name="sinkProvider">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Runtime.Remoting.Channels.IClientChannelSinkProvider" /> to be used by the channel. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ChannelName">
<MemberSignature Language="C#" Value="public string ChannelName { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added: an object of type 'string'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the name of the current channel.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ChannelPriority">
<MemberSignature Language="C#" Value="public int ChannelPriority { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<value>To be added: an object of type 'int'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the priority of the current channel.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CreateMessageSink">
<MemberSignature Language="C#" Value="public virtual System.Runtime.Remoting.Messaging.IMessageSink CreateMessageSink (string url, object remoteChannelData, out string objectURI);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Runtime.Remoting.Messaging.IMessageSink</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="url" Type="System.String" />
<Parameter Name="remoteChannelData" Type="System.Object" />
<Parameter Name="objectURI" Type="System.String&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="url">To be added: an object of type 'string'</param>
<param name="remoteChannelData">To be added: an object of type 'object'</param>
<param name="objectURI">To be added: an object of type 'string&amp;'</param>
<summary>To be added</summary>
<returns>To be added: an object of type 'Runtime.Remoting.Messaging.IMessageSink'</returns>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Item">
<MemberSignature Language="C#" Value="public override object this[object key] { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="key" Type="System.Object" />
</Parameters>
<Docs>
<param name="key">To be added: an object of type 'object'</param>
<summary>To be added</summary>
<value>To be added: an object of type 'object'</value>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Keys">
<MemberSignature Language="C#" Value="public override System.Collections.ICollection Keys { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Collections.ICollection</ReturnType>
</ReturnValue>
<Docs>
<value>To be added: an object of type 'Collections.ICollection'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Channel properties are used to configure the channel at run time. For a list of possible channel properties and an example, see <format type="text/html"><a href="226ecf74-ebbd-4ea0-a701-dcf4441deefe">Channel and Formatter Configuration Properties</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a <see cref="T:System.Collections.ICollection" /> of keys that the channel properties are associated with.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Parse">
<MemberSignature Language="C#" Value="public string Parse (string url, out string objectURI);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="url" Type="System.String" />
<Parameter Name="objectURI" Type="System.String&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="url">To be added: an object of type 'string'</param>
<param name="objectURI">To be added: an object of type 'string&amp;'</param>
<summary>To be added</summary>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

121
mcs/class/System.Runtime.Remoting/Documentation/en/System.Runtime.Remoting.Channels.Http/HttpRemotingHandler.xml Normal file
View File

@@ -0,0 +1,121 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="HttpRemotingHandler" FullName="System.Runtime.Remoting.Channels.Http.HttpRemotingHandler">
<TypeSignature Language="C#" Maintainer="auto" Value="public class HttpRemotingHandler : System.Web.IHttpHandler" />
<AssemblyInfo>
<AssemblyName>System.Runtime.Remoting</AssemblyName>
<AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00]</AssemblyPublicKey>
<AssemblyVersion>1.0.3300.0</AssemblyVersion>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<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>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.Web.IHttpHandler</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Custom HTTP handlers process specific, predefined types of HTTP requests. Executable code defined in the <see cref="T:System.Web.IHttpHandler" /> classes, rather than conventional ASP or ASP.NET Web pages, responds to these specific requests. HTTP handlers provide a way of interacting with the low-level request and response services of the IIS Web server, and provide functionality similar to ISAPI extensions but with a simpler programming model.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Implements an ASP.NET handler that forwards requests to the remoting HTTP channel.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public HttpRemotingHandler ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.Channels.Http.HttpRemotingHandler" /> class with default values.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public HttpRemotingHandler (Type type, object srvID);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="type" Type="System.Type" />
<Parameter Name="srvID" Type="System.Object" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use the default <see cref="T:System.Runtime.Remoting.Channels.Http.HttpRemotingHandler" /> constructor instead.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.Channels.Http.HttpRemotingHandler" /> class with default values. </para>
</summary>
<param name="type">
<attribution license="cc4" from="Microsoft" modified="false" />The constructor ignores the <paramref name="type" /> parameter.</param>
<param name="srvID">
<attribution license="cc4" from="Microsoft" modified="false" />The constructor ignores the <paramref name="srvID" /> parameter.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="IsReusable">
<MemberSignature Language="C#" Value="public bool IsReusable { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added: an object of type 'bool'</value>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a Boolean value that indicates whether another request can use the <see cref="T:System.Runtime.Remoting.Channels.Http.HttpRemotingHandler" />.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ProcessRequest">
<MemberSignature Language="C#" Value="public void ProcessRequest (System.Web.HttpContext context);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="context" Type="System.Web.HttpContext" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>For more information about the <see cref="M:System.Web.IHttpHandler.ProcessRequest(System.Web.HttpContext)" /> methods, see <see cref="M:System.Web.IHttpHandler.ProcessRequest(System.Web.HttpContext)" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Enables processing of HTTP Web requests by the current instance.</para>
</summary>
<param name="context">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.HttpContext" /> that provides references to the intrinsic server objects (for example, Request, Response, Session, and Server) used to service HTTP requests. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

111
mcs/class/System.Runtime.Remoting/Documentation/en/System.Runtime.Remoting.Channels.Http/HttpRemotingHandlerFactory.xml Normal file
View File

@@ -0,0 +1,111 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="HttpRemotingHandlerFactory" FullName="System.Runtime.Remoting.Channels.Http.HttpRemotingHandlerFactory">
<TypeSignature Language="C#" Maintainer="auto" Value="public class HttpRemotingHandlerFactory : System.Web.IHttpHandlerFactory" />
<AssemblyInfo>
<AssemblyName>System.Runtime.Remoting</AssemblyName>
<AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00]</AssemblyPublicKey>
<AssemblyVersion>1.0.3300.0</AssemblyVersion>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<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>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.Web.IHttpHandlerFactory</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The current class dynamically manufactures new instances of the <see cref="T:System.Runtime.Remoting.Channels.Http.HttpRemotingHandler" /> class.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes new instances of the <see cref="T:System.Runtime.Remoting.Channels.Http.HttpRemotingHandler" /> class.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public HttpRemotingHandlerFactory ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Creates an instance of <see cref="T:System.Runtime.Remoting.Channels.Http.HttpRemotingHandlerFactory" />.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetHandler">
<MemberSignature Language="C#" Value="public System.Web.IHttpHandler GetHandler (System.Web.HttpContext context, string verb, string url, string filePath);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Web.IHttpHandler</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="context" Type="System.Web.HttpContext" />
<Parameter Name="verb" Type="System.String" />
<Parameter Name="url" Type="System.String" />
<Parameter Name="filePath" Type="System.String" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>For more information about the current method, see <see cref="M:System.Web.IHttpHandlerFactory.GetHandler(System.Web.HttpContext,System.String,System.String,System.String)" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns an instance of the <see cref="T:System.Runtime.Remoting.Channels.Http.HttpRemotingHandler" /> class.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A new <see cref="T:System.Runtime.Remoting.Channels.Http.HttpRemotingHandler" /> that processes the request.</para>
</returns>
<param name="context">
<attribution license="cc4" from="Microsoft" modified="false" />An instance of the <see cref="T:System.Web.HttpContext" /> class that provides references to intrinsic server objects (for example, Request, Response, Session, and Server) used to service HTTP requests. </param>
<param name="verb">
<attribution license="cc4" from="Microsoft" modified="false" />The HTTP data transfer method (GET or POST) that the client uses. </param>
<param name="url">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="P:System.Web.HttpRequest.RawUrl" /> of the requested resource. </param>
<param name="filePath">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="P:System.Web.HttpRequest.PhysicalApplicationPath" /> to the requested resource. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ReleaseHandler">
<MemberSignature Language="C#" Value="public void ReleaseHandler (System.Web.IHttpHandler handler);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="handler" Type="System.Web.IHttpHandler" />
</Parameters>
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Enables a factory to reuse the specified <see cref="T:System.Runtime.Remoting.Channels.Http.HttpRemotingHandler" />.</para>
</summary>
<param name="handler">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.IHttpHandler" /> to release. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

496
mcs/class/System.Runtime.Remoting/Documentation/en/System.Runtime.Remoting.Channels.Http/HttpServerChannel.xml Normal file
View File

@@ -0,0 +1,496 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="HttpServerChannel" FullName="System.Runtime.Remoting.Channels.Http.HttpServerChannel">
<TypeSignature Language="C#" Maintainer="auto" Value="public class HttpServerChannel : System.Runtime.Remoting.Channels.BaseChannelWithProperties, System.Runtime.Remoting.Channels.IChannelReceiver, System.Runtime.Remoting.Channels.IChannelReceiverHook" />
<AssemblyInfo>
<AssemblyName>System.Runtime.Remoting</AssemblyName>
<AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00]</AssemblyPublicKey>
<AssemblyVersion>1.0.3300.0</AssemblyVersion>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<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>
<Base>
<BaseTypeName>System.Runtime.Remoting.Channels.BaseChannelWithProperties</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.Runtime.Remoting.Channels.IChannelReceiver</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.Runtime.Remoting.Channels.IChannelReceiverHook</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName>System.Reflection.DefaultMember("Item")</AttributeName>
</Attribute>
</Attributes>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Channels transport messages across remoting boundaries (for example, between computers on application domains). The <see cref="T:System.Runtime.Remoting.Channels.Http.HttpServerChannel" /> class transports messages using the HTTP protocol.</para>
<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>
<para>To perform additional processing of messages on the server-side, you can specify an implementation of the <see cref="T:System.Runtime.Remoting.Channels.IServerChannelSinkProvider" /> through which all messages processed by the <see cref="T:System.Runtime.Remoting.Channels.Http.HttpServerChannel" /> are passed.</para>
<para>The <see cref="T:System.Runtime.Remoting.Channels.Http.HttpServerChannel" /> accepts messages serialized in either binary or SOAP format.</para>
<para>A <see cref="T:System.Runtime.Remoting.Channels.Http.HttpServerChannel" /> 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.Http.HttpServerChannel.#ctor" /> constructor). For a list of these configuration properties, see the documentation for <see cref="M:System.Runtime.Remoting.Channels.Http.HttpServerChannel.#ctor" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Implements a server channel for remote calls that uses the HTTP protocol to transmit messages.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public HttpServerChannel ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.Channels.Http.HttpServerChannel" /> class.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public HttpServerChannel (int port);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="port" Type="System.Int32" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>To request that an available port be dynamically assigned, set the <paramref name="port" /> parameter to 0 (zero).</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.Channels.Http.HttpServerChannel" /> class that listens on the specified port.</para>
</summary>
<param name="port">
<attribution license="cc4" from="Microsoft" modified="false" />The port on which the channel listens. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public HttpServerChannel (System.Collections.IDictionary properties, System.Runtime.Remoting.Channels.IServerChannelSinkProvider sinkProvider);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="properties" Type="System.Collections.IDictionary" />
<Parameter Name="sinkProvider" Type="System.Runtime.Remoting.Channels.IServerChannelSinkProvider" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
<para>If you do not require sink functionality, set the <paramref name="sinkProvider" /> parameter to null.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.Channels.Http.HttpServerChannel" /> class with the specified channel properties and sink.</para>
</summary>
<param name="properties">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Collections.IDictionary" /> of the channel properties that hold the configuration information for the current channel. </param>
<param name="sinkProvider">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Runtime.Remoting.Channels.IServerChannelSinkProvider" /> to use with the new instance of the <see cref="T:System.Runtime.Remoting.Channels.Http.HttpServerChannel" />. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public HttpServerChannel (string name, int port);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="port" Type="System.Int32" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This constructor sets the <see cref="P:System.Runtime.Remoting.Channels.Http.HttpServerChannel.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>
<para>To request that an available port be dynamically assigned, set the <paramref name="port" /> parameter to 0 (zero).</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.Channels.Http.HttpServerChannel" /> class with the given name and that listens on the specified port.</para>
</summary>
<param name="name">
<attribution license="cc4" from="Microsoft" modified="false" />The name of the channel. </param>
<param name="port">
<attribution license="cc4" from="Microsoft" modified="false" />The port on which the channel listens. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public HttpServerChannel (string name, int port, System.Runtime.Remoting.Channels.IServerChannelSinkProvider sinkProvider);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="port" Type="System.Int32" />
<Parameter Name="sinkProvider" Type="System.Runtime.Remoting.Channels.IServerChannelSinkProvider" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This constructor sets the <see cref="P:System.Runtime.Remoting.Channels.Http.HttpServerChannel.ChannelName" /> property using the <paramref name="name" /> parameter.</para>
<para>To request that an available port be dynamically assigned, set the <paramref name="port" /> parameter to 0 (zero).</para>
<para>If you do not require sink functionality, set the <paramref name="sinkProvider" /> parameter to null.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.Channels.Http.HttpServerChannel" /> class at the specified port with the given name, which listens on the specified port, and uses the specified sink.</para>
</summary>
<param name="name">
<attribution license="cc4" from="Microsoft" modified="false" />The name of the channel. </param>
<param name="port">
<attribution license="cc4" from="Microsoft" modified="false" />The port on which the channel listens. </param>
<param name="sinkProvider">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Runtime.Remoting.Channels.IServerChannelSinkProvider" /> to be used by the channel. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="AddHookChannelUri">
<MemberSignature Language="C#" Value="public void AddHookChannelUri (string channelUri);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="channelUri" Type="System.String" />
</Parameters>
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Adds a URI on which the channel hook must listen.</para>
</summary>
<param name="channelUri">
<attribution license="cc4" from="Microsoft" modified="false" />A URI on which the channel hook must listen. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ChannelData">
<MemberSignature Language="C#" Value="public object ChannelData { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<value>To be added: an object of type 'object'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets channel-specific data.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ChannelName">
<MemberSignature Language="C#" Value="public string ChannelName { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added: an object of type 'string'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Every registered channel has a unique name. This name is used to retrieve a specific channel when calling <see cref="M:System.Runtime.Remoting.Channels.ChannelServices.GetChannel(System.String)" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the name of the current channel.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ChannelPriority">
<MemberSignature Language="C#" Value="public int ChannelPriority { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<value>To be added: an object of type 'int'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The priority controls the order in which channel data appears in a <see cref="T:System.Runtime.Remoting.ObjRef" /> instance; higher priority channels appear before lower priority channels. Clients try to connect to the server channels in the order that they are listed in the <see cref="T:System.Runtime.Remoting.ObjRef" /> instance. The default priority is 1; negative priorities are allowed.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the priority of the current channel.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ChannelScheme">
<MemberSignature Language="C#" Value="public string ChannelScheme { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added: an object of type 'string'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This value is not case-sensitive.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the type of listener to hook into (for example, "http").</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ChannelSinkChain">
<MemberSignature Language="C#" Value="public System.Runtime.Remoting.Channels.IServerChannelSink ChannelSinkChain { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Runtime.Remoting.Channels.IServerChannelSink</ReturnType>
</ReturnValue>
<Docs>
<value>To be added: an object of type 'Runtime.Remoting.Channels.IServerChannelSink'</value>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the channel sink chain that the current channel is using.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetChannelUri">
<MemberSignature Language="C#" Value="public string GetChannelUri ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns the URI of the current channel.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The URI of the current channel.</para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetUrlsForUri">
<MemberSignature Language="C#" Value="public virtual string[] GetUrlsForUri (string objectUri);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String[]</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="objectUri" Type="System.String" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The current method is used by <see cref="M:System.Runtime.Remoting.Channels.ChannelServices.GetUrlsForObject(System.MarshalByRefObject)" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<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.Http.HttpChannel" />.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>An array of the URLs for an object with the specified URI, hosted on the current <see cref="T:System.Runtime.Remoting.Channels.Http.HttpChannel" />.</para>
</returns>
<param name="objectUri">
<attribution license="cc4" from="Microsoft" modified="false" />The URI of the object for which URLs are required. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Item">
<MemberSignature Language="C#" Value="public override object this[object key] { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="key" Type="System.Object" />
</Parameters>
<Docs>
<param name="key">To be added: an object of type 'object'</param>
<summary>To be added</summary>
<value>To be added: an object of type 'object'</value>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Keys">
<MemberSignature Language="C#" Value="public override System.Collections.ICollection Keys { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Collections.ICollection</ReturnType>
</ReturnValue>
<Docs>
<value>To be added: an object of type 'Collections.ICollection'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Channel properties are used to configure the channel at run time. For a list of possible channel properties and an example, see <format type="text/html"><a href="226ECF74-EBBD-4EA0-A701-DCF4441DEEFE">[&lt;topic://cpconchannelformatterconfigurationproperties&gt;]</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a <see cref="T:System.Collections.ICollection" /> of keys the channel properties are associated with.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Parse">
<MemberSignature Language="C#" Value="public string Parse (string url, out string objectURI);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="url" Type="System.String" />
<Parameter Name="objectURI" Type="System.String&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="url">To be added: an object of type 'string'</param>
<param name="objectURI">To be added: an object of type 'string&amp;'</param>
<summary>To be added</summary>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="StartListening">
<MemberSignature Language="C#" Value="public void StartListening (object data);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="data" Type="System.Object" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>It is not necessary to call this method to begin listening on a newly initialized channel.</para>
<para>Use this method to restart listening on a channel after the <see cref="M:System.Runtime.Remoting.Channels.Http.HttpServerChannel.StopListening(System.Object)" /> method has been called to stop listening on the channel.</para>
<para>If your channel uses a dynamically assigned port number, your port number might change when you restart listening.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Instructs the current channel to start listening for requests.</para>
</summary>
<param name="data">
<attribution license="cc4" from="Microsoft" modified="false" />Should always be null for <see cref="T:System.Runtime.Remoting.Channels.Http.HttpChannel" />. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="StopListening">
<MemberSignature Language="C#" Value="public void StopListening (object data);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="data" Type="System.Object" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use this method to stop listening on a channel. To restart listening, use the <see cref="M:System.Runtime.Remoting.Channels.Http.HttpServerChannel.StartListening(System.Object)" /> method.</para>
<para>If your channel uses a dynamically assigned port number, your port number might change when you restart listening.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Instructs the current channel to stop listening for requests.</para>
</summary>
<param name="data">
<attribution license="cc4" from="Microsoft" modified="false" />Should always be null for <see cref="T:System.Runtime.Remoting.Channels.Http.HttpChannel" />. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="WantsToListen">
<MemberSignature Language="C#" Value="public bool WantsToListen { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<value>To be added: an object of type 'bool'</value>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a Boolean value that indicates whether <see cref="T:System.Runtime.Remoting.Channels.IChannelReceiverHook" /> wants to be hooked into the outside listener service.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

301
mcs/class/System.Runtime.Remoting/Documentation/en/System.Runtime.Remoting.Channels.Ipc/IpcChannel.xml Normal file
View File

@@ -0,0 +1,301 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="IpcChannel" FullName="System.Runtime.Remoting.Channels.Ipc.IpcChannel">
<TypeSignature Language="C#" Value="public class IpcChannel : System.Runtime.Remoting.Channels.IChannelReceiver, System.Runtime.Remoting.Channels.IChannelSender" />
<AssemblyInfo>
<AssemblyName>System.Runtime.Remoting</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.Runtime.Remoting.Channels.IChannelReceiver</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.Runtime.Remoting.Channels.IChannelSender</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Channels are used by the.NET Framework remoting infrastructure to transport remote calls. When a client calls a remote object, the call is serialized into a message that is sent by a client channel and received by a server channel. After the message is received, it is deserialized and processed. Any returned values are transmitted by the server channel and received by the client channel.</para>
<para>The <see cref="T:System.Runtime.Remoting.Channels.Ipc.IpcChannel" /> class is a convenience class combining the functionality of the <see cref="T:System.Runtime.Remoting.Channels.Ipc.IpcClientChannel" /> class and the <see cref="T:System.Runtime.Remoting.Channels.Ipc.IpcServerChannel" /> class.</para>
<block subset="none" type="note">
<para>When setting the exclusiveAddressUse property to false in the <paramref name="properties" /> argument, several <see cref="T:System.Runtime.Remoting.Channels.Ipc.IpcServerChannel" /> objects can be registered for the same named pipe. In such a case requests can go to any of the channels registered. This setting is considered secure only if ALCs are also used.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides a channel implementation that uses the IPC protocol to transmit messages.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public IpcChannel ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.Channels.Ipc.IpcChannel" /> class, activating only a client channel, and not a server channel.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public IpcChannel (string portName);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="portName" Type="System.String" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.Channels.Ipc.IpcChannel" /> class with a server channel that listens on the specified IPC port.</para>
</summary>
<param name="portName">
<attribution license="cc4" from="Microsoft" modified="false" />The name of the IPC port.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public IpcChannel (System.Collections.IDictionary properties, System.Runtime.Remoting.Channels.IClientChannelSinkProvider clientSinkProvider, System.Runtime.Remoting.Channels.IServerChannelSinkProvider serverSinkProvider);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="properties" Type="System.Collections.IDictionary" />
<Parameter Name="clientSinkProvider" Type="System.Runtime.Remoting.Channels.IClientChannelSinkProvider" />
<Parameter Name="serverSinkProvider" Type="System.Runtime.Remoting.Channels.IServerChannelSinkProvider" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
<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>
<block subset="none" type="note">
<para>When setting the exclusiveAddressUse property to false in the <paramref name="properties" /> argument, several <see cref="T:System.Runtime.Remoting.Channels.Ipc.IpcServerChannel" /> objects can be registered for the same named pipe. In such a case requests can go to any of the channels registered. This setting is considered secure only if ALCs are also used.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.Channels.Ipc.IpcChannel" /> class with the specified configuration properties and sinks.</para>
</summary>
<param name="properties">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Collections.IDictionary" /> collection specifying values for configuration properties to be used by the client and server channels. </param>
<param name="clientSinkProvider">
<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>
<param name="serverSinkProvider">
<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>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ChannelData">
<MemberSignature Language="C#" Value="public object ChannelData { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the channel-specific data.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ChannelName">
<MemberSignature Language="C#" Value="public string ChannelName { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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)" />. The default name is "ipc".</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the name of the current channel.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ChannelPriority">
<MemberSignature Language="C#" Value="public int ChannelPriority { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The default priority is 20.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the priority of the current channel.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CreateMessageSink">
<MemberSignature Language="C#" Value="public System.Runtime.Remoting.Messaging.IMessageSink CreateMessageSink (string url, object remoteChannelData, out string objectUri);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Runtime.Remoting.Messaging.IMessageSink</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="url" Type="System.String" />
<Parameter Name="remoteChannelData" Type="System.Object" />
<Parameter Name="objectUri" Type="System.String&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="url">To be added.</param>
<param name="remoteChannelData">To be added.</param>
<param name="objectUri">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetUrlsForUri">
<MemberSignature Language="C#" Value="public string[] GetUrlsForUri (string objectUri);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String[]</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="objectUri" Type="System.String" />
</Parameters>
<Docs>
<param name="objectUri">To be added.</param>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method is used by <see cref="M:System.Runtime.Remoting.Channels.ChannelServices.GetUrlsForObject(System.MarshalByRefObject)" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<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.Ipc.IpcChannel" />.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>An array of the URLs for an object with the specified URI, hosted on the current <see cref="T:System.Runtime.Remoting.Channels.Ipc.IpcChannel" />.</para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Parse">
<MemberSignature Language="C#" Value="public string Parse (string url, out string objectUri);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="url" Type="System.String" />
<Parameter Name="objectUri" Type="System.String&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="url">To be added.</param>
<param name="objectUri">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="StartListening">
<MemberSignature Language="C#" Value="public void StartListening (object data);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="data" Type="System.Object" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>It is not necessary to call this method to begin listening on a newly initialized channel.</para>
<para>Use this method to restart listening on a channel after the <see cref="M:System.Runtime.Remoting.Channels.Ipc.IpcChannel.StopListening(System.Object)" /> method has been called.</para>
<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>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Instructs the current channel to start listening for requests.</para>
</summary>
<param name="data">
<attribution license="cc4" from="Microsoft" modified="false" />Optional initialization information. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="StopListening">
<MemberSignature Language="C#" Value="public void StopListening (object data);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="data" Type="System.Object" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use this method to stop listening on a channel. To restart listening, use the <see cref="M:System.Runtime.Remoting.Channels.Ipc.IpcChannel.StartListening(System.Object)" /> method.</para>
<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>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Instructs the current channel to stop listening for requests.</para>
</summary>
<param name="data">
<attribution license="cc4" from="Microsoft" modified="false" />Optional state information for the channel. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

224
mcs/class/System.Runtime.Remoting/Documentation/en/System.Runtime.Remoting.Channels.Ipc/IpcClientChannel.xml Normal file
View File

@@ -0,0 +1,224 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="IpcClientChannel" FullName="System.Runtime.Remoting.Channels.Ipc.IpcClientChannel">
<TypeSignature Language="C#" Value="public class IpcClientChannel : System.Runtime.Remoting.Channels.IChannelSender" />
<AssemblyInfo>
<AssemblyName>System.Runtime.Remoting</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.Runtime.Remoting.Channels.IChannelSender</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Channels are used by the.NET Framework remoting infrastructure to transport remote calls. When a client calls a remote object, the call is serialized into a message that is sent by a client channel and received by a server channel. After the message is received, it is deserialized and processed. Any returned values are transmitted by the server channel and received by the client channel.</para>
<para>The <see cref="T:System.Runtime.Remoting.Channels.Ipc.IpcClientChannel" /> class uses the Windows interprocess communication (IPC) system to transport messages between application domains on the same computer. When communicating between application domains on the same computer, the IPC channel is much faster than the TCP or HTTP channels.</para>
<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.Ipc.IpcClientChannel" /> object will be passed.</para>
<para>By default, the <see cref="T:System.Runtime.Remoting.Channels.Ipc.IpcClientChannel" /> class uses a binary formatter to serialize all messages.</para>
<para>A <see cref="T:System.Runtime.Remoting.Channels.Ipc.IpcClientChannel" /> 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.Ipc.IpcClientChannel.#ctor(System.Collections.IDictionary,System.Runtime.Remoting.Channels.IClientChannelSinkProvider)" /> constructor). For a list of these configuration properties, see the documentation for the <see cref="M:System.Runtime.Remoting.Channels.Ipc.IpcClientChannel.#ctor(System.Collections.IDictionary,System.Runtime.Remoting.Channels.IClientChannelSinkProvider)" /> constructor.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Implements a client channel for remote calls that uses the IPC protocol to transmit messages.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public IpcClientChannel ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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. The following table shows the default value for each configuration property.</para>
<list type="table">
<listheader>
<item>
<term>
<para>Configuration property</para>
</term>
<description>
<para>Description</para>
</description>
</item>
</listheader>
<item>
<term>
<para>name</para>
</term>
<description>
<para>The default name is "ipc client". Each channel must have a unique name.</para>
</description>
</item>
<item>
<term>
<para>priority</para>
</term>
<description>
<para>The default priority is 1.</para>
</description>
</item>
</list>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.Channels.Ipc.IpcServerChannel" /> class.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public IpcClientChannel (System.Collections.IDictionary properties, System.Runtime.Remoting.Channels.IClientChannelSinkProvider sinkProvider);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="properties" Type="System.Collections.IDictionary" />
<Parameter Name="sinkProvider" Type="System.Runtime.Remoting.Channels.IClientChannelSinkProvider" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
<para>If you do not require sink functionality, set the <paramref name="sinkProvider" /> parameter to null.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.Channels.Ipc.IpcClientChannel" /> class with the specified configuration properties and sink.</para>
</summary>
<param name="properties">
<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>
<param name="sinkProvider">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Runtime.Remoting.Channels.IServerChannelSinkProvider" /> implementation to be used by the channel.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public IpcClientChannel (string name, System.Runtime.Remoting.Channels.IClientChannelSinkProvider sinkProvider);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="sinkProvider" Type="System.Runtime.Remoting.Channels.IClientChannelSinkProvider" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This constructor sets the <see cref="P:System.Runtime.Remoting.Channels.Ipc.IpcClientChannel.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>
<para>If you do not require sink functionality, set the <paramref name="sinkProvider" /> parameter to null.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.Channels.Ipc.IpcClientChannel" /> class with the specified name and sink.</para>
</summary>
<param name="name">
<attribution license="cc4" from="Microsoft" modified="false" />The name of the channel.</param>
<param name="sinkProvider">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Runtime.Remoting.Channels.IClientChannelSinkProvider" /> implementation to be used by the channel.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ChannelName">
<MemberSignature Language="C#" Value="public string ChannelName { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Every registered channel has a unique name. The name is used to retrieve a specific channel when calling the <see cref="M:System.Runtime.Remoting.Channels.ChannelServices.GetChannel(System.String)" /> method. The default name is "ipc client".</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the name of the current channel.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ChannelPriority">
<MemberSignature Language="C#" Value="public int ChannelPriority { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the priority of the current channel.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CreateMessageSink">
<MemberSignature Language="C#" Value="public System.Runtime.Remoting.Messaging.IMessageSink CreateMessageSink (string url, object remoteChannelData, out string objectUri);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Runtime.Remoting.Messaging.IMessageSink</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="url" Type="System.String" />
<Parameter Name="remoteChannelData" Type="System.Object" />
<Parameter Name="objectUri" Type="System.String&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="url">To be added.</param>
<param name="remoteChannelData">To be added.</param>
<param name="objectUri">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Parse">
<MemberSignature Language="C#" Value="public string Parse (string url, out string objectUri);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="url" Type="System.String" />
<Parameter Name="objectUri" Type="System.String&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="url">To be added.</param>
<param name="objectUri">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

339
mcs/class/System.Runtime.Remoting/Documentation/en/System.Runtime.Remoting.Channels.Ipc/IpcServerChannel.xml Normal file
View File

@@ -0,0 +1,339 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="IpcServerChannel" FullName="System.Runtime.Remoting.Channels.Ipc.IpcServerChannel">
<TypeSignature Language="C#" Value="public class IpcServerChannel : System.Runtime.Remoting.Channels.IChannelReceiver" />
<AssemblyInfo>
<AssemblyName>System.Runtime.Remoting</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.Runtime.Remoting.Channels.IChannelReceiver</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Channels are used by the .NET Framework remoting infrastructure to transport remote calls. When a client calls a remote object, the call is serialized into a message that is sent by a client channel and received by a server channel. After the message is received, it is deserialized and processed. Any returned values are transmitted by the server channel and received by the client channel.</para>
<para>The <see cref="T:System.Runtime.Remoting.Channels.Ipc.IpcServerChannel" /> class uses the Windows interprocess communication (IPC) system to transport messages between application domains on the same computer. When communicating between application domains on the same computer, the IPC channel is much faster than the TCP or HTTP channels.</para>
<para>To perform additional processing of messages on the server side, specify an implementation of the <see cref="T:System.Runtime.Remoting.Channels.IServerChannelSinkProvider" /> interface through which all messages processed by the <see cref="T:System.Runtime.Remoting.Channels.Ipc.IpcServerChannel" /> instance are passed.</para>
<para>The <see cref="T:System.Runtime.Remoting.Channels.Ipc.IpcServerChannel" /> instance accepts messages serialized in either binary or SOAP format.</para>
<para>A <see cref="T:System.Runtime.Remoting.Channels.Ipc.IpcServerChannel" /> 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 an <see cref="T:System.Collections.IDictionary" /> collection to the <see cref="M:System.Runtime.Remoting.Channels.Ipc.IpcServerChannel.#ctor(System.Collections.IDictionary,System.Runtime.Remoting.Channels.IServerChannelSinkProvider)" /> constructor). For a list of these configuration properties, see the documentation for the <see cref="M:System.Runtime.Remoting.Channels.Ipc.IpcServerChannel.#ctor(System.Collections.IDictionary,System.Runtime.Remoting.Channels.IServerChannelSinkProvider)" /> constructor.</para>
<block subset="none" type="note">
<para>When setting the exclusiveAddressUse property to false in the <paramref name="properties" /> argument, several <see cref="T:System.Runtime.Remoting.Channels.Ipc.IpcServerChannel" /> objects can be registered for the same named pipe. In such a case requests can go to any of the channels registered. This setting is considered secure only if ALCs are also used.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Implements a server channel for remote calls that uses the IPC system to transmit messages.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public IpcServerChannel (string portName);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="portName" Type="System.String" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.Channels.Ipc.IpcServerChannel" /> class with the specified IPC port name.</para>
</summary>
<param name="portName">
<attribution license="cc4" from="Microsoft" modified="false" />The name of the IPC port to be used by the channel.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public IpcServerChannel (System.Collections.IDictionary properties, System.Runtime.Remoting.Channels.IServerChannelSinkProvider serverSinkProvider);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="properties" Type="System.Collections.IDictionary" />
<Parameter Name="serverSinkProvider" Type="System.Runtime.Remoting.Channels.IServerChannelSinkProvider" />
</Parameters>
<Docs>
<param name="serverSinkProvider">To be added.</param>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
<para>If you do not require sink functionality, set the <paramref name="sinkProvider" /> parameter to null.</para>
<block subset="none" type="note">
<para>When setting the exclusiveAddressUse property to false in the <paramref name="properties" /> argument, several <see cref="T:System.Runtime.Remoting.Channels.Ipc.IpcServerChannel" /> objects can be registered for the same named pipe. In such a case requests can go to any of the channels registered. This setting is considered secure only if ALCs are also used.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.Channels.Ipc.IpcServerChannel" /> class with the specified channel properties and sink.</para>
</summary>
<param name="properties">
<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>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public IpcServerChannel (string name, string portName);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="portName" Type="System.String" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This constructor sets the <see cref="P:System.Runtime.Remoting.Channels.Ipc.IpcServerChannel.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>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.Channels.Ipc.IpcServerChannel" /> class with the specified channel name and IPC port name.</para>
</summary>
<param name="name">
<attribution license="cc4" from="Microsoft" modified="false" />The name of the channel.</param>
<param name="portName">
<attribution license="cc4" from="Microsoft" modified="false" />The name of the IPC port to be used by the channel.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public IpcServerChannel (string name, string portName, System.Runtime.Remoting.Channels.IServerChannelSinkProvider serverSinkProvider);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="portName" Type="System.String" />
<Parameter Name="serverSinkProvider" Type="System.Runtime.Remoting.Channels.IServerChannelSinkProvider" />
</Parameters>
<Docs>
<param name="serverSinkProvider">To be added.</param>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This constructor sets the <see cref="P:System.Runtime.Remoting.Channels.Ipc.IpcServerChannel.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>
<para>If you do not require sink functionality, set the <paramref name="sinkProvider" /> parameter to null.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.Channels.Ipc.IpcServerChannel" /> class with the specified channel name, IPC port name, and sink.</para>
</summary>
<param name="name">
<attribution license="cc4" from="Microsoft" modified="false" />The name of the channel.</param>
<param name="portName">
<attribution license="cc4" from="Microsoft" modified="false" />The name of the IPC port to be used by the channel.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ChannelData">
<MemberSignature Language="C#" Value="public object ChannelData { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Although returned as an instance of the <see cref="T:System.Object" /> class, the value of this property can be cast to an instance of <see cref="T:System.Runtime.Remoting.Channels.ChannelDataStore" /> that describes the channel to which the <see cref="T:System.Runtime.Remoting.Channels.Ipc.IpcServerChannel" /> object listens.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets channel-specific data.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ChannelName">
<MemberSignature Language="C#" Value="public string ChannelName { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Every registered channel has a unique name. The name is used to retrieve a specific channel when calling the <see cref="M:System.Runtime.Remoting.Channels.ChannelServices.GetChannel(System.String)" /> method. The default name is "ipc server".</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the name of the current channel.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ChannelPriority">
<MemberSignature Language="C#" Value="public int ChannelPriority { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The priority controls the order in which channel data appears in a <see cref="T:System.Runtime.Remoting.ObjRef" /> instance; higher priority channels appear before lower priority channels. Clients try to connect to the server channels in the order that they are listed in the <see cref="T:System.Runtime.Remoting.ObjRef" /> instance. The default priority is 20; negative priorities are allowed.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the priority of the current channel.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetChannelUri">
<MemberSignature Language="C#" Value="public string GetChannelUri ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The channel URI is used by the client to specify a remote server channel.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns the URI of the current channel.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A <see cref="T:System.String" /> that contains the URI of the channel.</para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetUrlsForUri">
<MemberSignature Language="C#" Value="public string[] GetUrlsForUri (string objectUri);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String[]</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="objectUri" Type="System.String" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method is used by the <see cref="M:System.Runtime.Remoting.Channels.ChannelServices.GetUrlsForObject(System.MarshalByRefObject)" /> method.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns an array of all the URLs for the object with the specified URI, hosted on the current <see cref="T:System.Runtime.Remoting.Channels.Ipc.IpcChannel" /> instance.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<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" /> instance.</para>
</returns>
<param name="objectUri">
<attribution license="cc4" from="Microsoft" modified="false" />The URI of the object for which URLs are required.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Parse">
<MemberSignature Language="C#" Value="public string Parse (string url, out string objectUri);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="url" Type="System.String" />
<Parameter Name="objectUri" Type="System.String&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="url">To be added.</param>
<param name="objectUri">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="StartListening">
<MemberSignature Language="C#" Value="public void StartListening (object data);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="data" Type="System.Object" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>It is not necessary to call this method to begin listening on a newly initialized channel.</para>
<para>Use this method to restart listening on a channel after the <see cref="M:System.Runtime.Remoting.Channels.Ipc.IpcServerChannel.StopListening(System.Object)" /> method has been called to stop listening on the channel.</para>
<para>The data object 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, pass null as the <paramref name="data" /> parameter value.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Instructs the current channel to start listening for requests.</para>
</summary>
<param name="data">
<attribution license="cc4" from="Microsoft" modified="false" />An object that specifies an initialization state, or null, if you do not want to pass a specific state to the channel.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="StopListening">
<MemberSignature Language="C#" Value="public void StopListening (object data);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="data" Type="System.Object" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use this method to stop listening on a channel. To restart listening, use the <see cref="M:System.Runtime.Remoting.Channels.Ipc.IpcServerChannel.StartListening(System.Object)" /> method.</para>
<para>The data object 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, pass null as the <paramref name="data" /> parameter value.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Instructs the current channel to stop listening for requests.</para>
</summary>
<param name="data">
<attribution license="cc4" from="Microsoft" modified="false" />An object that specifies an initialization state, or null, if you do not want to pass a specific state to the channel.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

315
mcs/class/System.Runtime.Remoting/Documentation/en/System.Runtime.Remoting.Channels.Tcp/TcpChannel.xml Normal file
View File

@@ -0,0 +1,315 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="TcpChannel" FullName="System.Runtime.Remoting.Channels.Tcp.TcpChannel">
<TypeSignature Language="C#" Maintainer="auto" Value="public class TcpChannel : System.Runtime.Remoting.Channels.IChannelReceiver, System.Runtime.Remoting.Channels.IChannelSender" />
<AssemblyInfo>
<AssemblyName>System.Runtime.Remoting</AssemblyName>
<AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00]</AssemblyPublicKey>
<AssemblyVersion>1.0.3300.0</AssemblyVersion>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<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>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.Runtime.Remoting.Channels.IChannelReceiver</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.Runtime.Remoting.Channels.IChannelSender</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
<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>
<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>
<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>
<block subset="none" type="note">
<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>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides a channel implementation that uses the TCP protocol to transmit messages.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TcpChannel ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TcpChannel (int port);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="port" Type="System.Int32" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
<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>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
</summary>
<param name="port">
<attribution license="cc4" from="Microsoft" modified="false" />The port on which the server channel listens. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TcpChannel (System.Collections.IDictionary properties, System.Runtime.Remoting.Channels.IClientChannelSinkProvider clientSinkProvider, System.Runtime.Remoting.Channels.IServerChannelSinkProvider serverSinkProvider);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="properties" Type="System.Collections.IDictionary" />
<Parameter Name="clientSinkProvider" Type="System.Runtime.Remoting.Channels.IClientChannelSinkProvider" />
<Parameter Name="serverSinkProvider" Type="System.Runtime.Remoting.Channels.IServerChannelSinkProvider" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
<block subset="none" type="note">
<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>
</block>
<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>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
</summary>
<param name="properties">
<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>
<param name="clientSinkProvider">
<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>
<param name="serverSinkProvider">
<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>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ChannelData">
<MemberSignature Language="C#" Value="public object ChannelData { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<value>To be added: an object of type 'object'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the channel-specific data.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ChannelName">
<MemberSignature Language="C#" Value="public string ChannelName { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added: an object of type 'string'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the name of the current channel.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ChannelPriority">
<MemberSignature Language="C#" Value="public int ChannelPriority { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<value>To be added: an object of type 'int'</value>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the priority of the current channel.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CreateMessageSink">
<MemberSignature Language="C#" Value="public System.Runtime.Remoting.Messaging.IMessageSink CreateMessageSink (string url, object remoteChannelData, out string objectURI);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Runtime.Remoting.Messaging.IMessageSink</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="url" Type="System.String" />
<Parameter Name="remoteChannelData" Type="System.Object" />
<Parameter Name="objectURI" Type="System.String&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="url">To be added: an object of type 'string'</param>
<param name="remoteChannelData">To be added: an object of type 'object'</param>
<param name="objectURI">To be added: an object of type 'string&amp;'</param>
<summary>To be added</summary>
<returns>To be added: an object of type 'Runtime.Remoting.Messaging.IMessageSink'</returns>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetUrlsForUri">
<MemberSignature Language="C#" Value="public string[] GetUrlsForUri (string uri);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String[]</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="uri" Type="System.String" />
</Parameters>
<Docs>
<param name="uri">To be added: an object of type 'string'</param>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method is used by <see cref="M:System.Runtime.Remoting.Channels.ChannelServices.GetUrlsForObject(System.MarshalByRefObject)" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Parse">
<MemberSignature Language="C#" Value="public string Parse (string url, out string objectURI);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="url" Type="System.String" />
<Parameter Name="objectURI" Type="System.String&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="url">To be added: an object of type 'string'</param>
<param name="objectURI">To be added: an object of type 'string&amp;'</param>
<summary>To be added</summary>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="StartListening">
<MemberSignature Language="C#" Value="public void StartListening (object data);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="data" Type="System.Object" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>It is not necessary to call this method to begin listening on a newly initialized channel.</para>
<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>
<para>If your channel uses a dynamically assigned port number, your port number might change when you restart listening.</para>
<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>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Instructs the current channel to start listening for requests.</para>
</summary>
<param name="data">
<attribution license="cc4" from="Microsoft" modified="false" />Optional initialization information. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="StopListening">
<MemberSignature Language="C#" Value="public void StopListening (object data);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="data" Type="System.Object" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
<para>If your channel uses a dynamically assigned port number, your port number might change when you restart listening.</para>
<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>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Instructs the current channel to stop listening for requests.</para>
</summary>
<param name="data">
<attribution license="cc4" from="Microsoft" modified="false" />Optional state information for the channel. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

202
mcs/class/System.Runtime.Remoting/Documentation/en/System.Runtime.Remoting.Channels.Tcp/TcpClientChannel.xml Normal file
View File

@@ -0,0 +1,202 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="TcpClientChannel" FullName="System.Runtime.Remoting.Channels.Tcp.TcpClientChannel">
<TypeSignature Language="C#" Maintainer="auto" Value="public class TcpClientChannel : System.Runtime.Remoting.Channels.IChannelSender" />
<AssemblyInfo>
<AssemblyName>System.Runtime.Remoting</AssemblyName>
<AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00]</AssemblyPublicKey>
<AssemblyVersion>1.0.3300.0</AssemblyVersion>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<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>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.Runtime.Remoting.Channels.IChannelSender</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
<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>
<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>
<para>By default, the <see cref="T:System.Runtime.Remoting.Channels.Tcp.TcpClientChannel" /> class uses a binary formatter to serialize all messages.</para>
<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>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>For remote calls, implements a client channel that uses the TCP protocol to transmit messages.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TcpClientChannel ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.Channels.Tcp.TcpClientChannel" /> class.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TcpClientChannel (System.Collections.IDictionary properties, System.Runtime.Remoting.Channels.IClientChannelSinkProvider sinkProvider);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="properties" Type="System.Collections.IDictionary" />
<Parameter Name="sinkProvider" Type="System.Runtime.Remoting.Channels.IClientChannelSinkProvider" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
<para>If you do not require sink functionality, set the <paramref name="sinkProvider" /> parameter to null.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
</summary>
<param name="properties">
<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>
<param name="sinkProvider">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Runtime.Remoting.Channels.IServerChannelSinkProvider" /> implementation to be used by the channel. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TcpClientChannel (string name, System.Runtime.Remoting.Channels.IClientChannelSinkProvider sinkProvider);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="sinkProvider" Type="System.Runtime.Remoting.Channels.IClientChannelSinkProvider" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
<para>If you do not require sink functionality, set the <paramref name="sinkProvider" /> parameter to null.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.Channels.Tcp.TcpClientChannel" /> class with the specified name and sink.</para>
</summary>
<param name="name">
<attribution license="cc4" from="Microsoft" modified="false" />The name of the channel. </param>
<param name="sinkProvider">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Runtime.Remoting.Channels.IClientChannelSinkProvider" /> implementation to be used by the channel. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ChannelName">
<MemberSignature Language="C#" Value="public string ChannelName { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added: an object of type 'string'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the name of the current channel.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ChannelPriority">
<MemberSignature Language="C#" Value="public int ChannelPriority { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<value>To be added: an object of type 'int'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the priority of the current channel.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CreateMessageSink">
<MemberSignature Language="C#" Value="public virtual System.Runtime.Remoting.Messaging.IMessageSink CreateMessageSink (string url, object remoteChannelData, out string objectURI);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Runtime.Remoting.Messaging.IMessageSink</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="url" Type="System.String" />
<Parameter Name="remoteChannelData" Type="System.Object" />
<Parameter Name="objectURI" Type="System.String&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="url">To be added: an object of type 'string'</param>
<param name="remoteChannelData">To be added: an object of type 'object'</param>
<param name="objectURI">To be added: an object of type 'string&amp;'</param>
<summary>To be added</summary>
<returns>To be added: an object of type 'Runtime.Remoting.Messaging.IMessageSink'</returns>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Parse">
<MemberSignature Language="C#" Value="public string Parse (string url, out string objectURI);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="url" Type="System.String" />
<Parameter Name="objectURI" Type="System.String&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="url">To be added: an object of type 'string'</param>
<param name="objectURI">To be added: an object of type 'string&amp;'</param>
<summary>To be added</summary>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

349
mcs/class/System.Runtime.Remoting/Documentation/en/System.Runtime.Remoting.Channels.Tcp/TcpServerChannel.xml Normal file
View File

@@ -0,0 +1,349 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="TcpServerChannel" FullName="System.Runtime.Remoting.Channels.Tcp.TcpServerChannel">
<TypeSignature Language="C#" Maintainer="auto" Value="public class TcpServerChannel : System.Runtime.Remoting.Channels.IChannelReceiver" />
<AssemblyInfo>
<AssemblyName>System.Runtime.Remoting</AssemblyName>
<AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00]</AssemblyPublicKey>
<AssemblyVersion>1.0.3300.0</AssemblyVersion>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<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>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.Runtime.Remoting.Channels.IChannelReceiver</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Channels transport messages across remoting boundaries (for example, computers or application domains). The <see cref="T:System.Runtime.Remoting.Channels.Tcp.TcpServerChannel" /> class transports messages using the TCP protocol.</para>
<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>
<para>To perform additional processing of messages on the server side, you can specify an implementation of the <see cref="T:System.Runtime.Remoting.Channels.IServerChannelSinkProvider" /> interface through which all messages processed by the <see cref="T:System.Runtime.Remoting.Channels.Tcp.TcpServerChannel" /> instance are passed.</para>
<para>The <see cref="T:System.Runtime.Remoting.Channels.Tcp.TcpServerChannel" /> instance accepts messages serialized in either binary or SOAP format.</para>
<para>A <see cref="T:System.Runtime.Remoting.Channels.Tcp.TcpServerChannel" /> 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.TcpServerChannel.#ctor(System.Collections.IDictionary,System.Runtime.Remoting.Channels.IServerChannelSinkProvider)" /> constructor). For a list of these configuration properties, see <format type="text/html"><a href="226ecf74-ebbd-4ea0-a701-dcf4441deefe">Channel and Formatter Configuration Properties</a></format>.</para>
<block subset="none" type="note">
<para>If the server computer is running Windows 95/98/Me, the <see cref="T:System.Runtime.Remoting.Channels.Tcp.TcpServerChannel" /> cannot be specified as secure.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Implements a server channel for remote calls that uses the TCP protocol to transmit messages.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TcpServerChannel (int port);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="port" Type="System.Int32" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>To request that an available port be dynamically assigned, set the <paramref name="port" /> parameter to 0 (zero).</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.Channels.Tcp.TcpServerChannel" /> class that listens on the specified port.</para>
</summary>
<param name="port">
<attribution license="cc4" from="Microsoft" modified="false" />The port on which the channel listens. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TcpServerChannel (System.Collections.IDictionary properties, System.Runtime.Remoting.Channels.IServerChannelSinkProvider serverSinkProvider);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="properties" Type="System.Collections.IDictionary" />
<Parameter Name="serverSinkProvider" Type="System.Runtime.Remoting.Channels.IServerChannelSinkProvider" />
</Parameters>
<Docs>
<param name="serverSinkProvider">To be added.</param>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
<block subset="none" type="note">
<para>If the server computer is running Windows 95/98/Me, the <see cref="T:System.Runtime.Remoting.Channels.Tcp.TcpServerChannel" /> cannot be specified as secure.</para>
</block>
<para>If you do not require sink functionality, set the <paramref name="sinkProvider" /> parameter to null.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.Channels.Tcp.TcpServerChannel" /> class with the specified channel properties and sink.</para>
</summary>
<param name="properties">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Collections.IDictionary" /> collection specifying values for configuration properties to be used by the channel. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TcpServerChannel (string name, int port);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="port" Type="System.Int32" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This constructor sets the <see cref="P:System.Runtime.Remoting.Channels.Tcp.TcpServerChannel.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>
<para>To request that an available port be dynamically assigned, set the <paramref name="port" /> parameter to 0 (zero).</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.Channels.Tcp.TcpServerChannel" /> class with the given name and that listens on the specified port.</para>
</summary>
<param name="name">
<attribution license="cc4" from="Microsoft" modified="false" />The name of the channel. </param>
<param name="port">
<attribution license="cc4" from="Microsoft" modified="false" />The port on which the channel listens. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TcpServerChannel (string name, int port, System.Runtime.Remoting.Channels.IServerChannelSinkProvider serverSinkProvider);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="port" Type="System.Int32" />
<Parameter Name="serverSinkProvider" Type="System.Runtime.Remoting.Channels.IServerChannelSinkProvider" />
</Parameters>
<Docs>
<param name="serverSinkProvider">To be added.</param>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This constructor sets the <see cref="P:System.Runtime.Remoting.Channels.Tcp.TcpServerChannel.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>
<para>To request that an available port be dynamically assigned, set the <paramref name="port" /> parameter to 0 (zero).</para>
<para>If you do not require sink functionality, set the <paramref name="sinkProvider" /> parameter to null.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.Channels.Tcp.TcpServerChannel" /> class with the given name, which listens on the specified port, and uses the specified sink.</para>
</summary>
<param name="name">
<attribution license="cc4" from="Microsoft" modified="false" />The name of the channel. </param>
<param name="port">
<attribution license="cc4" from="Microsoft" modified="false" />The port on which the channel listens. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ChannelData">
<MemberSignature Language="C#" Value="public object ChannelData { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<value>To be added: an object of type 'object'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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.Tcp.TcpServerChannel" /> object listens.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets channel-specific data.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ChannelName">
<MemberSignature Language="C#" Value="public string ChannelName { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added: an object of type 'string'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the name of the current channel.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ChannelPriority">
<MemberSignature Language="C#" Value="public int ChannelPriority { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<value>To be added: an object of type 'int'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The priority controls the order in which channel data appears in a <see cref="T:System.Runtime.Remoting.ObjRef" /> instance; higher priority channels appear before lower priority channels. Clients try to connect to the server channels in the order that they are listed in the <see cref="T:System.Runtime.Remoting.ObjRef" /> instance. The default priority is 1; negative priorities are allowed.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the priority of the current channel.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetChannelUri">
<MemberSignature Language="C#" Value="public string GetChannelUri ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns the URI of the current channel.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The URI of the current channel.</para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetUrlsForUri">
<MemberSignature Language="C#" Value="public virtual string[] GetUrlsForUri (string uri);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String[]</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="uri" Type="System.String" />
</Parameters>
<Docs>
<param name="uri">To be added: an object of type 'string'</param>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method is used by <see cref="M:System.Runtime.Remoting.Channels.ChannelServices.GetUrlsForObject(System.MarshalByRefObject)" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<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" /> instance.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<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" /> instance.</para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Parse">
<MemberSignature Language="C#" Value="public string Parse (string url, out string objectURI);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="url" Type="System.String" />
<Parameter Name="objectURI" Type="System.String&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="url">To be added: an object of type 'string'</param>
<param name="objectURI">To be added: an object of type 'string&amp;'</param>
<summary>To be added</summary>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="StartListening">
<MemberSignature Language="C#" Value="public void StartListening (object data);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="data" Type="System.Object" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>It is not necessary to call this method to begin listening on a newly initialized channel.</para>
<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 to stop listening on the channel.</para>
<para>If your channel uses a dynamically assigned port number, your port number might change when you restart listening.</para>
<para>The data object 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>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Instructs the current channel to start listening for requests.</para>
</summary>
<param name="data">
<attribution license="cc4" from="Microsoft" modified="false" />Optional initialization information. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="StopListening">
<MemberSignature Language="C#" Value="public void StopListening (object data);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="data" Type="System.Object" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
<para>If your channel uses a dynamically assigned port number, your port number might change when you restart listening.</para>
<para>The data object 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>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Instructs the current channel to stop listening for requests.</para>
</summary>
<param name="data">
<attribution license="cc4" from="Microsoft" modified="false" />Optional state information for the channel. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

317
mcs/class/System.Runtime.Remoting/Documentation/en/System.Runtime.Remoting.Channels/BinaryClientFormatterSink.xml Normal file
View File

@@ -0,0 +1,317 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="BinaryClientFormatterSink" FullName="System.Runtime.Remoting.Channels.BinaryClientFormatterSink">
<TypeSignature Language="C#" Maintainer="auto" Value="public class BinaryClientFormatterSink : System.Runtime.Remoting.Channels.IClientFormatterSink" />
<AssemblyInfo>
<AssemblyName>System.Runtime.Remoting</AssemblyName>
<AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00]</AssemblyPublicKey>
<AssemblyVersion>1.0.3300.0</AssemblyVersion>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<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>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.Runtime.Remoting.Channels.IClientFormatterSink</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The function of the formatter sink is to generate the necessary headers and serialize the message to the stream. After the formatter sink, the <see cref="T:System.Runtime.Remoting.Messaging.IMessage" /> is forwarded to all sinks in the chain through the <see cref="M:System.Runtime.Remoting.Channels.IClientChannelSink.ProcessMessage(System.Runtime.Remoting.Messaging.IMessage,System.Runtime.Remoting.Channels.ITransportHeaders,System.IO.Stream,System.Runtime.Remoting.Channels.ITransportHeaders@,System.IO.Stream@)" /> or <see cref="M:System.Runtime.Remoting.Channels.IClientChannelSink.AsyncProcessRequest(System.Runtime.Remoting.Channels.IClientChannelSinkStack,System.Runtime.Remoting.Messaging.IMessage,System.Runtime.Remoting.Channels.ITransportHeaders,System.IO.Stream)" /> calls. At this stage the message has already been serialized and is provided as information only. Sinks that need to create or modify the message must be placed in the sink chain before the formatter. This is easily achieved by implementing the <see cref="T:System.Runtime.Remoting.Channels.IClientFormatterSink" /> interface, which gives the impression of having a reference to the formatter sink. The real formatter sink can then be placed later in the sink chain.</para>
<list type="table">
<listheader>
<item>
<term>
<para>Property </para>
</term>
<description>
<para>Description </para>
</description>
</item>
</listheader>
<item>
<term>
<para>includeVersions </para>
</term>
<description>
<para>Specifies whether the formatter will include versioning information. Values are true or false.</para>
</description>
</item>
</list>
<block subset="none" type="note">
<para>Using an instance of this object with untrusted data or across an unsecure channel is a security risk. Use this object only with trusted data and across a secure channel. For more information, see <see cref="http://go.microsoft.com/fwlink/?LinkId=330378">Untrusted Data Security Risks</see>.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides the implementation for a client formatter sink that uses the <see cref="T:System.Runtime.Serialization.Formatters.Binary.BinaryFormatter" />.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public BinaryClientFormatterSink (System.Runtime.Remoting.Channels.IClientChannelSink nextSink);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="nextSink" Type="System.Runtime.Remoting.Channels.IClientChannelSink" />
</Parameters>
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.Channels.BinaryClientFormatterSink" /> class.</para>
</summary>
<param name="nextSink">
<attribution license="cc4" from="Microsoft" modified="false" />The next <see cref="T:System.Runtime.Remoting.Channels.IClientChannelSink" /> in the sink chain. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="AsyncProcessMessage">
<MemberSignature Language="C#" Value="public System.Runtime.Remoting.Messaging.IMessageCtrl AsyncProcessMessage (System.Runtime.Remoting.Messaging.IMessage msg, System.Runtime.Remoting.Messaging.IMessageSink replySink);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Runtime.Remoting.Messaging.IMessageCtrl</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="msg" Type="System.Runtime.Remoting.Messaging.IMessage" />
<Parameter Name="replySink" Type="System.Runtime.Remoting.Messaging.IMessageSink" />
</Parameters>
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Asynchronously processes the provided message.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A <see cref="T:System.Runtime.Remoting.Messaging.IMessageCtrl" /> that provides a way to control the asynchronous message after it has been dispatched.</para>
</returns>
<param name="msg">
<attribution license="cc4" from="Microsoft" modified="false" />The message to process. </param>
<param name="replySink">
<attribution license="cc4" from="Microsoft" modified="false" />The sink that will receive the reply to the provided message. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="AsyncProcessRequest">
<MemberSignature Language="C#" Value="public void AsyncProcessRequest (System.Runtime.Remoting.Channels.IClientChannelSinkStack sinkStack, System.Runtime.Remoting.Messaging.IMessage msg, System.Runtime.Remoting.Channels.ITransportHeaders headers, System.IO.Stream stream);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sinkStack" Type="System.Runtime.Remoting.Channels.IClientChannelSinkStack" />
<Parameter Name="msg" Type="System.Runtime.Remoting.Messaging.IMessage" />
<Parameter Name="headers" Type="System.Runtime.Remoting.Channels.ITransportHeaders" />
<Parameter Name="stream" Type="System.IO.Stream" />
</Parameters>
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Requests asynchronous processing of a method call on the current sink.</para>
</summary>
<param name="sinkStack">
<attribution license="cc4" from="Microsoft" modified="false" />A stack of channel sinks that called the current sink. </param>
<param name="msg">
<attribution license="cc4" from="Microsoft" modified="false" />The message to process. </param>
<param name="headers">
<attribution license="cc4" from="Microsoft" modified="false" />The headers to add to the outgoing message that is heading to the server. </param>
<param name="stream">
<attribution license="cc4" from="Microsoft" modified="false" />The stream that is headed toward the transport sink. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="AsyncProcessResponse">
<MemberSignature Language="C#" Value="public void AsyncProcessResponse (System.Runtime.Remoting.Channels.IClientResponseChannelSinkStack sinkStack, object state, System.Runtime.Remoting.Channels.ITransportHeaders headers, System.IO.Stream stream);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sinkStack" Type="System.Runtime.Remoting.Channels.IClientResponseChannelSinkStack" />
<Parameter Name="state" Type="System.Object" />
<Parameter Name="headers" Type="System.Runtime.Remoting.Channels.ITransportHeaders" />
<Parameter Name="stream" Type="System.IO.Stream" />
</Parameters>
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Requests asynchronous processing of a response to a method call on the current sink.</para>
</summary>
<param name="sinkStack">
<attribution license="cc4" from="Microsoft" modified="false" />A stack of sinks that called the current sink. </param>
<param name="state">
<attribution license="cc4" from="Microsoft" modified="false" />Information that is associated with the current sink, generated on the request side and needed on the response side. </param>
<param name="headers">
<attribution license="cc4" from="Microsoft" modified="false" />The headers that are retrieved from the server response stream. </param>
<param name="stream">
<attribution license="cc4" from="Microsoft" modified="false" />The stream that is coming back from the transport sink. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetRequestStream">
<MemberSignature Language="C#" Value="public System.IO.Stream GetRequestStream (System.Runtime.Remoting.Messaging.IMessage msg, System.Runtime.Remoting.Channels.ITransportHeaders headers);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.IO.Stream</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="msg" Type="System.Runtime.Remoting.Messaging.IMessage" />
<Parameter Name="headers" Type="System.Runtime.Remoting.Channels.ITransportHeaders" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Runtime.Remoting.Channels.BinaryClientFormatterSink.GetRequestStream(System.Runtime.Remoting.Messaging.IMessage,System.Runtime.Remoting.Channels.ITransportHeaders)" /> method is called by the formatter sink before it serializes the message.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns the <see cref="T:System.IO.Stream" /> onto which the provided message is to be serialized.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.IO.Stream" /> onto which the provided message is to be serialized.</para>
</returns>
<param name="msg">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Runtime.Remoting.Messaging.IMethodCallMessage" /> that contains details about the method call. </param>
<param name="headers">
<attribution license="cc4" from="Microsoft" modified="false" />The headers to add to the outgoing message that is heading to the server. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="NextChannelSink">
<MemberSignature Language="C#" Value="public System.Runtime.Remoting.Channels.IClientChannelSink NextChannelSink { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Runtime.Remoting.Channels.IClientChannelSink</ReturnType>
</ReturnValue>
<Docs>
<value>To be added: an object of type 'IClientChannelSink'</value>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the next <see cref="T:System.Runtime.Remoting.Channels.IClientChannelSink" /> in the sink chain.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="NextSink">
<MemberSignature Language="C#" Value="public System.Runtime.Remoting.Messaging.IMessageSink NextSink { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Runtime.Remoting.Messaging.IMessageSink</ReturnType>
</ReturnValue>
<Docs>
<value>To be added: an object of type 'Runtime.Remoting.Messaging.IMessageSink'</value>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the next <see cref="T:System.Runtime.Remoting.Messaging.IMessageSink" /> in the sink chain.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ProcessMessage">
<MemberSignature Language="C#" Value="public void ProcessMessage (System.Runtime.Remoting.Messaging.IMessage msg, System.Runtime.Remoting.Channels.ITransportHeaders requestHeaders, System.IO.Stream requestStream, out System.Runtime.Remoting.Channels.ITransportHeaders responseHeaders, out System.IO.Stream responseStream);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="msg" Type="System.Runtime.Remoting.Messaging.IMessage" />
<Parameter Name="requestHeaders" Type="System.Runtime.Remoting.Channels.ITransportHeaders" />
<Parameter Name="requestStream" Type="System.IO.Stream" />
<Parameter Name="responseHeaders" Type="System.Runtime.Remoting.Channels.ITransportHeaders&amp;" RefType="out" />
<Parameter Name="responseStream" Type="System.IO.Stream&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="msg">To be added: an object of type 'Runtime.Remoting.Messaging.IMessage'</param>
<param name="requestHeaders">To be added: an object of type 'ITransportHeaders'</param>
<param name="requestStream">To be added: an object of type 'IO.Stream'</param>
<param name="responseHeaders">To be added: an object of type 'ITransportHeaders&amp;'</param>
<param name="responseStream">To be added: an object of type 'IO.Stream&amp;'</param>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Properties">
<MemberSignature Language="C#" Value="public System.Collections.IDictionary Properties { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Collections.IDictionary</ReturnType>
</ReturnValue>
<Docs>
<value>To be added: an object of type 'Collections.IDictionary'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>For more information, see <format type="text/html"><a href="226ECF74-EBBD-4EA0-A701-DCF4441DEEFE">[&lt;topic://cpconchannelformatterconfigurationproperties&gt;]</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a <see cref="T:System.Collections.IDictionary" /> of properties for the current channel sink.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="SyncProcessMessage">
<MemberSignature Language="C#" Value="public System.Runtime.Remoting.Messaging.IMessage SyncProcessMessage (System.Runtime.Remoting.Messaging.IMessage msg);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Runtime.Remoting.Messaging.IMessage</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="msg" Type="System.Runtime.Remoting.Messaging.IMessage" />
</Parameters>
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Synchronously processes the provided message.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The response to the processed message.</para>
</returns>
<param name="msg">
<attribution license="cc4" from="Microsoft" modified="false" />The message to process. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

156
mcs/class/System.Runtime.Remoting/Documentation/en/System.Runtime.Remoting.Channels/BinaryClientFormatterSinkProvider.xml Normal file
View File

@@ -0,0 +1,156 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="BinaryClientFormatterSinkProvider" FullName="System.Runtime.Remoting.Channels.BinaryClientFormatterSinkProvider">
<TypeSignature Language="C#" Maintainer="auto" Value="public class BinaryClientFormatterSinkProvider : System.Runtime.Remoting.Channels.IClientFormatterSinkProvider" />
<AssemblyInfo>
<AssemblyName>System.Runtime.Remoting</AssemblyName>
<AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00]</AssemblyPublicKey>
<AssemblyVersion>1.0.3300.0</AssemblyVersion>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<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>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.Runtime.Remoting.Channels.IClientFormatterSinkProvider</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A <see cref="T:System.Runtime.Remoting.Channels.BinaryClientFormatterSinkProvider" /> creates client formatter sinks that use the <see cref="T:System.Runtime.Serialization.Formatters.Binary.BinaryFormatter" /> to serialize messages for the client channel through which remoting messages flow.</para>
<para>The function of the formatter sink is to generate the necessary headers and serialize the message to the stream. After the formatter sink, the <see cref="T:System.Runtime.Remoting.Messaging.IMessage" /> is forwarded to all sinks in the channel sink chain through the <see cref="M:System.Runtime.Remoting.Channels.IClientChannelSink.ProcessMessage(System.Runtime.Remoting.Messaging.IMessage,System.Runtime.Remoting.Channels.ITransportHeaders,System.IO.Stream,System.Runtime.Remoting.Channels.ITransportHeaders@,System.IO.Stream@)" /> or <see cref="M:System.Runtime.Remoting.Channels.IClientChannelSink.AsyncProcessRequest(System.Runtime.Remoting.Channels.IClientChannelSinkStack,System.Runtime.Remoting.Messaging.IMessage,System.Runtime.Remoting.Channels.ITransportHeaders,System.IO.Stream)" /> calls. At this stage, the message has already been serialized and is provided as information only. Sinks that need to create or modify the message must be placed in the sink chain before the formatter. You can do this by implementing both the <see cref="T:System.Runtime.Remoting.Messaging.IMessageSink" /> and <see cref="T:System.Runtime.Remoting.Channels.IClientChannelSink" /> interfaces. The formatter sink can then be placed in the sink chain later.</para>
<para>Formatter sinks use sink configuration properties to configure the channel at run time. Sink properties can be specified in a configuration file, or programmatically, inside of a <see cref="T:System.Collections.IDictionary" />. In a configuration file all values are represented by strings, but when building a property <see cref="T:System.Collections.IDictionary" /> programmatically, value types can be specified with their native values or with strings.</para>
<para>The following table shows the sink configuration properties that can be specified for the current sink provider.</para>
<list type="table">
<listheader>
<item>
<term>
<para>Property </para>
</term>
<description>
<para>Description </para>
</description>
</item>
</listheader>
<item>
<term>
<para>includeVersions </para>
</term>
<description>
<para>Specifies whether the formatter will include versioning information. Values are true or false.</para>
</description>
</item>
</list>
<block subset="none" type="note">
<para>Using an instance of this object with untrusted data or across an unsecure channel is a security risk. Use this object only with trusted data and across a secure channel. For more information, see <see cref="http://go.microsoft.com/fwlink/?LinkId=330378">Untrusted Data Security Risks</see>.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides the implementation for the binary client formatter sink provider.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public BinaryClientFormatterSinkProvider ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.Channels.BinaryClientFormatterSinkProvider" /> class with default values.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public BinaryClientFormatterSinkProvider (System.Collections.IDictionary properties, System.Collections.ICollection providerData);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="properties" Type="System.Collections.IDictionary" />
<Parameter Name="providerData" Type="System.Collections.ICollection" />
</Parameters>
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.Channels.BinaryClientFormatterSinkProvider" /> class with the given properties and provider data.</para>
</summary>
<param name="properties">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Collections.IDictionary" /> of configuration properties to use with the new instance of <see cref="T:System.Runtime.Remoting.Channels.BinaryClientFormatterSinkProvider" />. </param>
<param name="providerData">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Collections.ICollection" /> of <see cref="T:System.Runtime.Remoting.Channels.SinkProviderData" /> objects that contain provider data to use with the new instance of <see cref="T:System.Runtime.Remoting.Channels.BinaryClientFormatterSinkProvider" />. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CreateSink">
<MemberSignature Language="C#" Value="public System.Runtime.Remoting.Channels.IClientChannelSink CreateSink (System.Runtime.Remoting.Channels.IChannelSender channel, string url, object remoteChannelData);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Runtime.Remoting.Channels.IClientChannelSink</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="channel" Type="System.Runtime.Remoting.Channels.IChannelSender" />
<Parameter Name="url" Type="System.String" />
<Parameter Name="remoteChannelData" Type="System.Object" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When the <see cref="M:System.Runtime.Remoting.Channels.IClientChannelSinkProvider.CreateSink(System.Runtime.Remoting.Channels.IChannelSender,System.String,System.Object)" /> method is called, it creates its own channel sink, forwards the <see cref="M:System.Runtime.Remoting.Channels.IClientChannelSinkProvider.CreateSink(System.Runtime.Remoting.Channels.IChannelSender,System.String,System.Object)" /> call to the next sink provider in the chain (if there is one), and ensures that the next sink and the current one are linked together.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Creates a sink chain.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The first sink of the newly formed channel sink chain, or null, which indicates that this provider will not or cannot provide a connection for this endpoint.</para>
</returns>
<param name="channel">
<attribution license="cc4" from="Microsoft" modified="false" />Channel for which this sink chain is being constructed. </param>
<param name="url">
<attribution license="cc4" from="Microsoft" modified="false" />URL of object to connect to or the channel URI for the target object. </param>
<param name="remoteChannelData">
<attribution license="cc4" from="Microsoft" modified="false" />A channel data object that describes a channel on the remote server. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Next">
<MemberSignature Language="C#" Value="public System.Runtime.Remoting.Channels.IClientChannelSinkProvider Next { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Runtime.Remoting.Channels.IClientChannelSinkProvider</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<value>To be added: an object of type 'IClientChannelSinkProvider'</value>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the next <see cref="T:System.Runtime.Remoting.Channels.IClientChannelSinkProvider" /> in the sink provider chain.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

45
mcs/class/System.Runtime.Remoting/Documentation/en/System.Runtime.Remoting.Channels/BinaryServerFormatterSink+Protocol.xml Normal file
View File

@@ -0,0 +1,45 @@
<Type Name="BinaryServerFormatterSink+Protocol" FullName="System.Runtime.Remoting.Channels.BinaryServerFormatterSink+Protocol">
<TypeSignature Language="C#" Value="public enum BinaryServerFormatterSink.Protocol" />
<AssemblyInfo>
<AssemblyName>System.Runtime.Remoting</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="Http">
<MemberSignature Language="C#" Value="Http" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Runtime.Remoting.Channels.BinaryServerFormatterSink+Protocol</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Other">
<MemberSignature Language="C#" Value="Other" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Runtime.Remoting.Channels.BinaryServerFormatterSink+Protocol</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

267
mcs/class/System.Runtime.Remoting/Documentation/en/System.Runtime.Remoting.Channels/BinaryServerFormatterSink.xml Normal file
View File

@@ -0,0 +1,267 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="BinaryServerFormatterSink" FullName="System.Runtime.Remoting.Channels.BinaryServerFormatterSink">
<TypeSignature Language="C#" Maintainer="auto" Value="public class BinaryServerFormatterSink : System.Runtime.Remoting.Channels.IServerChannelSink" />
<AssemblyInfo>
<AssemblyName>System.Runtime.Remoting</AssemblyName>
<AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00]</AssemblyPublicKey>
<AssemblyVersion>1.0.3300.0</AssemblyVersion>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<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>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.Runtime.Remoting.Channels.IServerChannelSink</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The request stream propagates from the server transport sink through the server channel sinks until it reaches the appropriate formatter sink. The formatter sink deserializes the message and passes it through the pipeline. A special dispatch sink is inserted at the end of the channel sink chain by the <see cref="M:System.Runtime.Remoting.Channels.ChannelServices.CreateServerChannelSinkChain(System.Runtime.Remoting.Channels.IServerChannelSinkProvider,System.Runtime.Remoting.Channels.IChannelReceiver)" /> method, which is called by server channels to create the server channel sink chains. When the message reaches the dispatch sink, the dispatch sink passes the message to the remoting infrastructure.</para>
<para>The following table shows the sink configuration properties that can be specified for the current sink provider.</para>
<list type="table">
<listheader>
<item>
<term>
<para>Property </para>
</term>
<description>
<para>Description </para>
</description>
</item>
</listheader>
<item>
<term>
<para>includeVersions </para>
</term>
<description>
<para>Specifies whether the formatter will include versioning information. Values true or false.</para>
</description>
</item>
<item>
<term>
<para>strictBinding </para>
</term>
<description>
<para>Indicates that a receiving formatter will first try to identify the type using complete version information if it exists before using only the type name and assembly name without version information. Values true or false. The default for both system-provided formatters is false. </para>
</description>
</item>
<item>
<term>
<para>typeFilterLevel </para>
</term>
<description>
<para>A string value that specifies the level of automatic deserialization that a server channel attempts. Supported values are Low (the default) and Full. For details about deserialization levels, see <format type="text/html"><a href="313A0E88-5B2B-4A17-8391-0DDF9F7A787B">[&lt;topic://cpconAutomaticDeserializationInNETRemoting&gt;]</a></format>.</para>
<para>This property is supported only by the .NET Framework version 1.1 on the following platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, and Windows Server 2003 family. </para>
</description>
</item>
</list>
<block subset="none" type="note">
<para>Using an instance of this object with untrusted data or across an unsecure channel is a security risk. Use this object only with trusted data and across a secure channel. For more information, see <see cref="http://go.microsoft.com/fwlink/?LinkId=330378">Untrusted Data Security Risks</see>.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides the implementation for a server formatter sink that uses the <see cref="T:System.Runtime.Serialization.Formatters.Binary.BinaryFormatter" />.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public BinaryServerFormatterSink (System.Runtime.Remoting.Channels.BinaryServerFormatterSink.Protocol protocol, System.Runtime.Remoting.Channels.IServerChannelSink nextSink, System.Runtime.Remoting.Channels.IChannelReceiver receiver);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="protocol" Type="System.Runtime.Remoting.Channels.BinaryServerFormatterSink+Protocol" />
<Parameter Name="nextSink" Type="System.Runtime.Remoting.Channels.IServerChannelSink" />
<Parameter Name="receiver" Type="System.Runtime.Remoting.Channels.IChannelReceiver" />
</Parameters>
<Docs>
<param name="protocol">To be added: an object of type 'BinaryServerFormatterSink+Protocol'</param>
<param name="nextSink">To be added: an object of type 'IServerChannelSink'</param>
<param name="receiver">To be added: an object of type 'IChannelReceiver'</param>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="AsyncProcessResponse">
<MemberSignature Language="C#" Value="public void AsyncProcessResponse (System.Runtime.Remoting.Channels.IServerResponseChannelSinkStack sinkStack, object state, System.Runtime.Remoting.Messaging.IMessage message, System.Runtime.Remoting.Channels.ITransportHeaders headers, System.IO.Stream stream);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sinkStack" Type="System.Runtime.Remoting.Channels.IServerResponseChannelSinkStack" />
<Parameter Name="state" Type="System.Object" />
<Parameter Name="message" Type="System.Runtime.Remoting.Messaging.IMessage" />
<Parameter Name="headers" Type="System.Runtime.Remoting.Channels.ITransportHeaders" />
<Parameter Name="stream" Type="System.IO.Stream" />
</Parameters>
<Docs>
<param name="message">To be added.</param>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Requests processing of the response from a method call that is sent asynchronously.</para>
</summary>
<param name="sinkStack">
<attribution license="cc4" from="Microsoft" modified="false" />A stack of sinks that is leading back to the server transport sink. </param>
<param name="state">
<attribution license="cc4" from="Microsoft" modified="false" />Information that is associated with the current sink, generated on the request side, and needed on the response side. </param>
<param name="headers">
<attribution license="cc4" from="Microsoft" modified="false" />The headers to add to the return message that is heading to the client. </param>
<param name="stream">
<attribution license="cc4" from="Microsoft" modified="false" />The stream that is heading back to the transport sink. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetResponseStream">
<MemberSignature Language="C#" Value="public System.IO.Stream GetResponseStream (System.Runtime.Remoting.Channels.IServerResponseChannelSinkStack sinkStack, object state, System.Runtime.Remoting.Messaging.IMessage msg, System.Runtime.Remoting.Channels.ITransportHeaders headers);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.IO.Stream</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sinkStack" Type="System.Runtime.Remoting.Channels.IServerResponseChannelSinkStack" />
<Parameter Name="state" Type="System.Object" />
<Parameter Name="msg" Type="System.Runtime.Remoting.Messaging.IMessage" />
<Parameter Name="headers" Type="System.Runtime.Remoting.Channels.ITransportHeaders" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method is called when a response stream needs to be created.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns the <see cref="T:System.IO.Stream" /> onto which the provided response message is to be serialized.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.IO.Stream" /> onto which the provided response message is to be serialized.</para>
</returns>
<param name="sinkStack">
<attribution license="cc4" from="Microsoft" modified="false" />A stack of sinks that is leading back to the server transport sink. </param>
<param name="state">
<attribution license="cc4" from="Microsoft" modified="false" />Information that is associated with the current sink, generated on the request side, and needed on the response side. </param>
<param name="msg">
<attribution license="cc4" from="Microsoft" modified="false" />The response message to serialize. </param>
<param name="headers">
<attribution license="cc4" from="Microsoft" modified="false" />The headers to put in the response stream to the client. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="NextChannelSink">
<MemberSignature Language="C#" Value="public System.Runtime.Remoting.Channels.IServerChannelSink NextChannelSink { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Runtime.Remoting.Channels.IServerChannelSink</ReturnType>
</ReturnValue>
<Docs>
<value>To be added: an object of type 'IServerChannelSink'</value>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the next <see cref="T:System.Runtime.Remoting.Channels.IServerChannelSink" /> in the sink chain.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ProcessMessage">
<MemberSignature Language="C#" Value="public System.Runtime.Remoting.Channels.ServerProcessing ProcessMessage (System.Runtime.Remoting.Channels.IServerChannelSinkStack sinkStack, System.Runtime.Remoting.Messaging.IMessage requestMsg, System.Runtime.Remoting.Channels.ITransportHeaders requestHeaders, System.IO.Stream requestStream, out System.Runtime.Remoting.Messaging.IMessage responseMsg, out System.Runtime.Remoting.Channels.ITransportHeaders responseHeaders, out System.IO.Stream responseStream);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Runtime.Remoting.Channels.ServerProcessing</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sinkStack" Type="System.Runtime.Remoting.Channels.IServerChannelSinkStack" />
<Parameter Name="requestMsg" Type="System.Runtime.Remoting.Messaging.IMessage" />
<Parameter Name="requestHeaders" Type="System.Runtime.Remoting.Channels.ITransportHeaders" />
<Parameter Name="requestStream" Type="System.IO.Stream" />
<Parameter Name="responseMsg" Type="System.Runtime.Remoting.Messaging.IMessage&amp;" RefType="out" />
<Parameter Name="responseHeaders" Type="System.Runtime.Remoting.Channels.ITransportHeaders&amp;" RefType="out" />
<Parameter Name="responseStream" Type="System.IO.Stream&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="sinkStack">To be added: an object of type 'IServerChannelSinkStack'</param>
<param name="requestMsg">To be added: an object of type 'Runtime.Remoting.Messaging.IMessage'</param>
<param name="requestHeaders">To be added: an object of type 'ITransportHeaders'</param>
<param name="requestStream">To be added: an object of type 'IO.Stream'</param>
<param name="responseMsg">To be added: an object of type 'Runtime.Remoting.Messaging.IMessage&amp;'</param>
<param name="responseHeaders">To be added: an object of type 'ITransportHeaders&amp;'</param>
<param name="responseStream">To be added: an object of type 'IO.Stream&amp;'</param>
<summary>To be added</summary>
<returns>To be added: an object of type 'ServerProcessing'</returns>
<remarks>To be added</remarks>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Properties">
<MemberSignature Language="C#" Value="public System.Collections.IDictionary Properties { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Collections.IDictionary</ReturnType>
</ReturnValue>
<Docs>
<value>To be added: an object of type 'Collections.IDictionary'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>For more information, see <format type="text/html"><a href="226ECF74-EBBD-4EA0-A701-DCF4441DEEFE">[&lt;topic://cpconchannelformatterconfigurationproperties&gt;]</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a <see cref="T:System.Collections.IDictionary" /> of properties for the current channel sink.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="TypeFilterLevel">
<MemberSignature Language="C#" Value="public System.Runtime.Serialization.Formatters.TypeFilterLevel TypeFilterLevel { set; get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.ComVisible(false)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Runtime.Serialization.Formatters.TypeFilterLevel</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Supported values are Low (the default) and Full. For details about deserialization levels, see <format type="text/html"><a href="313a0e88-5b2b-4a17-8391-0ddf9f7a787b">Automatic Deserialization in .NET Remoting</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the TypeFilterLevel value of automatic deserialization that the BinaryServerFormatterSink performs.</para>
</summary>
</Docs>
</Member>
</Members>
</Type>

198
mcs/class/System.Runtime.Remoting/Documentation/en/System.Runtime.Remoting.Channels/BinaryServerFormatterSinkProvider.xml Normal file
View File

@@ -0,0 +1,198 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="BinaryServerFormatterSinkProvider" FullName="System.Runtime.Remoting.Channels.BinaryServerFormatterSinkProvider">
<TypeSignature Language="C#" Maintainer="auto" Value="public class BinaryServerFormatterSinkProvider : System.Runtime.Remoting.Channels.IServerFormatterSinkProvider" />
<AssemblyInfo>
<AssemblyName>System.Runtime.Remoting</AssemblyName>
<AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00]</AssemblyPublicKey>
<AssemblyVersion>1.0.3300.0</AssemblyVersion>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<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>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.Runtime.Remoting.Channels.IServerFormatterSinkProvider</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Channel sinks are connected to a server channel through implementations of the <see cref="T:System.Runtime.Remoting.Channels.IServerChannelSinkProvider" /> interface. All the remoting server channels provide constructors that take a <see cref="T:System.Runtime.Remoting.Channels.IServerChannelSinkProvider" /> as a parameter.</para>
<para>Channel sink providers are stored in a chain, and the user is responsible for chaining all channel sink providers together before passing the outer one to the channel constructor. <see cref="T:System.Runtime.Remoting.Channels.IServerChannelSinkProvider" /> provides a property called <see cref="P:System.Runtime.Remoting.Channels.IServerChannelSinkProvider.Next" /> for this purpose.</para>
<para>When multiple channel sink providers are provided in a configuration file, the remoting infrastructure will chain them together in the order they are found in the configuration file. The channel sink providers will be created when the channel is created during the <see cref="M:System.Runtime.Remoting.RemotingConfiguration.Configure(System.String)" /> call.</para>
<para>Formatter sinks use sink configuration properties to configure the channel at run time. Sink properties can be specified in a configuration file, or programmatically, inside of a <see cref="T:System.Collections.IDictionary" />. In a configuration file all values are represented by strings, but when building a property <see cref="T:System.Collections.IDictionary" /> programmatically, value types can be specified with their native values or with strings.</para>
<para>The following table shows the sink configuration properties that can be specified for the current sink provider.</para>
<list type="table">
<listheader>
<item>
<term>
<para>Property </para>
</term>
<description>
<para>Description </para>
</description>
</item>
</listheader>
<item>
<term>
<para>includeVersions </para>
</term>
<description>
<para>Specifies whether the formatter will include versioning information. Values are true or false.</para>
</description>
</item>
</list>
<block subset="none" type="note">
<para>Using an instance of this object with untrusted data or across an unsecure channel is a security risk. Use this object only with trusted data and across a secure channel. For more information, see <see cref="http://go.microsoft.com/fwlink/?LinkId=330378">Untrusted Data Security Risks</see>.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides the implementation for the server formatter channel sink provider that uses the <see cref="T:System.Runtime.Serialization.Formatters.Binary.BinaryFormatter" />.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public BinaryServerFormatterSinkProvider ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.Channels.BinaryServerFormatterSinkProvider" /> class with default values.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public BinaryServerFormatterSinkProvider (System.Collections.IDictionary properties, System.Collections.ICollection providerData);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="properties" Type="System.Collections.IDictionary" />
<Parameter Name="providerData" Type="System.Collections.ICollection" />
</Parameters>
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.Channels.BinaryServerFormatterSinkProvider" /> class with the provided properties and provider data.</para>
</summary>
<param name="properties">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Collections.IDictionary" /> of configuration properties to use with the new instance of <see cref="T:System.Runtime.Remoting.Channels.BinaryServerFormatterSinkProvider" />. </param>
<param name="providerData">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Collections.ICollection" /> of <see cref="T:System.Runtime.Remoting.Channels.SinkProviderData" /> to use with the new instance of <see cref="T:System.Runtime.Remoting.Channels.BinaryServerFormatterSinkProvider" />. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CreateSink">
<MemberSignature Language="C#" Value="public System.Runtime.Remoting.Channels.IServerChannelSink CreateSink (System.Runtime.Remoting.Channels.IChannelReceiver channel);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Runtime.Remoting.Channels.IServerChannelSink</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="channel" Type="System.Runtime.Remoting.Channels.IChannelReceiver" />
</Parameters>
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Creates a sink chain.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The first sink of the newly formed channel sink chain.</para>
</returns>
<param name="channel">
<attribution license="cc4" from="Microsoft" modified="false" />The channel for which to create the channel sink chain. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetChannelData">
<MemberSignature Language="C#" Value="public void GetChannelData (System.Runtime.Remoting.Channels.IChannelDataStore channelData);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="channelData" Type="System.Runtime.Remoting.Channels.IChannelDataStore" />
</Parameters>
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns the channel data for the channel that the current sink is associated with.</para>
</summary>
<param name="channelData">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Runtime.Remoting.Channels.IChannelDataStore" /> object in which the channel data is to be returned. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Next">
<MemberSignature Language="C#" Value="public System.Runtime.Remoting.Channels.IServerChannelSinkProvider Next { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Runtime.Remoting.Channels.IServerChannelSinkProvider</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<value>To be added: an object of type 'IServerChannelSinkProvider'</value>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the next <see cref="T:System.Runtime.Remoting.Channels.IServerChannelSinkProvider" /> in the sink provider chain.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="TypeFilterLevel">
<MemberSignature Language="C#" Value="public System.Runtime.Serialization.Formatters.TypeFilterLevel TypeFilterLevel { set; get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.ComVisible(false)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Runtime.Serialization.Formatters.TypeFilterLevel</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Supported values are Low (the default) and Full. For details about deserialization levels, see <format type="text/html"><a href="313a0e88-5b2b-4a17-8391-0ddf9f7a787b">Automatic Deserialization in .NET Remoting</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the TypeFilterLevel value of automatic deserialization the BinaryServerFormatterSink performs.</para>
</summary>
</Docs>
</Member>
</Members>
</Type>

Some files were not shown because too many files have changed in this diff Show More