-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
RequestCachingSection.xml
328 lines (316 loc) · 20 KB
/
RequestCachingSection.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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
<Type Name="RequestCachingSection" FullName="System.Net.Configuration.RequestCachingSection">
<TypeSignature Language="C#" Value="public sealed class RequestCachingSection : System.Configuration.ConfigurationSection" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit RequestCachingSection extends System.Configuration.ConfigurationSection" />
<TypeSignature Language="DocId" Value="T:System.Net.Configuration.RequestCachingSection" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class RequestCachingSection
Inherits ConfigurationSection" />
<TypeSignature Language="F#" Value="type RequestCachingSection = class
 inherit ConfigurationSection" />
<TypeSignature Language="C++ CLI" Value="public ref class RequestCachingSection sealed : System::Configuration::ConfigurationSection" />
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Configuration.ConfigurationSection</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Represents the configuration section for cache behavior. This class cannot be inherited.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This class corresponds to the [<requestCaching> Element (Network Settings)](/dotnet/framework/configure-apps/file-schema/network/requestcaching-element-network-settings) configuration element.
This class is used to access information about default caching behavior for resources requested by using the <xref:System.Net.WebRequest> and <xref:System.Net.WebClient> classes.
This class provides programmatic access to information that can be stored in configuration files.
]]></format>
</remarks>
<related type="Article" href="/dotnet/framework/configure-apps/file-schema/network/">Network Settings Schema</related>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public RequestCachingSection ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Net.Configuration.RequestCachingSection.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 RequestCachingSection();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Net.Configuration.RequestCachingSection" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DefaultFtpCachePolicy">
<MemberSignature Language="C#" Value="public System.Net.Configuration.FtpCachePolicyElement DefaultFtpCachePolicy { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Net.Configuration.FtpCachePolicyElement DefaultFtpCachePolicy" />
<MemberSignature Language="DocId" Value="P:System.Net.Configuration.RequestCachingSection.DefaultFtpCachePolicy" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property DefaultFtpCachePolicy As FtpCachePolicyElement" />
<MemberSignature Language="F#" Value="member this.DefaultFtpCachePolicy : System.Net.Configuration.FtpCachePolicyElement" Usage="System.Net.Configuration.RequestCachingSection.DefaultFtpCachePolicy" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Net::Configuration::FtpCachePolicyElement ^ DefaultFtpCachePolicy { System::Net::Configuration::FtpCachePolicyElement ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Configuration.ConfigurationProperty("defaultFtpCachePolicy")]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.ConfigurationProperty("defaultFtpCachePolicy")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Net.Configuration.FtpCachePolicyElement</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the default FTP caching behavior for the local computer.</summary>
<value>A <see cref="T:System.Net.Configuration.FtpCachePolicyElement" /> that defines the default cache policy.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DefaultHttpCachePolicy">
<MemberSignature Language="C#" Value="public System.Net.Configuration.HttpCachePolicyElement DefaultHttpCachePolicy { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Net.Configuration.HttpCachePolicyElement DefaultHttpCachePolicy" />
<MemberSignature Language="DocId" Value="P:System.Net.Configuration.RequestCachingSection.DefaultHttpCachePolicy" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property DefaultHttpCachePolicy As HttpCachePolicyElement" />
<MemberSignature Language="F#" Value="member this.DefaultHttpCachePolicy : System.Net.Configuration.HttpCachePolicyElement" Usage="System.Net.Configuration.RequestCachingSection.DefaultHttpCachePolicy" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Net::Configuration::HttpCachePolicyElement ^ DefaultHttpCachePolicy { System::Net::Configuration::HttpCachePolicyElement ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Configuration.ConfigurationProperty("defaultHttpCachePolicy")]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.ConfigurationProperty("defaultHttpCachePolicy")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Net.Configuration.HttpCachePolicyElement</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the default caching behavior for the local computer.</summary>
<value>A <see cref="T:System.Net.Configuration.HttpCachePolicyElement" /> that defines the default cache policy.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Unless the <xref:System.Net.Configuration.RequestCachingSection.DisableAllCaching%2A> property is set to `true`, the policy returned by this property overrides the policy set in the <xref:System.Net.Configuration.RequestCachingSection.DefaultPolicyLevel%2A> property.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="DefaultPolicyLevel">
<MemberSignature Language="C#" Value="public System.Net.Cache.RequestCacheLevel DefaultPolicyLevel { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Net.Cache.RequestCacheLevel DefaultPolicyLevel" />
<MemberSignature Language="DocId" Value="P:System.Net.Configuration.RequestCachingSection.DefaultPolicyLevel" />
<MemberSignature Language="VB.NET" Value="Public Property DefaultPolicyLevel As RequestCacheLevel" />
<MemberSignature Language="F#" Value="member this.DefaultPolicyLevel : System.Net.Cache.RequestCacheLevel with get, set" Usage="System.Net.Configuration.RequestCachingSection.DefaultPolicyLevel" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Net::Cache::RequestCacheLevel DefaultPolicyLevel { System::Net::Cache::RequestCacheLevel get(); void set(System::Net::Cache::RequestCacheLevel value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Configuration.ConfigurationProperty("defaultPolicyLevel", DefaultValue=System.Net.Cache.RequestCacheLevel.BypassCache)]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.ConfigurationProperty("defaultPolicyLevel", DefaultValue=System.Net.Cache.RequestCacheLevel.BypassCache)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Net.Cache.RequestCacheLevel</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the default cache policy level.</summary>
<value>A <see cref="T:System.Net.Cache.RequestCacheLevel" /> enumeration value.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DeserializeElement">
<MemberSignature Language="C#" Value="protected override void DeserializeElement (System.Xml.XmlReader reader, bool serializeCollectionKey);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void DeserializeElement(class System.Xml.XmlReader reader, bool serializeCollectionKey) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Net.Configuration.RequestCachingSection.DeserializeElement(System.Xml.XmlReader,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub DeserializeElement (reader As XmlReader, serializeCollectionKey As Boolean)" />
<MemberSignature Language="F#" Value="override this.DeserializeElement : System.Xml.XmlReader * bool -> unit" Usage="requestCachingSection.DeserializeElement (reader, serializeCollectionKey)" />
<MemberSignature Language="C++ CLI" Value="protected:
 override void DeserializeElement(System::Xml::XmlReader ^ reader, bool serializeCollectionKey);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="reader" Type="System.Xml.XmlReader" />
<Parameter Name="serializeCollectionKey" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="reader">To be added.</param>
<param name="serializeCollectionKey">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DisableAllCaching">
<MemberSignature Language="C#" Value="public bool DisableAllCaching { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool DisableAllCaching" />
<MemberSignature Language="DocId" Value="P:System.Net.Configuration.RequestCachingSection.DisableAllCaching" />
<MemberSignature Language="VB.NET" Value="Public Property DisableAllCaching As Boolean" />
<MemberSignature Language="F#" Value="member this.DisableAllCaching : bool with get, set" Usage="System.Net.Configuration.RequestCachingSection.DisableAllCaching" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool DisableAllCaching { bool get(); void set(bool value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Configuration.ConfigurationProperty("disableAllCaching", DefaultValue=false)]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.ConfigurationProperty("disableAllCaching", DefaultValue=false)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a Boolean value that enables caching on the local computer.</summary>
<value>
<see langword="true" /> if caching is disabled on the local computer; otherwise, <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If this configuration attribute is set to `true` in any configuration file, caching is disabled globally, and all other cache related settings are ignored. In addition, caching cannot be enabled programmatically.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="IsPrivateCache">
<MemberSignature Language="C#" Value="public bool IsPrivateCache { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsPrivateCache" />
<MemberSignature Language="DocId" Value="P:System.Net.Configuration.RequestCachingSection.IsPrivateCache" />
<MemberSignature Language="VB.NET" Value="Public Property IsPrivateCache As Boolean" />
<MemberSignature Language="F#" Value="member this.IsPrivateCache : bool with get, set" Usage="System.Net.Configuration.RequestCachingSection.IsPrivateCache" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool IsPrivateCache { bool get(); void set(bool value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Configuration.ConfigurationProperty("isPrivateCache", DefaultValue=true)]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.ConfigurationProperty("isPrivateCache", DefaultValue=true)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a Boolean value that indicates whether the local computer cache is private.</summary>
<value>
<see langword="true" /> if the cache provides user isolation; otherwise, <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
On client machines, this value is typically set to `true` indicating that one user cannot use resources cached by another user. For middle-tier applications, this value is typically set to `false`.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="PostDeserialize">
<MemberSignature Language="C#" Value="protected override void PostDeserialize ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void PostDeserialize() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Net.Configuration.RequestCachingSection.PostDeserialize" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub PostDeserialize ()" />
<MemberSignature Language="F#" Value="override this.PostDeserialize : unit -> unit" Usage="requestCachingSection.PostDeserialize " />
<MemberSignature Language="C++ CLI" Value="protected:
 override void PostDeserialize();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<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.Net.Configuration.RequestCachingSection.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.Net.Configuration.RequestCachingSection.Properties" />
<MemberSignature Language="C++ CLI" Value="protected:
 virtual property System::Configuration::ConfigurationPropertyCollection ^ Properties { System::Configuration::ConfigurationPropertyCollection ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Configuration.ConfigurationPropertyCollection</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UnspecifiedMaximumAge">
<MemberSignature Language="C#" Value="public TimeSpan UnspecifiedMaximumAge { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan UnspecifiedMaximumAge" />
<MemberSignature Language="DocId" Value="P:System.Net.Configuration.RequestCachingSection.UnspecifiedMaximumAge" />
<MemberSignature Language="VB.NET" Value="Public Property UnspecifiedMaximumAge As TimeSpan" />
<MemberSignature Language="F#" Value="member this.UnspecifiedMaximumAge : TimeSpan with get, set" Usage="System.Net.Configuration.RequestCachingSection.UnspecifiedMaximumAge" />
<MemberSignature Language="C++ CLI" Value="public:
 property TimeSpan UnspecifiedMaximumAge { TimeSpan get(); void set(TimeSpan value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Configuration.ConfigurationProperty("unspecifiedMaximumAge", DefaultValue="1.00:00:00")]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.ConfigurationProperty("unspecifiedMaximumAge", DefaultValue="1.00:00:00")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value used as the maximum age for cached resources that do not have expiration information.</summary>
<value>A <see cref="T:System.TimeSpan" /> that provides a default maximum age for cached resources.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Setting this property ensures that a resource that does not have expiration header information does not remain fresh in the cache indefinitely.
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>