-
Notifications
You must be signed in to change notification settings - Fork 14
/
BinaryLogReplayEventSource.xml
192 lines (192 loc) · 12.7 KB
/
BinaryLogReplayEventSource.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
<Type Name="BinaryLogReplayEventSource" FullName="Microsoft.Build.Logging.BinaryLogReplayEventSource">
<TypeSignature Language="C#" Value="public sealed class BinaryLogReplayEventSource : Microsoft.Build.Logging.EventArgsDispatcher" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit BinaryLogReplayEventSource extends Microsoft.Build.Logging.EventArgsDispatcher" FrameworkAlternate="msbuild-15;msbuild-15-netcore" />
<TypeSignature Language="DocId" Value="T:Microsoft.Build.Logging.BinaryLogReplayEventSource" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class BinaryLogReplayEventSource
Inherits EventArgsDispatcher" />
<TypeSignature Language="F#" Value="type BinaryLogReplayEventSource = class
 inherit EventArgsDispatcher" />
<TypeSignature Language="C++ CLI" Value="public ref class BinaryLogReplayEventSource sealed : Microsoft::Build::Logging::EventArgsDispatcher" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed BinaryLogReplayEventSource extends Microsoft.Build.Logging.EventArgsDispatcher" FrameworkAlternate="msbuild-16;msbuild-16-netcore;msbuild-17;msbuild-17-netcore" />
<AssemblyInfo>
<AssemblyName>Microsoft.Build</AssemblyName>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Build.Logging.EventArgsDispatcher</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="msbuild-17-netcore">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(0)>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="msbuild-17-netcore">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(1)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Provides a method to read a binary log file (*.binlog) and replay all stored BuildEventArgs
by implementing IEventSource and raising corresponding events.
</summary>
<remarks>The class is public so that we can call it from MSBuild.exe when replaying a log file.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public BinaryLogReplayEventSource ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Logging.BinaryLogReplayEventSource.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 BinaryLogReplayEventSource();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build</AssemblyName>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="NotificationsSourceCreated">
<MemberSignature Language="C#" Value="public event Action<Microsoft.Build.Logging.IBuildEventArgsReaderNotifications>? NotificationsSourceCreated;" />
<MemberSignature Language="ILAsm" Value=".event class System.Action`1<class Microsoft.Build.Logging.IBuildEventArgsReaderNotifications> NotificationsSourceCreated" />
<MemberSignature Language="DocId" Value="E:Microsoft.Build.Logging.BinaryLogReplayEventSource.NotificationsSourceCreated" />
<MemberSignature Language="VB.NET" Value="Public Event NotificationsSourceCreated As Action(Of IBuildEventArgsReaderNotifications) " />
<MemberSignature Language="F#" Value="member this.NotificationsSourceCreated : Action<Microsoft.Build.Logging.IBuildEventArgsReaderNotifications> " Usage="member this.NotificationsSourceCreated : System.Action<Microsoft.Build.Logging.IBuildEventArgsReaderNotifications> " />
<MemberSignature Language="C++ CLI" Value="public:
 event Action<Microsoft::Build::Logging::IBuildEventArgsReaderNotifications ^> ^ NotificationsSourceCreated;" />
<MemberType>Event</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build</AssemblyName>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="msbuild-17-netcore">
<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.Action<Microsoft.Build.Logging.IBuildEventArgsReaderNotifications></ReturnType>
</ReturnValue>
<Docs>
<summary>
Raised once <see cref="T:Microsoft.Build.Logging.BuildEventArgsReader" /> is created during replaying
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OpenReader">
<MemberSignature Language="C#" Value="public static System.IO.BinaryReader OpenReader (string sourceFilePath);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.IO.BinaryReader OpenReader(string sourceFilePath) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Logging.BinaryLogReplayEventSource.OpenReader(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function OpenReader (sourceFilePath As String) As BinaryReader" />
<MemberSignature Language="F#" Value="static member OpenReader : string -> System.IO.BinaryReader" Usage="Microsoft.Build.Logging.BinaryLogReplayEventSource.OpenReader sourceFilePath" />
<MemberSignature Language="C++ CLI" Value="public:
 static System::IO::BinaryReader ^ OpenReader(System::String ^ sourceFilePath);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build</AssemblyName>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IO.BinaryReader</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sourceFilePath" Type="System.String" Index="0" FrameworkAlternate="msbuild-17;msbuild-17-netcore" />
