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.

448 lines
24 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 SingleThreadTaskScheduler
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class SingleThreadTaskScheduler
  11. ">
  12. <meta name="generator" content="docfx 2.59.3.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">Search Results for <span></span></div>
  59. <div class="sr-items">
  60. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  61. </div>
  62. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></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.Async.SingleThreadTaskScheduler">
  75. <h1 id="IPA_Utilities_Async_SingleThreadTaskScheduler" data-uid="IPA.Utilities.Async.SingleThreadTaskScheduler" class="text-break">Class SingleThreadTaskScheduler
  76. </h1>
  77. <div class="markdown level0 summary"><p>A single-threaded task scheduler that runs all of its tasks on the same thread.</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">SingleThreadTaskScheduler</span></div>
  84. </div>
  85. <div class="implements">
  86. <h5>Implements</h5>
  87. <div><span class="xref">IDisposable</span></div>
  88. </div>
  89. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Utilities.Async.html">IPA.Utilities.Async</a></h6>
  90. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  91. <h5 id="IPA_Utilities_Async_SingleThreadTaskScheduler_syntax">Syntax</h5>
  92. <div class="codewrapper">
  93. <pre><code class="lang-csharp hljs">public class SingleThreadTaskScheduler : TaskScheduler</code></pre>
  94. </div>
  95. <h3 id="properties">Properties
  96. </h3>
  97. <span class="small pull-right mobile-hide">
  98. <span class="divider">|</span>
  99. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Utilities_Async_SingleThreadTaskScheduler_IsRunning.md&amp;value=---%0Auid%3A%20IPA.Utilities.Async.SingleThreadTaskScheduler.IsRunning%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>
  100. </span>
  101. <span class="small pull-right mobile-hide">
  102. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Utilities/Async/SingleThreadTaskScheduler.cs/#L24">View Source</a>
  103. </span>
  104. <a id="IPA_Utilities_Async_SingleThreadTaskScheduler_IsRunning_" data-uid="IPA.Utilities.Async.SingleThreadTaskScheduler.IsRunning*"></a>
  105. <h4 id="IPA_Utilities_Async_SingleThreadTaskScheduler_IsRunning" data-uid="IPA.Utilities.Async.SingleThreadTaskScheduler.IsRunning">IsRunning</h4>
  106. <div class="markdown level1 summary"><p>Gets whether or not the underlying thread has been started.</p>
  107. </div>
  108. <div class="markdown level1 conceptual"></div>
  109. <h5 class="decalaration">Declaration</h5>
  110. <div class="codewrapper">
  111. <pre><code class="lang-csharp hljs">public bool IsRunning { get; }</code></pre>
  112. </div>
  113. <h5 class="propertyValue">Property Value</h5>
  114. <table class="table table-bordered table-striped table-condensed">
  115. <thead>
  116. <tr>
  117. <th>Type</th>
  118. <th>Description</th>
  119. </tr>
  120. </thead>
  121. <tbody>
  122. <tr>
  123. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
  124. <td></td>
  125. </tr>
  126. </tbody>
  127. </table>
  128. <h3 id="methods">Methods
  129. </h3>
  130. <span class="small pull-right mobile-hide">
  131. <span class="divider">|</span>
  132. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Utilities_Async_SingleThreadTaskScheduler_Dispose.md&amp;value=---%0Auid%3A%20IPA.Utilities.Async.SingleThreadTaskScheduler.Dispose%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>
  133. </span>
  134. <span class="small pull-right mobile-hide">
  135. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Utilities/Async/SingleThreadTaskScheduler.cs/#L179">View Source</a>
  136. </span>
  137. <a id="IPA_Utilities_Async_SingleThreadTaskScheduler_Dispose_" data-uid="IPA.Utilities.Async.SingleThreadTaskScheduler.Dispose*"></a>
  138. <h4 id="IPA_Utilities_Async_SingleThreadTaskScheduler_Dispose" data-uid="IPA.Utilities.Async.SingleThreadTaskScheduler.Dispose">Dispose()</h4>
  139. <div class="markdown level1 summary"><p>Disposes this object. This puts the object into an unusable state.</p>
  140. </div>
  141. <div class="markdown level1 conceptual"></div>
  142. <h5 class="decalaration">Declaration</h5>
  143. <div class="codewrapper">
  144. <pre><code class="lang-csharp hljs">public void Dispose()</code></pre>
  145. </div>
  146. <span class="small pull-right mobile-hide">
  147. <span class="divider">|</span>
  148. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Utilities_Async_SingleThreadTaskScheduler_Dispose_System_Boolean_.md&amp;value=---%0Auid%3A%20IPA.Utilities.Async.SingleThreadTaskScheduler.Dispose(System.Boolean)%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>
  149. </span>
  150. <span class="small pull-right mobile-hide">
  151. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Utilities/Async/SingleThreadTaskScheduler.cs/#L162">View Source</a>
  152. </span>
  153. <a id="IPA_Utilities_Async_SingleThreadTaskScheduler_Dispose_" data-uid="IPA.Utilities.Async.SingleThreadTaskScheduler.Dispose*"></a>
  154. <h4 id="IPA_Utilities_Async_SingleThreadTaskScheduler_Dispose_System_Boolean_" data-uid="IPA.Utilities.Async.SingleThreadTaskScheduler.Dispose(System.Boolean)">Dispose(Boolean)</h4>
  155. <div class="markdown level1 summary"><p>Disposes this object.</p>
  156. </div>
  157. <div class="markdown level1 conceptual"></div>
  158. <h5 class="decalaration">Declaration</h5>
  159. <div class="codewrapper">
  160. <pre><code class="lang-csharp hljs">protected virtual void Dispose(bool disposing)</code></pre>
  161. </div>
  162. <h5 class="parameters">Parameters</h5>
  163. <table class="table table-bordered table-striped table-condensed">
  164. <thead>
  165. <tr>
  166. <th>Type</th>
  167. <th>Name</th>
  168. <th>Description</th>
  169. </tr>
  170. </thead>
  171. <tbody>
  172. <tr>
  173. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
  174. <td><span class="parametername">disposing</span></td>
  175. <td><p>whether or not to dispose managed objects</p>
  176. </td>
  177. </tr>
  178. </tbody>
  179. </table>
  180. <span class="small pull-right mobile-hide">
  181. <span class="divider">|</span>
  182. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Utilities_Async_SingleThreadTaskScheduler_Exit.md&amp;value=---%0Auid%3A%20IPA.Utilities.Async.SingleThreadTaskScheduler.Exit%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>
  183. </span>
  184. <span class="small pull-right mobile-hide">
  185. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Utilities/Async/SingleThreadTaskScheduler.cs/#L52">View Source</a>
  186. </span>
  187. <a id="IPA_Utilities_Async_SingleThreadTaskScheduler_Exit_" data-uid="IPA.Utilities.Async.SingleThreadTaskScheduler.Exit*"></a>
  188. <h4 id="IPA_Utilities_Async_SingleThreadTaskScheduler_Exit" data-uid="IPA.Utilities.Async.SingleThreadTaskScheduler.Exit">Exit()</h4>
  189. <div class="markdown level1 summary"><p>Terminates the runner thread, and waits for the currently running task to complete.</p>
  190. </div>
  191. <div class="markdown level1 conceptual"></div>
  192. <h5 class="decalaration">Declaration</h5>
  193. <div class="codewrapper">
  194. <pre><code class="lang-csharp hljs">public IEnumerable&lt;Task&gt; Exit()</code></pre>
  195. </div>
  196. <h5 class="returns">Returns</h5>
  197. <table class="table table-bordered table-striped table-condensed">
  198. <thead>
  199. <tr>
  200. <th>Type</th>
  201. <th>Description</th>
  202. </tr>
  203. </thead>
  204. <tbody>
  205. <tr>
  206. <td><span class="xref">IEnumerable</span>&lt;<span class="xref">Task</span>&gt;</td>
  207. <td><p>an <see cref="!:IEnumerable&lt;T>"></see> of <see cref="!:Task"></see>s that did not execute</p>
  208. </td>
  209. </tr>
  210. </tbody>
  211. </table>
  212. <h5 id="IPA_Utilities_Async_SingleThreadTaskScheduler_Exit_remarks">Remarks</h5>
  213. <div class="markdown level1 remarks"><p>After this method returns, this object has been disposed and is no longer in a valid state.</p>
  214. </div>
  215. <span class="small pull-right mobile-hide">
  216. <span class="divider">|</span>
  217. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Utilities_Async_SingleThreadTaskScheduler_GetScheduledTasks.md&amp;value=---%0Auid%3A%20IPA.Utilities.Async.SingleThreadTaskScheduler.GetScheduledTasks%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>
  218. </span>
  219. <span class="small pull-right mobile-hide">
  220. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Utilities/Async/SingleThreadTaskScheduler.cs/#L86">View Source</a>
  221. </span>
  222. <a id="IPA_Utilities_Async_SingleThreadTaskScheduler_GetScheduledTasks_" data-uid="IPA.Utilities.Async.SingleThreadTaskScheduler.GetScheduledTasks*"></a>
  223. <h4 id="IPA_Utilities_Async_SingleThreadTaskScheduler_GetScheduledTasks" data-uid="IPA.Utilities.Async.SingleThreadTaskScheduler.GetScheduledTasks">GetScheduledTasks()</h4>
  224. <div class="markdown level1 summary"><p>Throws a <see cref="!:NotSupportedException"></see>.</p>
  225. </div>
  226. <div class="markdown level1 conceptual"></div>
  227. <h5 class="decalaration">Declaration</h5>
  228. <div class="codewrapper">
  229. <pre><code class="lang-csharp hljs">protected override IEnumerable&lt;Task&gt; GetScheduledTasks()</code></pre>
  230. </div>
  231. <h5 class="returns">Returns</h5>
  232. <table class="table table-bordered table-striped table-condensed">
  233. <thead>
  234. <tr>
  235. <th>Type</th>
  236. <th>Description</th>
  237. </tr>
  238. </thead>
  239. <tbody>
  240. <tr>
  241. <td><span class="xref">IEnumerable</span>&lt;<span class="xref">Task</span>&gt;</td>
  242. <td><p>nothing</p>
  243. </td>
  244. </tr>
  245. </tbody>
  246. </table>
  247. <span class="small pull-right mobile-hide">
  248. <span class="divider">|</span>
  249. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Utilities_Async_SingleThreadTaskScheduler_Join.md&amp;value=---%0Auid%3A%20IPA.Utilities.Async.SingleThreadTaskScheduler.Join%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>
  250. </span>
  251. <span class="small pull-right mobile-hide">
  252. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Utilities/Async/SingleThreadTaskScheduler.cs/#L73">View Source</a>
  253. </span>
  254. <a id="IPA_Utilities_Async_SingleThreadTaskScheduler_Join_" data-uid="IPA.Utilities.Async.SingleThreadTaskScheduler.Join*"></a>
  255. <h4 id="IPA_Utilities_Async_SingleThreadTaskScheduler_Join" data-uid="IPA.Utilities.Async.SingleThreadTaskScheduler.Join">Join()</h4>
  256. <div class="markdown level1 summary"><p>Waits for the runner thread to complete all tasks in the queue, then exits.</p>
  257. </div>
  258. <div class="markdown level1 conceptual"></div>
  259. <h5 class="decalaration">Declaration</h5>
  260. <div class="codewrapper">
  261. <pre><code class="lang-csharp hljs">public void Join()</code></pre>
  262. </div>
  263. <h5 id="IPA_Utilities_Async_SingleThreadTaskScheduler_Join_remarks">Remarks</h5>
  264. <div class="markdown level1 remarks"><p>After this method returns, this object has been disposed and is no longer in a valid state.</p>
  265. </div>
  266. <span class="small pull-right mobile-hide">
  267. <span class="divider">|</span>
  268. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Utilities_Async_SingleThreadTaskScheduler_QueueTask_Task_.md&amp;value=---%0Auid%3A%20IPA.Utilities.Async.SingleThreadTaskScheduler.QueueTask(Task)%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>
  269. </span>
  270. <span class="small pull-right mobile-hide">
  271. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Utilities/Async/SingleThreadTaskScheduler.cs/#L98">View Source</a>
  272. </span>
  273. <a id="IPA_Utilities_Async_SingleThreadTaskScheduler_QueueTask_" data-uid="IPA.Utilities.Async.SingleThreadTaskScheduler.QueueTask*"></a>
  274. <h4 id="IPA_Utilities_Async_SingleThreadTaskScheduler_QueueTask_Task_" data-uid="IPA.Utilities.Async.SingleThreadTaskScheduler.QueueTask(Task)">QueueTask(Task)</h4>
  275. <div class="markdown level1 summary"><p>Queues a given <see cref="!:Task"></see> to this scheduler. The <see cref="!:Task"></see> <em>must&gt;</em> be
  276. scheduled for this <see cref="!:TaskScheduler"></see> by the runtime.</p>
  277. </div>
  278. <div class="markdown level1 conceptual"></div>
  279. <h5 class="decalaration">Declaration</h5>
  280. <div class="codewrapper">
  281. <pre><code class="lang-csharp hljs">protected override void QueueTask(Task task)</code></pre>
  282. </div>
  283. <h5 class="parameters">Parameters</h5>
  284. <table class="table table-bordered table-striped table-condensed">
  285. <thead>
  286. <tr>
  287. <th>Type</th>
  288. <th>Name</th>
  289. <th>Description</th>
  290. </tr>
  291. </thead>
  292. <tbody>
  293. <tr>
  294. <td><span class="xref">Task</span></td>
  295. <td><span class="parametername">task</span></td>
  296. <td><p>the <see cref="!:Task"></see> to queue</p>
  297. </td>
  298. </tr>
  299. </tbody>
  300. </table>
  301. <span class="small pull-right mobile-hide">
  302. <span class="divider">|</span>
  303. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Utilities_Async_SingleThreadTaskScheduler_Start.md&amp;value=---%0Auid%3A%20IPA.Utilities.Async.SingleThreadTaskScheduler.Start%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>
  304. </span>
  305. <span class="small pull-right mobile-hide">
  306. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Utilities/Async/SingleThreadTaskScheduler.cs/#L37">View Source</a>
  307. </span>
  308. <a id="IPA_Utilities_Async_SingleThreadTaskScheduler_Start_" data-uid="IPA.Utilities.Async.SingleThreadTaskScheduler.Start*"></a>
  309. <h4 id="IPA_Utilities_Async_SingleThreadTaskScheduler_Start" data-uid="IPA.Utilities.Async.SingleThreadTaskScheduler.Start">Start()</h4>
  310. <div class="markdown level1 summary"><p>Starts the thread that executes tasks scheduled with this <see cref="!:TaskScheduler"></see></p>
  311. </div>
  312. <div class="markdown level1 conceptual"></div>
  313. <h5 class="decalaration">Declaration</h5>
  314. <div class="codewrapper">
  315. <pre><code class="lang-csharp hljs">public void Start()</code></pre>
  316. </div>
  317. <span class="small pull-right mobile-hide">
  318. <span class="divider">|</span>
  319. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Utilities_Async_SingleThreadTaskScheduler_TryExecuteTaskInline_Task_System_Boolean_.md&amp;value=---%0Auid%3A%20IPA.Utilities.Async.SingleThreadTaskScheduler.TryExecuteTaskInline(Task%2CSystem.Boolean)%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>
  320. </span>
  321. <span class="small pull-right mobile-hide">
  322. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Utilities/Async/SingleThreadTaskScheduler.cs/#L116">View Source</a>
  323. </span>
  324. <a id="IPA_Utilities_Async_SingleThreadTaskScheduler_TryExecuteTaskInline_" data-uid="IPA.Utilities.Async.SingleThreadTaskScheduler.TryExecuteTaskInline*"></a>
  325. <h4 id="IPA_Utilities_Async_SingleThreadTaskScheduler_TryExecuteTaskInline_Task_System_Boolean_" data-uid="IPA.Utilities.Async.SingleThreadTaskScheduler.TryExecuteTaskInline(Task,System.Boolean)">TryExecuteTaskInline(Task, Boolean)</h4>
  326. <div class="markdown level1 summary"><p>Rejects any attempts to execute a task inline.</p>
  327. </div>
  328. <div class="markdown level1 conceptual"></div>
  329. <h5 class="decalaration">Declaration</h5>
  330. <div class="codewrapper">
  331. <pre><code class="lang-csharp hljs">protected override bool TryExecuteTaskInline(Task task, bool taskWasPreviouslyQueued)</code></pre>
  332. </div>
  333. <h5 class="parameters">Parameters</h5>
  334. <table class="table table-bordered table-striped table-condensed">
  335. <thead>
  336. <tr>
  337. <th>Type</th>
  338. <th>Name</th>
  339. <th>Description</th>
  340. </tr>
  341. </thead>
  342. <tbody>
  343. <tr>
  344. <td><span class="xref">Task</span></td>
  345. <td><span class="parametername">task</span></td>
  346. <td><p>the task to attempt to execute</p>
  347. </td>
  348. </tr>
  349. <tr>
  350. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
  351. <td><span class="parametername">taskWasPreviouslyQueued</span></td>
  352. <td><p>whether the task was previously queued to this scheduler</p>
  353. </td>
  354. </tr>
  355. </tbody>
  356. </table>
  357. <h5 class="returns">Returns</h5>
  358. <table class="table table-bordered table-striped table-condensed">
  359. <thead>
  360. <tr>
  361. <th>Type</th>
  362. <th>Description</th>
  363. </tr>
  364. </thead>
  365. <tbody>
  366. <tr>
  367. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
  368. <td><span class="xref">false</span></td>
  369. </tr>
  370. </tbody>
  371. </table>
  372. <h5 id="IPA_Utilities_Async_SingleThreadTaskScheduler_TryExecuteTaskInline_Task_System_Boolean__remarks">Remarks</h5>
  373. <div class="markdown level1 remarks"><p>This task scheduler <em>always</em> runs its tasks on the thread that it manages, therefore it doesn&apos;t
  374. make sense to run it inline.</p>
  375. </div>
  376. <h3 id="implements">Implements</h3>
  377. <div>
  378. <span class="xref">IDisposable</span>
  379. </div>
  380. <h3 id="extensionmethods">Extension Methods</h3>
  381. <div>
  382. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetField__2___0_System_String___1_">ReflectionUtil.SetField&lt;T, U&gt;(T, String, U)</a>
  383. </div>
  384. <div>
  385. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetField__2___1_System_String_">ReflectionUtil.GetField&lt;U, T&gt;(T, String)</a>
  386. </div>
  387. <div>
  388. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetProperty__2___0_System_String___1_">ReflectionUtil.SetProperty&lt;T, U&gt;(T, String, U)</a>
  389. </div>
  390. <div>
  391. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetProperty__2___1_System_String_">ReflectionUtil.GetProperty&lt;U, T&gt;(T, String)</a>
  392. </div>
  393. <div>
  394. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokeMethod__2___1_System_String_System_Object___">ReflectionUtil.InvokeMethod&lt;U, T&gt;(T, String, Object[])</a>
  395. </div>
  396. </article>
  397. </div>
  398. <div class="hidden-sm col-md-2" role="complementary">
  399. <div class="sideaffix">
  400. <div class="contribution">
  401. <ul class="nav">
  402. <li>
  403. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Utilities_Async_SingleThreadTaskScheduler.md&amp;value=---%0Auid%3A%20IPA.Utilities.Async.SingleThreadTaskScheduler%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>
  404. </li>
  405. <li>
  406. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/0ba9d3c46d55d5ae58d8887ac27b303379298b53/IPA.Loader/Utilities/Async/SingleThreadTaskScheduler.cs/#L14" class="contribution-link">View Source</a>
  407. </li>
  408. </ul>
  409. </div>
  410. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  411. <h5>In This Article</h5>
  412. <div></div>
  413. </nav>
  414. </div>
  415. </div>
  416. </div>
  417. </div>
  418. <footer>
  419. <div class="grad-bottom"></div>
  420. <div class="footer">
  421. <div class="container">
  422. <span class="pull-right">
  423. <a href="#top">Back to top</a>
  424. </span>
  425. <span>Generated by <strong>DocFX</strong></span>
  426. </div>
  427. </div>
  428. </footer>
  429. </div>
  430. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  431. <script type="text/javascript" src="../styles/docfx.js"></script>
  432. <script type="text/javascript" src="../styles/main.js"></script>
  433. </body>
  434. </html>