/
TransportElement.xml
309 lines (301 loc) · 20.9 KB
/
TransportElement.xml
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
298
299
300
301
302
303
304
305
306
307
308
309
<Type Name="TransportElement" FullName="System.ServiceModel.Configuration.TransportElement">
<TypeSignature Language="C#" Value="public abstract class TransportElement : System.ServiceModel.Configuration.BindingElementExtensionElement" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit TransportElement extends System.ServiceModel.Configuration.BindingElementExtensionElement" />
<TypeSignature Language="DocId" Value="T:System.ServiceModel.Configuration.TransportElement" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class TransportElement
Inherits BindingElementExtensionElement" />
<TypeSignature Language="F#" Value="type TransportElement = class
 inherit BindingElementExtensionElement" />
<TypeSignature Language="C++ CLI" Value="public ref class TransportElement abstract : System::ServiceModel::Configuration::BindingElementExtensionElement" />
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.ServiceModel.Configuration.BindingElementExtensionElement</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Provides a base class to represent a transport binding configuration element.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This class contains properties that are common to all of the transport binding configuration elements provided by Windows Communication Foundation (WCF). It handles the translation of the message encoder settings and base transport settings into their run-time manifestations. It delegates the translation of transport-specific settings (for example, HttpProxySettings for HTTP) logic in its concrete derived class transport bindings.
]]></format>
</remarks>
<related type="Article" href="/dotnet/framework/wcf/feature-details/transports">Transports in WCF</related>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected TransportElement ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.ServiceModel.Configuration.TransportElement.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberSignature Language="C++ CLI" Value="protected:
 TransportElement();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.ServiceModel.Configuration.TransportElement" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ApplyConfiguration">
<MemberSignature Language="C#" Value="public override void ApplyConfiguration (System.ServiceModel.Channels.BindingElement bindingElement);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void ApplyConfiguration(class System.ServiceModel.Channels.BindingElement bindingElement) cil managed" />
<MemberSignature Language="DocId" Value="M:System.ServiceModel.Configuration.TransportElement.ApplyConfiguration(System.ServiceModel.Channels.BindingElement)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub ApplyConfiguration (bindingElement As BindingElement)" />
<MemberSignature Language="F#" Value="override this.ApplyConfiguration : System.ServiceModel.Channels.BindingElement -> unit" Usage="transportElement.ApplyConfiguration bindingElement" />
<MemberSignature Language="C++ CLI" Value="public:
 override void ApplyConfiguration(System::ServiceModel::Channels::BindingElement ^ bindingElement);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="bindingElement" Type="System.ServiceModel.Channels.BindingElement" />
</Parameters>
<Docs>
<param name="bindingElement">The <see cref="T:System.ServiceModel.Channels.BindingElement" /> to this configuration element.</param>
<summary>Applies the settings of the specified <see cref="T:System.ServiceModel.Channels.BindingElement" /> to this configuration element.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CopyFrom">
<MemberSignature Language="C#" Value="public override void CopyFrom (System.ServiceModel.Configuration.ServiceModelExtensionElement from);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void CopyFrom(class System.ServiceModel.Configuration.ServiceModelExtensionElement from) cil managed" />
<MemberSignature Language="DocId" Value="M:System.ServiceModel.Configuration.TransportElement.CopyFrom(System.ServiceModel.Configuration.ServiceModelExtensionElement)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub CopyFrom (from As ServiceModelExtensionElement)" />
<MemberSignature Language="F#" Value="override this.CopyFrom : System.ServiceModel.Configuration.ServiceModelExtensionElement -> unit" Usage="transportElement.CopyFrom from" />
<MemberSignature Language="C++ CLI" Value="public:
 override void CopyFrom(System::ServiceModel::Configuration::ServiceModelExtensionElement ^ from);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="from" Type="System.ServiceModel.Configuration.ServiceModelExtensionElement" />
