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.
615 lines
33 KiB
615 lines
33 KiB
<!DOCTYPE html>
|
|
<!--[if IE]><![endif]-->
|
|
<html>
|
|
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>Class SingleThreadTaskScheduler
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class SingleThreadTaskScheduler
|
|
">
|
|
<meta name="generator" content="docfx 2.59.4.0">
|
|
|
|
<link rel="shortcut icon" href="../favicon.ico">
|
|
<link rel="stylesheet" href="../styles/docfx.vendor.css">
|
|
<link rel="stylesheet" href="../styles/docfx.css">
|
|
<link rel="stylesheet" href="../styles/main.css">
|
|
<link rel="stylesheet" href="../styles/fix.css">
|
|
<link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
|
|
<meta property="docfx:navrel" content="../toc.html">
|
|
<meta property="docfx:tocrel" content="toc.html">
|
|
|
|
<meta property="docfx:rel" content="../">
|
|
<meta property="docfx:newtab" content="true">
|
|
</head> <body data-spy="scroll" data-target="#affix" data-offset="120">
|
|
<div id="wrapper">
|
|
<header>
|
|
|
|
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
|
|
<a class="navbar-brand" href="../index.html">
|
|
<img id="logo" class="svg" src="../logo.svg" alt="">
|
|
</a>
|
|
</div>
|
|
<div class="collapse navbar-collapse" id="navbar">
|
|
<form class="navbar-form navbar-right" role="search" id="search">
|
|
<div class="form-group">
|
|
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
|
|
</div>
|
|
</form>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<div class="subnav navbar navbar-default">
|
|
<div class="container hide-when-search" id="breadcrumb">
|
|
<ul class="breadcrumb">
|
|
<li></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container body-content">
|
|
|
|
<div id="search-results">
|
|
<div class="search-list">Search Results for <span></span></div>
|
|
<div class="sr-items">
|
|
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
|
|
</div>
|
|
<ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
|
|
</div>
|
|
</div>
|
|
<div role="main" class="container body-content hide-when-search">
|
|
|
|
<div class="sidenav hide-when-search">
|
|
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
|
<div class="sidetoggle collapse" id="sidetoggle">
|
|
<div id="sidetoc"></div>
|
|
</div>
|
|
</div>
|
|
<div class="article row grid-right">
|
|
<div class="col-md-10">
|
|
<article class="content wrap" id="_content" data-uid="IPA.Utilities.Async.SingleThreadTaskScheduler">
|
|
|
|
|
|
<h1 id="IPA_Utilities_Async_SingleThreadTaskScheduler" data-uid="IPA.Utilities.Async.SingleThreadTaskScheduler" class="text-break">Class SingleThreadTaskScheduler
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>A single-threaded task scheduler that runs all of its tasks on the same thread.</p>
|
|
</div>
|
|
<div class="markdown level0 conceptual"></div>
|
|
<div class="inheritance">
|
|
<h5>Inheritance</h5>
|
|
<div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">Object</a></div>
|
|
<div class="level1"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.taskscheduler">TaskScheduler</a></div>
|
|
<div class="level2"><span class="xref">SingleThreadTaskScheduler</span></div>
|
|
</div>
|
|
<div class="implements">
|
|
<h5>Implements</h5>
|
|
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</a></div>
|
|
</div>
|
|
<div class="inheritedMembers">
|
|
<h5>Inherited Members</h5>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.taskscheduler.trydequeue#system-threading-tasks-taskscheduler-trydequeue(system-threading-tasks-task)">TaskScheduler.TryDequeue(Task)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.taskscheduler.fromcurrentsynchronizationcontext#system-threading-tasks-taskscheduler-fromcurrentsynchronizationcontext">TaskScheduler.FromCurrentSynchronizationContext()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.taskscheduler.tryexecutetask#system-threading-tasks-taskscheduler-tryexecutetask(system-threading-tasks-task)">TaskScheduler.TryExecuteTask(Task)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.taskscheduler.maximumconcurrencylevel#system-threading-tasks-taskscheduler-maximumconcurrencylevel">TaskScheduler.MaximumConcurrencyLevel</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.taskscheduler.default#system-threading-tasks-taskscheduler-default">TaskScheduler.Default</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.taskscheduler.current#system-threading-tasks-taskscheduler-current">TaskScheduler.Current</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.taskscheduler.id#system-threading-tasks-taskscheduler-id">TaskScheduler.Id</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.taskscheduler.unobservedtaskexception#system-threading-tasks-taskscheduler-unobservedtaskexception">TaskScheduler.UnobservedTaskException</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring#system-object-tostring">Object.ToString()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">Object.Equals(Object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">Object.Equals(Object, Object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals#system-object-referenceequals(system-object-system-object)">Object.ReferenceEquals(Object, Object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode#system-object-gethashcode">Object.GetHashCode()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype#system-object-gettype">Object.GetType()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone#system-object-memberwiseclone">Object.MemberwiseClone()</a>
|
|
</div>
|
|
</div>
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="IPA.Utilities.Async.html">IPA.Utilities.Async</a></h6>
|
|
<h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
|
|
<h5 id="IPA_Utilities_Async_SingleThreadTaskScheduler_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class SingleThreadTaskScheduler : TaskScheduler, IDisposable</code></pre>
|
|
</div>
|
|
<h3 id="properties">Properties
|
|
</h3>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Utilities_Async_SingleThreadTaskScheduler_IsRunning.md&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>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/2236b34fe80ae08107933a57221e788cccbc4668/IPA.Loader/Utilities/Async/SingleThreadTaskScheduler.cs/#L24">View Source</a>
|
|
</span>
|
|
<a id="IPA_Utilities_Async_SingleThreadTaskScheduler_IsRunning_" data-uid="IPA.Utilities.Async.SingleThreadTaskScheduler.IsRunning*"></a>
|
|
<h4 id="IPA_Utilities_Async_SingleThreadTaskScheduler_IsRunning" data-uid="IPA.Utilities.Async.SingleThreadTaskScheduler.IsRunning">IsRunning</h4>
|
|
<div class="markdown level1 summary"><p>Gets whether or not the underlying thread has been started.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool IsRunning { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="exceptions">Exceptions</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Condition</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.objectdisposedexception">ObjectDisposedException</a></td>
|
|
<td><p>Thrown if this object has already been disposed.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="methods">Methods
|
|
</h3>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Utilities_Async_SingleThreadTaskScheduler_Dispose.md&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>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/2236b34fe80ae08107933a57221e788cccbc4668/IPA.Loader/Utilities/Async/SingleThreadTaskScheduler.cs/#L179">View Source</a>
|
|
</span>
|
|
<a id="IPA_Utilities_Async_SingleThreadTaskScheduler_Dispose_" data-uid="IPA.Utilities.Async.SingleThreadTaskScheduler.Dispose*"></a>
|
|
<h4 id="IPA_Utilities_Async_SingleThreadTaskScheduler_Dispose" data-uid="IPA.Utilities.Async.SingleThreadTaskScheduler.Dispose">Dispose()</h4>
|
|
<div class="markdown level1 summary"><p>Disposes this object. This puts the object into an unusable state.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void Dispose()</code></pre>
|
|
</div>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Utilities_Async_SingleThreadTaskScheduler_Dispose_System_Boolean_.md&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>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/2236b34fe80ae08107933a57221e788cccbc4668/IPA.Loader/Utilities/Async/SingleThreadTaskScheduler.cs/#L162">View Source</a>
|
|
</span>
|
|
<a id="IPA_Utilities_Async_SingleThreadTaskScheduler_Dispose_" data-uid="IPA.Utilities.Async.SingleThreadTaskScheduler.Dispose*"></a>
|
|
<h4 id="IPA_Utilities_Async_SingleThreadTaskScheduler_Dispose_System_Boolean_" data-uid="IPA.Utilities.Async.SingleThreadTaskScheduler.Dispose(System.Boolean)">Dispose(Boolean)</h4>
|
|
<div class="markdown level1 summary"><p>Disposes this object.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected virtual void Dispose(bool disposing)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
|
|
<td><span class="parametername">disposing</span></td>
|
|
<td><p>whether or not to dispose managed objects</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Utilities_Async_SingleThreadTaskScheduler_Exit.md&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>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/2236b34fe80ae08107933a57221e788cccbc4668/IPA.Loader/Utilities/Async/SingleThreadTaskScheduler.cs/#L52">View Source</a>
|
|
</span>
|
|
<a id="IPA_Utilities_Async_SingleThreadTaskScheduler_Exit_" data-uid="IPA.Utilities.Async.SingleThreadTaskScheduler.Exit*"></a>
|
|
<h4 id="IPA_Utilities_Async_SingleThreadTaskScheduler_Exit" data-uid="IPA.Utilities.Async.SingleThreadTaskScheduler.Exit">Exit()</h4>
|
|
<div class="markdown level1 summary"><p>Terminates the runner thread, and waits for the currently running task to complete.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public IEnumerable<Task> Exit()</code></pre>
|
|
</div>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a>></td>
|
|
<td><p>an <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable<T></a> of <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a>s that did not execute</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 id="IPA_Utilities_Async_SingleThreadTaskScheduler_Exit_remarks">Remarks</h5>
|
|
<div class="markdown level1 remarks"><p>After this method returns, this object has been disposed and is no longer in a valid state.</p>
|
|
</div>
|
|
<h5 class="exceptions">Exceptions</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Condition</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.objectdisposedexception">ObjectDisposedException</a></td>
|
|
<td><p>Thrown if this object has already been disposed.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Utilities_Async_SingleThreadTaskScheduler_GetScheduledTasks.md&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>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/2236b34fe80ae08107933a57221e788cccbc4668/IPA.Loader/Utilities/Async/SingleThreadTaskScheduler.cs/#L86">View Source</a>
|
|
</span>
|
|
<a id="IPA_Utilities_Async_SingleThreadTaskScheduler_GetScheduledTasks_" data-uid="IPA.Utilities.Async.SingleThreadTaskScheduler.GetScheduledTasks*"></a>
|
|
<h4 id="IPA_Utilities_Async_SingleThreadTaskScheduler_GetScheduledTasks" data-uid="IPA.Utilities.Async.SingleThreadTaskScheduler.GetScheduledTasks">GetScheduledTasks()</h4>
|
|
<div class="markdown level1 summary"><p>Throws a <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.notsupportedexception">NotSupportedException</a>.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected override IEnumerable<Task> GetScheduledTasks()</code></pre>
|
|
</div>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a>></td>
|
|
<td><p>nothing</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.taskscheduler.getscheduledtasks#system-threading-tasks-taskscheduler-getscheduledtasks">TaskScheduler.GetScheduledTasks()</a></div>
|
|
<h5 class="exceptions">Exceptions</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Condition</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.notsupportedexception">NotSupportedException</a></td>
|
|
<td><p>Always.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Utilities_Async_SingleThreadTaskScheduler_Join.md&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>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/2236b34fe80ae08107933a57221e788cccbc4668/IPA.Loader/Utilities/Async/SingleThreadTaskScheduler.cs/#L73">View Source</a>
|
|
</span>
|
|
<a id="IPA_Utilities_Async_SingleThreadTaskScheduler_Join_" data-uid="IPA.Utilities.Async.SingleThreadTaskScheduler.Join*"></a>
|
|
<h4 id="IPA_Utilities_Async_SingleThreadTaskScheduler_Join" data-uid="IPA.Utilities.Async.SingleThreadTaskScheduler.Join">Join()</h4>
|
|
<div class="markdown level1 summary"><p>Waits for the runner thread to complete all tasks in the queue, then exits.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void Join()</code></pre>
|
|
</div>
|
|
<h5 id="IPA_Utilities_Async_SingleThreadTaskScheduler_Join_remarks">Remarks</h5>
|
|
<div class="markdown level1 remarks"><p>After this method returns, this object has been disposed and is no longer in a valid state.</p>
|
|
</div>
|
|
<h5 class="exceptions">Exceptions</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Condition</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.objectdisposedexception">ObjectDisposedException</a></td>
|
|
<td><p>Thrown if this object has already been disposed.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Utilities_Async_SingleThreadTaskScheduler_QueueTask_System_Threading_Tasks_Task_.md&value=---%0Auid%3A%20IPA.Utilities.Async.SingleThreadTaskScheduler.QueueTask(System.Threading.Tasks.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>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/2236b34fe80ae08107933a57221e788cccbc4668/IPA.Loader/Utilities/Async/SingleThreadTaskScheduler.cs/#L98">View Source</a>
|
|
</span>
|
|
<a id="IPA_Utilities_Async_SingleThreadTaskScheduler_QueueTask_" data-uid="IPA.Utilities.Async.SingleThreadTaskScheduler.QueueTask*"></a>
|
|
<h4 id="IPA_Utilities_Async_SingleThreadTaskScheduler_QueueTask_System_Threading_Tasks_Task_" data-uid="IPA.Utilities.Async.SingleThreadTaskScheduler.QueueTask(System.Threading.Tasks.Task)">QueueTask(Task)</h4>
|
|
<div class="markdown level1 summary"><p>Queues a given <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a> to this scheduler. The <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a> <em>must></em> be
|
|
scheduled for this <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.taskscheduler">TaskScheduler</a> by the runtime.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected override void QueueTask(Task task)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a></td>
|
|
<td><span class="parametername">task</span></td>
|
|
<td><p>the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a> to queue</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.taskscheduler.queuetask#system-threading-tasks-taskscheduler-queuetask(system-threading-tasks-task)">TaskScheduler.QueueTask(Task)</a></div>
|
|
<h5 class="exceptions">Exceptions</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Condition</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.objectdisposedexception">ObjectDisposedException</a></td>
|
|
<td><p>Thrown if this object has already been disposed.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Utilities_Async_SingleThreadTaskScheduler_Start.md&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>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/2236b34fe80ae08107933a57221e788cccbc4668/IPA.Loader/Utilities/Async/SingleThreadTaskScheduler.cs/#L37">View Source</a>
|
|
</span>
|
|
<a id="IPA_Utilities_Async_SingleThreadTaskScheduler_Start_" data-uid="IPA.Utilities.Async.SingleThreadTaskScheduler.Start*"></a>
|
|
<h4 id="IPA_Utilities_Async_SingleThreadTaskScheduler_Start" data-uid="IPA.Utilities.Async.SingleThreadTaskScheduler.Start">Start()</h4>
|
|
<div class="markdown level1 summary"><p>Starts the thread that executes tasks scheduled with this <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.taskscheduler">TaskScheduler</a></p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void Start()</code></pre>
|
|
</div>
|
|
<h5 class="exceptions">Exceptions</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Condition</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.objectdisposedexception">ObjectDisposedException</a></td>
|
|
<td><p>Thrown if this object has already been disposed.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Utilities_Async_SingleThreadTaskScheduler_TryExecuteTaskInline_System_Threading_Tasks_Task_System_Boolean_.md&value=---%0Auid%3A%20IPA.Utilities.Async.SingleThreadTaskScheduler.TryExecuteTaskInline(System.Threading.Tasks.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>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/2236b34fe80ae08107933a57221e788cccbc4668/IPA.Loader/Utilities/Async/SingleThreadTaskScheduler.cs/#L116">View Source</a>
|
|
</span>
|
|
<a id="IPA_Utilities_Async_SingleThreadTaskScheduler_TryExecuteTaskInline_" data-uid="IPA.Utilities.Async.SingleThreadTaskScheduler.TryExecuteTaskInline*"></a>
|
|
<h4 id="IPA_Utilities_Async_SingleThreadTaskScheduler_TryExecuteTaskInline_System_Threading_Tasks_Task_System_Boolean_" data-uid="IPA.Utilities.Async.SingleThreadTaskScheduler.TryExecuteTaskInline(System.Threading.Tasks.Task,System.Boolean)">TryExecuteTaskInline(Task, Boolean)</h4>
|
|
<div class="markdown level1 summary"><p>Rejects any attempts to execute a task inline.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected override bool TryExecuteTaskInline(Task task, bool taskWasPreviouslyQueued)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a></td>
|
|
<td><span class="parametername">task</span></td>
|
|
<td><p>the task to attempt to execute</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
|
|
<td><span class="parametername">taskWasPreviouslyQueued</span></td>
|
|
<td><p>whether the task was previously queued to this scheduler</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
|
|
<td><span class="xref">false</span></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.taskscheduler.tryexecutetaskinline#system-threading-tasks-taskscheduler-tryexecutetaskinline(system-threading-tasks-task-system-boolean)">TaskScheduler.TryExecuteTaskInline(Task, Boolean)</a></div>
|
|
<h5 id="IPA_Utilities_Async_SingleThreadTaskScheduler_TryExecuteTaskInline_System_Threading_Tasks_Task_System_Boolean__remarks">Remarks</h5>
|
|
<div class="markdown level1 remarks"><p>This task scheduler <em>always</em> runs its tasks on the thread that it manages, therefore it doesn't
|
|
make sense to run it inline.</p>
|
|
</div>
|
|
<h5 class="exceptions">Exceptions</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Condition</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.objectdisposedexception">ObjectDisposedException</a></td>
|
|
<td><p>Thrown if this object has already been disposed.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="implements">Implements</h3>
|
|
<div>
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">System.IDisposable</a>
|
|
</div>
|
|
<h3 id="extensionmethods">Extension Methods</h3>
|
|
<div>
|
|
<a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetField__2___0_System_String___1_">ReflectionUtil.SetField<T, U>(T, String, U)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetField__2___1_System_String_">ReflectionUtil.GetField<U, T>(T, String)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetProperty__2___0_System_String___1_">ReflectionUtil.SetProperty<T, U>(T, String, U)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetProperty__2___1_System_String_">ReflectionUtil.GetProperty<U, T>(T, String)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokeMethod__2___1_System_String_System_Object___">ReflectionUtil.InvokeMethod<U, T>(T, String, Object[])</a>
|
|
</div>
|
|
</article>
|
|
</div>
|
|
|
|
<div class="hidden-sm col-md-2" role="complementary">
|
|
<div class="sideaffix">
|
|
<div class="contribution">
|
|
<ul class="nav">
|
|
<li>
|
|
<a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Utilities_Async_SingleThreadTaskScheduler.md&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>
|
|
</li>
|
|
<li>
|
|
<a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/2236b34fe80ae08107933a57221e788cccbc4668/IPA.Loader/Utilities/Async/SingleThreadTaskScheduler.cs/#L14" class="contribution-link">View Source</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
|
<h5>In This Article</h5>
|
|
<div></div>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<footer>
|
|
<div class="grad-bottom"></div>
|
|
<div class="footer">
|
|
<div class="container">
|
|
<span class="pull-right">
|
|
<a href="#top">Back to top</a>
|
|
</span>
|
|
|
|
<span>Generated by <strong>DocFX</strong></span>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
</div>
|
|
|
|
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
|
<script type="text/javascript" src="../styles/docfx.js"></script>
|
|
<script type="text/javascript" src="../styles/main.js"></script>
|
|
</body>
|
|
</html>
|