-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
CacheItemPriority.xml
195 lines (190 loc) · 11.1 KB
/
CacheItemPriority.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
<Type Name="CacheItemPriority" FullName="System.Web.Caching.CacheItemPriority">
<TypeSignature Language="C#" Value="public enum CacheItemPriority" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed CacheItemPriority extends System.Enum" />
<TypeSignature Language="DocId" Value="T:System.Web.Caching.CacheItemPriority" />
<TypeSignature Language="VB.NET" Value="Public Enum CacheItemPriority" />
<TypeSignature Language="F#" Value="type CacheItemPriority = " />
<TypeSignature Language="C++ CLI" Value="public enum class CacheItemPriority" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>Specifies the relative priority of items stored in the <see cref="T:System.Web.Caching.Cache" /> object.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
When the Web server hosting an ASP.NET application runs low on memory, the <xref:System.Web.Caching.Cache> object selectively purges items to free system memory. When an item is added to the cache, you can assign it a relative priority compared to the other items stored in the cache. Items to which you assign higher priority values are less likely to be deleted from the cache when the server is processing a large number of requests, whereas items to which you assign lower priority values are more likely to be deleted. The default is `Normal`.
> [!NOTE]
> Items can always be removed from the cache programmatically, regardless of their cache priority.
## Examples
The following example uses the <xref:System.Web.Caching.Cache.Insert%2A?displayProperty=nameWithType> method to add an item to the <xref:System.Web.Caching.Cache> object with its `priority` parameter set to `High`:
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/CacheItemPriority Syntax/CS/CacheItemPrioritycs.aspx" id="Snippet1":::
:::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/CacheItemPriority Syntax/VB/CacheItemPriorityvb.aspx" id="Snippet1":::
]]></format>
</remarks>
<altmember cref="T:System.Web.Caching.Cache" />
<related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/6hbbsfk6(v=vs.100)">Caching Application Data</related>
</Docs>
<Members>
<Member MemberName="AboveNormal">
<MemberSignature Language="C#" Value="AboveNormal" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Web.Caching.CacheItemPriority AboveNormal = int32(4)" />
<MemberSignature Language="DocId" Value="F:System.Web.Caching.CacheItemPriority.AboveNormal" />
<MemberSignature Language="VB.NET" Value="AboveNormal" />
<MemberSignature Language="F#" Value="AboveNormal = 4" Usage="System.Web.Caching.CacheItemPriority.AboveNormal" />
<MemberSignature Language="C++ CLI" Value="AboveNormal" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Web.Caching.CacheItemPriority</ReturnType>
</ReturnValue>
<MemberValue>4</MemberValue>
<Docs>
<summary>Cache items with this priority level are less likely to be deleted as the server frees system memory than those assigned a <see cref="F:System.Web.Caching.CacheItemPriority.Normal" /> priority.</summary>
</Docs>
</Member>
<Member MemberName="BelowNormal">
<MemberSignature Language="C#" Value="BelowNormal" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Web.Caching.CacheItemPriority BelowNormal = int32(2)" />
<MemberSignature Language="DocId" Value="F:System.Web.Caching.CacheItemPriority.BelowNormal" />
<MemberSignature Language="VB.NET" Value="BelowNormal" />
<MemberSignature Language="F#" Value="BelowNormal = 2" Usage="System.Web.Caching.CacheItemPriority.BelowNormal" />
<MemberSignature Language="C++ CLI" Value="BelowNormal" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Web.Caching.CacheItemPriority</ReturnType>
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>Cache items with this priority level are more likely to be deleted from the cache as the server frees system memory than items assigned a <see cref="F:System.Web.Caching.CacheItemPriority.Normal" /> priority.</summary>
</Docs>
</Member>
<Member MemberName="Default">
<MemberSignature Language="C#" Value="Default" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Web.Caching.CacheItemPriority Default = int32(3)" />
<MemberSignature Language="DocId" Value="F:System.Web.Caching.CacheItemPriority.Default" />
<MemberSignature Language="VB.NET" Value="Default" />
<MemberSignature Language="F#" Value="Default = 3" Usage="System.Web.Caching.CacheItemPriority.Default" />
<MemberSignature Language="C++ CLI" Value="Default" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Web.Caching.CacheItemPriority</ReturnType>
</ReturnValue>
<MemberValue>3</MemberValue>
<Docs>
<summary>The default value for a cached item's priority is <see cref="F:System.Web.Caching.CacheItemPriority.Normal" />.</summary>
</Docs>
</Member>
<Member MemberName="High">
<MemberSignature Language="C#" Value="High" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Web.Caching.CacheItemPriority High = int32(5)" />
<MemberSignature Language="DocId" Value="F:System.Web.Caching.CacheItemPriority.High" />
<MemberSignature Language="VB.NET" Value="High" />
<MemberSignature Language="F#" Value="High = 5" Usage="System.Web.Caching.CacheItemPriority.High" />
<MemberSignature Language="C++ CLI" Value="High" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Web.Caching.CacheItemPriority</ReturnType>
</ReturnValue>
<MemberValue>5</MemberValue>
<Docs>
<summary>Cache items with this priority level are the least likely to be deleted from the cache as the server frees system memory.</summary>
</Docs>
</Member>
<Member MemberName="Low">
<MemberSignature Language="C#" Value="Low" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Web.Caching.CacheItemPriority Low = int32(1)" />
<MemberSignature Language="DocId" Value="F:System.Web.Caching.CacheItemPriority.Low" />
<MemberSignature Language="VB.NET" Value="Low" />
<MemberSignature Language="F#" Value="Low = 1" Usage="System.Web.Caching.CacheItemPriority.Low" />
<MemberSignature Language="C++ CLI" Value="Low" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Web.Caching.CacheItemPriority</ReturnType>
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>Cache items with this priority level are the most likely to be deleted from the cache as the server frees system memory.</summary>
</Docs>
</Member>
<Member MemberName="Normal">
<MemberSignature Language="C#" Value="Normal" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Web.Caching.CacheItemPriority Normal = int32(3)" />
<MemberSignature Language="DocId" Value="F:System.Web.Caching.CacheItemPriority.Normal" />
<MemberSignature Language="VB.NET" Value="Normal" />
<MemberSignature Language="F#" Value="Normal = 3" Usage="System.Web.Caching.CacheItemPriority.Normal" />
<MemberSignature Language="C++ CLI" Value="Normal" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Web.Caching.CacheItemPriority</ReturnType>
</ReturnValue>
<MemberValue>3</MemberValue>
<Docs>
<summary>Cache items with this priority level are likely to be deleted from the cache as the server frees system memory only after those items with <see cref="F:System.Web.Caching.CacheItemPriority.Low" /> or <see cref="F:System.Web.Caching.CacheItemPriority.BelowNormal" /> priority. This is the default.</summary>
</Docs>
</Member>
<Member MemberName="NotRemovable">
<MemberSignature Language="C#" Value="NotRemovable" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Web.Caching.CacheItemPriority NotRemovable = int32(6)" />
<MemberSignature Language="DocId" Value="F:System.Web.Caching.CacheItemPriority.NotRemovable" />
<MemberSignature Language="VB.NET" Value="NotRemovable" />
<MemberSignature Language="F#" Value="NotRemovable = 6" Usage="System.Web.Caching.CacheItemPriority.NotRemovable" />
<MemberSignature Language="C++ CLI" Value="NotRemovable" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Web.Caching.CacheItemPriority</ReturnType>
</ReturnValue>
<MemberValue>6</MemberValue>
<Docs>
<summary>The cache items with this priority level will not be automatically deleted from the cache as the server frees system memory. However, items with this priority level are removed along with other items according to the item's absolute or sliding expiration time.</summary>
</Docs>
</Member>
</Members>
</Type>