</Parameters>
<Docs>
<param name="from">The configuration element whose settings are to be copied to this configuration element.</param>
<summary>Copies the settings from the specified configuration element to this configuration element.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateBindingElement">
<MemberSignature Language="C#" Value="protected internal override System.ServiceModel.Channels.BindingElement CreateBindingElement ();" />
<MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig virtual instance class System.ServiceModel.Channels.BindingElement CreateBindingElement() cil managed" />
<MemberSignature Language="DocId" Value="M:System.ServiceModel.Configuration.TransportElement.CreateBindingElement" />
<MemberSignature Language="VB.NET" Value="Protected Friend Overrides Function CreateBindingElement () As BindingElement" />
<MemberSignature Language="F#" Value="override this.CreateBindingElement : unit -> System.ServiceModel.Channels.BindingElement" Usage="transportElement.CreateBindingElement " />
<MemberSignature Language="C++ CLI" Value="protected public:
 override System::ServiceModel::Channels::BindingElement ^ CreateBindingElement();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ServiceModel.Channels.BindingElement</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Creates a new custom binding element object whose properties are copied from the settings of this configuration element.</summary>
<returns>A custom <see cref="T:System.ServiceModel.Channels.BindingElement" /> object.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateDefaultBindingElement">
<MemberSignature Language="C#" Value="protected abstract System.ServiceModel.Channels.TransportBindingElement CreateDefaultBindingElement ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class System.ServiceModel.Channels.TransportBindingElement CreateDefaultBindingElement() cil managed" />
<MemberSignature Language="DocId" Value="M:System.ServiceModel.Configuration.TransportElement.CreateDefaultBindingElement" />
<MemberSignature Language="VB.NET" Value="Protected MustOverride Function CreateDefaultBindingElement () As TransportBindingElement" />
<MemberSignature Language="F#" Value="abstract member CreateDefaultBindingElement : unit -> System.ServiceModel.Channels.TransportBindingElement" Usage="transportElement.CreateDefaultBindingElement " />
<MemberSignature Language="C++ CLI" Value="protected:
 abstract System::ServiceModel::Channels::TransportBindingElement ^ CreateDefaultBindingElement();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ServiceModel.Channels.TransportBindingElement</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns a custom binding element object with default values.</summary>
<returns>A custom <see cref="T:System.ServiceModel.Channels.BindingElement" /> object with default values.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="InitializeFrom">
<MemberSignature Language="C#" Value="protected internal override void InitializeFrom (System.ServiceModel.Channels.BindingElement bindingElement);" />
<MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig virtual instance void InitializeFrom(class System.ServiceModel.Channels.BindingElement bindingElement) cil managed" />
<MemberSignature Language="DocId" Value="M:System.ServiceModel.Configuration.TransportElement.InitializeFrom(System.ServiceModel.Channels.BindingElement)" />
<MemberSignature Language="VB.NET" Value="Protected Friend Overrides Sub InitializeFrom (bindingElement As BindingElement)" />
<MemberSignature Language="F#" Value="override this.InitializeFrom : System.ServiceModel.Channels.BindingElement -> unit" Usage="transportElement.InitializeFrom bindingElement" />
<MemberSignature Language="C++ CLI" Value="protected public:
 override void InitializeFrom(System::ServiceModel::Channels::BindingElement ^ bindingElement);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="bindingElement" Type="System.ServiceModel.Channels.BindingElement" />
