1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
|
<?xml version="1.0" encoding="utf-8"?>
<Type Name="ChannelFactoryBase<TChannel>" FullName="System.ServiceModel.Channels.ChannelFactoryBase<TChannel>">
<TypeSignature Language="C#" Value="public abstract class ChannelFactoryBase<TChannel> : System.ServiceModel.Channels.ChannelFactoryBase, System.ServiceModel.Channels.IChannelFactory<TChannel>" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit ChannelFactoryBase`1<TChannel> extends System.ServiceModel.Channels.ChannelFactoryBase implements class System.ServiceModel.Channels.IChannelFactory, class System.ServiceModel.Channels.IChannelFactory`1<!TChannel>, class System.ServiceModel.ICommunicationObject" />
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<TypeParameters>
<TypeParameter Name="TChannel" />
</TypeParameters>
<Base>
<BaseTypeName>System.ServiceModel.Channels.ChannelFactoryBase</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.ServiceModel.Channels.IChannelFactory<TChannel></InterfaceName>
</Interface>
</Interfaces>
<Docs>
<typeparam name="TChannel">To be added.</typeparam>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The channels created by channel factories on the client are accepted on the server by channel listeners. Once the channel connection is established between client and service, they can communicate by exchanging messages.</para>
<para>The <see cref="Overload:System.ServiceModel.Channels.ChannelFactoryBase`1.CreateChannel" /> uses the specified address as the destination for outgoing messages. The ServiceAddress.Uri property is used as the To header in the message. The ServiceReference.Via property is used as the physical destination to send messages to. This is typically the same as the ServiceAddress.Uri value.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides a common base implementation for channel factories on the client to create channels of a specified type connected to a specified address.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected ChannelFactoryBase ();" />
<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>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The default constructor initializes timeout properties with the service model timeout values when exchanging messages. The default value is 1 minute for open, send, and close operations and 10 minutes for the receive operation. Use <see cref="M:System.ServiceModel.Channels.ChannelFactoryBase`1.#ctor(System.ServiceModel.IDefaultCommunicationTimeouts)" /> if you want to specify other values for these operation timeouts.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.ServiceModel.Channels.ChannelFactoryBase`1" /> class. </para>
</summary>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected ChannelFactoryBase (System.ServiceModel.IDefaultCommunicationTimeouts timeouts);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(class System.ServiceModel.IDefaultCommunicationTimeouts timeouts) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="timeouts" Type="System.ServiceModel.IDefaultCommunicationTimeouts" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use <see cref="M:System.ServiceModel.Channels.ChannelFactoryBase`1.#ctor(System.ServiceModel.IDefaultCommunicationTimeouts)" /> instead of the default constructor if you want to specify custom values for the open, send, receive, and close operation timeouts instead of using the service model default values.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.ServiceModel.Channels.ChannelFactoryBase`1" /> class with the default communication timeouts specified.</para>
</summary>
<param name="timeouts">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ServiceModel.IDefaultCommunicationTimeouts" /> that specifies the default timeouts for open, send, receive, and close operations when exchanging messages.</param>
</Docs>
</Member>
<Member MemberName="CreateChannel">
<MemberSignature Language="C#" Value="public TChannel CreateChannel (System.ServiceModel.EndpointAddress remoteAddress);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance !TChannel CreateChannel(class System.ServiceModel.EndpointAddress remoteAddress) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>TChannel</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="remoteAddress" Type="System.ServiceModel.EndpointAddress" />
</Parameters>
<Docs>
<param name="remoteAddress">To be added.</param>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method calls <see cref="M:System.ServiceModel.Channels.ChannelFactoryBase`1.OnCreateChannel(System.ServiceModel.EndpointAddress,System.Uri)" /> when invoked. This method cannot be overridden by a derived class. </para>
<para>This uses <see cref="P:System.ServiceModel.EndpointAddress.Uri" /> as the transport address to which messages are sent on the output channel.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Creates a particular type of channel with a specified endpoint address.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A channel of type <paramref name="TChannel" /> with the specified <paramref name="address" />.</para>
</returns>
</Docs>
</Member>
<Member MemberName="CreateChannel">
<MemberSignature Language="C#" Value="public TChannel CreateChannel (System.ServiceModel.EndpointAddress remoteAddress, Uri via);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance !TChannel CreateChannel(class System.ServiceModel.EndpointAddress remoteAddress, class System.Uri via) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>TChannel</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="remoteAddress" Type="System.ServiceModel.EndpointAddress" />
<Parameter Name="via" Type="System.Uri" />
</Parameters>
<Docs>
<param name="remoteAddress">To be added.</param>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method calls <see cref="M:System.ServiceModel.Channels.ChannelFactoryBase`1.OnCreateChannel(System.ServiceModel.EndpointAddress,System.Uri)" /> when invoked.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Creates a particular type of channel with specified transport and endpoint addresses.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A channel of type <paramref name="TChannel" /> with the specified remote and transport addresses.</para>
</returns>
<param name="via">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Uri" /> that contains the transport address to which messages are sent on the output channel.</param>
</Docs>
</Member>
<Member MemberName="OnAbort">
<MemberSignature Language="C#" Value="protected override void OnAbort ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void OnAbort() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method is called by <see cref="M:System.ServiceModel.Channels.CommunicationObject.Abort" />. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Aborts each channel managed by the channel factory.</para>
</summary>
</Docs>
</Member>
<Member MemberName="OnBeginClose">
<MemberSignature Language="C#" Value="protected override IAsyncResult OnBeginClose (TimeSpan timeout, AsyncCallback callback, object state);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance class System.IAsyncResult OnBeginClose(valuetype System.TimeSpan timeout, class System.AsyncCallback callback, object state) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IAsyncResult</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="timeout" Type="System.TimeSpan" />
<Parameter Name="callback" Type="System.AsyncCallback" />
<Parameter Name="state" Type="System.Object" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Begins an asynchronous operation to close all the channels associated with the channel factory within a specified interval of time.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.IAsyncResult" /> that references the asynchronous on-close operation. </para>
</returns>
<param name="timeout">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Timespan" /> that specifies how long the on-close operation has to complete before timing out.</param>
<param name="callback">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.AsyncCallback" /> delegate that receives the notification of the asynchronous completion of the on-close operation.</param>
<param name="state">
<attribution license="cc4" from="Microsoft" modified="false" />An object, specified by the application, that contains state information associated with the asynchronous on-close operation.</param>
</Docs>
</Member>
<Member MemberName="OnClose">
<MemberSignature Language="C#" Value="protected override void OnClose (TimeSpan timeout);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void OnClose(valuetype System.TimeSpan timeout) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="timeout" Type="System.TimeSpan" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method sequentially attempts to close all of the active channels associated with the channel factory in no particular order. The timeout parameter is the cumulative amount of time available for closing all of the channels. If a graceful close of one of the channels fails (for example, if the channel is faulted causing an exception to be thrown) then this operation fails and does not attempt to close the remaining channels. Failure in this method causes the factory and any remaining channels to be aborted rather than closed.</para>
<para>This method is called by <see cref="M:System.ServiceModel.Channels.CommunicationObject.Close" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Closes all the channels associated with the channel factory within a specified interval of time.</para>
</summary>
<param name="timeout">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Timespan" /> that specifies how long the on-close operation has to complete before timing out.</param>
</Docs>
</Member>
<Member MemberName="OnCreateChannel">
<MemberSignature Language="C#" Value="protected abstract TChannel OnCreateChannel (System.ServiceModel.EndpointAddress remoteAddress, Uri via);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance !TChannel OnCreateChannel(class System.ServiceModel.EndpointAddress remoteAddress, class System.Uri via) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>TChannel</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="remoteAddress" Type="System.ServiceModel.EndpointAddress" />
<Parameter Name="via" Type="System.Uri" />
</Parameters>
<Docs>
<param name="remoteAddress">To be added.</param>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method is called by <see cref="Overload:System.ServiceModel.Channels.ChannelFactoryBase`1.CreateChannel" /> when invoked.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When implemented in a derived class, provides an extensibility point when creating channels.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A channel of type <paramref name="TChannel" /> with the specified addresses.</para>
</returns>
<param name="via">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Uri" /> that contains the transport address to which messages are sent on the output channel.</param>
</Docs>
</Member>
<Member MemberName="OnEndClose">
<MemberSignature Language="C#" Value="protected override void OnEndClose (IAsyncResult result);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void OnEndClose(class System.IAsyncResult result) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="result" Type="System.IAsyncResult" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Completes an asynchronous operation to close all the channels associated with the channel factory within a specified interval of time.</para>
</summary>
<param name="result">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.IAsyncResult" /> returned by a call to the <see cref="M:System.ServiceModel.Channels.ChannelFactoryBase`1.OnBeginClose(System.TimeSpan,System.AsyncCallback,System.Object)" /> method.</param>
</Docs>
</Member>
<Member MemberName="ValidateCreateChannel">
<MemberSignature Language="C#" Value="protected void ValidateCreateChannel ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig instance void ValidateCreateChannel() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The method throws one of the exceptions listed and checks for the conditions in the order they are listed in the table.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Confirms that the channel factory is opened and ready to create channels.</para>
</summary>
</Docs>
</Member>
</Members>
</Type>
|