com.phloxui
Version:
PhloxUI Ng2+ Framework
363 lines • 19.7 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>IBackgroundProcessManager | com.phloxui</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">com.phloxui</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../globals.html">Globals</a>
</li>
<li>
<a href="../modules/_share_ibackgroundprocessmanager_.html">"share/IBackgroundProcessManager"</a>
</li>
<li>
<a href="_share_ibackgroundprocessmanager_.ibackgroundprocessmanager.html">IBackgroundProcessManager</a>
</li>
</ul>
<h1>Interface IBackgroundProcessManager</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p style="text-indent: 2em;">
A <code>ng</code> service interface mainly handles <code>application</code>'s <code>background process</code> executions.
Despite the <code>ng</code> framework provides you an <code>asynchronous</code> execution mechanism via <code>Promise</code>
or <code>Observer</code> already, this service aims to make all those <code>asynchronous</code> executions easily monitorable
by the user. For example, if your <code>application</code> needs to execute multiple <code>asynchronous</code> user's tasks
such as saving multiple documents to the backend server at the same time, by using this service, it will keep record of
those processes and give you the information about which one is running or is complete at any time.
</p>
</div>
<dl class="tsd-comment-tags">
<dt>author</dt>
<dd><p>shiorin, tee4cute</p>
</dd>
<dt>see</dt>
<dd><p><a href="../classes/_service_backgroundprocessmanager_service_.backgroundprocessmanager.html">BackgroundProcessManager</a></p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">IBackgroundProcessManager</span>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implemented by</h3>
<ul class="tsd-hierarchy">
<li><a href="../classes/_service_backgroundprocessmanager_service_.backgroundprocessmanager.html" class="tsd-signature-type">BackgroundProcessManager</a></li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_share_ibackgroundprocessmanager_.ibackgroundprocessmanager.html#execute" class="tsd-kind-icon">execute</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_share_ibackgroundprocessmanager_.ibackgroundprocessmanager.html#getrunningprocesses" class="tsd-kind-icon">get<wbr>Running<wbr>Processes</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="_share_ibackgroundprocessmanager_.ibackgroundprocessmanager.html#getrunningprocessescount" class="tsd-kind-icon">get<wbr>Running<wbr>Processes<wbr>Count</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="execute" class="tsd-anchor"></a>
<h3>execute</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">execute<span class="tsd-signature-symbol">(</span>processFunc<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</span>, option<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in share/IBackgroundProcessManager.ts:36</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p style="text-indent: 1em;">
Execute a new background process which will <code>perform</code> the given <code><b>processFunc</b></code>.
</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>processFunc: <span class="tsd-signature-type">Function</span></h5>
<div class="tsd-comment tsd-typography">
<p>A <code>function</code> which will be performed asynchronously.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> option: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<p>A configuration object. This depends on each implementation of this interface. But, at least, it should contain the following
properties:<br/>
<code>
{
"type": "string",
"name": "string"
}
</code></p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
<p>A <code>Promise</code> which will be <code>resolved</code> when the execution is done and its <code>result</code> is the value
returned from the given <code><b>processFunc</b></code>. If the given <code><b>processFunc</b></code> returns a <code>Promise</code>,
this method will return that <code>Promise</code> directly.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="getrunningprocesses" class="tsd-anchor"></a>
<h3>get<wbr>Running<wbr>Processes</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">get<wbr>Running<wbr>Processes<span class="tsd-signature-symbol">(</span>typeName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in share/IBackgroundProcessManager.ts:67</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p style="text-indent: 1em;">
Get <code>model</code>s of running processes by the given <code><b>typeName</b></code> and <code><b>name</b></code>. If you want to
get all running process <code>model</code>s in the system, just pass <code>null</code> into all parameters.
</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>typeName: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>A process <code>type name</code>. Passing <code>null</code> means no filter or including all <code>type name</code>s.</p>
</div>
</li>
<li>
<h5>name: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>A process <code>name</code>. Passing <code>null</code> means no filter or including all process <code>name</code>s.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h4>
<p>An array of running process <code>model</code>s according to the given <code><b>typeName</b></code> and <code><b>name</b></code>.
This method will return an <code>empty array</code> if no matching running process found.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="getrunningprocessescount" class="tsd-anchor"></a>
<h3>get<wbr>Running<wbr>Processes<wbr>Count</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">get<wbr>Running<wbr>Processes<wbr>Count<span class="tsd-signature-symbol">(</span>typeName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in share/IBackgroundProcessManager.ts:52</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p style="text-indent: 1em;">
Get the running processes count by the given <code><b>typeName</b></code> and <code><b>name</b></code>. If you want to
count all running processes in the system, just pass <code>null</code> into all parameters. The returning value of this method must be
the same as <code>array's length</code> returned from <a href="_share_ibackgroundprocessmanager_.ibackgroundprocessmanager.html#getrunningprocesses">getRunningProcesses</a> method.
</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>typeName: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>A process <code>type name</code>. Passing <code>null</code> means no filter or including all <code>type name</code>s.</p>
</div>
</li>
<li>
<h5>name: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>A process <code>name</code>. Passing <code>null</code> means no filter or including all process <code>name</code>s.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
<p>A number of running processes according to the given <code><b>typeName</b></code> and <code><b>name</b></code>.
This method will return <code>0</code> if no matching running process found.</p>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
<li class="current tsd-kind-external-module">
<a href="../modules/_share_ibackgroundprocessmanager_.html">"share/IBackground<wbr>Process<wbr>Manager"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-external-module">
<a href="_share_ibackgroundprocessmanager_.ibackgroundprocessmanager.html" class="tsd-kind-icon">IBackground<wbr>Process<wbr>Manager</a>
<ul>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_share_ibackgroundprocessmanager_.ibackgroundprocessmanager.html#execute" class="tsd-kind-icon">execute</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_share_ibackgroundprocessmanager_.ibackgroundprocessmanager.html#getrunningprocesses" class="tsd-kind-icon">get<wbr>Running<wbr>Processes</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="_share_ibackgroundprocessmanager_.ibackgroundprocessmanager.html#getrunningprocessescount" class="tsd-kind-icon">get<wbr>Running<wbr>Processes<wbr>Count</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>