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.

170 lines
9.7 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> </title>
  8. <meta name="viewport" content="width=device-width">
  9. <meta name="title" content=" ">
  10. <meta name="generator" content="docfx 2.59.4.0">
  11. <link rel="shortcut icon" href="../favicon.ico">
  12. <link rel="stylesheet" href="../styles/docfx.vendor.css">
  13. <link rel="stylesheet" href="../styles/docfx.css">
  14. <link rel="stylesheet" href="../styles/main.css">
  15. <link rel="stylesheet" href="../styles/fix.css">
  16. <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
  17. <meta property="docfx:navrel" content="../toc.html">
  18. <meta property="docfx:tocrel" content="toc.html">
  19. <meta property="docfx:rel" content="../">
  20. <meta property="docfx:newtab" content="true">
  21. </head> <body data-spy="scroll" data-target="#affix" data-offset="120">
  22. <div id="wrapper">
  23. <header>
  24. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  25. <div class="container">
  26. <div class="navbar-header">
  27. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  28. <span class="sr-only">Toggle navigation</span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. </button>
  33. <a class="navbar-brand" href="../index.html">
  34. <img id="logo" class="svg" src="../logo.svg" alt="">
  35. </a>
  36. </div>
  37. <div class="collapse navbar-collapse" id="navbar">
  38. <form class="navbar-form navbar-right" role="search" id="search">
  39. <div class="form-group">
  40. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  41. </div>
  42. </form>
  43. </div>
  44. </div>
  45. </nav>
  46. <div class="subnav navbar navbar-default">
  47. <div class="container hide-when-search" id="breadcrumb">
  48. <ul class="breadcrumb">
  49. <li></li>
  50. </ul>
  51. </div>
  52. </div>
  53. </header>
  54. <div class="container body-content">
  55. <div id="search-results">
  56. <div class="search-list">Search Results for <span></span></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
  61. </div>
  62. </div>
  63. <div role="main" class="container body-content hide-when-search">
  64. <div class="sidenav hide-when-search">
  65. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  66. <div class="sidetoggle collapse" id="sidetoggle">
  67. <div id="sidetoc"></div>
  68. </div>
  69. </div>
  70. <div class="article row grid-right">
  71. <div class="col-md-10">
  72. <article class="content wrap" id="_content" data-uid="IPA.Utilities.Async">
  73. <h1 id="IPA_Utilities_Async" data-uid="IPA.Utilities.Async" class="text-break"></h1>
  74. <div class="markdown level0 summary"></div>
  75. <div class="markdown level0 conceptual"></div>
  76. <div class="markdown level0 remarks"></div>
  77. <h3 id="classes">Classes
  78. </h3>
  79. <h4><a class="xref" href="IPA.Utilities.Async.Coroutines.html">Coroutines</a></h4>
  80. <section><p>A class providing coroutine helpers.</p>
  81. </section>
  82. <h4><a class="xref" href="IPA.Utilities.Async.SingleCreationValueCache-2.html">SingleCreationValueCache&lt;TKey, TValue&gt;</a></h4>
  83. <section><p>A dictionary-like type intended for thread-safe value caches whose values are created only once ever.</p>
  84. </section>
  85. <h4><a class="xref" href="IPA.Utilities.Async.SingleThreadTaskScheduler.html">SingleThreadTaskScheduler</a></h4>
  86. <section><p>A single-threaded task scheduler that runs all of its tasks on the same thread.</p>
  87. </section>
  88. <h4><a class="xref" href="IPA.Utilities.Async.Synchronization.html">Synchronization</a></h4>
  89. <section><p>Utilities for inter-thread synchronization. All Locker method acquire their object immediately,
  90. and should only be used with <span class="xref">langword_csharp_using</span> to automatically release them.</p>
  91. </section>
  92. <h4><a class="xref" href="IPA.Utilities.Async.UnityMainThreadTaskScheduler.html">UnityMainThreadTaskScheduler</a></h4>
  93. <section><p>A task scheduler that runs tasks on the Unity main thread via coroutines.</p>
  94. </section>
  95. <h3 id="structs">Structs
  96. </h3>
  97. <h4><a class="xref" href="IPA.Utilities.Async.Synchronization.MutexLocker.html">Synchronization.MutexLocker</a></h4>
  98. <section><p>A locker for a <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.mutex">Mutex</a> that automatically releases when it is disposed.
  99. Create this with <a class="xref" href="IPA.Utilities.Async.Synchronization.html#IPA_Utilities_Async_Synchronization_Lock_System_Threading_Mutex_">Lock(Mutex)</a>.</p>
  100. </section>
  101. <h4><a class="xref" href="IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimReadLocker.html">Synchronization.ReaderWriterLockSlimReadLocker</a></h4>
  102. <section><p>A locker for a read lock on a <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.readerwriterlockslim">ReaderWriterLockSlim</a> that automatically releases when
  103. it is disposed. Create this with <a class="xref" href="IPA.Utilities.Async.Synchronization.html#IPA_Utilities_Async_Synchronization_LockRead_System_Threading_ReaderWriterLockSlim_">LockRead(ReaderWriterLockSlim)</a>.</p>
  104. </section>
  105. <h4><a class="xref" href="IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimUpgradableReadLocker.html">Synchronization.ReaderWriterLockSlimUpgradableReadLocker</a></h4>
  106. <section><p>A locker for an upgradable read lock on a <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.readerwriterlockslim">ReaderWriterLockSlim</a> that automatically releases
  107. 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>
  108. </section>
  109. <h4><a class="xref" href="IPA.Utilities.Async.Synchronization.ReaderWriterLockSlimWriteLocker.html">Synchronization.ReaderWriterLockSlimWriteLocker</a></h4>
  110. <section><p>A locker for a write lock on a <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.readerwriterlockslim">ReaderWriterLockSlim</a> that automatically releases when
  111. it is disposed. Create this with <a class="xref" href="IPA.Utilities.Async.Synchronization.html#IPA_Utilities_Async_Synchronization_LockWrite_System_Threading_ReaderWriterLockSlim_">LockWrite(ReaderWriterLockSlim)</a>.</p>
  112. </section>
  113. <h4><a class="xref" href="IPA.Utilities.Async.Synchronization.SemaphoreLocker.html">Synchronization.SemaphoreLocker</a></h4>
  114. <section><p>A locker for a <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.semaphore">Semaphore</a> that automatically releases when it is disposed.
  115. Create this with <a class="xref" href="IPA.Utilities.Async.Synchronization.html#IPA_Utilities_Async_Synchronization_Lock_System_Threading_Semaphore_">Lock(Semaphore)</a>.</p>
  116. </section>
  117. <h4><a class="xref" href="IPA.Utilities.Async.Synchronization.SemaphoreSlimAsyncLocker.html">Synchronization.SemaphoreSlimAsyncLocker</a></h4>
  118. <section><p>A locker for a <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.semaphoreslim">SemaphoreSlim</a> that was created asynchronously and automatically releases
  119. when it is disposed. Create this with <a class="xref" href="IPA.Utilities.Async.Synchronization.html#IPA_Utilities_Async_Synchronization_LockAsync_System_Threading_SemaphoreSlim_">LockAsync(SemaphoreSlim)</a>.</p>
  120. </section>
  121. <h4><a class="xref" href="IPA.Utilities.Async.Synchronization.SemaphoreSlimLocker.html">Synchronization.SemaphoreSlimLocker</a></h4>
  122. <section><p>A locker for a <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.semaphoreslim">SemaphoreSlim</a> that automatically releases when it is disposed.
  123. Create this with <a class="xref" href="IPA.Utilities.Async.Synchronization.html#IPA_Utilities_Async_Synchronization_Lock_System_Threading_SemaphoreSlim_">Lock(SemaphoreSlim)</a>.</p>
  124. </section>
  125. </article>
  126. </div>
  127. <div class="hidden-sm col-md-2" role="complementary">
  128. <div class="sideaffix">
  129. <div class="contribution">
  130. <ul class="nav">
  131. </ul>
  132. </div>
  133. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  134. <h5>In This Article</h5>
  135. <div></div>
  136. </nav>
  137. </div>
  138. </div>
  139. </div>
  140. </div>
  141. <footer>
  142. <div class="grad-bottom"></div>
  143. <div class="footer">
  144. <div class="container">
  145. <span class="pull-right">
  146. <a href="#top">Back to top</a>
  147. </span>
  148. <span>Generated by <strong>DocFX</strong></span>
  149. </div>
  150. </div>
  151. </footer>
  152. </div>
  153. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  154. <script type="text/javascript" src="../styles/docfx.js"></script>
  155. <script type="text/javascript" src="../styles/main.js"></script>
  156. </body>
  157. </html>