/
TcpEndpointProbesOptions.xml
159 lines (159 loc) · 9.04 KB
/
TcpEndpointProbesOptions.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
<Type Name="TcpEndpointProbesOptions" FullName="Microsoft.Extensions.Diagnostics.Probes.TcpEndpointProbesOptions">
<TypeSignature Language="C#" Value="public class TcpEndpointProbesOptions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit TcpEndpointProbesOptions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Diagnostics.Probes.TcpEndpointProbesOptions" />
<TypeSignature Language="VB.NET" Value="Public Class TcpEndpointProbesOptions" />
<TypeSignature Language="F#" Value="type TcpEndpointProbesOptions = class" />
<TypeSignature Language="C++ CLI" Value="public ref class TcpEndpointProbesOptions" />
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Diagnostics.Probes</AssemblyName>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Options to control TCP-based health check probes.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TcpEndpointProbesOptions ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Diagnostics.Probes.TcpEndpointProbesOptions.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 TcpEndpointProbesOptions();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Diagnostics.Probes</AssemblyName>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="FilterChecks">
<MemberSignature Language="C#" Value="public Func<Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration,bool>? FilterChecks { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Func`2<class Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration, bool> FilterChecks" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Diagnostics.Probes.TcpEndpointProbesOptions.FilterChecks" />
<MemberSignature Language="VB.NET" Value="Public Property FilterChecks As Func(Of HealthCheckRegistration, Boolean)" />
<MemberSignature Language="F#" Value="member this.FilterChecks : Func<Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration, bool> with get, set" Usage="Microsoft.Extensions.Diagnostics.Probes.TcpEndpointProbesOptions.FilterChecks" />
<MemberSignature Language="C++ CLI" Value="public:
 property Func<Microsoft::Extensions::Diagnostics::HealthChecks::HealthCheckRegistration ^, bool> ^ FilterChecks { Func<Microsoft::Extensions::Diagnostics::HealthChecks::HealthCheckRegistration ^, bool> ^ get(); void set(Func<Microsoft::Extensions::Diagnostics::HealthChecks::HealthCheckRegistration ^, bool> ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Diagnostics.Probes</AssemblyName>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1 })]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1 })>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Func<Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration,System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a predicate that is used to include health checks based on user-defined criteria.
</summary>
<value>
The default value is <see langword="null" />, which has the effect of enabling all health checks.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="HealthAssessmentPeriod">
<MemberSignature Language="C#" Value="public TimeSpan HealthAssessmentPeriod { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.TimeSpan HealthAssessmentPeriod" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Diagnostics.Probes.TcpEndpointProbesOptions.HealthAssessmentPeriod" />
<MemberSignature Language="VB.NET" Value="Public Property HealthAssessmentPeriod As TimeSpan" />
<MemberSignature Language="F#" Value="member this.HealthAssessmentPeriod : TimeSpan with get, set" Usage="Microsoft.Extensions.Diagnostics.Probes.TcpEndpointProbesOptions.HealthAssessmentPeriod" />
<MemberSignature Language="C++ CLI" Value="public:
 property TimeSpan HealthAssessmentPeriod { TimeSpan get(); void set(TimeSpan value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Diagnostics.Probes</AssemblyName>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.TimeSpan</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the interval at which the health of the application is assessed.
</summary>
<value>
The default value is 30 seconds.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaxPendingConnections">
<MemberSignature Language="C#" Value="public int MaxPendingConnections { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 MaxPendingConnections" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Diagnostics.Probes.TcpEndpointProbesOptions.MaxPendingConnections" />
<MemberSignature Language="VB.NET" Value="Public Property MaxPendingConnections As Integer" />
<MemberSignature Language="F#" Value="member this.MaxPendingConnections : int with get, set" Usage="Microsoft.Extensions.Diagnostics.Probes.TcpEndpointProbesOptions.MaxPendingConnections" />
<MemberSignature Language="C++ CLI" Value="public:
 property int MaxPendingConnections { int get(); void set(int value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Diagnostics.Probes</AssemblyName>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DataAnnotations.Range(1, 10000)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DataAnnotations.Range(1, 10000)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the maximum length of the pending connections queue.
</summary>
<value>
The default value is 10.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TcpPort">
<MemberSignature Language="C#" Value="public int TcpPort { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 TcpPort" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Diagnostics.Probes.TcpEndpointProbesOptions.TcpPort" />
<MemberSignature Language="VB.NET" Value="Public Property TcpPort As Integer" />
<MemberSignature Language="F#" Value="member this.TcpPort : int with get, set" Usage="Microsoft.Extensions.Diagnostics.Probes.TcpEndpointProbesOptions.TcpPort" />
<MemberSignature Language="C++ CLI" Value="public:
 property int TcpPort { int get(); void set(int value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Diagnostics.Probes</AssemblyName>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DataAnnotations.Range(1, 65535)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DataAnnotations.Range(1, 65535)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the TCP port that gets opened if the service is healthy and closed otherwise.
</summary>
<value>
The default value is 2305.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>