2021-12-26 16:15:04 +00:00
< html >
< head >
< meta name = "viewport" content = "width=device-width, initial-scale=1" charset = "UTF-8" >
< title > [common]UpdatableStatesMachine< / title >
2021-12-29 20:59:26 +00:00
< link href = "../../../images/logo-icon.svg" rel = "icon" type = "image/svg" > < script > var pathToRoot = "../../../" ; < / script > < script > c o n s t s t o r a g e = l o c a l S t o r a g e . g e t I t e m ( " d o k k a - d a r k - m o d e " )
const savedDarkMode = storage ? JSON.parse(storage) : false
if(savedDarkMode === true){
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}< / script >
2022-01-18 13:02:16 +00:00
< 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 >
2021-12-26 16:15:04 +00:00
< body >
2021-12-29 20:59:26 +00:00
< div class = "navigation-wrapper" id = "navigation-wrapper" >
< div id = "leftToggler" > < span class = "icon-toggler" > < / span > < / div >
< div class = "library-name" > < a href = "../../../index.html" > micro_utils.dokka< / a > < / div >
2022-02-07 17:14:36 +00:00
< div > 0.9.6< / div >
2021-12-29 20:59:26 +00:00
< div class = "pull-right d-flex" >
< div class = "filter-section" id = "filter-section" > < button class = "platform-tag platform-selector jvm-like" data-active = "" data-filter = ":micro_utils.dokka:dokkaHtml/androidMain" > android< / button > < button class = "platform-tag platform-selector common-like" data-active = "" data-filter = ":micro_utils.dokka:dokkaHtml/commonMain" > common< / button > < button class = "platform-tag platform-selector jvm-like" data-active = "" data-filter = ":micro_utils.dokka:dokkaHtml/jvmMain" > jvm< / button > < / div >
< button id = "theme-toggle-button" > < span id = "theme-toggle" > < / span > < / button >
< div id = "searchBar" > < / div >
< / div >
< / div >
2021-12-26 16:15:04 +00:00
< div id = "container" >
2021-12-29 20:59:26 +00:00
< div id = "leftColumn" >
2021-12-26 16:15:04 +00:00
< div id = "sideMenu" > < / div >
< / div >
2022-01-18 13:02:16 +00:00
< div id = "main" >
2021-12-29 20:59:26 +00:00
< div class = "main-content" id = "content" pageIds = "micro_utils.dokka::dev.inmo.micro_utils.fsm.common/UpdatableStatesMachine///PointingToDeclaration//-1478683138" >
< div class = "breadcrumbs" > < a href = "../../../index.html" > micro_utils.dokka< / a > /< a href = "../index.html" > dev.inmo.micro_utils.fsm.common< / a > /< a href = "index.html" > [common]UpdatableStatesMachine< / a > < / div >
2021-12-26 16:15:04 +00:00
< div class = "cover " >
< h1 class = "cover" > < span > Updatable< / span > < wbr > < / wbr > < span > States< / span > < wbr > < / wbr > < span > < span > Machine< / span > < / span > < / h1 >
2021-12-29 20:59:26 +00:00
< 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 = ":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set = ":micro_utils.dokka:dokkaHtml/commonMain" data-active = "" data-toggle = ":micro_utils.dokka:dokkaHtml/commonMain" > common< / button > < / div >
< div class = "content sourceset-depenent-content" data-active = "" data-togglable = ":micro_utils.dokka:dokkaHtml/commonMain" > < div class = "symbol monospace" > < span class = "token keyword" > interface < / span > < a href = "index.html" > UpdatableStatesMachine< / a > < span class = "token operator" > < < / span > < span class = "token keyword" > < / span > < a href = "index.html" > T< / a > < span class = "token operator" > : < / span > < a href = "../[common]-state/index.html" > State< / a > < span class = "token operator" > > < / span > : < a href = "../[common]-states-machine/index.html" > StatesMachine< / a > < span class = "token operator" > < < / span > < span class = "token keyword" > < / span > < a href = "index.html" > T< / a > < span class = "token operator" > > < / 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 > < p class = "paragraph" > This extender of < a href = "../[common]-states-machine/index.html" > StatesMachine< / a > interface declare one new function < a href = "update-chain.html" > updateChain< / a > . Realizations of this interface must be able to perform update of chain in internal < a href = "../[common]-states-manager/index.html" > StatesManager< / a > < / p > < / div > < / div >
2021-12-26 16:15:04 +00:00
< / div >
< div class = "tabbedcontent" >
< div class = "tabs-section" tabs-section = "tabs-section" > < button class = "section-tab" data-active = "" data-togglable = "Functions" > Functions< / button > < button class = "section-tab" data-togglable = "Inheritors" > Inheritors< / button > < / div >
< div class = "tabs-section-body" >
< h2 class = "" > Functions< / h2 >
< div class = "table" data-togglable = "Functions" > < a data-name = "1210167093%2FFunctions%2F-1478683138" anchor-label = "handleState" id = "1210167093%2FFunctions%2F-1478683138" data-filterable-set = ":micro_utils.dokka:dokkaHtml/commonMain" > < / a >
< 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 " >
2022-01-18 13:02:16 +00:00
< div class = "" > < span class = "inline-flex" >
< div > < a href = "../[common]-states-handler/handle-state.html" > < span > handle< / span > < wbr > < / wbr > < span > < span > State< / span > < / span > < / a > < / div >
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "1210167093%2FFunctions%2F-1478683138" > < / span >
2021-12-26 16:15:04 +00:00
< div class = "copy-popup-wrapper " > < span class = "copy-popup-icon" > < / span > < span > Link copied to clipboard< / span > < / div >
< / span > < / span > < / div >
< div >
2021-12-29 20:59:26 +00:00
< 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 = ":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set = ":micro_utils.dokka:dokkaHtml/commonMain" data-active = "" data-toggle = ":micro_utils.dokka:dokkaHtml/commonMain" > common< / button > < / div >
< div class = "content sourceset-depenent-content" data-active = "" data-togglable = ":micro_utils.dokka:dokkaHtml/commonMain" > < div class = "symbol monospace" > < span class = "token keyword" > abstract < / span > < span class = "token keyword" > suspend < / span > < span class = "token keyword" > fun < / span > < a href = "../[common]-states-machine/index.html" > StatesMachine< / a > < span class = "token operator" > < < / span > < span class = "token keyword" > in < / span > < a href = "index.html" > T< / a > < span class = "token operator" > > < / span > < span class = "token punctuation" > .< / span > < a href = "../[common]-states-handler/handle-state.html" > < span class = "token function" > handleState< / span > < / a > < span class = "token punctuation" > (< / span > state< span class = "token operator" > : < / span > < a href = "index.html" > T< / a > < span class = "token punctuation" > )< / span > < span class = "token operator" > : < / span > < a href = "index.html" > T< / a > < span class = "token operator" > ?< / 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 class = "brief " > < p class = "paragraph" > Main handling of < a href = "../[common]-states-handler/handle-state.html" > state< / a > . In case when this < a href = "../[common]-states-handler/handle-state.html" > state< / a > leads to another < a href = "../[common]-state/index.html" > State< / a > and < a href = "../[common]-states-handler/handle-state.html" > handleState< / a > returns not null < a href = "../[common]-state/index.html" > State< / a > it is assumed that chain is not completed.< / p > < / div > < / div > < / div >
2021-12-26 16:15:04 +00:00
< / div >
< / div >
< / div >
< / div >
< a data-name = "-1673894440%2FFunctions%2F-1478683138" anchor-label = "launchStateHandling" id = "-1673894440%2FFunctions%2F-1478683138" data-filterable-set = ":micro_utils.dokka:dokkaHtml/commonMain" > < / a >
< 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 " >
2022-01-18 13:02:16 +00:00
< div class = "" > < span class = "inline-flex" >
< div > < a href = "../[common]-states-machine/launch-state-handling.html" > < span > launch< / span > < wbr > < / wbr > < span > State< / span > < wbr > < / wbr > < span > < span > Handling< / span > < / span > < / a > < / div >
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "-1673894440%2FFunctions%2F-1478683138" > < / span >
2021-12-26 16:15:04 +00:00
< div class = "copy-popup-wrapper " > < span class = "copy-popup-icon" > < / span > < span > Link copied to clipboard< / span > < / div >
< / span > < / span > < / div >
< div >
2021-12-29 20:59:26 +00:00
< 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 = ":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set = ":micro_utils.dokka:dokkaHtml/commonMain" data-active = "" data-toggle = ":micro_utils.dokka:dokkaHtml/commonMain" > common< / button > < / div >
< div class = "content sourceset-depenent-content" data-active = "" data-togglable = ":micro_utils.dokka:dokkaHtml/commonMain" > < div class = "symbol monospace" > < span class = "token keyword" > open < / span > < span class = "token keyword" > suspend < / span > < span class = "token keyword" > fun < / span > < a href = "../[common]-states-machine/launch-state-handling.html" > < span class = "token function" > launchStateHandling< / span > < / a > < span class = "token punctuation" > (< / span > state< span class = "token operator" > : < / span > < a href = "index.html" > T< / a > < span class = "token punctuation" > , < / span > handlers< span class = "token operator" > : < / span > < a href = "https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html" > List< / a > < span class = "token operator" > < < / span > < span class = "token keyword" > < / span > < a href = "../[common]-checkable-handler-holder/index.html" > CheckableHandlerHolder< / a > < span class = "token operator" > < < / span > < span class = "token keyword" > in < / span > < a href = "index.html" > T< / a > < span class = "token punctuation" > , < / span > < span class = "token keyword" > < / span > < a href = "index.html" > T< / a > < span class = "token operator" > > < / span > < span class = "token operator" > > < / span > < span class = "token punctuation" > )< / span > < span class = "token operator" > : < / span > < a href = "index.html" > T< / a > < span class = "token operator" > ?< / 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 >
2021-12-26 16:15:04 +00:00
< / div >
< / div >
< / div >
< / div >
< a data-name = "1816937877%2FFunctions%2F-1478683138" anchor-label = "start" id = "1816937877%2FFunctions%2F-1478683138" data-filterable-set = ":micro_utils.dokka:dokkaHtml/commonMain" > < / a >
< 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 " >
2022-01-18 13:02:16 +00:00
< div class = "" > < span class = "inline-flex" >
< div > < a href = "../[common]-states-machine/start.html" > < span > < span > start< / span > < / span > < / a > < / div >
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "1816937877%2FFunctions%2F-1478683138" > < / span >
2021-12-26 16:15:04 +00:00
< div class = "copy-popup-wrapper " > < span class = "copy-popup-icon" > < / span > < span > Link copied to clipboard< / span > < / div >
< / span > < / span > < / div >
< div >
2021-12-29 20:59:26 +00:00
< 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 = ":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set = ":micro_utils.dokka:dokkaHtml/commonMain" data-active = "" data-toggle = ":micro_utils.dokka:dokkaHtml/commonMain" > common< / button > < / div >
< div class = "content sourceset-depenent-content" data-active = "" data-togglable = ":micro_utils.dokka:dokkaHtml/commonMain" > < div class = "symbol monospace" > < span class = "token keyword" > abstract < / span > < span class = "token keyword" > < / span > < span class = "token keyword" > fun < / span > < a href = "../[common]-states-machine/start.html" > < span class = "token function" > start< / span > < / a > < span class = "token punctuation" > (< / span > scope< span class = "token operator" > : < / span > < span data-unresolved-link = "kotlinx.coroutines/CoroutineScope///PointingToDeclaration/" > CoroutineScope< / span > < span class = "token punctuation" > )< / span > < span class = "token operator" > : < / span > < span data-unresolved-link = "kotlinx.coroutines/Job///PointingToDeclaration/" > Job< / 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 class = "brief " > < p class = "paragraph" > Starts handling of < a href = "../[common]-state/index.html" > State< / a > s< / p > < / div > < / div > < / div >
2021-12-26 16:15:04 +00:00
< / div >
< / div >
< / div >
< / div >
< a data-name = "-1903622856%2FFunctions%2F-1478683138" anchor-label = "startChain" id = "-1903622856%2FFunctions%2F-1478683138" data-filterable-set = ":micro_utils.dokka:dokkaHtml/commonMain" > < / a >
< 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 " >
2022-01-18 13:02:16 +00:00
< div class = "" > < span class = "inline-flex" >
< div > < a href = "../[common]-states-machine/start-chain.html" > < span > start< / span > < wbr > < / wbr > < span > < span > Chain< / span > < / span > < / a > < / div >
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "-1903622856%2FFunctions%2F-1478683138" > < / span >
2021-12-26 16:15:04 +00:00
< div class = "copy-popup-wrapper " > < span class = "copy-popup-icon" > < / span > < span > Link copied to clipboard< / span > < / div >
< / span > < / span > < / div >
< div >
2021-12-29 20:59:26 +00:00
< 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 = ":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set = ":micro_utils.dokka:dokkaHtml/commonMain" data-active = "" data-toggle = ":micro_utils.dokka:dokkaHtml/commonMain" > common< / button > < / div >
< div class = "content sourceset-depenent-content" data-active = "" data-togglable = ":micro_utils.dokka:dokkaHtml/commonMain" > < div class = "symbol monospace" > < span class = "token keyword" > abstract < / span > < span class = "token keyword" > suspend < / span > < span class = "token keyword" > fun < / span > < a href = "../[common]-states-machine/start-chain.html" > < span class = "token function" > startChain< / span > < / a > < span class = "token punctuation" > (< / span > state< span class = "token operator" > : < / span > < a href = "index.html" > T< / a > < 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 class = "brief " > < p class = "paragraph" > Start chain of < a href = "../[common]-state/index.html" > State< / a > s witn < a href = "../[common]-states-machine/start-chain.html" > state< / a > < / p > < / div > < / div > < / div >
2021-12-26 16:15:04 +00:00
< / div >
< / div >
< / div >
< / div >
< a data-name = "-1587467804%2FFunctions%2F-1478683138" anchor-label = "updateChain" id = "-1587467804%2FFunctions%2F-1478683138" data-filterable-set = ":micro_utils.dokka:dokkaHtml/commonMain" > < / a >
< 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 " >
2022-01-18 13:02:16 +00:00
< div class = "" > < span class = "inline-flex" >
< div > < a href = "update-chain.html" > < span > update< / span > < wbr > < / wbr > < span > < span > Chain< / span > < / span > < / a > < / div >
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "-1587467804%2FFunctions%2F-1478683138" > < / span >
2021-12-26 16:15:04 +00:00
< div class = "copy-popup-wrapper " > < span class = "copy-popup-icon" > < / span > < span > Link copied to clipboard< / span > < / div >
< / span > < / span > < / div >
< div >
2021-12-29 20:59:26 +00:00
< 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 = ":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set = ":micro_utils.dokka:dokkaHtml/commonMain" data-active = "" data-toggle = ":micro_utils.dokka:dokkaHtml/commonMain" > common< / button > < / div >
< div class = "content sourceset-depenent-content" data-active = "" data-togglable = ":micro_utils.dokka:dokkaHtml/commonMain" > < div class = "symbol monospace" > < span class = "token keyword" > abstract < / span > < span class = "token keyword" > suspend < / span > < span class = "token keyword" > fun < / span > < a href = "update-chain.html" > < span class = "token function" > updateChain< / span > < / a > < span class = "token punctuation" > (< / span > currentState< span class = "token operator" > : < / span > < a href = "index.html" > T< / a > < span class = "token punctuation" > , < / span > newState< span class = "token operator" > : < / span > < a href = "index.html" > T< / a > < 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 class = "brief " > < p class = "paragraph" > Update chain with current state equal to < a href = "update-chain.html" > currentState< / a > with < a href = "update-chain.html" > newState< / a > . Behaviour of this update preforming in cases when < a href = "update-chain.html" > currentState< / a > does not exist in < a href = "../[common]-states-manager/index.html" > StatesManager< / a > must be declared inside of realization of < a href = "../[common]-states-manager/update.html" > StatesManager.update< / a > function< / p > < / div > < / div > < / div >
2021-12-26 16:15:04 +00:00
< / div >
< / div >
< / div >
< / div >
< / div >
< h2 class = "" > Inheritors< / h2 >
< div class = "table" data-togglable = "Inheritors" > < a data-name = "1080667633%2FInheritors%2F1737121690" anchor-label = "DefaultUpdatableStatesMachine" id = "1080667633%2FInheritors%2F1737121690" data-filterable-set = ":micro_utils.dokka:dokkaHtml/androidMain :micro_utils.dokka:dokkaHtml/commonMain :micro_utils.dokka:dokkaHtml/jvmMain" > < / a >
< div class = "table-row" data-filterable-current = ":micro_utils.dokka:dokkaHtml/androidMain :micro_utils.dokka:dokkaHtml/commonMain :micro_utils.dokka:dokkaHtml/jvmMain" data-filterable-set = ":micro_utils.dokka:dokkaHtml/androidMain :micro_utils.dokka:dokkaHtml/commonMain :micro_utils.dokka:dokkaHtml/jvmMain" >
< div class = "main-subrow keyValue " >
2022-01-18 13:02:16 +00:00
< div class = "" > < span class = "inline-flex" >
< div > < span data-unresolved-link = "dev.inmo.micro_utils.fsm.common/DefaultUpdatableStatesMachine///PointingToDeclaration/" > DefaultUpdatableStatesMachine< / span > < / div >
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "1080667633%2FInheritors%2F1737121690" > < / span >
2021-12-26 16:15:04 +00:00
< div class = "copy-popup-wrapper " > < span class = "copy-popup-icon" > < / span > < span > Link copied to clipboard< / span > < / div >
< / span > < / span > < / div >
< div > < / div >
< / div >
< / div >
< / div >
< / div >
< / div >
< / div >
2022-01-08 10:15:47 +00:00
< 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 >
2021-12-26 16:15:04 +00:00
< / div >
< / div >
< / body >
< / html >
