-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
Copy pathGCKind.xml
139 lines (133 loc) · 6.24 KB
/
GCKind.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
<Type Name="GCKind" FullName="System.GCKind">
<TypeSignature Language="C#" Value="public enum GCKind" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed GCKind extends System.Enum" />
<TypeSignature Language="DocId" Value="T:System.GCKind" />
<TypeSignature Language="VB.NET" Value="Public Enum GCKind" />
<TypeSignature Language="F#" Value="type GCKind = " />
<TypeSignature Language="C++ CLI" Value="public enum class GCKind" />
<AssemblyInfo>
<AssemblyName>System.Runtime</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>Specifies the kind of a garbage collection.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
A GC can be one of the 3 kinds - ephemeral, full blocking, or background.
Their frequencies are very different. Ephemeral GCs happen much more often than the other two kinds. Background GCs usually happen infrequently, and full blocking GCs usually happen very infrequently. In order to sample the very infrequent GCs, collections are separated into kinds so callers can ask for all three kinds while maintaining a reasonable sampling rate. For example, if you're sampling once every second, without this distinction, you may never observe a background GC. With this distinction, you can always get info of the last GC of the kind you specify.
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName="Any">
<MemberSignature Language="C#" Value="Any" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.GCKind Any = int32(0)" />
<MemberSignature Language="DocId" Value="F:System.GCKind.Any" />
<MemberSignature Language="VB.NET" Value="Any" />
<MemberSignature Language="F#" Value="Any = 0" Usage="System.GCKind.Any" />
<MemberSignature Language="C++ CLI" Value="Any" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.GCKind</ReturnType>
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>Any kind of collection.</summary>
</Docs>
</Member>
<Member MemberName="Background">
<MemberSignature Language="C#" Value="Background" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.GCKind Background = int32(3)" />
<MemberSignature Language="DocId" Value="F:System.GCKind.Background" />
<MemberSignature Language="VB.NET" Value="Background" />
<MemberSignature Language="F#" Value="Background = 3" Usage="System.GCKind.Background" />
<MemberSignature Language="C++ CLI" Value="Background" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.GCKind</ReturnType>
</ReturnValue>
<MemberValue>3</MemberValue>
<Docs>
<summary>A background collection. This is always a generation 2 collection.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This is always a gen2 collection.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Ephemeral">
<MemberSignature Language="C#" Value="Ephemeral" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.GCKind Ephemeral = int32(1)" />
<MemberSignature Language="DocId" Value="F:System.GCKind.Ephemeral" />
<MemberSignature Language="VB.NET" Value="Ephemeral" />
<MemberSignature Language="F#" Value="Ephemeral = 1" Usage="System.GCKind.Ephemeral" />
<MemberSignature Language="C++ CLI" Value="Ephemeral" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.GCKind</ReturnType>
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>A gen0 or gen1 collection.</summary>
</Docs>
</Member>
<Member MemberName="FullBlocking">
<MemberSignature Language="C#" Value="FullBlocking" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.GCKind FullBlocking = int32(2)" />
<MemberSignature Language="DocId" Value="F:System.GCKind.FullBlocking" />
<MemberSignature Language="VB.NET" Value="FullBlocking" />
<MemberSignature Language="F#" Value="FullBlocking = 2" Usage="System.GCKind.FullBlocking" />
<MemberSignature Language="C++ CLI" Value="FullBlocking" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime</AssemblyName>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.GCKind</ReturnType>
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>A blocking gen2 collection.</summary>
</Docs>
</Member>
</Members>
</Type>