</Parameters>
<Docs>
<param name="bindingElement">A binding element.</param>
<summary>Initializes this binding configuration element with the content of the specified binding element.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ManualAddressing">
<MemberSignature Language="C#" Value="public bool ManualAddressing { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool ManualAddressing" />
<MemberSignature Language="DocId" Value="P:System.ServiceModel.Configuration.TransportElement.ManualAddressing" />
<MemberSignature Language="VB.NET" Value="Public Property ManualAddressing As Boolean" />
<MemberSignature Language="F#" Value="member this.ManualAddressing : bool with get, set" Usage="System.ServiceModel.Configuration.TransportElement.ManualAddressing" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool ManualAddressing { bool get(); void set(bool value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Configuration.ConfigurationProperty("manualAddressing", DefaultValue=false)]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.ConfigurationProperty("manualAddressing", DefaultValue=false)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a Boolean value that specifies whether the user takes control of message addressing.</summary>
<value>
<see langword="true" /> if the user can address every message individually; <see langword="false" /> if the default WCF addressing mechanism automatically creates addresses for all messages. The default is <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This property is usually used in router scenarios, where the application determines which one of several destinations to send a message to.
If this property is set to `true`, the channel assumes the message has already been addressed and does not add any additional information to it.
If this property is set to `false`, the channel adds SOAP addressing information to the message.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="MaxBufferPoolSize">
<MemberSignature Language="C#" Value="public long MaxBufferPoolSize { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 MaxBufferPoolSize" />
<MemberSignature Language="DocId" Value="P:System.ServiceModel.Configuration.TransportElement.MaxBufferPoolSize" />
<MemberSignature Language="VB.NET" Value="Public Property MaxBufferPoolSize As Long" />
<MemberSignature Language="F#" Value="member this.MaxBufferPoolSize : int64 with get, set" Usage="System.ServiceModel.Configuration.TransportElement.MaxBufferPoolSize" />
<MemberSignature Language="C++ CLI" Value="public:
 property long MaxBufferPoolSize { long get(); void set(long value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Configuration.ConfigurationProperty("maxBufferPoolSize", DefaultValue=524288)]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.ConfigurationProperty("maxBufferPoolSize", DefaultValue=524288)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Configuration.LongValidator(MinValue=1)]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.LongValidator(MinValue=1)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the maximum size, in bytes, of the buffer pool.</summary>
<value>The maximum size of the buffer pool. The default is 524,288 bytes (512 * 1024).</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Many parts of WCF use buffers. Creating and destroying buffers each time they are used is expensive, and garbage collection for buffers is also expensive. With buffer pools, you can take a buffer from the pool, use it, and return it to the pool once you are done. Thus the overhead in creating and destroying buffers is avoided.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="MaxReceivedMessageSize">
<MemberSignature Language="C#" Value="public long MaxReceivedMessageSize { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 MaxReceivedMessageSize" />
<MemberSignature Language="DocId" Value="P:System.ServiceModel.Configuration.TransportElement.MaxReceivedMessageSize" />
<MemberSignature Language="VB.NET" Value="Public Property MaxReceivedMessageSize As Long" />
<MemberSignature Language="F#" Value="member this.MaxReceivedMessageSize : int64 with get, set" Usage="System.ServiceModel.Configuration.TransportElement.MaxReceivedMessageSize" />
<MemberSignature Language="C++ CLI" Value="public:
 property long MaxReceivedMessageSize { long get(); void set(long value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Configuration.ConfigurationProperty("maxReceivedMessageSize", DefaultValue=65536)]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.ConfigurationProperty("maxReceivedMessageSize", DefaultValue=65536)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Configuration.LongValidator(MinValue=1)]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.LongValidator(MinValue=1)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the maximum allowable message size, in bytes, that can be received.</summary>
<value>The maximum allowable message size that can be received.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Properties">
<MemberSignature Language="C#" Value="protected override System.Configuration.ConfigurationPropertyCollection Properties { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Configuration.ConfigurationPropertyCollection Properties" />
<MemberSignature Language="DocId" Value="P:System.ServiceModel.Configuration.TransportElement.Properties" />
<MemberSignature Language="VB.NET" Value="Protected Overrides ReadOnly Property Properties As ConfigurationPropertyCollection" />
<MemberSignature Language="F#" Value="member this.Properties : System.Configuration.ConfigurationPropertyCollection" Usage="System.ServiceModel.Configuration.TransportElement.Properties" />
<MemberSignature Language="C++ CLI" Value="protected:
 virtual property System::Configuration::ConfigurationPropertyCollection ^ Properties { System::Configuration::ConfigurationPropertyCollection ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Configuration.ConfigurationPropertyCollection</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a <see cref="T:System.Configuration.ConfigurationPropertyCollection" /> instance that contains a collection of <see cref="T:System.Configuration.ConfigurationProperty" /> objects that can be attributes or <see cref="T:System.Configuration.ConfigurationElement" /> objects of this configuration element.</summary>
<value>A <see cref="T:System.Configuration.ConfigurationPropertyCollection" /> instance that contains a collection of <see cref="T:System.Configuration.ConfigurationProperty" /> objects that can be attributes or <see cref="T:System.Configuration.ConfigurationElement" /> objects of this configuration element.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>