mcs/class/System.Runtime.Remoting/Documentation/en/System.Runtime.Remoting.MetadataServices/SdlChannelSink.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="SdlChannelSink" FullName="System.Runtime.Remoting.MetadataServices.SdlChannelSink">
   3   <TypeSignature Language="C#" Maintainer="auto" Value="public class SdlChannelSink : System.Runtime.Remoting.Channels.IServerChannelSink" />
   4   <AssemblyInfo>
   5     <AssemblyName>System.Runtime.Remoting</AssemblyName>
   6     <AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00]</AssemblyPublicKey>
   7     <AssemblyVersion>1.0.3300.0</AssemblyVersion>
   8     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
   9     <AssemblyVersion>2.0.0.0</AssemblyVersion>
  10   </AssemblyInfo>
  11   <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the &lt;link location="node:gtk-sharp/programming/threads"&gt;Gtk# Thread Programming&lt;/link&gt; for details.</ThreadSafetyStatement>
  12   <Base>
  13     <BaseTypeName>System.Object</BaseTypeName>
  14   </Base>
  15   <Interfaces>
  16     <Interface>
  17       <InterfaceName>System.Runtime.Remoting.Channels.IServerChannelSink</InterfaceName>
  18     </Interface>
  19   </Interfaces>
  20   <Docs>
  21     <remarks>
  22       <attribution license="cc4" from="Microsoft" modified="false" />
  23       <para>The <see cref="T:System.Runtime.Remoting.MetadataServices.SdlChannelSink" /> is used to create WSDL in situations where the URL ends with the string "?wsdl".</para>
  24       <para>The following table shows the channel configuration properties that can be specified for this channel sink. The first two properties combine to control the WSDL publication of objects published by the application domain. If false is specified for the first property, no WSDL is returned, regardless of the second property. (The default is true.) Otherwise, the second controls whether the global metadata object URI is permitted to respond. (The default is false.) </para>
  25       <list type="table">
  26         <listheader>
  27           <item>
  28             <term>
  29               <para>Property </para>
  30             </term>
  31             <description>
  32               <para>Description </para>
  33             </description>
  34           </item>
  35         </listheader>
  36         <item>
  37           <term>
  38             <para>metadataEnabled </para>
  39           </term>
  40           <description>
  41             <para>A Boolean value that specifies whether to honor requests that end in "?wsdl" if this sink is in the channel sink chain. The default setting is true. If false, the sink throws an exception in all cases where metadata is requested for any object in the application domain.</para>
  42             <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, Windows Server 2003 family. </para>
  43           </description>
  44         </item>
  45         <item>
  46           <term>
  47             <para>remoteApplicationMetadataEnabled </para>
  48           </term>
  49           <description>
  50             <para>A Boolean value that specifies whether to honor requests for the object URI "RemoteApplicationMetadata?wsdl", which returns WSDL that describes all objects that are published by the application domain. If false, then any request to "RemoteApplicationMetadata.rem" throws an exception. All other "?wsdl" requests for particular object URIs are honored. If true, the global metadata request is honored. The default setting is false.</para>
  51             <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, Windows Server 2003 family. </para>
  52           </description>
  53         </item>
  54       </list>
  55     </remarks>
  56     <summary>
  57       <attribution license="cc4" from="Microsoft" modified="false" />
  58       <para>Provides the implementation for a server channel sink that generates Web Services Description Language (WSDL) dynamically on the server.</para>
  59     </summary>
  60   </Docs>
  61   <Members>
  62     <Member MemberName=".ctor">
  63       <MemberSignature Language="C#" Value="public SdlChannelSink (System.Runtime.Remoting.Channels.IChannelReceiver channel, System.Runtime.Remoting.Channels.IServerChannelSink next);" />
  64       <MemberType>Constructor</MemberType>
  65       <ReturnValue />
  66       <Parameters>
  67         <Parameter Name="channel" Type="System.Runtime.Remoting.Channels.IChannelReceiver" />
  68         <Parameter Name="next" Type="System.Runtime.Remoting.Channels.IServerChannelSink" />
  69       </Parameters>
  70       <Docs>
  71         <param name="channel">To be added.</param>
  72         <param name="next">To be added.</param>
  73         <remarks>To be added</remarks>
  74         <summary>
  75           <attribution license="cc4" from="Microsoft" modified="false" />
  76           <para>Initializes a new instance of the <see cref="T:System.Runtime.Remoting.MetadataServices.SdlChannelSink" /> class.</para>
  77         </summary>
  78       </Docs>
  79       <AssemblyInfo>
  80         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  81         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  82       </AssemblyInfo>
  83     </Member>
  84     <Member MemberName="AsyncProcessResponse">
  85       <MemberSignature Language="C#" Value="public void AsyncProcessResponse (System.Runtime.Remoting.Channels.IServerResponseChannelSinkStack sinkStack, object state, System.Runtime.Remoting.Messaging.IMessage msg, System.Runtime.Remoting.Channels.ITransportHeaders headers, System.IO.Stream stream);" />
  86       <MemberType>Method</MemberType>
  87       <ReturnValue>
  88         <ReturnType>System.Void</ReturnType>
  89       </ReturnValue>
  90       <Parameters>
  91         <Parameter Name="sinkStack" Type="System.Runtime.Remoting.Channels.IServerResponseChannelSinkStack" />
  92         <Parameter Name="state" Type="System.Object" />
  93         <Parameter Name="msg" Type="System.Runtime.Remoting.Messaging.IMessage" />
  94         <Parameter Name="headers" Type="System.Runtime.Remoting.Channels.ITransportHeaders" />
  95         <Parameter Name="stream" Type="System.IO.Stream" />
  96       </Parameters>
  97       <Docs>
  98         <remarks>To be added</remarks>
  99         <summary>
 100           <attribution license="cc4" from="Microsoft" modified="false" />
 101           <para>Requests processing from the current sink of the response from a method call that was sent asynchronously.</para>
 102         </summary>
 103         <param name="sinkStack">
 104           <attribution license="cc4" from="Microsoft" modified="false" />A stack of sinks that lead back to the server transport sink. </param>
 105         <param name="state">
 106           <attribution license="cc4" from="Microsoft" modified="false" />Information associated with the current sink, generated on the request side, and needed on the response side. </param>
 107         <param name="msg">
 108           <attribution license="cc4" from="Microsoft" modified="false" />The response message. </param>
 109         <param name="headers">
 110           <attribution license="cc4" from="Microsoft" modified="false" />The headers to add to the return message heading to the client. </param>
 111         <param name="stream">
 112           <attribution license="cc4" from="Microsoft" modified="false" />The stream heading back to the transport sink. </param>
 113       </Docs>
 114       <AssemblyInfo>
 115         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 116         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 117       </AssemblyInfo>
 118     </Member>
 119     <Member MemberName="GetResponseStream">
 120       <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);" />
 121       <MemberType>Method</MemberType>
 122       <ReturnValue>
 123         <ReturnType>System.IO.Stream</ReturnType>
 124       </ReturnValue>
 125       <Parameters>
 126         <Parameter Name="sinkStack" Type="System.Runtime.Remoting.Channels.IServerResponseChannelSinkStack" />
 127         <Parameter Name="state" Type="System.Object" />
 128         <Parameter Name="msg" Type="System.Runtime.Remoting.Messaging.IMessage" />
 129         <Parameter Name="headers" Type="System.Runtime.Remoting.Channels.ITransportHeaders" />
 130       </Parameters>
 131       <Docs>
 132         <remarks>
 133           <attribution license="cc4" from="Microsoft" modified="false" />
 134           <para>The current method is called when a response stream needs to be created.</para>
 135         </remarks>
 136         <summary>
 137           <attribution license="cc4" from="Microsoft" modified="false" />
 138           <para>Returns the <see cref="T:System.IO.Stream" /> onto which the provided response message is to be serialized.</para>
 139         </summary>
 140         <returns>
 141           <attribution license="cc4" from="Microsoft" modified="false" />
 142           <para>The <see cref="T:System.IO.Stream" /> onto which the provided response message is to be serialized.</para>
 143         </returns>
 144         <param name="sinkStack">
 145           <attribution license="cc4" from="Microsoft" modified="false" />A stack of sinks that lead back to the server transport sink. </param>
 146         <param name="state">
 147           <attribution license="cc4" from="Microsoft" modified="false" />Information associated with the current sink, generated on the request side, and needed on the response side. </param>
 148         <param name="msg">
 149           <attribution license="cc4" from="Microsoft" modified="false" />The response message to serialize. </param>
 150         <param name="headers">
 151           <attribution license="cc4" from="Microsoft" modified="false" />The headers to put in the response stream to the client. </param>
 152       </Docs>
 153       <AssemblyInfo>
 154         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 155         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 156       </AssemblyInfo>
 157     </Member>
 158     <Member MemberName="NextChannelSink">
 159       <MemberSignature Language="C#" Value="public System.Runtime.Remoting.Channels.IServerChannelSink NextChannelSink { get; }" />
 160       <MemberType>Property</MemberType>
 161       <ReturnValue>
 162         <ReturnType>System.Runtime.Remoting.Channels.IServerChannelSink</ReturnType>
 163       </ReturnValue>
 164       <Docs>
 165         <value>To be added: an object of type 'Runtime.Remoting.Channels.IServerChannelSink'</value>
 166         <remarks>To be added</remarks>
 167         <summary>
 168           <attribution license="cc4" from="Microsoft" modified="false" />
 169           <para>Gets the next <see cref="T:System.Runtime.Remoting.Channels.IServerChannelSink" /> in the sink chain.</para>
 170         </summary>
 171       </Docs>
 172       <AssemblyInfo>
 173         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 174         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 175       </AssemblyInfo>
 176     </Member>
 177     <Member MemberName="ProcessMessage">
 178       <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);" />
 179       <MemberType>Method</MemberType>
 180       <ReturnValue>
 181         <ReturnType>System.Runtime.Remoting.Channels.ServerProcessing</ReturnType>
 182       </ReturnValue>
 183       <Parameters>
 184         <Parameter Name="sinkStack" Type="System.Runtime.Remoting.Channels.IServerChannelSinkStack" />
 185         <Parameter Name="requestMsg" Type="System.Runtime.Remoting.Messaging.IMessage" />
 186         <Parameter Name="requestHeaders" Type="System.Runtime.Remoting.Channels.ITransportHeaders" />
 187         <Parameter Name="requestStream" Type="System.IO.Stream" />
 188         <Parameter Name="responseMsg" Type="System.Runtime.Remoting.Messaging.IMessage&amp;" RefType="out" />
 189         <Parameter Name="responseHeaders" Type="System.Runtime.Remoting.Channels.ITransportHeaders&amp;" RefType="out" />
 190         <Parameter Name="responseStream" Type="System.IO.Stream&amp;" RefType="out" />
 191       </Parameters>
 192       <Docs>
 193         <param name="sinkStack">To be added: an object of type 'Runtime.Remoting.Channels.IServerChannelSinkStack'</param>
 194         <param name="requestMsg">To be added: an object of type 'Runtime.Remoting.Messaging.IMessage'</param>
 195         <param name="requestHeaders">To be added: an object of type 'Runtime.Remoting.Channels.ITransportHeaders'</param>
 196         <param name="requestStream">To be added: an object of type 'IO.Stream'</param>
 197         <param name="responseMsg">To be added: an object of type 'Runtime.Remoting.Messaging.IMessage&amp;'</param>
 198         <param name="responseHeaders">To be added: an object of type 'Runtime.Remoting.Channels.ITransportHeaders&amp;'</param>
 199         <param name="responseStream">To be added: an object of type 'IO.Stream&amp;'</param>
 200         <summary>To be added</summary>
 201         <returns>To be added: an object of type 'Runtime.Remoting.Channels.ServerProcessing'</returns>
 202         <remarks>To be added</remarks>
 203       </Docs>
 204       <AssemblyInfo>
 205         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 206         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 207       </AssemblyInfo>
 208     </Member>
 209     <Member MemberName="Properties">
 210       <MemberSignature Language="C#" Value="public System.Collections.IDictionary Properties { get; }" />
 211       <MemberType>Property</MemberType>
 212       <ReturnValue>
 213         <ReturnType>System.Collections.IDictionary</ReturnType>
 214       </ReturnValue>
 215       <Docs>
 216         <value>To be added: an object of type 'Collections.IDictionary'</value>
 217         <remarks>
 218           <attribution license="cc4" from="Microsoft" modified="false" />
 219           <block subset="none" type="note">
 220             <para>For more information, see <format type="text/html"><a href="226ECF74-EBBD-4EA0-A701-DCF4441DEEFE">[&lt;topic://cpconchannelformatterconfigurationproperties&gt;]</a></format>.</para>
 221           </block>
 222         </remarks>
 223         <summary>
 224           <attribution license="cc4" from="Microsoft" modified="false" />
 225           <para>Gets a <see cref="T:System.Collections.IDictionary" /> of properties for the current channel sink.</para>
 226         </summary>
 227       </Docs>
 228       <AssemblyInfo>
 229         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 230         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 231       </AssemblyInfo>
 232     </Member>
 233   </Members>
 234 </Type>