You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

232 lines
12 KiB

  1. <!DOCTYPE html>
  2. <!--[if IE]><![endif]-->
  3. <html>
  4. <head>
  5. <meta charset="utf-8">
  6. <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  7. <title>Class CriticalSection
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class CriticalSection
  11. ">
  12. <meta name="generator" content="docfx 2.48.0.0">
  13. <link rel="shortcut icon" href="../favicon.ico">
  14. <link rel="stylesheet" href="../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../styles/docfx.css">
  16. <link rel="stylesheet" href="../styles/main.css">
  17. <link rel="stylesheet" href="../styles/fix.css">
  18. <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
  19. <meta property="docfx:navrel" content="../toc.html">
  20. <meta property="docfx:tocrel" content="toc.html">
  21. <meta property="docfx:rel" content="../">
  22. <meta property="docfx:newtab" content="true">
  23. </head> <body data-spy="scroll" data-target="#affix" data-offset="120">
  24. <div id="wrapper">
  25. <header>
  26. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  27. <div class="container">
  28. <div class="navbar-header">
  29. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  30. <span class="sr-only">Toggle navigation</span>
  31. <span class="icon-bar"></span>
  32. <span class="icon-bar"></span>
  33. <span class="icon-bar"></span>
  34. </button>
  35. <a class="navbar-brand" href="../index.html">
  36. <img id="logo" class="svg" src="../logo.svg" alt="">
  37. </a>
  38. </div>
  39. <div class="collapse navbar-collapse" id="navbar">
  40. <form class="navbar-form navbar-right" role="search" id="search">
  41. <div class="form-group">
  42. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  43. </div>
  44. </form>
  45. </div>
  46. </div>
  47. </nav>
  48. <div class="subnav navbar navbar-default">
  49. <div class="container hide-when-search" id="breadcrumb">
  50. <ul class="breadcrumb">
  51. <li></li>
  52. </ul>
  53. </div>
  54. </div>
  55. </header>
  56. <div class="container body-content">
  57. <div id="search-results">
  58. <div class="search-list"></div>
  59. <div class="sr-items">
  60. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  61. </div>
  62. <ul id="pagination"></ul>
  63. </div>
  64. </div>
  65. <div role="main" class="container body-content hide-when-search">
  66. <div class="sidenav hide-when-search">
  67. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  68. <div class="sidetoggle collapse" id="sidetoggle">
  69. <div id="sidetoc"></div>
  70. </div>
  71. </div>
  72. <div class="article row grid-right">
  73. <div class="col-md-10">
  74. <article class="content wrap" id="_content" data-uid="IPA.Utilities.CriticalSection">
  75. <h1 id="IPA_Utilities_CriticalSection" data-uid="IPA.Utilities.CriticalSection" class="text-break">Class CriticalSection
  76. </h1>
  77. <div class="markdown level0 summary"><p>Provides utilities for managing various critical sections.</p>
  78. </div>
  79. <div class="markdown level0 conceptual"></div>
  80. <div class="inheritance">
  81. <h5>Inheritance</h5>
  82. <div class="level0"><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></div>
  83. <div class="level1"><span class="xref">CriticalSection</span></div>
  84. </div>
  85. <div class="inheritedMembers">
  86. <h5>Inherited Members</h5>
  87. <div>
  88. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.tostring#System_Object_ToString">Object.ToString()</a>
  89. </div>
  90. <div>
  91. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#System_Object_Equals_System_Object_">Object.Equals(Object)</a>
  92. </div>
  93. <div>
  94. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#System_Object_Equals_System_Object_System_Object_">Object.Equals(Object, Object)</a>
  95. </div>
  96. <div>
  97. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.referenceequals#System_Object_ReferenceEquals_System_Object_System_Object_">Object.ReferenceEquals(Object, Object)</a>
  98. </div>
  99. <div>
  100. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gethashcode#System_Object_GetHashCode">Object.GetHashCode()</a>
  101. </div>
  102. <div>
  103. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gettype#System_Object_GetType">Object.GetType()</a>
  104. </div>
  105. <div>
  106. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.memberwiseclone#System_Object_MemberwiseClone">Object.MemberwiseClone()</a>
  107. </div>
  108. </div>
  109. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Utilities.html">IPA.Utilities</a></h6>
  110. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  111. <h5 id="IPA_Utilities_CriticalSection_syntax">Syntax</h5>
  112. <div class="codewrapper">
  113. <pre><code class="lang-csharp hljs">public static class CriticalSection</code></pre>
  114. </div>
  115. <h3 id="methods">Methods
  116. </h3>
  117. <span class="small pull-right mobile-hide">
  118. <span class="divider">|</span>
  119. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Utilities_CriticalSection_EnterExecuteSection.md&amp;value=---%0Auid%3A%20IPA.Utilities.CriticalSection.EnterExecuteSection%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  120. </span>
  121. <span class="small pull-right mobile-hide">
  122. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/9d00450e08f00c71f424eab56f5723e87dc08901/IPA.Loader/Utilities/CriticalSection.cs/#L143">View Source</a>
  123. </span>
  124. <a id="IPA_Utilities_CriticalSection_EnterExecuteSection_" data-uid="IPA.Utilities.CriticalSection.EnterExecuteSection*"></a>
  125. <h4 id="IPA_Utilities_CriticalSection_EnterExecuteSection" data-uid="IPA.Utilities.CriticalSection.EnterExecuteSection">EnterExecuteSection()</h4>
  126. <div class="markdown level1 summary"><p>Enters a critical execution section. Does not nest.</p>
  127. </div>
  128. <div class="markdown level1 conceptual"></div>
  129. <h5 class="decalaration">Declaration</h5>
  130. <div class="codewrapper">
  131. <pre><code class="lang-csharp hljs">public static void EnterExecuteSection()</code></pre>
  132. </div>
  133. <span class="small pull-right mobile-hide">
  134. <span class="divider">|</span>
  135. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Utilities_CriticalSection_ExecuteSection.md&amp;value=---%0Auid%3A%20IPA.Utilities.CriticalSection.ExecuteSection%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  136. </span>
  137. <span class="small pull-right mobile-hide">
  138. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/9d00450e08f00c71f424eab56f5723e87dc08901/IPA.Loader/Utilities/CriticalSection.cs/#L133">View Source</a>
  139. </span>
  140. <a id="IPA_Utilities_CriticalSection_ExecuteSection_" data-uid="IPA.Utilities.CriticalSection.ExecuteSection*"></a>
  141. <h4 id="IPA_Utilities_CriticalSection_ExecuteSection" data-uid="IPA.Utilities.CriticalSection.ExecuteSection">ExecuteSection()</h4>
  142. <div class="markdown level1 summary"><p>Creates an <a class="xref" href="IPA.Utilities.CriticalSection.AutoExecuteSection.html">CriticalSection.AutoExecuteSection</a> for automated management of an execute section.</p>
  143. </div>
  144. <div class="markdown level1 conceptual"></div>
  145. <h5 class="decalaration">Declaration</h5>
  146. <div class="codewrapper">
  147. <pre><code class="lang-csharp hljs">public static CriticalSection.AutoExecuteSection ExecuteSection()</code></pre>
  148. </div>
  149. <h5 class="returns">Returns</h5>
  150. <table class="table table-bordered table-striped table-condensed">
  151. <thead>
  152. <tr>
  153. <th>Type</th>
  154. <th>Description</th>
  155. </tr>
  156. </thead>
  157. <tbody>
  158. <tr>
  159. <td><a class="xref" href="IPA.Utilities.CriticalSection.AutoExecuteSection.html">CriticalSection.AutoExecuteSection</a></td>
  160. <td><p>the new <a class="xref" href="IPA.Utilities.CriticalSection.AutoExecuteSection.html">CriticalSection.AutoExecuteSection</a> that manages the section</p>
  161. </td>
  162. </tr>
  163. </tbody>
  164. </table>
  165. <span class="small pull-right mobile-hide">
  166. <span class="divider">|</span>
  167. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Utilities_CriticalSection_ExitExecuteSection.md&amp;value=---%0Auid%3A%20IPA.Utilities.CriticalSection.ExitExecuteSection%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  168. </span>
  169. <span class="small pull-right mobile-hide">
  170. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/9d00450e08f00c71f424eab56f5723e87dc08901/IPA.Loader/Utilities/CriticalSection.cs/#L160">View Source</a>
  171. </span>
  172. <a id="IPA_Utilities_CriticalSection_ExitExecuteSection_" data-uid="IPA.Utilities.CriticalSection.ExitExecuteSection*"></a>
  173. <h4 id="IPA_Utilities_CriticalSection_ExitExecuteSection" data-uid="IPA.Utilities.CriticalSection.ExitExecuteSection">ExitExecuteSection()</h4>
  174. <div class="markdown level1 summary"><p>Exits a critical execution section. Does not nest.</p>
  175. </div>
  176. <div class="markdown level1 conceptual"></div>
  177. <h5 class="decalaration">Declaration</h5>
  178. <div class="codewrapper">
  179. <pre><code class="lang-csharp hljs">public static void ExitExecuteSection()</code></pre>
  180. </div>
  181. </article>
  182. </div>
  183. <div class="hidden-sm col-md-2" role="complementary">
  184. <div class="sideaffix">
  185. <div class="contribution">
  186. <ul class="nav">
  187. <li>
  188. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Utilities_CriticalSection.md&amp;value=---%0Auid%3A%20IPA.Utilities.CriticalSection%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
  189. </li>
  190. <li>
  191. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/9d00450e08f00c71f424eab56f5723e87dc08901/IPA.Loader/Utilities/CriticalSection.cs/#L14" class="contribution-link">View Source</a>
  192. </li>
  193. </ul>
  194. </div>
  195. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  196. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  197. </nav>
  198. </div>
  199. </div>
  200. </div>
  201. </div>
  202. <footer>
  203. <div class="grad-bottom"></div>
  204. <div class="footer">
  205. <div class="container">
  206. <span class="pull-right">
  207. <a href="#top">Back to top</a>
  208. </span>
  209. <span>Generated by <strong>DocFX</strong></span>
  210. </div>
  211. </div>
  212. </footer>
  213. </div>
  214. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  215. <script type="text/javascript" src="../styles/docfx.js"></script>
  216. <script type="text/javascript" src="../styles/main.js"></script>
  217. </body>
  218. </html>