mirror of
https://github.com/tgstation/tgstation-server.git
synced 2026-08-26 14:37:44 +01:00
98 lines
14 KiB
HTML
98 lines
14 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.15"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>tgstation-server: src/Tgstation.Server.Host/Jobs/IJobManager.cs Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectlogo"><img alt="Logo" src="tgs.ico"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">tgstation-server
|
|
</div>
|
|
<div id="projectbrief">The /tg/station 13 server suite</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.15 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_34761767c1c3cd212f9d2f80ea0828a8.html">Tgstation.Server.Host</a></li><li class="navelem"><a class="el" href="dir_27a421f75b087b80bd0b7a1dbec733b4.html">Jobs</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">IJobManager.cs</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="_i_job_manager_8cs.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="keyword">using</span> Microsoft.Extensions.Hosting;</div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="keyword">using</span> System;</div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="keyword">using</span> System.Threading;</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="keyword">using</span> System.Threading.Tasks;</div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="keyword">using</span> <a class="code" href="namespace_tgstation.html">Tgstation</a>.<a class="code" href="namespace_tgstation_1_1_server.html">Server</a>.<a class="code" href="namespace_tgstation_1_1_server_1_1_host.html">Host</a>.<a class="code" href="namespace_tgstation_1_1_server_1_1_host_1_1_database.html">Database</a>;</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="keyword">using</span> <a class="code" href="namespace_tgstation.html">Tgstation</a>.<a class="code" href="namespace_tgstation_1_1_server.html">Server</a>.<a class="code" href="namespace_tgstation_1_1_server_1_1_host.html">Host</a>.<a class="code" href="namespace_tgstation_1_1_server_1_1_host_1_1_models.html">Models</a>;</div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div><div class="line"><a name="l00008"></a><span class="lineno"><a class="line" href="namespace_tgstation_1_1_server_1_1_host_1_1_jobs.html"> 8</a></span> <span class="keyword">namespace </span><a class="code" href="namespace_tgstation_1_1_server_1_1_host_1_1_jobs.html">Tgstation.Server.Host.Jobs</a></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> {</div><div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_i_job_manager.html"> 13</a></span>  <span class="keyword">public</span> <span class="keyword">interface </span><a class="code" href="interface_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_i_job_manager.html">IJobManager</a> : <a class="code" href="class_i_hosted_service.html">IHostedService</a></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  {</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  <span class="keywordtype">int</span>? <a class="code" href="interface_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_i_job_manager.html#ae7faeff247c3770617a353653bf21c4c">JobProgress</a>(<a class="code" href="class_tgstation_1_1_server_1_1_host_1_1_models_1_1_job.html">Job</a> job);</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  Task <a class="code" href="interface_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_i_job_manager.html#ad13e45f48187be1d93f98f7dc60597d2">RegisterOperation</a>(<a class="code" href="class_tgstation_1_1_server_1_1_host_1_1_models_1_1_job.html">Job</a> job, Func<<a class="code" href="class_tgstation_1_1_server_1_1_host_1_1_models_1_1_job.html">Job</a>, <a class="code" href="interface_tgstation_1_1_server_1_1_host_1_1_database_1_1_i_database_context.html">IDatabaseContext</a>, Action<int>, CancellationToken, Task> operation, CancellationToken cancellationToken);</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#pragma warning disable CA1068 // CancellationToken parameters must come last https://github.com/dotnet/roslyn-analyzers/issues/1816</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  Task <a class="code" href="interface_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_i_job_manager.html#a04ad7543ef9c8863c1d8d0b46d17f522">WaitForJobCompletion</a>(<a class="code" href="class_tgstation_1_1_server_1_1_host_1_1_models_1_1_job.html">Job</a> job, <a class="code" href="class_tgstation_1_1_server_1_1_host_1_1_models_1_1_user.html">User</a> canceller, CancellationToken jobCancellationToken, CancellationToken cancellationToken);</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#pragma warning restore CA1068 // CancellationToken parameters must come last</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  Task<bool> <a class="code" href="interface_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_i_job_manager.html#a1b40e25839cf51f0a92c1daad842efeb">CancelJob</a>(<a class="code" href="class_tgstation_1_1_server_1_1_host_1_1_models_1_1_job.html">Job</a> job, <a class="code" href="class_tgstation_1_1_server_1_1_host_1_1_models_1_1_user.html">User</a> user, <span class="keywordtype">bool</span> blocking, CancellationToken cancellationToken);</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  }</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> }</div><div class="ttc" id="namespace_tgstation_1_1_server_1_1_host_1_1_models_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_models.html">Tgstation.Server.Host.Models</a></div><div class="ttdef"><b>Definition:</b> <a href="_tgstation_8_server_8_host_2_models_2_chat_bot_8cs_source.html#l00005">ChatBot.cs:5</a></div></div>
|
|
<div class="ttc" id="interface_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_i_job_manager_html_ae7faeff247c3770617a353653bf21c4c"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_i_job_manager.html#ae7faeff247c3770617a353653bf21c4c">Tgstation.Server.Host.Jobs.IJobManager.JobProgress</a></div><div class="ttdeci">int? JobProgress(Job job)</div><div class="ttdoc">Get the Api.Models.Job.Progress for a job</div></div>
|
|
<div class="ttc" id="interface_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_i_job_manager_html_a1b40e25839cf51f0a92c1daad842efeb"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_i_job_manager.html#a1b40e25839cf51f0a92c1daad842efeb">Tgstation.Server.Host.Jobs.IJobManager.CancelJob</a></div><div class="ttdeci">Task< bool > CancelJob(Job job, User user, bool blocking, CancellationToken cancellationToken)</div><div class="ttdoc">Cancels a give job</div></div>
|
|
<div class="ttc" id="class_tgstation_1_1_server_1_1_host_1_1_models_1_1_user_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_models_1_1_user.html">Tgstation.Server.Host.Models.User</a></div><div class="ttdef"><b>Definition:</b> <a href="_tgstation_8_server_8_host_2_models_2_user_8cs_source.html#l00008">User.cs:8</a></div></div>
|
|
<div class="ttc" id="interface_tgstation_1_1_server_1_1_host_1_1_database_1_1_i_database_context_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_database_1_1_i_database_context.html">Tgstation.Server.Host.Database.IDatabaseContext</a></div><div class="ttdoc">Represents the database</div><div class="ttdef"><b>Definition:</b> <a href="_i_database_context_8cs_source.html#l00012">IDatabaseContext.cs:12</a></div></div>
|
|
<div class="ttc" id="class_tgstation_1_1_server_1_1_host_1_1_models_1_1_job_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_models_1_1_job.html">Tgstation.Server.Host.Models.Job</a></div><div class="ttdef"><b>Definition:</b> <a href="_tgstation_8_server_8_host_2_models_2_job_8cs_source.html#l00010">Job.cs:10</a></div></div>
|
|
<div class="ttc" id="interface_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_i_job_manager_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_i_job_manager.html">Tgstation.Server.Host.Jobs.IJobManager</a></div><div class="ttdoc">Manages the runtime of Jobs</div><div class="ttdef"><b>Definition:</b> <a href="_i_job_manager_8cs_source.html#l00013">IJobManager.cs:13</a></div></div>
|
|
<div class="ttc" id="namespace_tgstation_1_1_server_1_1_host_1_1_jobs_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_jobs.html">Tgstation.Server.Host.Jobs</a></div><div class="ttdef"><b>Definition:</b> <a href="_i_job_manager_8cs_source.html#l00008">IJobManager.cs:8</a></div></div>
|
|
<div class="ttc" id="namespace_tgstation_1_1_server_html"><div class="ttname"><a href="namespace_tgstation_1_1_server.html">Tgstation.Server</a></div><div class="ttdef"><b>Definition:</b> <a href="_api_headers_8cs_source.html#l00012">ApiHeaders.cs:12</a></div></div>
|
|
<div class="ttc" id="class_i_hosted_service_html"><div class="ttname"><a href="class_i_hosted_service.html">IHostedService</a></div></div>
|
|
<div class="ttc" id="interface_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_i_job_manager_html_a04ad7543ef9c8863c1d8d0b46d17f522"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_i_job_manager.html#a04ad7543ef9c8863c1d8d0b46d17f522">Tgstation.Server.Host.Jobs.IJobManager.WaitForJobCompletion</a></div><div class="ttdeci">Task WaitForJobCompletion(Job job, User canceller, CancellationToken jobCancellationToken, CancellationToken cancellationToken)</div><div class="ttdoc">Wait for a given job to complete</div></div>
|
|
<div class="ttc" id="interface_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_i_job_manager_html_ad13e45f48187be1d93f98f7dc60597d2"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_jobs_1_1_i_job_manager.html#ad13e45f48187be1d93f98f7dc60597d2">Tgstation.Server.Host.Jobs.IJobManager.RegisterOperation</a></div><div class="ttdeci">Task RegisterOperation(Job job, Func< Job, IDatabaseContext, Action< int >, CancellationToken, Task > operation, CancellationToken cancellationToken)</div><div class="ttdoc">Registers a given Job and begins running it</div></div>
|
|
<div class="ttc" id="namespace_tgstation_1_1_server_1_1_host_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host.html">Tgstation.Server.Host</a></div><div class="ttdef"><b>Definition:</b> <a href="_byond_executable_lock_8cs_source.html#l00003">ByondExecutableLock.cs:3</a></div></div>
|
|
<div class="ttc" id="namespace_tgstation_1_1_server_1_1_host_1_1_database_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_database.html">Tgstation.Server.Host.Database</a></div><div class="ttdef"><b>Definition:</b> <a href="_database_connection_factory_8cs_source.html#l00008">DatabaseConnectionFactory.cs:8</a></div></div>
|
|
<div class="ttc" id="namespace_tgstation_html"><div class="ttname"><a href="namespace_tgstation.html">Tgstation</a></div><div class="ttdef"><b>Definition:</b> <a href="_api_headers_8cs_source.html#l00012">ApiHeaders.cs:12</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.15
|
|
</small></address>
|
|
</body>
|
|
</html>
|