InsanusMokrassar/MicroUtils
1
0
Fork 0
mirror of https://github.com/InsanusMokrassar/MicroUtils.git synced 2025-01-13 11:19:57 +00:00
Code Issues Packages Projects Releases Wiki Activity
2abbd2fe72
MicroUtils/micro_utils.dokka/dev.inmo.micro_utils.coroutines/join-first.html

128 lines
16 KiB
HTML
Raw Normal View History

deploy: 30389e8536089d52c5fe44b4af650bf8a6d3fb79
2024-07-15 10:45:58 +00:00
<!DOCTYPE html>
<html class="no-js">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>joinFirst</title>
<link href="../../images/logo-icon.svg" rel="icon" type="image/svg">
<script>var pathToRoot = "../../";</script>
<script>document.documentElement.classList.replace("no-js","js");</script>
<script>const storage = localStorage.getItem("dokka-dark-mode")
if (storage == null) {
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
<script type="text/javascript" src="../../scripts/sourceset_dependencies.js" async="async"></script>
<link href="../../styles/style.css" rel="Stylesheet">
<link href="../../styles/main.css" rel="Stylesheet">
<link href="../../styles/prism.css" rel="Stylesheet">
<link href="../../styles/logo-styles.css" rel="Stylesheet">
<link href="../../styles/font-jb-sans-auto.css" rel="Stylesheet">
deploy: ac68b0b941b98b52b2c1b5372c534f62f98a6b21
2024-12-21 03:30:22 +00:00
<link href="../../ui-kit/ui-kit.min.css" rel="Stylesheet">
deploy: 30389e8536089d52c5fe44b4af650bf8a6d3fb79
2024-07-15 10:45:58 +00:00
<script type="text/javascript" src="../../scripts/clipboard.js" async="async"></script>
<script type="text/javascript" src="../../scripts/navigation-loader.js" async="async"></script>
<script type="text/javascript" src="../../scripts/platform-content-handler.js" async="async"></script>
<script type="text/javascript" src="../../scripts/main.js" defer="defer"></script>
<script type="text/javascript" src="../../scripts/prism.js" async="async"></script>
deploy: ac68b0b941b98b52b2c1b5372c534f62f98a6b21
2024-12-21 03:30:22 +00:00
<script type="text/javascript" src="../../ui-kit/ui-kit.min.js" defer="defer"></script>
deploy: 30389e8536089d52c5fe44b4af650bf8a6d3fb79
2024-07-15 10:45:58 +00:00
<script type="text/javascript" src="../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
<div class="root">
deploy: ac68b0b941b98b52b2c1b5372c534f62f98a6b21
2024-12-21 03:30:22 +00:00
<nav class="navigation theme-dark" id="navigation-wrapper">
<a class="library-name--link" href="../../index.html">
micro_utils.dokka
</a>
<button class="navigation-controls--btn navigation-controls--btn_toc ui-kit_mobile-only" id="toc-toggle"
type="button">Toggle table of contents
</button>
<div class="navigation-controls--break ui-kit_mobile-only"></div>
<div class="library-version" id="library-version">
0.24.0 </div>
<div class="navigation-controls">
<div class="filter-section filter-section_loading" id="filter-section">
<button class="platform-tag platform-selector common-like" data-active=""
data-filter=":micro_utils.dokka:dokkaHtml/commonMain">common</button>
<div class="dropdown filter-section--dropdown" data-role="dropdown" id="filter-section-dropdown">
<button class="button button_dropdown filter-section--dropdown-toggle" role="combobox"
data-role="dropdown-toggle"
aria-controls="platform-tags-listbox"
aria-haspopup="listbox"
aria-expanded="false"
aria-label="Toggle source sets"
></button>
<ul role="listbox" id="platform-tags-listbox" class="dropdown--list" data-role="dropdown-listbox">
<div class="dropdown--header"><span>Platform filter</span>
<button class="button" data-role="dropdown-toggle" aria-label="Close platform filter">
<i class="ui-kit-icon ui-kit-icon_cross"></i>
</button>
</div>
<li role="option" class="dropdown--option platform-selector-option common-like" tabindex="0">
<label class="checkbox">
<input type="checkbox" class="checkbox--input" id=":micro_utils.dokka:dokkaHtml/commonMain"
data-filter=":micro_utils.dokka:dokkaHtml/commonMain"/>
<span class="checkbox--icon"></span>
common
</label>
</li>
</ul>
<div class="dropdown--overlay"></div>
deploy: 30389e8536089d52c5fe44b4af650bf8a6d3fb79
2024-07-15 10:45:58 +00:00
</div>
</div>
deploy: ac68b0b941b98b52b2c1b5372c534f62f98a6b21
2024-12-21 03:30:22 +00:00
<button class="navigation-controls--btn navigation-controls--btn_theme" id="theme-toggle-button"
type="button">Switch theme
</button>
<div class="navigation-controls--btn navigation-controls--btn_search" id="searchBar" role="button">Search in
API
</div>
deploy: 30389e8536089d52c5fe44b4af650bf8a6d3fb79
2024-07-15 10:45:58 +00:00
</div>
deploy: ac68b0b941b98b52b2c1b5372c534f62f98a6b21
2024-12-21 03:30:22 +00:00
</nav>
deploy: 30389e8536089d52c5fe44b4af650bf8a6d3fb79
2024-07-15 10:45:58 +00:00
<div id="container">
<div class="sidebar" id="leftColumn">
deploy: ac68b0b941b98b52b2c1b5372c534f62f98a6b21
2024-12-21 03:30:22 +00:00
<div class="dropdown theme-dark_mobile" data-role="dropdown" id="toc-dropdown">
<ul role="listbox" id="toc-listbox" class="dropdown--list dropdown--list_toc-list"
data-role="dropdown-listbox">
<div class="dropdown--header">
<span>
micro_utils.dokka
</span>
<button class="button" data-role="dropdown-toggle" aria-label="Close table of contents">
<i class="ui-kit-icon ui-kit-icon_cross"></i>
</button>
</div>
<div class="sidebar--inner" id="sideMenu"></div>
</ul>
<div class="dropdown--overlay"></div>
</div>
deploy: 30389e8536089d52c5fe44b4af650bf8a6d3fb79
2024-07-15 10:45:58 +00:00
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageIds="micro_utils.dokka::dev.inmo.micro_utils.coroutines//joinFirst/kotlin.collections.Iterable[kotlinx.coroutines.Job]#kotlinx.coroutines.CoroutineScope#kotlin.Boolean/PointingToDeclaration//-1478683138">
<div class="breadcrumbs"><a href="../../index.html">micro_utils.dokka</a><span class="delimiter">/</span><a href="index.html">dev.inmo.micro_utils.coroutines</a><span class="delimiter">/</span><span class="current">joinFirst</span></div>
<div class="cover ">
<h1 class="cover"><span>join</span><wbr></wbr><span><span>First</span></span></h1>
</div>
deploy: ac68b0b941b98b52b2c1b5372c534f62f98a6b21
2024-12-21 03:30:22 +00:00
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-iterable/index.html">Iterable</a><span class="token operator">&lt;</span><span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="join-first.html"><span class="token function">joinFirst</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">scope<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineScope///PointingToDeclaration/">CoroutineScope</span><span class="token punctuation">, </span></span><span class="parameter ">cancelOthers<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">true</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//coroutines/src/commonMain/kotlin/dev/inmo/micro_utils/coroutines/JoinFirst.kt#L12">source</a>)</span></span></div><p class="paragraph">Trying to <span data-unresolved-link="kotlinx.coroutines/Job/join/#/PointingToDeclaration/">Job.join</span> on all <span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">this</span>s. The first <span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span> completed its work will interrupt all others joins and, if <a href="join-first.html">cancelOthers</a> passed as true (<strong>by default</strong>), will also cancel all the others <span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span>s</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>scope</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Will be used to create <a href="-linked-supervisor-scope.html">CoroutineScope.LinkedSupervisorScope</a> and launch joining of all <span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span>s in it</p></div></div></div></div></div><hr><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-iterable/index.html">Iterable</a><span class="token operator">&lt;</span><span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span><span class="token operator">&gt;</span><span class="token punctuation">.</span><a href="join-first.html"><span class="token function">joinFirst</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">cancelOthers<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">true</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/Job///PointingToDeclaration/">Job</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//coroutines/src/commonMain/kotlin/dev/inmo/micro_utils/coroutines/JoinFirst.kt#L39">sourc
deploy: 30389e8536089d52c5fe44b4af650bf8a6d3fb79
2024-07-15 10:45:58 +00:00
</div>
deploy: ac68b0b941b98b52b2c1b5372c534f62f98a6b21
2024-12-21 03:30:22 +00:00
<div class="footer">
<a href="#content" id="go-to-top-link" class="footer--button footer--button_go-to-top"></a>
<span>© 2024 Copyright</span>
<span class="pull-right">
<span>Generated by </span>
<a class="footer--link footer--link_external" href="https://github.com/Kotlin/dokka">
<span>dokka</span>
</a>
</span>
</div>
deploy: 30389e8536089d52c5fe44b4af650bf8a6d3fb79
2024-07-15 10:45:58 +00:00
</div>
</div>
</div>
</body>
deploy: ac68b0b941b98b52b2c1b5372c534f62f98a6b21
2024-12-21 03:30:22 +00:00
</html>
Reference in New Issue Copy Permalink