280 lines
19 KiB
XML
280 lines
19 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
||
<Type Name="BindingElement" FullName="System.ServiceModel.Channels.BindingElement">
|
||
<TypeSignature Language="C#" Value="public abstract class BindingElement" />
|
||
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit BindingElement extends System.Object" />
|
||
<AssemblyInfo>
|
||
<AssemblyName>System.ServiceModel</AssemblyName>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<Base>
|
||
<BaseTypeName>System.Object</BaseTypeName>
|
||
</Base>
|
||
<Interfaces />
|
||
<Docs>
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>A binding consists of an ordered set of binding elements that inherit from this abstract base class. The <see cref="T:System.ServiceModel.Channels.TransportBindingElement" /> class inherits from the <see cref="T:System.ServiceModel.Channels.BindingElement" /> class. </para>
|
||
<para>Creating a binding and binding element for your transport is optional if you are just using the channel model. It is possible to do everything you need through the channel factory and listener as long as they are made public. </para>
|
||
<para>The indigo1 service model uses a factory pattern where the binding is used to create the channel stack. If you want to use the indigo2 service model, then using a transport binding element is required. Placing this binding element into a binding is a good practice because it removes the requirement for users to create their own custom binding for your transport. It is best to create both a binding and binding element, and hide the channel factory and listener inside the assembly.</para>
|
||
<para>On the sending side, a binding is used to build a <see cref="T:System.ServiceModel.Channels.IChannelFactory" />, which in turn builds a channel stack and returns a reference to the top channel in the stack. The application can then use this channel to send messages. </para>
|
||
<para>Similarly, on the receiving side a binding is used to build a <see cref="T:System.ServiceModel.Channels.IChannelListener" />, which listens for incoming messages. The <see cref="T:System.ServiceModel.Channels.IChannelListener" /> provides messages to the listening application by creating channel stacks and handing the application a reference to the top channel. The application then uses this channel to receive incoming messages.</para>
|
||
<block subset="none" type="note">
|
||
<para> If you are adding message headers that must be encrypted you must return a <see cref="T:System.ServiceModel.Security.ChannelProtectionRequirements" /> instance with your requirements from the <see cref="M:System.ServiceModel.Channels.BindingElement.GetProperty``1(System.ServiceModel.Channels.BindingContext)" /> method when asked for <see cref="T:System.ServiceModel.Security.ChannelProtectionRequirements" />.</para>
|
||
</block>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>The elements of the bindings that build the channel factories and channel listeners for various types of channels that are used to process outgoing and incoming messages.</para>
|
||
</summary>
|
||
</Docs>
|
||
<Members>
|
||
<Member MemberName=".ctor">
|
||
<MemberSignature Language="C#" Value="protected BindingElement ();" />
|
||
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
|
||
<MemberType>Constructor</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<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.ServiceModel.Channels.BindingElement" /> class. </para>
|
||
</summary>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName=".ctor">
|
||
<MemberSignature Language="C#" Value="protected BindingElement (System.ServiceModel.Channels.BindingElement other);" />
|
||
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class System.ServiceModel.Channels.BindingElement other) cil managed" />
|
||
<MemberType>Constructor</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<Parameters>
|
||
<Parameter Name="other" Type="System.ServiceModel.Channels.BindingElement" />
|
||
</Parameters>
|
||
<Docs>
|
||
<param name="other">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.Channels.BindingElement" /> class from a specified binding element.</para>
|
||
</summary>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="BuildChannelFactory<TChannel>">
|
||
<MemberSignature Language="C#" Value="public virtual System.ServiceModel.Channels.IChannelFactory<TChannel> BuildChannelFactory<TChannel> (System.ServiceModel.Channels.BindingContext context);" />
|
||
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.ServiceModel.Channels.IChannelFactory`1<!!TChannel> BuildChannelFactory<TChannel>(class System.ServiceModel.Channels.BindingContext context) cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.ServiceModel.Channels.IChannelFactory<TChannel></ReturnType>
|
||
</ReturnValue>
|
||
<TypeParameters>
|
||
<TypeParameter Name="TChannel" />
|
||
</TypeParameters>
|
||
<Parameters>
|
||
<Parameter Name="context" Type="System.ServiceModel.Channels.BindingContext" />
|
||
</Parameters>
|
||
<Docs>
|
||
<remarks>To be added.</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Initializes a channel factory for producing channels of a specified type from the binding context.</para>
|
||
</summary>
|
||
<returns>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>The <see cref="T:System.ServiceModel.Channels.IChannelFactory`1" /> of type <paramref name="TChannel" /> initialized from the <paramref name="context" />.</para>
|
||
</returns>
|
||
<param name="context">
|
||
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ServiceModel.Channels.BindingContext" /> that provides context for the binding element. </param>
|
||
<typeparam name="TChannel">
|
||
<attribution license="cc4" from="Microsoft" modified="false" />The type of channel the factory builds.</typeparam>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="BuildChannelListener<TChannel>">
|
||
<MemberSignature Language="C#" Value="public virtual System.ServiceModel.Channels.IChannelListener<TChannel> BuildChannelListener<TChannel> (System.ServiceModel.Channels.BindingContext context) where TChannel : class, System.ServiceModel.Channels.IChannel;" />
|
||
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.ServiceModel.Channels.IChannelListener`1<!!TChannel> BuildChannelListener<class (class System.ServiceModel.Channels.IChannel) TChannel>(class System.ServiceModel.Channels.BindingContext context) cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.ServiceModel.Channels.IChannelListener<TChannel></ReturnType>
|
||
</ReturnValue>
|
||
<TypeParameters>
|
||
<TypeParameter Name="TChannel">
|
||
<Constraints>
|
||
<ParameterAttribute>ReferenceTypeConstraint</ParameterAttribute>
|
||
<InterfaceName>System.ServiceModel.Channels.IChannel</InterfaceName>
|
||
</Constraints>
|
||
</TypeParameter>
|
||
</TypeParameters>
|
||
<Parameters>
|
||
<Parameter Name="context" Type="System.ServiceModel.Channels.BindingContext" />
|
||
</Parameters>
|
||
<Docs>
|
||
<remarks>To be added.</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Initializes a channel listener to accept channels of a specified type from the binding context.</para>
|
||
</summary>
|
||
<returns>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>The <see cref="T:System.ServiceModel.Channels.IChannelListener`1" /> of type <see cref="T:System.ServiceModel.Channels.IChannel" /> initialized from the <paramref name="context" />.</para>
|
||
</returns>
|
||
<param name="context">
|
||
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ServiceModel.Channels.BindingContext" /> that provides context for the binding element.</param>
|
||
<typeparam name="TChannel">
|
||
<attribution license="cc4" from="Microsoft" modified="false" />The type of channel the listener is built to accept.</typeparam>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="CanBuildChannelFactory<TChannel>">
|
||
<MemberSignature Language="C#" Value="public virtual bool CanBuildChannelFactory<TChannel> (System.ServiceModel.Channels.BindingContext context);" />
|
||
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool CanBuildChannelFactory<TChannel>(class System.ServiceModel.Channels.BindingContext context) cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Boolean</ReturnType>
|
||
</ReturnValue>
|
||
<TypeParameters>
|
||
<TypeParameter Name="TChannel" />
|
||
</TypeParameters>
|
||
<Parameters>
|
||
<Parameter Name="context" Type="System.ServiceModel.Channels.BindingContext" />
|
||
</Parameters>
|
||
<Docs>
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Use this method if you want to check that the channel factory for channels of type <paramref name="TChannel" /> can be build for the <paramref name="context" /> provided before attempting to build the factory. Alternatively, build the channel factory by calling <see cref="M:System.ServiceModel.Channels.BindingElement.BuildChannelFactory``1(System.ServiceModel.Channels.BindingContext)" /> and catch the exception generated if it cannot be built.</para>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Returns a value that indicates whether the binding element can build a channel factory for a specific type of channel.</para>
|
||
</summary>
|
||
<returns>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>true if the <see cref="T:System.ServiceModel.Channels.IChannelFactory`1" /> of type <paramref name="TChannel" /> can be built by the binding element; otherwise, false.</para>
|
||
</returns>
|
||
<param name="context">
|
||
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ServiceModel.Channels.BindingContext" /> that provides context for the binding element. </param>
|
||
<typeparam name="TChannel">
|
||
<attribution license="cc4" from="Microsoft" modified="false" />The type of channel the channel factory produces.</typeparam>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="CanBuildChannelListener<TChannel>">
|
||
<MemberSignature Language="C#" Value="public virtual bool CanBuildChannelListener<TChannel> (System.ServiceModel.Channels.BindingContext context) where TChannel : class, System.ServiceModel.Channels.IChannel;" />
|
||
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool CanBuildChannelListener<class (class System.ServiceModel.Channels.IChannel) TChannel>(class System.ServiceModel.Channels.BindingContext context) cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.Boolean</ReturnType>
|
||
</ReturnValue>
|
||
<TypeParameters>
|
||
<TypeParameter Name="TChannel">
|
||
<Constraints>
|
||
<ParameterAttribute>ReferenceTypeConstraint</ParameterAttribute>
|
||
<InterfaceName>System.ServiceModel.Channels.IChannel</InterfaceName>
|
||
</Constraints>
|
||
</TypeParameter>
|
||
</TypeParameters>
|
||
<Parameters>
|
||
<Parameter Name="context" Type="System.ServiceModel.Channels.BindingContext" />
|
||
</Parameters>
|
||
<Docs>
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Use this method if you want to check that the channel listener for channels of type <paramref name="TChannel" /> can be build for the <paramref name="context" /> provided before attempting to build the listener. Alternatively, build the channel listener by calling <see cref="M:System.ServiceModel.Channels.BindingElement.BuildChannelListener``1(System.ServiceModel.Channels.BindingContext)" /> and catch the exception generated if it cannot be built.</para>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Returns a value that indicates whether the binding element can build a listener for a specific type of channel.</para>
|
||
</summary>
|
||
<returns>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>true if the <see cref="T:System.ServiceModel.Channels.IChannelListener`1" /> of type <see cref="T:System.ServiceModel.Channels.IChannel" /> can be built by the binding element; otherwise, false.</para>
|
||
</returns>
|
||
<param name="context">
|
||
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ServiceModel.Channels.BindingContext" /> that provides context for the binding element. </param>
|
||
<typeparam name="TChannel">
|
||
<attribution license="cc4" from="Microsoft" modified="false" />The type of channel the listener accepts.</typeparam>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="Clone">
|
||
<MemberSignature Language="C#" Value="public abstract System.ServiceModel.Channels.BindingElement Clone ();" />
|
||
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.ServiceModel.Channels.BindingElement Clone() cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>System.ServiceModel.Channels.BindingElement</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters />
|
||
<Docs>
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Implement the <see cref="M:System.ServiceModel.Channels.BindingElement.Clone" /> method to return a deep clone of your binding element. Returning a clone enables the runtime to support the case in which multiple custom bindings share a custom binding element. If a clone is not returned, the run-time behavior is undefined.</para>
|
||
<para>A deep clone of an object creates a copy of the object and a copy of everything directly or indirectly referenced by that object. (This is also called copying the entire object graph.) A shallow clone of an object, by contrast, is a copy of the object only. If the object contains references to other objects, the shallow copy does not create copies of the referred objects; instead, it copies only the references to the original objects.</para>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>When overridden in a derived class, returns a copy of the binding element object.</para>
|
||
</summary>
|
||
<returns>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>A <see cref="T:System.ServiceModel.Channels.BindingElement" /> object that is a deep clone of the original.</para>
|
||
</returns>
|
||
</Docs>
|
||
</Member>
|
||
<Member MemberName="GetProperty<T>">
|
||
<MemberSignature Language="C#" Value="public abstract T GetProperty<T> (System.ServiceModel.Channels.BindingContext context) where T : class;" />
|
||
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance !!T GetProperty<class T>(class System.ServiceModel.Channels.BindingContext context) cil managed" />
|
||
<MemberType>Method</MemberType>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>4.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<ReturnValue>
|
||
<ReturnType>T</ReturnType>
|
||
</ReturnValue>
|
||
<TypeParameters>
|
||
<TypeParameter Name="T">
|
||
<Constraints>
|
||
<ParameterAttribute>ReferenceTypeConstraint</ParameterAttribute>
|
||
</Constraints>
|
||
</TypeParameter>
|
||
</TypeParameters>
|
||
<Parameters>
|
||
<Parameter Name="context" Type="System.ServiceModel.Channels.BindingContext" />
|
||
</Parameters>
|
||
<Docs>
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Use this to retrieve capabilities, requirements and parameters from the binding element stack. If a binding element supports returning the requested object, it returns it. If not, it delegates the call down to the next binding element in the stack. If it gets to the bottom of the stack and no binding element supported the requested object, then the method returns null.</para>
|
||
<block subset="none" type="note">
|
||
<para>If you are adding message headers that must be encrypted you must return a <see cref="T:System.ServiceModel.Security.ChannelProtectionRequirements" /> instance with your requirements from this method when asked for <see cref="T:System.ServiceModel.Security.ChannelProtectionRequirements" />.</para>
|
||
</block>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>When overridden in a derived class, returns a typed object requested, if present, from the appropriate layer in the binding stack.</para>
|
||
</summary>
|
||
<returns>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>The typed object <paramref name="T" /> requested if it is present or null if it is not present.</para>
|
||
</returns>
|
||
<param name="context">
|
||
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ServiceModel.Channels.BindingContext" /> for the binding element.</param>
|
||
<typeparam name="T">
|
||
<attribution license="cc4" from="Microsoft" modified="false" />The typed object for which the method is querying.</typeparam>
|
||
</Docs>
|
||
</Member>
|
||
</Members>
|
||
</Type> |