Skip to content

Commit

Permalink
Deploying to site from @ b03f95c 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
squarejesse committed Jul 15, 2024
1 parent 9a4c723 commit 39e2ad0
Show file tree
Hide file tree
Showing 10 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion docs/latest/scripts/pages.json

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
<div class="cover ">
<h1 class="cover"><span>Zipline</span><wbr><span><span>Loader</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":zipline-loader:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">dispatcher<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineDispatcher///PointingToDeclaration/">CoroutineDispatcher</span><span class="token punctuation">, </span></span><span class="parameter ">manifestVerifier<span class="token operator">: </span><a href="../-manifest-verifier/index.html">ManifestVerifier</a><span class="token punctuation">, </span></span><span class="parameter ">httpClient<span class="token operator">: </span><a href="../-zipline-http-client/index.html">ZiplineHttpClient</a><span class="token punctuation">, </span></span><span class="parameter ">eventListener<span class="token operator">: </span><a href="../../../zipline/app.cash.zipline/-event-listener/index.html">EventListener</a><span class="token operator"> = </span>EventListener.NONE<span class="token punctuation">, </span></span><span class="parameter ">nowEpochMs<span class="token operator">: </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a><span class="token operator"> = </span>systemEpochMsClock</span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/cashapp/zipline/tree/trunk//zipline-loader/src/commonMain/kotlin/app/cash/zipline/loader/ZiplineLoader.kt#L68">source</a>)</span></span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":zipline-loader:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">dispatcher<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineDispatcher///PointingToDeclaration/">CoroutineDispatcher</span><span class="token punctuation">, </span></span><span class="parameter ">manifestVerifier<span class="token operator">: </span><a href="../-manifest-verifier/index.html">ManifestVerifier</a><span class="token punctuation">, </span></span><span class="parameter ">httpClient<span class="token operator">: </span><a href="../-zipline-http-client/index.html">ZiplineHttpClient</a><span class="token punctuation">, </span></span><span class="parameter ">eventListener<span class="token operator">: </span><a href="../../../zipline/app.cash.zipline/-event-listener/index.html">EventListener</a><span class="token operator"> = </span>EventListener.NONE<span class="token punctuation">, </span></span><span class="parameter ">nowEpochMs<span class="token operator">: </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -&gt; </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html">Long</a><span class="token operator"> = </span>systemEpochMsClock</span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/cashapp/zipline/tree/trunk//zipline-loader/src/commonMain/kotlin/app/cash/zipline/loader/ZiplineLoader.kt#L82">source</a>)</span></span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
<div class="cover ">
<h1 class="cover"><span>concurrent</span><wbr><span><span>Downloads</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":zipline-loader:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">var </span><a href="concurrent-downloads.html">concurrentDownloads</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/cashapp/zipline/tree/trunk//zipline-loader/src/commonMain/kotlin/app/cash/zipline/loader/ZiplineLoader.kt#L135">source</a>)</span></span></div><p class="paragraph">Callers can modify this as desired to change the default network download concurrency level.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":zipline-loader:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">var </span><a href="concurrent-downloads.html">concurrentDownloads</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/cashapp/zipline/tree/trunk//zipline-loader/src/commonMain/kotlin/app/cash/zipline/loader/ZiplineLoader.kt#L163">source</a>)</span></span></div><p class="paragraph">Callers can modify this as desired to change the default network download concurrency level.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
<div class="cover ">
<h1 class="cover"><span><span>download</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":zipline-loader:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="download.html"><span class="token function">download</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">applicationName<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">downloadFileSystem<span class="token operator">: </span><span data-unresolved-link="okio/FileSystem///PointingToDeclaration/">FileSystem</span><span class="token punctuation">, </span></span><span class="parameter ">downloadDir<span class="token operator">: </span><span data-unresolved-link="okio/Path///PointingToDeclaration/">Path</span><span class="token punctuation">, </span></span><span class="parameter ">manifestUrl<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/cashapp/zipline/tree/trunk//zipline-loader/src/commonMain/kotlin/app/cash/zipline/loader/ZiplineLoader.kt#L530">source</a>)</span></span></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":zipline-loader:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="download.html"><span class="token function">download</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">applicationName<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">downloadFileSystem<span class="token operator">: </span><span data-unresolved-link="okio/FileSystem///PointingToDeclaration/">FileSystem</span><span class="token punctuation">, </span></span><span class="parameter ">downloadDir<span class="token operator">: </span><span data-unresolved-link="okio/Path///PointingToDeclaration/">Path</span><span class="token punctuation">, </span></span><span class="parameter ">manifestUrl<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/cashapp/zipline/tree/trunk//zipline-loader/src/commonMain/kotlin/app/cash/zipline/loader/ZiplineLoader.kt#L559">source</a>)</span></span></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
<div class="breadcrumbs"><a href="../../index.html">zipline-loader</a><span class="delimiter">/</span><a href="../index.html">app.cash.zipline.loader</a><span class="delimiter">/</span><span class="current">ZiplineLoader</span></div>
<div class="cover ">
<h1 class="cover"><span>Zipline</span><wbr><span><span>Loader</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":zipline-loader:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="index.html">ZiplineLoader</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/cashapp/zipline/tree/trunk//zipline-loader/src/commonMain/kotlin/app/cash/zipline/loader/ZiplineLoader.kt#L58">source</a>)</span></span></div><p class="paragraph">Gets code from an HTTP server, or optional local cache or embedded filesystem, and handles with a receiver (by default, loads it into a zipline instance).</p><p class="paragraph">Loader attempts to load code as quickly as possible with concurrent network downloads and code loading.</p></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":zipline-loader:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="index.html">ZiplineLoader</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/cashapp/zipline/tree/trunk//zipline-loader/src/commonMain/kotlin/app/cash/zipline/loader/ZiplineLoader.kt#L71">source</a>)</span></span></div><p class="paragraph">Gets code from an HTTP server, or optional local cache or embedded filesystem, and handles with a receiver (by default, loads it into a zipline instance).</p><p class="paragraph">Loader attempts to load code as quickly as possible with concurrent network downloads and code loading.</p><h1 class="">Concurrency</h1><p class="paragraph">This class uses two different coroutine dispatchers:</p><ul><li><p class="paragraph">The <a href="../../../zipline-loader/app.cash.zipline.loader/-zipline-loader/dispatcher.html">dispatcher</a> is the only dispatcher permitted to call functions on the returned <a href="../../../zipline/app.cash.zipline/-zipline/index.html">Zipline</a> instance. Each instance is thread-confined and this dispatcher must implement that enforcement.</p></li><li><p class="paragraph">The <a href="../../../zipline-loader/app.cash.zipline.loader/-zipline-loader/cache-dispatcher.html">cacheDispatcher</a> is the only dispatcher permitted to call functions on <a href="../-zipline-cache/index.html">ZiplineCache</a>. The cache is also thread-confined, and the two threads may be different.</p></li></ul><p class="paragraph">In applications where multiple <a href="../../../zipline/app.cash.zipline/-zipline/index.html">Zipline</a> instances are used, but the instances all share a cache, there should be N + 1 dispatchers: one for the cache plus another for each application.</p></div></div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
Expand Down Expand Up @@ -152,17 +152,17 @@ <h2 class="">Functions</h2>
</div>
</div>
</div>
<a data-name="-1512232900%2FFunctions%2F-412860760" anchor-label="withCache" id="-1512232900%2FFunctions%2F-412860760" data-filterable-set=":zipline-loader:dokkaHtmlPartial/commonMain"></a>
<a data-name="-254788381%2FFunctions%2F-412860760" anchor-label="withCache" id="-254788381%2FFunctions%2F-412860760" data-filterable-set=":zipline-loader:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":zipline-loader:dokkaHtmlPartial/commonMain" data-filterable-set=":zipline-loader:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="with-cache.html"><span>with</span><wbr><span><span>Cache</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1512232900%2FFunctions%2F-412860760"></span>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-254788381%2FFunctions%2F-412860760"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":zipline-loader:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">fun </span><a href="with-cache.html"><span class="token function">withCache</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">cache<span class="token operator">: </span><a href="../-zipline-cache/index.html">ZiplineCache</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">ZiplineLoader</a></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":zipline-loader:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">fun </span><a href="with-cache.html"><span class="token function">withCache</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">cache<span class="token operator">: </span><a href="../-zipline-cache/index.html">ZiplineCache</a><span class="token punctuation">, </span></span><span class="parameter ">cacheDispatcher<span class="token operator">: </span><span data-unresolved-link="kotlinx.coroutines/CoroutineDispatcher///PointingToDeclaration/">CoroutineDispatcher</span><span class="token operator">?</span><span class="token operator"> = </span>null</span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="index.html">ZiplineLoader</a></div></div></div>
</div>
</div>
</div>
Expand Down
Loading

0 comments on commit 39e2ad0

Please sign in to comment.