</Parameters>
<Docs>
<param name="sourceFilePath" />
<summary>
Creates a <see cref="T:System.IO.BinaryReader" /> for the provided binary log file.
Performs decompression and buffering in the optimal way.
Caller is responsible for disposing the returned reader.
</summary>
<returns>BinaryReader of the given binlog file.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Replay">
<MemberSignature Language="C#" Value="public void Replay (string sourceFilePath);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Replay(string sourceFilePath) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Logging.BinaryLogReplayEventSource.Replay(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub Replay (sourceFilePath As String)" />
<MemberSignature Language="F#" Value="member this.Replay : string -> unit" Usage="binaryLogReplayEventSource.Replay sourceFilePath" />
<MemberSignature Language="C++ CLI" Value="public:
 void Replay(System::String ^ sourceFilePath);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build</AssemblyName>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sourceFilePath" Type="System.String" />
</Parameters>
<Docs>
<param name="sourceFilePath">The full file path of the binary log file</param>
<summary>
Read the provided binary log file and raise corresponding events for each BuildEventArgs
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Replay">
<MemberSignature Language="C#" Value="public void Replay (System.IO.BinaryReader binaryReader, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Replay(class System.IO.BinaryReader binaryReader, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Logging.BinaryLogReplayEventSource.Replay(System.IO.BinaryReader,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Sub Replay (binaryReader As BinaryReader, cancellationToken As CancellationToken)" />
<MemberSignature Language="F#" Value="member this.Replay : System.IO.BinaryReader * System.Threading.CancellationToken -> unit" Usage="binaryLogReplayEventSource.Replay (binaryReader, cancellationToken)" />
<MemberSignature Language="C++ CLI" Value="public:
 void Replay(System::IO::BinaryReader ^ binaryReader, System::Threading::CancellationToken cancellationToken);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build</AssemblyName>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="binaryReader" Type="System.IO.BinaryReader" Index="0" FrameworkAlternate="msbuild-17;msbuild-17-netcore" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="msbuild-17;msbuild-17-netcore" />
</Parameters>
<Docs>
<param name="binaryReader">The binary log content binary reader - caller is responsible for disposing.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> indicating the replay should stop as soon as possible.</param>
<summary>
Read the provided binary log file and raise corresponding events for each BuildEventArgs
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Replay">
<MemberSignature Language="C#" Value="public void Replay (string sourceFilePath, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Replay(string sourceFilePath, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Build.Logging.BinaryLogReplayEventSource.Replay(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Sub Replay (sourceFilePath As String, cancellationToken As CancellationToken)" />
<MemberSignature Language="F#" Value="member this.Replay : string * System.Threading.CancellationToken -> unit" Usage="binaryLogReplayEventSource.Replay (sourceFilePath, cancellationToken)" />
<MemberSignature Language="C++ CLI" Value="public:
 void Replay(System::String ^ sourceFilePath, System::Threading::CancellationToken cancellationToken);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Build</AssemblyName>
<AssemblyVersion>15.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sourceFilePath" Type="System.String" Index="0" FrameworkAlternate="msbuild-16;msbuild-16-netcore;msbuild-17;msbuild-17-netcore" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="msbuild-16;msbuild-16-netcore;msbuild-17;msbuild-17-netcore" />
</Parameters>
<Docs>
<param name="sourceFilePath">The full file path of the binary log file</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> indicating the replay should stop as soon as possible.</param>
<summary>
Read the provided binary log file and raise corresponding events for each BuildEventArgs
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>