mirror of
https://github.com/InsanusMokrassar/TelegramBotAPI.git
synced 2024-12-28 11:37:13 +00:00
84 lines
12 KiB
HTML
84 lines
12 KiB
HTML
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>ExceptionsOnlyLimiter</title>
|
|
<link href="../../../../../../images/logo-icon.svg" rel="icon" type="image/svg"><script>var pathToRoot = "../../../";</script><script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script><link href="../../../styles/style.css" rel="Stylesheet"><link href="../../../styles/logo-styles.css" rel="Stylesheet"><link href="../../../styles/jetbrains-mono.css" rel="Stylesheet"><link href="../../../styles/main.css" rel="Stylesheet"><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" async="async"></script> </head>
|
|
<body>
|
|
<div id="container">
|
|
<div id="leftColumn"><a href="../../../index.html">
|
|
<div id="logo"></div>
|
|
</a>
|
|
<div id="paneSearch"></div>
|
|
<div id="sideMenu"></div>
|
|
</div>
|
|
<div id="main">
|
|
<div id="leftToggler"><span class="icon-toggler"></span></div>
|
|
<script type="text/javascript" src="../../../scripts/main.js"></script> <div class="main-content" id="content" pageIds="docs::dev.inmo.tgbotapi.bot.settings.limiters/ExceptionsOnlyLimiter///PointingToDeclaration//1141957422">
|
|
<div class="navigation-wrapper" id="navigation-wrapper">
|
|
<div class="breadcrumbs"><a href="../../../index.html">docs</a>/<a href="../index.html">dev.inmo.tgbotapi.bot.settings.limiters</a>/<a href="index.html">ExceptionsOnlyLimiter</a></div>
|
|
<div class="pull-right d-flex">
|
|
<div class="filter-section" id="filter-section"><button class="platform-tag platform-selector common-like" data-active="" data-filter=":docs:dokkaHtml/commonMain">common</button></div>
|
|
<div id="searchBar"></div>
|
|
</div>
|
|
</div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span>Exceptions</span><wbr></wbr><span>Only</span><wbr></wbr><span>Limiter</span></h1>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div class="symbol monospace">class <a href="index.html">ExceptionsOnlyLimiter</a>(defaultTooManyRequestsDelay: <a href="../../dev.inmo.tgbotapi.types/index.html#%5Bdev.inmo.tgbotapi.types%2FMilliSeconds%2F%2F%2FPointingToDeclaration%2F%5D%2FClasslikes%2F1141957422">MilliSeconds</a>) : <a href="../-request-limiter/index.html">RequestLimiter</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><p class="paragraph">This limiter will limit requests only after getting a <a href="../../dev.inmo.tgbotapi.types/-retry-after-error/index.html">RetryAfterError</a> or <span data-unresolved-link="io.ktor.client.features/ClientRequestException///PointingToDeclaration/">ClientRequestException</span> with <span data-unresolved-link="io.ktor.http/HttpStatusCode.Companion/TooManyRequests/#/PointingToDeclaration/">HttpStatusCode.TooManyRequests</span> status code. Important thing is that in case if some of block has been blocked, all the others will wait until it will be possible to be called</p></div></div>
|
|
</div>
|
|
<div class="tabbedcontent">
|
|
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Constructors">Constructors</button><button class="section-tab" data-togglable="Functions">Functions</button><button class="section-tab" data-togglable="Parameters">Parameters</button></div>
|
|
<div class="tabs-section-body">
|
|
<h2 class="">Parameters</h2>
|
|
<div data-togglable="Parameters">
|
|
<div class="platform-hinted WithExtraAttributes" data-platform-hinted="data-platform-hinted" data-togglable="Parameters"><div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div data-togglable="Parameters"><div class="table" data-togglable="Parameters"><div class="table-row" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain"><div class="main-subrow keyValue WithExtraAttributes"><div class=""><span class="inline-flex">defaultTooManyRequestsDelay</span></div><div><div class="title"><div data-togglable="Parameters"><p class="paragraph">This parameter will be used in case of getting <span data-unresolved-link="io.ktor.client.features/ClientRequestException///PointingToDeclaration/">ClientRequestException</span> with <span data-unresolved-link="io.ktor.http/HttpStatusCode.Companion/TooManyRequests/#/PointingToDeclaration/">HttpStatusCode.TooManyRequests</span> as a parameter for delay like it would be <a href="../../dev.inmo.tgbotapi.bot.exceptions/-too-much-requests-exception/index.html">TooMuchRequestsException</a>. The reason of it is that in <span data-unresolved-link="io.ktor.client.features/ClientRequestException///PointingToDeclaration/">ClientRequestException</span> there is no information about required delay between requests</p></div></div></div></div></div></div></div></div></div>
|
|
</div>
|
|
<h2 class="tabbedcontent">Constructors</h2>
|
|
<div class="table" data-togglable="Constructors"><a data-name="%5Bdev.inmo.tgbotapi.bot.settings.limiters%2FExceptionsOnlyLimiter%2FExceptionsOnlyLimiter%2F%23kotlin.Long%2FPointingToDeclaration%2F%5D%2FConstructors%2F1141957422" anchor-label="ExceptionsOnlyLimiter" id="%5Bdev.inmo.tgbotapi.bot.settings.limiters%2FExceptionsOnlyLimiter%2FExceptionsOnlyLimiter%2F%23kotlin.Long%2FPointingToDeclaration%2F%5D%2FConstructors%2F1141957422" data-filterable-set=":docs:dokkaHtml/commonMain"></a>
|
|
<div class="table-row" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain">
|
|
<div class="main-subrow keyValue TabbedContent">
|
|
<div class=""><span class="inline-flex"><a href="-exceptions-only-limiter.html">ExceptionsOnlyLimiter</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bdev.inmo.tgbotapi.bot.settings.limiters%2FExceptionsOnlyLimiter%2FExceptionsOnlyLimiter%2F%23kotlin.Long%2FPointingToDeclaration%2F%5D%2FConstructors%2F1141957422"></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="platform-tags ">
|
|
<div class="platform-tag common-like">common</div>
|
|
</div>
|
|
<div class="title">
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div class="symbol monospace">fun <a href="-exceptions-only-limiter.html">ExceptionsOnlyLimiter</a>(defaultTooManyRequestsDelay: <a href="../../dev.inmo.tgbotapi.types/index.html#%5Bdev.inmo.tgbotapi.types%2FMilliSeconds%2F%2F%2FPointingToDeclaration%2F%5D%2FClasslikes%2F1141957422">MilliSeconds</a> = 1000L)<span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="brief ">This parameter will be used in case of getting <span data-unresolved-link="io.ktor.client.features/ClientRequestException///PointingToDeclaration/">ClientRequestException</span> with <span data-unresolved-link="io.ktor.http/HttpStatusCode.Companion/TooManyRequests/#/PointingToDeclaration/">HttpStatusCode.TooManyRequests</span> as a parameter for delay like it would be <a href="../../dev.inmo.tgbotapi.bot.exceptions/-too-much-requests-exception/index.html">TooMuchRequestsException</a>.</div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2 class="">Functions</h2>
|
|
<div class="table" data-togglable="Functions"><a data-name="%5Bdev.inmo.tgbotapi.bot.settings.limiters%2FExceptionsOnlyLimiter%2Flimit%2F%23kotlin.coroutines.SuspendFunction0%5BTypeParam%28bounds%3D%5Bkotlin.Any%3F%5D%29%5D%2FPointingToDeclaration%2F%5D%2FFunctions%2F1141957422" anchor-label="limit" id="%5Bdev.inmo.tgbotapi.bot.settings.limiters%2FExceptionsOnlyLimiter%2Flimit%2F%23kotlin.coroutines.SuspendFunction0%5BTypeParam%28bounds%3D%5Bkotlin.Any%3F%5D%29%5D%2FPointingToDeclaration%2F%5D%2FFunctions%2F1141957422" data-filterable-set=":docs:dokkaHtml/commonMain"></a>
|
|
<div class="table-row" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain">
|
|
<div class="main-subrow keyValue ">
|
|
<div class=""><span class="inline-flex"><a href="limit.html">limit</a><span class="anchor-wrapper"><span class="anchor-icon" pointing-to="%5Bdev.inmo.tgbotapi.bot.settings.limiters%2FExceptionsOnlyLimiter%2Flimit%2F%23kotlin.coroutines.SuspendFunction0%5BTypeParam%28bounds%3D%5Bkotlin.Any%3F%5D%29%5D%2FPointingToDeclaration%2F%5D%2FFunctions%2F1141957422"></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="platform-tags ">
|
|
<div class="platform-tag common-like">common</div>
|
|
</div>
|
|
<div class="title"><div class="divergent-group" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain"><div class="with-platform-tags"><span class="pull-right"></span></div>
|
|
|
|
<div>
|
|
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div class="symbol monospace">open suspend override fun <<a href="limit.html">T</a>> <a href="limit.html">limit</a>(block: suspend () -> <a href="limit.html">T</a>): <a href="limit.html">T</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
|
|
</div>
|
|
<a data-name="%5Bdev.inmo.tgbotapi.bot.settings.limiters%2FExceptionsOnlyLimiter%2Flimit%2F%23kotlin.coroutines.SuspendFunction0%5BTypeParam%28bounds%3D%5Bkotlin.Any%3F%5D%29%5D%2FPointingToDeclaration%2F%5D%2FFunctions%2F1141957422" anchor-label="limit" id="%5Bdev.inmo.tgbotapi.bot.settings.limiters%2FExceptionsOnlyLimiter%2Flimit%2F%23kotlin.coroutines.SuspendFunction0%5BTypeParam%28bounds%3D%5Bkotlin.Any%3F%5D%29%5D%2FPointingToDeclaration%2F%5D%2FFunctions%2F1141957422" data-filterable-set=":docs:dokkaHtml/commonMain"></a><div class="brief "><a data-name="%5Bdev.inmo.tgbotapi.bot.settings.limiters%2FExceptionsOnlyLimiter%2Flimit%2F%23kotlin.coroutines.SuspendFunction0%5BTypeParam%28bounds%3D%5Bkotlin.Any%3F%5D%29%5D%2FPointingToDeclaration%2F%5D%2FFunctions%2F1141957422" anchor-label="limit" id="%5Bdev.inmo.tgbotapi.bot.settings.limiters%2FExceptionsOnlyLimiter%2Flimit%2F%23kotlin.coroutines.SuspendFunction0%5BTypeParam%28bounds%3D%5Bkotlin.Any%3F%5D%29%5D%2FPointingToDeclaration%2F%5D%2FFunctions%2F1141957422" data-filterable-set=":docs:dokkaHtml/commonMain"></a>Use limit for working of block (like delay between or after, for example)</div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="footer"><span class="go-to-top-icon"><a href="#content"></a></span><span>© 2021 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></div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|
|
|