<!DOCTYPE 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>const storage = localStorage.getItem("dokka-dark-mode") const savedDarkMode = storage ? JSON.parse(storage) : false if(savedDarkMode === true){ document.getElementsByTagName("html")[0].classList.add("theme-dark") }</script> <script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script> <link href="../../../styles/style.css" rel="Stylesheet"> <link href="../../../styles/jetbrains-mono.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"> <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> </head> <body> <div class="navigation-wrapper" id="navigation-wrapper"> <div id="leftToggler"><span class="icon-toggler"></span></div> <div class="library-name"> <a href="../../../index.html"> <span>docs</span> </a> </div> <div> 3.2.3 </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> <button id="theme-toggle-button"><span id="theme-toggle"></span></button> <div id="searchBar"></div> </div> </div> <div id="container"> <div id="leftColumn"> <div id="sideMenu"></div> </div> <div id="main"> <div class="main-content" id="content" pageIds="docs::dev.inmo.tgbotapi.bot.settings.limiters/ExceptionsOnlyLimiter///PointingToDeclaration//-1982836883"> <div class="breadcrumbs"><a href="../../../index.html">docs</a><span class="delimiter">/</span><a href="../index.html">dev.inmo.tgbotapi.bot.settings.limiters</a><span class="delimiter">/</span><a href="index.html">ExceptionsOnlyLimiter</a></div> <div class="cover "> <h1 class="cover"><span>Exceptions</span><wbr></wbr><span>Only</span><wbr></wbr><span><span>Limiter</span></span></h1> <div class="platform-hinted with-platform-tabs" data-platform-hinted="data-platform-hinted"> <div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark common-like" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain" data-active="" data-toggle=":docs:dokkaHtml/commonMain">common</button></div> <div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="index.html">ExceptionsOnlyLimiter</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">defaultTooManyRequestsDelay<span class="token operator">: </span><a href="../../dev.inmo.tgbotapi.types/index.html#1266067951%2FClasslikes%2F-1982836883">MilliSeconds</a><span class="token operator"> = </span><span class="token constant">1000</span></span></span><span class="token punctuation">)</span> : <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.plugins/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 with-platform-tabs" data-platform-hinted="data-platform-hinted" data-togglable="Parameters"> <div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark common-like" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain" data-active="" data-toggle=":docs:dokkaHtml/commonMain">common</button></div> <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"><div><span>default</span><wbr></wbr><span>Too</span><wbr></wbr><span>Many</span><wbr></wbr><span>Requests</span><wbr></wbr><span><span>Delay</span></span></div></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.plugins/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.plugins/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="-1851131613%2FConstructors%2F-1982836883" anchor-label="ExceptionsOnlyLimiter" id="-1851131613%2FConstructors%2F-1982836883" 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"> <div><a href="-exceptions-only-limiter.html"><span>Exceptions</span><wbr></wbr><span>Only</span><wbr></wbr><span><span>Limiter</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1851131613%2FConstructors%2F-1982836883"></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 with-platform-tabs" data-platform-hinted="data-platform-hinted"> <div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark common-like" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain" data-active="" data-toggle=":docs:dokkaHtml/commonMain">common</button></div> <div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="-exceptions-only-limiter.html"><span class="token function">ExceptionsOnlyLimiter</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">defaultTooManyRequestsDelay<span class="token operator">: </span><a href="../../dev.inmo.tgbotapi.types/index.html#1266067951%2FClasslikes%2F-1982836883">MilliSeconds</a><span class="token operator"> = </span><span class="token constant">1000</span></span></span><span class="token punctuation">)</span><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> </div> </div> </div> </div> <h2 class="">Functions</h2> <div class="table" data-togglable="Functions"><a data-name="1966603133%2FFunctions%2F-1982836883" anchor-label="limit" id="1966603133%2FFunctions%2F-1982836883" 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"> <div><a href="limit.html"><span><span>limit</span></span></a></div> <span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1966603133%2FFunctions%2F-1982836883"></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 with-platform-tabs" data-platform-hinted="data-platform-hinted"> <div class="platform-bookmarks-row" data-toggle-list="data-toggle-list"><button class="platform-bookmark common-like" data-filterable-current=":docs:dokkaHtml/commonMain" data-filterable-set=":docs:dokkaHtml/commonMain" data-active="" data-toggle=":docs:dokkaHtml/commonMain">common</button></div> <div class="content sourceset-depenent-content" data-active="" data-togglable=":docs:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">suspend override </span><span class="token keyword">fun </span><span class="token operator"><</span><span class="token keyword"></span><a href="limit.html">T</a><span class="token operator">> </span><a href="limit.html"><span class="token function">limit</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">block<span class="token operator">: </span><span class="token keyword">suspend </span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator"> -> </span><span class="token keyword"></span><a href="limit.html">T</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><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 class="brief "><p class="paragraph">Use limit for working of block (like delay between or after, for example)</p></div></div> </div> </div> </div> </div> </div> </div> </div> </div> </div> <div class="footer"> <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2022 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>