Files
linux-packaging-mono/mcs/class/System.ServiceModel/Documentation/en/System.ServiceModel/DuplexClientBase`1.xml
Jo Shields a575963da9 Imported Upstream version 3.6.0
Former-commit-id: da6be194a6b1221998fc28233f2503bd61dd9d14
2014-08-13 10:39:27 +01:00

383 lines
22 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<Type Name="DuplexClientBase&lt;TChannel&gt;" FullName="System.ServiceModel.DuplexClientBase&lt;TChannel&gt;">
<TypeSignature Language="C#" Value="public class DuplexClientBase&lt;TChannel&gt; : System.ServiceModel.ClientBase&lt;TChannel&gt; where TChannel : class" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit DuplexClientBase`1&lt;class TChannel&gt; extends System.ServiceModel.ClientBase`1&lt;!TChannel&gt;" />
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<TypeParameters>
<TypeParameter Name="TChannel">
<Constraints>
<ParameterAttribute>ReferenceTypeConstraint</ParameterAttribute>
</Constraints>
</TypeParameter>
</TypeParameters>
<Base>
<BaseTypeName>System.ServiceModel.ClientBase&lt;TChannel&gt;</BaseTypeName>
<BaseTypeArguments>
<BaseTypeArgument TypeParamName="TChannel">TChannel</BaseTypeArgument>
</BaseTypeArguments>
</Base>
<Interfaces />
<Docs>
<typeparam name="TChannel">To be added.</typeparam>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use the <see cref="T:System.ServiceModel.DuplexClientBase`1" /> class to create a channel to a service that specifies a callback object. The <see cref="T:System.ServiceModel.DuplexClientBase`1" /> object wraps a <see cref="T:System.ServiceModel.DuplexChannelFactory`1" /> object, which provides the connectivity for the indigo2 object. You can use either type to connect to a duplex service. For more information about duplex services, see <format type="text/html"><a href="396b875a-d203-4ebe-a3a1-6a330d962e95">Duplex Services</a></format>.</para>
<para>Special note for Managed C++ users deriving from this class:</para>
<list type="bullet">
<item>
<para>Put your cleanup code in (On)(Begin)Close (and/or OnAbort), not in a destructor.</para>
</item>
<item>
<para>Avoid destructors: they cause the compiler to auto-generate <see cref="T:System.IDisposable" /></para>
</item>
<item>
<para>Avoid non-reference members: they can cause the compiler to auto-generate <see cref="T:System.IDisposable" /></para>
</item>
<item>
<para>Avoid finalizers; but if you include one, you should suppress the build warning and call <see cref="M:System.GC.SuppressFinalize(System.Object)" /> and the finalizer itself from (On)(Begin)Close (and/or OnAbort) in order to emulate what would have been the auto-generated <see cref="T:System.IDisposable" /> behavior.</para>
</item>
</list>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Used to create a channel to a duplex service and associate that channel with a callback object.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected DuplexClientBase (object instance);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(object instance) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="instance" Type="System.Object" />
</Parameters>
<Docs>
<param name="instance">To be added.</param>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>indigo2 creates a new <see cref="T:System.ServiceModel.InstanceContext" /> object using the <paramref name="callbackInstance" /> object to handle all callback operations.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.ServiceModel.DuplexClientBase`1" /> class using the specified callback object.</para>
</summary>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected DuplexClientBase (System.ServiceModel.InstanceContext instance);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class System.ServiceModel.InstanceContext instance) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="instance" Type="System.ServiceModel.InstanceContext" />
</Parameters>
<Docs>
<param name="instance">To be added.</param>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <paramref name="callbackInstance" /> provided by the user is used to service all callback operations.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.ServiceModel.DuplexClientBase`1" /> class using the specified callback object.</para>
</summary>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected DuplexClientBase (object instance, System.ServiceModel.Description.ServiceEndpoint endpoint);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(object instance, class System.ServiceModel.Description.ServiceEndpoint endpoint) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="instance" Type="System.Object" />
<Parameter Name="endpoint" Type="System.ServiceModel.Description.ServiceEndpoint" />
</Parameters>
<Docs>
<param name="instance">To be added.</param>
<param name="endpoint">To be added.</param>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.ServiceModel.DuplexClientBase`1" /> class with the specified callback object and service endpoint.</para>
</summary>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected DuplexClientBase (object instance, string configurationName);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(object instance, string configurationName) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="instance" Type="System.Object" />
<Parameter Name="configurationName" Type="System.String" />
</Parameters>
<Docs>
<param name="instance">To be added.</param>
<param name="configurationName">To be added.</param>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>indigo2 creates a new <see cref="T:System.ServiceModel.InstanceContext" /> object using the <paramref name="callbackInstance" /> object to handle all callback operations.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.ServiceModel.DuplexClientBase`1" /> class using the specified callback object and configuration name.</para>
</summary>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected DuplexClientBase (System.ServiceModel.InstanceContext instance, System.ServiceModel.Description.ServiceEndpoint endpoint);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class System.ServiceModel.InstanceContext instance, class System.ServiceModel.Description.ServiceEndpoint endpoint) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="instance" Type="System.ServiceModel.InstanceContext" />
<Parameter Name="endpoint" Type="System.ServiceModel.Description.ServiceEndpoint" />
</Parameters>
<Docs>
<param name="instance">To be added.</param>
<param name="endpoint">To be added.</param>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.ServiceModel.DuplexClientBase`1" /> class with the specified callback object and service endpoint.</para>
</summary>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected DuplexClientBase (System.ServiceModel.InstanceContext instance, string configurationName);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class System.ServiceModel.InstanceContext instance, string configurationName) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="instance" Type="System.ServiceModel.InstanceContext" />
<Parameter Name="configurationName" Type="System.String" />
</Parameters>
<Docs>
<param name="instance">To be added.</param>
<param name="configurationName">To be added.</param>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <paramref name="callbackInstance" /> provided by the user is used to service all callback operations.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.ServiceModel.DuplexClientBase`1" /> class using the specified callback object and configuration name.</para>
</summary>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected DuplexClientBase (object instance, System.ServiceModel.Channels.Binding binding, System.ServiceModel.EndpointAddress address);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(object instance, class System.ServiceModel.Channels.Binding binding, class System.ServiceModel.EndpointAddress address) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="instance" Type="System.Object" />
<Parameter Name="binding" Type="System.ServiceModel.Channels.Binding" />
<Parameter Name="address" Type="System.ServiceModel.EndpointAddress" />
</Parameters>
<Docs>
<param name="instance">To be added.</param>
<param name="binding">To be added.</param>
<param name="address">To be added.</param>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>indigo2 creates a new <see cref="T:System.ServiceModel.InstanceContext" /> object using the <paramref name="callbackInstance" /> object to handle all callback operations.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.ServiceModel.DuplexClientBase`1" /> class using the specified callback object, binding, and service endpoint address.</para>
</summary>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected DuplexClientBase (object instance, string bindingConfigurationName, System.ServiceModel.EndpointAddress address);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(object instance, string bindingConfigurationName, class System.ServiceModel.EndpointAddress address) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="instance" Type="System.Object" />
<Parameter Name="bindingConfigurationName" Type="System.String" />
<Parameter Name="address" Type="System.ServiceModel.EndpointAddress" />
</Parameters>
<Docs>
<param name="instance">To be added.</param>
<param name="bindingConfigurationName">To be added.</param>
<param name="address">To be added.</param>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>indigo2 creates a new <see cref="T:System.ServiceModel.InstanceContext" /> object using the <paramref name="callbackInstance" /> object to handle all callback operations.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.ServiceModel.DuplexClientBase`1" /> class using the specified callback object, configuration name, and service endpoint address.</para>
</summary>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected DuplexClientBase (object instance, string endpointConfigurationName, string remoteAddress);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(object instance, string endpointConfigurationName, string remoteAddress) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="instance" Type="System.Object" />
<Parameter Name="endpointConfigurationName" Type="System.String" />
<Parameter Name="remoteAddress" Type="System.String" />
</Parameters>
<Docs>
<param name="instance">To be added.</param>
<param name="endpointConfigurationName">To be added.</param>
<param name="remoteAddress">To be added.</param>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>indigo2 creates a new <see cref="T:System.ServiceModel.InstanceContext" /> object using the <paramref name="callbackInstance" /> object to handle all callback operations.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.ServiceModel.DuplexClientBase`1" /> class using the specified callback object, endpoint configuration name, and service endpoint address.</para>
</summary>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected DuplexClientBase (System.ServiceModel.InstanceContext instance, System.ServiceModel.Channels.Binding binding, System.ServiceModel.EndpointAddress address);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class System.ServiceModel.InstanceContext instance, class System.ServiceModel.Channels.Binding binding, class System.ServiceModel.EndpointAddress address) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="instance" Type="System.ServiceModel.InstanceContext" />
<Parameter Name="binding" Type="System.ServiceModel.Channels.Binding" />
<Parameter Name="address" Type="System.ServiceModel.EndpointAddress" />
</Parameters>
<Docs>
<param name="instance">To be added.</param>
<param name="binding">To be added.</param>
<param name="address">To be added.</param>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <paramref name="callbackInstance" /> provided by the user is used to service all callback operations.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.ServiceModel.DuplexClientBase`1" /> class using the specified callback object, binding, and service endpoint address.</para>
</summary>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected DuplexClientBase (System.ServiceModel.InstanceContext instance, string configurationName, System.ServiceModel.EndpointAddress address);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class System.ServiceModel.InstanceContext instance, string configurationName, class System.ServiceModel.EndpointAddress address) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="instance" Type="System.ServiceModel.InstanceContext" />
<Parameter Name="configurationName" Type="System.String" />
<Parameter Name="address" Type="System.ServiceModel.EndpointAddress" />
</Parameters>
<Docs>
<param name="instance">To be added.</param>
<param name="configurationName">To be added.</param>
<param name="address">To be added.</param>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <paramref name="callbackInstance" /> provided by the user is used to service all callback operations.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.ServiceModel.DuplexClientBase`1" /> class using the specified callback object, configuration name, and service endpoint address.</para>
</summary>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected DuplexClientBase (System.ServiceModel.InstanceContext instance, string endpointConfigurationName, string remoteAddress);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class System.ServiceModel.InstanceContext instance, string endpointConfigurationName, string remoteAddress) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="instance" Type="System.ServiceModel.InstanceContext" />
<Parameter Name="endpointConfigurationName" Type="System.String" />
<Parameter Name="remoteAddress" Type="System.String" />
</Parameters>
<Docs>
<param name="instance">To be added.</param>
<param name="endpointConfigurationName">To be added.</param>
<param name="remoteAddress">To be added.</param>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <paramref name="callbackInstance" /> provided by the user is used to service all callback operations.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.ServiceModel.DuplexClientBase`1" /> class using the specified callback object, configuration name, and service endpoint address.</para>
</summary>
</Docs>
</Member>
<Member MemberName="CreateChannel">
<MemberSignature Language="C#" Value="protected override TChannel CreateChannel ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance !TChannel CreateChannel() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>TChannel</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns a channel to the service associated with the callback object passed to the constructor.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A channel to the service of the type of the service contract interface.</para>
</returns>
</Docs>
</Member>
<Member MemberName="InnerDuplexChannel">
<MemberSignature Language="C#" Value="public System.ServiceModel.IDuplexContextChannel InnerDuplexChannel { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.ServiceModel.IDuplexContextChannel InnerDuplexChannel" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ServiceModel.IDuplexContextChannel</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the inner duplex channel.</para>
</summary>
</Docs>
</Member>
</Members>
</Type>