-
Notifications
You must be signed in to change notification settings - Fork 112
/
IHttpSysRequestTimingFeature.xml
110 lines (110 loc) · 8.07 KB
/
IHttpSysRequestTimingFeature.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
<Type Name="IHttpSysRequestTimingFeature" FullName="Microsoft.AspNetCore.Server.HttpSys.IHttpSysRequestTimingFeature">
<TypeSignature Language="C#" Value="public interface IHttpSysRequestTimingFeature" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit IHttpSysRequestTimingFeature" />
<TypeSignature Language="DocId" Value="T:Microsoft.AspNetCore.Server.HttpSys.IHttpSysRequestTimingFeature" />
<TypeSignature Language="VB.NET" Value="Public Interface IHttpSysRequestTimingFeature" />
<TypeSignature Language="F#" Value="type IHttpSysRequestTimingFeature = interface" />
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Server.HttpSys</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<summary>
This exposes the Http.Sys HTTP_REQUEST_TIMING_INFO extensibility point which contains request processing timestamp data from Http.Sys.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="Timestamps">
<MemberSignature Language="C#" Value="public ReadOnlySpan<long> Timestamps { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.ReadOnlySpan`1<int64> Timestamps" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Server.HttpSys.IHttpSysRequestTimingFeature.Timestamps" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Timestamps As ReadOnlySpan(Of Long)" />
<MemberSignature Language="F#" Value="member this.Timestamps : ReadOnlySpan<int64>" Usage="Microsoft.AspNetCore.Server.HttpSys.IHttpSysRequestTimingFeature.Timestamps" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Server.HttpSys</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ReadOnlySpan<System.Int64></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets all Http.Sys timing timestamps
</summary>
<value>To be added.</value>
<remarks>
These timestamps were obtained using QueryPerformanceCounter <see href="https://learn.microsoft.com/windows/win32/api/profileapi/nf-profileapi-queryperformancecounter" /> and the timestamp frequency can be obtained via QueryPerformanceFrequency <see href="https://learn.microsoft.com/windows/win32/api/profileapi/nf-profileapi-queryperformancefrequency" />.
The index of the timing can be cast to <see cref="T:Microsoft.AspNetCore.Server.HttpSys.HttpSysRequestTimingType" /> to know what the timing represents.
The value may be 0 if the timing is not available for the current request.
</remarks>
</Docs>
</Member>
<Member MemberName="TryGetElapsedTime">
<MemberSignature Language="C#" Value="public bool TryGetElapsedTime (Microsoft.AspNetCore.Server.HttpSys.HttpSysRequestTimingType startingTimestampType, Microsoft.AspNetCore.Server.HttpSys.HttpSysRequestTimingType endingTimestampType, out TimeSpan elapsed);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool TryGetElapsedTime(valuetype Microsoft.AspNetCore.Server.HttpSys.HttpSysRequestTimingType startingTimestampType, valuetype Microsoft.AspNetCore.Server.HttpSys.HttpSysRequestTimingType endingTimestampType, [out] valuetype System.TimeSpan& elapsed) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Server.HttpSys.IHttpSysRequestTimingFeature.TryGetElapsedTime(Microsoft.AspNetCore.Server.HttpSys.HttpSysRequestTimingType,Microsoft.AspNetCore.Server.HttpSys.HttpSysRequestTimingType,System.TimeSpan@)" />
<MemberSignature Language="VB.NET" Value="Public Function TryGetElapsedTime (startingTimestampType As HttpSysRequestTimingType, endingTimestampType As HttpSysRequestTimingType, ByRef elapsed As TimeSpan) As Boolean" />
<MemberSignature Language="F#" Value="abstract member TryGetElapsedTime : Microsoft.AspNetCore.Server.HttpSys.HttpSysRequestTimingType * Microsoft.AspNetCore.Server.HttpSys.HttpSysRequestTimingType * TimeSpan -> bool" Usage="iHttpSysRequestTimingFeature.TryGetElapsedTime (startingTimestampType, endingTimestampType, elapsed)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Server.HttpSys</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="startingTimestampType" Type="Microsoft.AspNetCore.Server.HttpSys.HttpSysRequestTimingType" />
<Parameter Name="endingTimestampType" Type="Microsoft.AspNetCore.Server.HttpSys.HttpSysRequestTimingType" />
<Parameter Name="elapsed" Type="System.TimeSpan" RefType="out" />
</Parameters>
<Docs>
<param name="startingTimestampType">The timestamp type marking the beginning of the time period.</param>
<param name="endingTimestampType">The timestamp type marking the end of the time period.</param>
<param name="elapsed">A <see cref="T:System.TimeSpan" /> for the elapsed time between the starting and ending timestamps.</param>
<summary>
Gets the elapsed time between the two given timings.
</summary>
<returns>True if both given timings were set (i.e., non-zero).</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TryGetTimestamp">
<MemberSignature Language="C#" Value="public bool TryGetTimestamp (Microsoft.AspNetCore.Server.HttpSys.HttpSysRequestTimingType timestampType, out long timestamp);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool TryGetTimestamp(valuetype Microsoft.AspNetCore.Server.HttpSys.HttpSysRequestTimingType timestampType, [out] int64& timestamp) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Server.HttpSys.IHttpSysRequestTimingFeature.TryGetTimestamp(Microsoft.AspNetCore.Server.HttpSys.HttpSysRequestTimingType,System.Int64@)" />
<MemberSignature Language="VB.NET" Value="Public Function TryGetTimestamp (timestampType As HttpSysRequestTimingType, ByRef timestamp As Long) As Boolean" />
<MemberSignature Language="F#" Value="abstract member TryGetTimestamp : Microsoft.AspNetCore.Server.HttpSys.HttpSysRequestTimingType * int64 -> bool" Usage="iHttpSysRequestTimingFeature.TryGetTimestamp (timestampType, timestamp)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Server.HttpSys</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="timestampType" Type="Microsoft.AspNetCore.Server.HttpSys.HttpSysRequestTimingType" />
<Parameter Name="timestamp" Type="System.Int64" RefType="out" />
</Parameters>
<Docs>
<param name="timestampType">The timestamp type to get.</param>
<param name="timestamp">The value of the timestamp if set.</param>
<summary>
Gets the timestamp for the given timing.
</summary>
<returns>True if the given timing was set (i.e., non-zero).</returns>
<remarks>
These timestamps were obtained using QueryPerformanceCounter <see href="https://learn.microsoft.com/windows/win32/api/profileapi/nf-profileapi-queryperformancecounter" /> and the timestamp frequency can be obtained via QueryPerformanceFrequency <see href="https://learn.microsoft.com/windows/win32/api/profileapi/nf-profileapi-queryperformancefrequency" />.
</remarks>
</Docs>
</Member>
</Members>
</Type>