Aucune description
Vous ne pouvez pas sélectionner plus de 25 sujets Les noms de sujets doivent commencer par une lettre ou un nombre, peuvent contenir des tirets ('-') et peuvent comporter jusqu'à 35 caractères.

Bee.BinLog.xml 9.6KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Bee.BinLog</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Bee.BinLog.BuildResult">
  8. <summary>
  9. An enum describing the result of a bee backend execution.
  10. </summary>
  11. </member>
  12. <member name="F:Bee.BinLog.BuildResult.Success">
  13. <summary>
  14. All nodes built successfully
  15. </summary>
  16. </member>
  17. <member name="F:Bee.BinLog.BuildResult.Interrupted">
  18. <summary>
  19. User interrupted the build (e.g CTRL+C)
  20. </summary>
  21. </member>
  22. <member name="F:Bee.BinLog.BuildResult.Croak">
  23. <summary>
  24. An internal really bad error happened
  25. </summary>
  26. </member>
  27. <member name="F:Bee.BinLog.BuildResult.BuildError">
  28. <summary>
  29. An action in the build graph failed
  30. </summary>
  31. </member>
  32. <member name="F:Bee.BinLog.BuildResult.RequireFrontendRerun">
  33. <summary>
  34. Frontend needs to run again
  35. </summary>
  36. </member>
  37. <member name="F:Bee.BinLog.BuildFinishedMessageRaw.reason">
  38. <summary>
  39. If the result of the build is RequestFrontendRerun, this will contain the reason why that was requested
  40. </summary>
  41. </member>
  42. <member name="T:Bee.BinLog.BinLogReader">
  43. <summary>
  44. To parse a binlog, instantiate a BinLogReader, subscribe to the events you care about, and then invoke .ReadFromStream() repeatedly until you no longer
  45. expect interesting messages. (once you receive OnBuildFinished, you know nothing interesting will follow anymore)
  46. </summary>
  47. </member>
  48. <member name="F:Bee.BinLog.BinLogReader._nodeInfoMessagesRaw">
  49. <summary>
  50. every nodeinfo message that arrives, we store it in a separate array, so we can very quickly acces it. These messages are small, as they do not contain the actual
  51. information like outputfile, outputdirectory etc, but instead it contains offsets where these strings can be found in the binlog.
  52. </summary>
  53. </member>
  54. <member name="T:Bee.BinLog.BinLogStorage">
  55. <summary>
  56. This class stores a binlog file in memory as it becomes available. We store it in chunks of 128k, allocating new chunks
  57. as required.
  58. </summary>
  59. </member>
  60. <member name="T:Bee.BinLog.BinLogStorage.Span">
  61. <summary>
  62. A poor man's span, because we do not yet have the .netcore Span since we need to target .net47 for now.
  63. </summary>
  64. </member>
  65. <member name="M:Bee.BinLog.BinLogStorage.GetSpan(System.Int32,System.Int32)">
  66. <summary>
  67. Get a linear-accesable span at a certain offset and length into the binlog. The fast path for this will return an existing chunk with an offset + length.
  68. </summary>
  69. </member>
  70. <member name="M:Bee.BinLog.BinLogStorage.GetSpanForChunkOverlappingRequest(System.Int32,System.Int32)">
  71. <summary>
  72. There will be some strings or messages whose contents straddle two chunks. Since chunks should be relatively big (megabyte-ish), it's okay if the one message we try
  73. to read across the boundary is slow.
  74. </summary>
  75. </member>
  76. <member name="T:Bee.BinLog.BuildStartedMessage">
  77. <summary>
  78. A message for when a backend build starts
  79. </summary>
  80. </member>
  81. <member name="P:Bee.BinLog.BuildStartedMessage.HighestThreadId">
  82. <summary>
  83. </summary>
  84. </member>
  85. <member name="P:Bee.BinLog.BuildStartedMessage.MaxNodesCount">
  86. <summary>
  87. </summary>
  88. </member>
  89. <member name="T:Bee.BinLog.NodeInfo">
  90. <summary>
  91. Contains information about a node in the buildgraph
  92. </summary>
  93. </member>
  94. <member name="P:Bee.BinLog.NodeInfo.NodeIndex">
  95. <summary>
  96. The node index of this node. This correspons to the index in the dag.json.
  97. </summary>
  98. </member>
  99. <member name="P:Bee.BinLog.NodeInfo.Annotation">
  100. <summary>
  101. The annotation of this node.
  102. </summary>
  103. </member>
  104. <member name="P:Bee.BinLog.NodeInfo.DisplayName">
  105. <summary>
  106. The display name of this node for showing in UI.
  107. </summary>
  108. </member>
  109. <member name="P:Bee.BinLog.NodeInfo.OutputFile">
  110. <summary>
  111. The first output file (if any) of this node.
  112. </summary>
  113. </member>
  114. <member name="P:Bee.BinLog.NodeInfo.OutputDirectory">
  115. <summary>
  116. The first output directory (if any) of this node.
  117. </summary>
  118. </member>
  119. <member name="P:Bee.BinLog.NodeInfo.ProfilerOutput">
  120. <summary>
  121. The profiler output file (if any) of this node.
  122. </summary>
  123. </member>
  124. <member name="P:Bee.BinLog.NodeInfo.RspFile">
  125. <summary>
  126. The first rsp file used by this node if any
  127. </summary>
  128. </member>
  129. <member name="T:Bee.BinLog.NodeEnqueuedMessage">
  130. <summary>
  131. A message for when a node gets queued. Getting queued means that the bee backend has decided that this node has to somehow be produced.
  132. </summary>
  133. </member>
  134. <member name="P:Bee.BinLog.NodeEnqueuedMessage.EnqueuedNode">
  135. <summary>
  136. The node being queued.
  137. </summary>
  138. </member>
  139. <member name="P:Bee.BinLog.NodeEnqueuedMessage.EnqueueingNode">
  140. <summary>
  141. The node that required this node to be enqueued.
  142. </summary>
  143. </member>
  144. <member name="T:Bee.BinLog.NodeStartedMessage">
  145. <summary>
  146. A message for when a node starts actually being executed.
  147. </summary>
  148. </member>
  149. <member name="P:Bee.BinLog.NodeStartedMessage.Node">
  150. <summary>
  151. The node being started.
  152. </summary>
  153. </member>
  154. <member name="P:Bee.BinLog.NodeStartedMessage.ThreadIndex">
  155. <summary>
  156. The index of the build thread that started executing this node.
  157. </summary>
  158. </member>
  159. <member name="P:Bee.BinLog.NodeStartedMessage.StartIndex">
  160. <summary>
  161. You can use this number to figure out which node was started before/after which other node. The only guarantee is that the number is increasing.
  162. </summary>
  163. </member>
  164. <member name="T:Bee.BinLog.NodeUpToDateMessage">
  165. <summary>
  166. A message for when the bee backend has determined that a node does not need to be executed because the version from the previous build is still good.
  167. </summary>
  168. </member>
  169. <member name="P:Bee.BinLog.NodeUpToDateMessage.Node">
  170. <summary>
  171. The node that is up to date
  172. </summary>
  173. </member>
  174. <member name="T:Bee.BinLog.NodeFinishedMessage">
  175. <summary>
  176. A message for when a node that was previously started is now finished
  177. </summary>
  178. </member>
  179. <member name="P:Bee.BinLog.NodeFinishedMessage.Node">
  180. <summary>
  181. The node that finished.
  182. </summary>
  183. </member>
  184. <member name="P:Bee.BinLog.NodeFinishedMessage.ThreadIndex">
  185. <summary>
  186. The index of the build thread that started executing this node.
  187. </summary>
  188. </member>
  189. <member name="P:Bee.BinLog.NodeFinishedMessage.Output">
  190. <summary>
  191. The combined stdout + stderr of the execution.
  192. </summary>
  193. </member>
  194. <member name="P:Bee.BinLog.NodeFinishedMessage.CmdLine">
  195. <summary>
  196. The commandline used to execute this node.
  197. </summary>
  198. </member>
  199. <member name="P:Bee.BinLog.NodeFinishedMessage.ExitCode">
  200. <summary>
  201. The exit code of the execution.
  202. </summary>
  203. </member>
  204. <member name="P:Bee.BinLog.NodeFinishedMessage.Duration">
  205. <summary>
  206. The duration of the execution.
  207. </summary>
  208. </member>
  209. <member name="T:Bee.BinLog.BuildFinishedMessage">
  210. <summary>
  211. A message for when a backend build is finished
  212. </summary>
  213. </member>
  214. <member name="P:Bee.BinLog.BuildFinishedMessage.Result">
  215. <summary>
  216. The result of the build
  217. </summary>
  218. </member>
  219. <member name="P:Bee.BinLog.BuildFinishedMessage.Reason">
  220. <summary>
  221. If the buildResult is BuildResult.RequestFrontendRerun, this will contain the reason why that was requested
  222. </summary>
  223. </member>
  224. <member name="T:Bee.BinLog.RPCActionMessage">
  225. <summary>
  226. A message for when a backend wants us to execute an RPC message
  227. </summary>
  228. </member>
  229. <member name="P:Bee.BinLog.RPCActionMessage.NodeIndex">
  230. <summary>
  231. The node dag index
  232. </summary>
  233. </member>
  234. <member name="P:Bee.BinLog.RPCActionMessage.Action">
  235. <summary>
  236. The action name
  237. </summary>
  238. </member>
  239. <member name="P:Bee.BinLog.RPCActionMessage.Data">
  240. <summary>
  241. The action data
  242. </summary>
  243. </member>
  244. </members>
  245. </doc>