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.

258 lines
15 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>Struct Synchronization.ReaderWriterLockSlimUpgradableReadLocker
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Struct Synchronization.ReaderWriterLockSlimUpgradableReadLocker
  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 href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
  18. <meta property="docfx:navrel" content="../toc.html">
  19. <meta property="docfx:tocrel" content="toc.html">
  20. <meta property="docfx:rel" content="../">
  21. <meta property="docfx:newtab" content="true">
  22. </head> <body data-spy="scroll" data-target="#affix" data-offset="120">
  23. <div id="wrapper">
  24. <header>
  25. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  26. <div class="container">
  27. <div class="navbar-header">
  28. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  29. <span class="sr-only">Toggle navigation</span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. <span class="icon-bar"></span>
  33. </button>
  34. <a class="navbar-brand" href="../index.html">
  35. <img id="logo" class="svg" src="../logo.svg" alt="">
  36. </a>
  37. </div>
  38. <div class="collapse navbar-collapse" id="navbar">
  39. <form class="navbar-form navbar-right" role="search" id="search">
  40. <div class="form-group">
  41. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  42. </div>
  43. </form>
  44. </div>
  45. </div>
  46. </nav>
  47. <div class="subnav navbar navbar-default">
  48. <div class="container hide-when-search" id="breadcrumb">
  49. <ul class="breadcrumb">
  50. <li></li>
  51. </ul>
  52. </div>
  53. </div>
  54. </header>
  55. <div class="container body-content">
  56. <div id="search-results">
  57. <div class="search-list"></div>
  58. <div class="sr-items">
  59. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  60. </div>
  61. <ul id="pagination"></ul>
  62. </div>
  63. </div>
  64. <div role="main" class="container body-content hide-when-search">
  65. <div class="sidenav hide-when-search">
  66. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  67. <div class="sidetoggle collapse" id="sidetoggle">
  68. <div id="sidetoc"></div>
  69. </div>
  70. </div>
  71. <div class="article row grid-right">
  72. <div class="col-md-10">
  73. <article class="content wrap" id="_content" data-uid="IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimUpgradableReadLocker">
  74. <h1 id="IPA_Utilities_Async_Synchronization_ReaderWriterLockSlimUpgradableReadLocker" data-uid="IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimUpgradableReadLocker" class="text-break">Struct Synchronization.ReaderWriterLockSlimUpgradableReadLocker
  75. </h1>
  76. <div class="markdown level0 summary"><p>A locker for an upgradable read lock on a <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.threading.readerwriterlockslim">ReaderWriterLockSlim</a> that automatically releases
  77. when it is disposed. Create this with <a class="xref" href="IPA.Utilities.Async.Synchronization.html#IPA_Utilities_Async_Synchronization_LockReadUpgradable_System_Threading_ReaderWriterLockSlim_">LockReadUpgradable(ReaderWriterLockSlim)</a>.</p>
  78. </div>
  79. <div class="markdown level0 conceptual"></div>
  80. <div classs="implements">
  81. <h5>Implements</h5>
  82. <div><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.idisposable">IDisposable</a></div>
  83. </div>
  84. <div class="inheritedMembers">
  85. <h5>Inherited Members</h5>
  86. <div>
  87. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.valuetype.equals#System_ValueType_Equals_System_Object_">ValueType.Equals(Object)</a>
  88. </div>
  89. <div>
  90. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.valuetype.gethashcode#System_ValueType_GetHashCode">ValueType.GetHashCode()</a>
  91. </div>
  92. <div>
  93. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.valuetype.tostring#System_ValueType_ToString">ValueType.ToString()</a>
  94. </div>
  95. <div>
  96. <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>
  97. </div>
  98. <div>
  99. <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>
  100. </div>
  101. <div>
  102. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gettype#System_Object_GetType">Object.GetType()</a>
  103. </div>
  104. </div>
  105. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Utilities.Async.html">IPA.Utilities.Async</a></h6>
  106. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  107. <h5 id="IPA_Utilities_Async_Synchronization_ReaderWriterLockSlimUpgradableReadLocker_syntax">Syntax</h5>
  108. <div class="codewrapper">
  109. <pre><code class="lang-csharp hljs">public struct ReaderWriterLockSlimUpgradableReadLocker : IDisposable</code></pre>
  110. </div>
  111. <h3 id="methods">Methods
  112. </h3>
  113. <span class="small pull-right mobile-hide">
  114. <span class="divider">|</span>
  115. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/4.0.0-beta/docs/override/new?filename=IPA_Utilities_Async_Synchronization_ReaderWriterLockSlimUpgradableReadLocker_Upgrade.md&amp;value=---%0Auid%3A%20IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimUpgradableReadLocker.Upgrade%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>
  116. </span>
  117. <span class="small pull-right mobile-hide">
  118. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/21abb2931dd49ff806e3bbcdeb789ff6a6f96cef/IPA.Loader/Utilities/Async/Synchronization.cs/#L164">View Source</a>
  119. </span>
  120. <a id="IPA_Utilities_Async_Synchronization_ReaderWriterLockSlimUpgradableReadLocker_Upgrade_" data-uid="IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimUpgradableReadLocker.Upgrade*"></a>
  121. <h4 id="IPA_Utilities_Async_Synchronization_ReaderWriterLockSlimUpgradableReadLocker_Upgrade" data-uid="IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimUpgradableReadLocker.Upgrade">Upgrade()</h4>
  122. <div class="markdown level1 summary"><p>Creates a locker for a write lock on the <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.threading.readerwriterlockslim">ReaderWriterLockSlim</a> associated with this locker,
  123. upgrading the current thread&apos;s lock.</p>
  124. </div>
  125. <div class="markdown level1 conceptual"></div>
  126. <h5 class="decalaration">Declaration</h5>
  127. <div class="codewrapper">
  128. <pre><code class="lang-csharp hljs">public Synchronization.ReaderWriterLockSlimWriteLocker Upgrade()</code></pre>
  129. </div>
  130. <h5 class="returns">Returns</h5>
  131. <table class="table table-bordered table-striped table-condensed">
  132. <thead>
  133. <tr>
  134. <th>Type</th>
  135. <th>Description</th>
  136. </tr>
  137. </thead>
  138. <tbody>
  139. <tr>
  140. <td><a class="xref" href="IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimWriteLocker.html">Synchronization.ReaderWriterLockSlimWriteLocker</a></td>
  141. <td><p>a locker for the new write lock</p>
  142. </td>
  143. </tr>
  144. </tbody>
  145. </table>
  146. <h5 id="IPA_Utilities_Async_Synchronization_ReaderWriterLockSlimUpgradableReadLocker_Upgrade_seealso">See Also</h5>
  147. <div class="seealso">
  148. <div><a class="xref" href="IPA.Utilities.Async.Synchronization.html">Synchronization</a></div>
  149. </div>
  150. <h3 id="eii">Explicit Interface Implementations
  151. </h3>
  152. <span class="small pull-right mobile-hide">
  153. <span class="divider">|</span>
  154. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/4.0.0-beta/docs/override/new?filename=IPA_Utilities_Async_Synchronization_ReaderWriterLockSlimUpgradableReadLocker_System_IDisposable_Dispose.md&amp;value=---%0Auid%3A%20IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimUpgradableReadLocker.System%23IDisposable%23Dispose%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>
  155. </span>
  156. <span class="small pull-right mobile-hide">
  157. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/21abb2931dd49ff806e3bbcdeb789ff6a6f96cef/IPA.Loader/Utilities/Async/Synchronization.cs/#L166">View Source</a>
  158. </span>
  159. <a id="IPA_Utilities_Async_Synchronization_ReaderWriterLockSlimUpgradableReadLocker_System_IDisposable_Dispose_" data-uid="IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimUpgradableReadLocker.System#IDisposable#Dispose*"></a>
  160. <h4 id="IPA_Utilities_Async_Synchronization_ReaderWriterLockSlimUpgradableReadLocker_System_IDisposable_Dispose" data-uid="IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimUpgradableReadLocker.System#IDisposable#Dispose">IDisposable.Dispose()</h4>
  161. <div class="markdown level1 summary"></div>
  162. <div class="markdown level1 conceptual"></div>
  163. <h5 class="decalaration">Declaration</h5>
  164. <div class="codewrapper">
  165. <pre><code class="lang-csharp hljs">void IDisposable.Dispose()</code></pre>
  166. </div>
  167. <h3 id="implements">Implements</h3>
  168. <div>
  169. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.idisposable">System.IDisposable</a>
  170. </div>
  171. <h3 id="extensionmethods">Extension Methods</h3>
  172. <div>
  173. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetField_System_Object_System_String_System_Object_">ReflectionUtil.SetField(Object, String, Object)</a>
  174. </div>
  175. <div>
  176. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetField__1___0_System_String_System_Object_">ReflectionUtil.SetField&lt;T&gt;(T, String, Object)</a>
  177. </div>
  178. <div>
  179. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetField__1_System_Object_System_String_">ReflectionUtil.GetField&lt;T&gt;(Object, String)</a>
  180. </div>
  181. <div>
  182. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetField__2___1_System_String_">ReflectionUtil.GetField&lt;T, U&gt;(U, String)</a>
  183. </div>
  184. <div>
  185. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetProperty_System_Object_System_String_System_Object_">ReflectionUtil.SetProperty(Object, String, Object)</a>
  186. </div>
  187. <div>
  188. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetProperty__1___0_System_String_System_Object_">ReflectionUtil.SetProperty&lt;T&gt;(T, String, Object)</a>
  189. </div>
  190. <div>
  191. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokeMethod_System_Object_System_String_System_Object___">ReflectionUtil.InvokeMethod(Object, String, Object[])</a>
  192. </div>
  193. <div>
  194. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokeMethod__1___0_System_String_System_Object___">ReflectionUtil.InvokeMethod&lt;T&gt;(T, String, Object[])</a>
  195. </div>
  196. <div>
  197. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokeMethod__1_System_Object_System_String_System_Object___">ReflectionUtil.InvokeMethod&lt;T&gt;(Object, String, Object[])</a>
  198. </div>
  199. <div>
  200. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokeMethod__2___1_System_String_System_Object___">ReflectionUtil.InvokeMethod&lt;T, U&gt;(U, String, Object[])</a>
  201. </div>
  202. <h3 id="seealso">See Also</h3>
  203. <div class="seealso">
  204. <div><a class="xref" href="IPA.Utilities.Async.Synchronization.html">Synchronization</a></div>
  205. <div><a class="xref" href="IPA.Utilities.Async.Synchronization.html#IPA_Utilities_Async_Synchronization_LockReadUpgradable_System_Threading_ReaderWriterLockSlim_">LockReadUpgradable(ReaderWriterLockSlim)</a></div>
  206. </div>
  207. </article>
  208. </div>
  209. <div class="hidden-sm col-md-2" role="complementary">
  210. <div class="sideaffix">
  211. <div class="contribution">
  212. <ul class="nav">
  213. <li>
  214. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/4.0.0-beta/docs/override/new?filename=IPA_Utilities_Async_Synchronization_ReaderWriterLockSlimUpgradableReadLocker.md&amp;value=---%0Auid%3A%20IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimUpgradableReadLocker%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>
  215. </li>
  216. <li>
  217. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/21abb2931dd49ff806e3bbcdeb789ff6a6f96cef/IPA.Loader/Utilities/Async/Synchronization.cs/#L148" class="contribution-link">View Source</a>
  218. </li>
  219. </ul>
  220. </div>
  221. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  222. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  223. </nav>
  224. </div>
  225. </div>
  226. </div>
  227. </div>
  228. <footer>
  229. <div class="grad-bottom"></div>
  230. <div class="footer">
  231. <div class="container">
  232. <span class="pull-right">
  233. <a href="#top">Back to top</a>
  234. </span>
  235. <span>Generated by <strong>DocFX</strong></span>
  236. </div>
  237. </div>
  238. </footer>
  239. </div>
  240. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  241. <script type="text/javascript" src="../styles/docfx.js"></script>
  242. <script type="text/javascript" src="../styles/main.js"></script>
  243. </body>
  244. </html>