diff --git a/.github/actions/detect-modified-projects/README.md b/.github/actions/detect-modified-projects/README.md index 751fd3db..e6e40333 100644 --- a/.github/actions/detect-modified-projects/README.md +++ b/.github/actions/detect-modified-projects/README.md @@ -6,18 +6,21 @@ This GitHub Action allows you to run gradle tasks on projects within your reposi ### Inputs -- `projects` (required): Projects to run the tasks on, comma-separated. -- `tasks` (required): Tasks to run on the projects, comma-separated. -- `parent_project_task` (optional): Task to run on the parent project. -- `execute_on_root_anyway` (optional): Execute on root regardless of if any projects have been provided. Accepted values: 'true' or 'false'. +- `projects` (required): Projects to run the tasks on, comma-separated. +- `tasks` (required): Tasks to run on the projects, comma-separated. +- `parent_project_task` (optional): Task to run on the parent project. +- `execute_on_root_anyway` (optional): Execute on root regardless of if any projects have been provided. Accepted + values: 'true' or 'false'. ### Outputs -- `gradle_output` : Output from Gradle. +- `gradle_output` : Output from Gradle. ### Example Usage + name: Execute gradle tasks on projects description: Run gradle tasks on projects + ```yaml on: push: diff --git a/.github/actions/detect-modified-projects/dist/index.js b/.github/actions/detect-modified-projects/dist/index.js index b5c33c7b..7cfecf3d 100644 --- a/.github/actions/detect-modified-projects/dist/index.js +++ b/.github/actions/detect-modified-projects/dist/index.js @@ -1,18 +1,22 @@ "use strict"; -var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { +var __createBinding = (this && this.__createBinding) || (Object.create ? (function (o, m, k, k2) { if (k2 === undefined) k2 = k; var desc = Object.getOwnPropertyDescriptor(m, k); if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { return m[k]; } }; + desc = { + enumerable: true, get: function () { + return m[k]; + } + }; } Object.defineProperty(o, k2, desc); -}) : (function(o, m, k, k2) { +}) : (function (o, m, k, k2) { if (k2 === undefined) k2 = k; o[k2] = m[k]; })); -var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); -}) : function(o, v) { +var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function (o, v) { + Object.defineProperty(o, "default", {enumerable: true, value: v}); +}) : function (o, v) { o["default"] = v; }); var __importStar = (this && this.__importStar) || function (mod) { @@ -22,32 +26,32 @@ var __importStar = (this && this.__importStar) || function (mod) { __setModuleDefault(result, mod); return result; }; -Object.defineProperty(exports, "__esModule", { value: true }); +Object.defineProperty(exports, "__esModule", {value: true}); const child_process_1 = require("child_process"); const core = __importStar(require("@actions/core")); + function run() { var _a, _b, _c, _d; try { const subprojectPrefixes = (_b = (_a = core.getInput('project_prefixes')) === null || _a === void 0 ? void 0 : _a.split(",")) !== null && _b !== void 0 ? _b : []; const requiredProjects = (_d = (_c = core.getInput('required_projects')) === null || _c === void 0 ? void 0 : _c.split(",")) !== null && _d !== void 0 ? _d : []; core.debug("executing git fetch"); - (0, child_process_1.execSync)('git fetch --unshallow', { encoding: 'utf-8' }); + (0, child_process_1.execSync)('git fetch --unshallow', {encoding: 'utf-8'}); const githubSha = process.env.GITHUB_SHA; if (!githubSha) { core.setFailed('GITHUB_SHA not set'); } const diffCmd = `git diff --name-only HEAD~1..${githubSha}`; core.debug(`Executing: ${diffCmd}`); - core.debug(`Git Status: ${(0, child_process_1.execSync)(`git status`, { encoding: 'utf-8' }).trim()}`); - core.debug(`SHA Exists: ${(0, child_process_1.execSync)(`git cat-file -e ${githubSha}`, { encoding: 'utf-8' }).trim()}`); - let modifiedProjects = (0, child_process_1.execSync)(diffCmd, { encoding: 'utf8' }); + core.debug(`Git Status: ${(0, child_process_1.execSync)(`git status`, {encoding: 'utf-8'}).trim()}`); + core.debug(`SHA Exists: ${(0, child_process_1.execSync)(`git cat-file -e ${githubSha}`, {encoding: 'utf-8'}).trim()}`); + let modifiedProjects = (0, child_process_1.execSync)(diffCmd, {encoding: 'utf8'}); core.debug("Modified Projects:" + modifiedProjects); core.debug("Required Projects:" + requiredProjects); if (modifiedProjects.includes('buildSrc/') && !modifiedProjects.includes('ktor-')) { core.debug("only buildSrc has modified"); modifiedProjects = "buildSrc"; - } - else { + } else { const subprojectPrefixesPattern = subprojectPrefixes.join("|"); core.debug("subprojectPrefixesPattern: " + subprojectPrefixesPattern); const regex = subprojectPrefixes.length > 0 @@ -55,8 +59,8 @@ function run() { : null; let modifiedProjectsArray = modifiedProjects.split('\n') .filter(line => { - return regex ? regex.test(line) : true; - }) + return regex ? regex.test(line) : true; + }) .map(line => line.split('/', 1)[0]) .sort() .filter((value, index, self) => self.indexOf(value) === index); @@ -65,13 +69,12 @@ function run() { if (modifiedProjects) { core.info(`Modified subprojects including required projects: ${modifiedProjects}`); core.setOutput('modified_projects', modifiedProjects); - } - else { + } else { core.info("No modified subprojects"); } - } - catch (error) { + } catch (error) { core.setFailed(`Action failed with error: ${error}`); } } + run(); diff --git a/.github/actions/detect-modified-projects/tsconfig.json b/.github/actions/detect-modified-projects/tsconfig.json index c4325c91..cd8037da 100644 --- a/.github/actions/detect-modified-projects/tsconfig.json +++ b/.github/actions/detect-modified-projects/tsconfig.json @@ -12,5 +12,7 @@ "exclude": [ "node_modules" ], - "include": ["./src/**/*.ts"], + "include": [ + "./src/**/*.ts" + ] } diff --git a/.github/actions/execute-gradle-tasks-on-projects/README.md b/.github/actions/execute-gradle-tasks-on-projects/README.md index 00df4284..d0e54d9f 100644 --- a/.github/actions/execute-gradle-tasks-on-projects/README.md +++ b/.github/actions/execute-gradle-tasks-on-projects/README.md @@ -4,16 +4,18 @@ This GitHub Action allows you to run gradle tasks on projects within your reposi ### Inputs -- `projects` (required): Projects to run the tasks on, comma-separated. -- `tasks` (required): Tasks to run on the projects, comma-separated. -- `parent_project_task` (optional): Task to run on the parent project. -- `execute_on_root_anyway` (optional): Execute on root regardless of if any projects have been provided. Accepted values: 'true' or 'false'. +- `projects` (required): Projects to run the tasks on, comma-separated. +- `tasks` (required): Tasks to run on the projects, comma-separated. +- `parent_project_task` (optional): Task to run on the parent project. +- `execute_on_root_anyway` (optional): Execute on root regardless of if any projects have been provided. Accepted + values: 'true' or 'false'. ### Outputs -- `gradle_output` : Output from Gradle. +- `gradle_output` : Output from Gradle. ### Example Usage + ```yaml name: Execute gradle tasks on projects description: Run gradle tasks on projects @@ -37,4 +39,4 @@ jobs: tasks: 'build,test' parent_project_task: 'clean' execute_on_root_anyway: 'false' -``` \ No newline at end of file +``` diff --git a/.github/actions/execute-gradle-tasks-on-projects/dist/index.js b/.github/actions/execute-gradle-tasks-on-projects/dist/index.js index 2a6d6e21..5b7d7461 100644 --- a/.github/actions/execute-gradle-tasks-on-projects/dist/index.js +++ b/.github/actions/execute-gradle-tasks-on-projects/dist/index.js @@ -1,18 +1,22 @@ "use strict"; -var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { +var __createBinding = (this && this.__createBinding) || (Object.create ? (function (o, m, k, k2) { if (k2 === undefined) k2 = k; var desc = Object.getOwnPropertyDescriptor(m, k); if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { - desc = { enumerable: true, get: function() { return m[k]; } }; + desc = { + enumerable: true, get: function () { + return m[k]; + } + }; } Object.defineProperty(o, k2, desc); -}) : (function(o, m, k, k2) { +}) : (function (o, m, k, k2) { if (k2 === undefined) k2 = k; o[k2] = m[k]; })); -var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) { - Object.defineProperty(o, "default", { enumerable: true, value: v }); -}) : function(o, v) { +var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function (o, v) { + Object.defineProperty(o, "default", {enumerable: true, value: v}); +}) : function (o, v) { o["default"] = v; }); var __importStar = (this && this.__importStar) || function (mod) { @@ -22,20 +26,24 @@ var __importStar = (this && this.__importStar) || function (mod) { __setModuleDefault(result, mod); return result; }; -Object.defineProperty(exports, "__esModule", { value: true }); +Object.defineProperty(exports, "__esModule", {value: true}); const core = __importStar(require("@actions/core")); const child_process_1 = require("child_process"); + class StringBuilder { constructor() { this._parts = []; } + append(value) { this._parts.push(value); } + toString() { return this._parts.join(""); } } + async function run() { var _a, _b; try { @@ -56,8 +64,7 @@ async function run() { if (projects === 'buildSrc') { core.debug(`only buildSrc has changed, setting gradleProjectsTasks to ${tasks.replace(",", " ")}`); gradleProjectsTasks = `${tasks.replace(",", " ")} `; - } - else { + } else { const projArr = projects.split(',').filter((p) => p.trim() !== ''); core.debug(`building gradleProjectsTasks with projects: ${projArr} and tasks: ${taskArr}`); if (taskArr.length === 0 && !rootProjectTask) { @@ -74,8 +81,7 @@ async function run() { return acc2 + `:${proj}:${task} `; }, ''); }, ''); - } - else { + } else { gradleProjectsTasks = taskArr.reduce((acc1, task) => { return acc1 + `${task} `; }, ''); @@ -101,16 +107,15 @@ async function run() { gradleChild.on('exit', (code, signal) => { if (code !== 0) { reject(new Error(`Gradle exited with code ${code} due to signal ${signal}`)); - } - else { + } else { resolve(gradleOutputBuilder.toString()); } }); }); core.setOutput('gradle_output', await processPromise); - } - catch (error) { + } catch (error) { core.setFailed(error.message); } } + run(); diff --git a/.github/actions/execute-gradle-tasks-on-projects/src/index.ts b/.github/actions/execute-gradle-tasks-on-projects/src/index.ts index 79a0688e..1fc54eae 100644 --- a/.github/actions/execute-gradle-tasks-on-projects/src/index.ts +++ b/.github/actions/execute-gradle-tasks-on-projects/src/index.ts @@ -12,6 +12,7 @@ class StringBuilder { return this._parts.join(""); } } + async function run() { try { let projects = core.getInput('projects'); diff --git a/.github/actions/execute-gradle-tasks-on-projects/tsconfig.json b/.github/actions/execute-gradle-tasks-on-projects/tsconfig.json index c4325c91..cd8037da 100644 --- a/.github/actions/execute-gradle-tasks-on-projects/tsconfig.json +++ b/.github/actions/execute-gradle-tasks-on-projects/tsconfig.json @@ -12,5 +12,7 @@ "exclude": [ "node_modules" ], - "include": ["./src/**/*.ts"], + "include": [ + "./src/**/*.ts" + ] } diff --git a/README.md b/README.md index 6d05b9a4..2b87323a 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ [![Docs](https://custom-icon-badges.demolab.com/badge/Pages-blue.svg?label=Docs&logo=github&logoColor=white?icon=githubpages&style=for-the-badge)](https://github.com/Flaxoos/extra-ktor-plugins/actions/workflows/pages/pages-build-deployment) [![Awesome Kotlin Badge](https://custom-icon-badges.demolab.com/badge/awesome-kotlin-orange.svg?labelColor=blue&style=for-the-badge)](https://github.com/KotlinBy/awesome-kotlin) --- + ### Feature-rich, efficient, and highly customizable plugins for your Multiplatform Ktor Server or Client --- @@ -19,24 +20,24 @@ | **[Task Scheduling](ktor-server-task-scheduling)** | **JVM / Native^** | Task scheduling for distributed servers with various and extendable task management strategies | | **[Rate Limiting](ktor-server-rate-limiting)** | **JVM / Native** | Highly configurable rate limiter with offering different startegies, request weighting, blacklisting and whitelisting of requests based on authentication, host and user agents | - ### **Client Plugins** -| Plugin | Supported Platforms | Description | -|----------------------------------------------------|----------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Plugin | Supported Platforms | Description | +|----------------------------------------------------|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **[Circuit Breaker](ktor-client-circuit-breaker)** | **JVM / Native / JS** | Enhances system resilience by halting requests to failing services once a defined error threshold is reached. Automatically switches between open and closed states based on the health of the targeted service. | Note that `^` means issues with native binary dependencies, feel free to pull the project and publish locally --- - ## Usage Pleas see [Documentation](https://flaxoos.github.io/extra-ktor-plugins/) ## Installation + The libraries are published to maven central, see above for the latest version + ```kotlin dependencies { implementation("io.github.flaxoos:ktor-server-kafka:$ktor_plugins_version") @@ -47,11 +48,13 @@ dependencies { ``` ## Examples: + See [examples repository](https://github.com/Flaxoos/flax-ktor-plugins-examples) ## Contributing -Contributions are always welcome! If you have an idea for a plugin or want to improve an existing one, feel free to fork this repository and submit a pull request. +Contributions are always welcome! If you have an idea for a plugin or want to improve an existing one, feel free to fork +this repository and submit a pull request. ## Sponsership diff --git a/build.gradle.kts b/build.gradle.kts index f40f2708..d90d7021 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -11,7 +11,11 @@ import ru.vyarus.gradle.plugin.python.PythonExtension plugins { alias(libs.plugins.nexusPublish) - id(libs.plugins.dokka.get().pluginId) + id( + libs.plugins.dokka + .get() + .pluginId, + ) id("ru.vyarus.mkdocs-build") version "3.0.0" } diff --git a/buildSrc/src/main/kotlin/io/github/flaxoos/ktor/Conventions.kt b/buildSrc/src/main/kotlin/io/github/flaxoos/ktor/Conventions.kt index 22dd820b..51c36899 100644 --- a/buildSrc/src/main/kotlin/io/github/flaxoos/ktor/Conventions.kt +++ b/buildSrc/src/main/kotlin/io/github/flaxoos/ktor/Conventions.kt @@ -30,7 +30,9 @@ import org.gradle.plugins.ide.idea.model.IdeaModel import org.jetbrains.kotlin.gradle.dsl.KotlinMultiplatformExtension import org.jetbrains.kotlin.gradle.plugin.KotlinDependencyHandler import org.jetbrains.kotlin.gradle.plugin.KotlinSourceSet -import org.jetbrains.kotlin.gradle.utils.named +import org.jlleitschuh.gradle.ktlint.KtlintExtension +import org.jlleitschuh.gradle.ktlint.tasks.KtLintCheckTask +import org.jlleitschuh.gradle.ktlint.tasks.KtLintFormatTask open class Conventions : Plugin { open fun KotlinMultiplatformExtension.conventionSpecifics(project: Project) {} @@ -107,11 +109,17 @@ open class Conventions : Plugin { buildUponDefaultConfig = true } - tasks.named("build").configure { - dependsOn("ktlintFormat") - dependsOn(tasks.matching { it.name.matches(Regex("detekt(?!.*Baseline).*\\b(Main|Test)\\b\n")) }) + the().apply { + version.set(versionOf("ktlint")) + } + + tasks.withType { + dependsOn(tasks.withType()) } + tasks.named("build") { + dependsOn(tasks.matching { it.name.matches(Regex("detekt(?!.*Baseline).*\\b(Main|Test)\\b\n")) }) + } tasks.withType(Test::class) { useJUnitPlatform() } @@ -126,7 +134,7 @@ open class Conventions : Plugin { verify { rule { isEnabled = true - minBound(60) + minBound(55) } onCheck = true } @@ -242,7 +250,3 @@ fun NamedDomainObjectCollection.nativeTestDependencies(configur private fun Project.ktorVersion() = versionOf("ktor") fun Project.projectDependencies(configuration: DependencyHandlerScope.() -> Unit) = DependencyHandlerScope.of(dependencies).configuration() - -@Target(AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER) -@Retention(AnnotationRetention.RUNTIME) -annotation class KoverIgnore diff --git a/buildSrc/src/main/kotlin/io/github/flaxoos/ktor/ProjectPropertyDelegate.kt b/buildSrc/src/main/kotlin/io/github/flaxoos/ktor/ProjectPropertyDelegate.kt index 5340f338..5188e98d 100644 --- a/buildSrc/src/main/kotlin/io/github/flaxoos/ktor/ProjectPropertyDelegate.kt +++ b/buildSrc/src/main/kotlin/io/github/flaxoos/ktor/ProjectPropertyDelegate.kt @@ -1,31 +1,28 @@ package io.github.flaxoos.ktor -import org.gradle.api.Project import kotlin.reflect.KProperty +import org.gradle.api.Project class ProjectPropertyDelegate { - operator fun getValue(thisRef: Project, property: KProperty<*>): String = + operator fun getValue( + thisRef: Project, + property: KProperty<*>, + ): String = thisRef.findProperty(property.name.camelCaseToLowerDots()) as String? ?: System.getenv(property.name.camelCaseToUpperUnderscore()) ?: "".also { thisRef.logger.warn( "Property ${property.name} not found ${thisRef.name}. " + - "Ensure it is defined in gradle.properties (lower case, dot separated) or as a system property " + - "(upper case, underscore separated)." + "Ensure it is defined in gradle.properties (lower case, dot separated) or as a system property " + + "(upper case, underscore separated).", ) } - companion object { - private fun String.camelCaseToLowerDots(): String { - return this.replace(Regex("([a-z])([A-Z])"), "$1.$2").lowercase() - } + private fun String.camelCaseToLowerDots(): String = this.replace(Regex("([a-z])([A-Z])"), "$1.$2").lowercase() - private fun String.camelCaseToUpperUnderscore(): String { - return this.replace(Regex("([a-z])([A-Z])"), "$1_$2").uppercase() - } + private fun String.camelCaseToUpperUnderscore(): String = this.replace(Regex("([a-z])([A-Z])"), "$1_$2").uppercase() - fun projectOrSystemEnv() = - ProjectPropertyDelegate() + fun projectOrSystemEnv() = ProjectPropertyDelegate() } -} \ No newline at end of file +} diff --git a/buildSrc/src/main/kotlin/io/github/flaxoos/ktor/extensions/Credentials.kt b/buildSrc/src/main/kotlin/io/github/flaxoos/ktor/extensions/Credentials.kt index 5732a3b8..39962f21 100644 --- a/buildSrc/src/main/kotlin/io/github/flaxoos/ktor/extensions/Credentials.kt +++ b/buildSrc/src/main/kotlin/io/github/flaxoos/ktor/extensions/Credentials.kt @@ -35,4 +35,4 @@ val Project.ossrhUsername: String by ProjectPropertyDelegate.projectOrSystemEnv( val Project.ossrhPassword: String by ProjectPropertyDelegate.projectOrSystemEnv() val Project.signingKeyBase64: String by ProjectPropertyDelegate.projectOrSystemEnv() val Project.signingKeyArmorBase64: String by ProjectPropertyDelegate.projectOrSystemEnv() -val Project.signingPassword: String by ProjectPropertyDelegate.projectOrSystemEnv() \ No newline at end of file +val Project.signingPassword: String by ProjectPropertyDelegate.projectOrSystemEnv() diff --git a/buildSrc/src/main/kotlin/io/github/flaxoos/ktor/extensions/Kotlin.kt b/buildSrc/src/main/kotlin/io/github/flaxoos/ktor/extensions/Kotlin.kt index a5d71e42..bbccf03f 100644 --- a/buildSrc/src/main/kotlin/io/github/flaxoos/ktor/extensions/Kotlin.kt +++ b/buildSrc/src/main/kotlin/io/github/flaxoos/ktor/extensions/Kotlin.kt @@ -15,15 +15,15 @@ fun Project.enableContextReceivers() { } } - fun Project.setLanguageAndApiVersions() { tasks.withType(KotlinCompilationTask::class) { compilerOptions { - val gradleKotlinVersion = KotlinVersion.valueOf( - KOTLIN.uppercase() + "_" + versionOf(KOTLIN).substringBeforeLast(".").replace(".", "_") - ) + val gradleKotlinVersion = + KotlinVersion.valueOf( + KOTLIN.uppercase() + "_" + versionOf(KOTLIN).substringBeforeLast(".").replace(".", "_"), + ) languageVersion.set(gradleKotlinVersion) apiVersion.set(gradleKotlinVersion) } } -} \ No newline at end of file +} diff --git a/buildSrc/src/main/kotlin/io/github/flaxoos/ktor/extensions/Publishing.kt b/buildSrc/src/main/kotlin/io/github/flaxoos/ktor/extensions/Publishing.kt index 1dfdcac0..2a87ad79 100644 --- a/buildSrc/src/main/kotlin/io/github/flaxoos/ktor/extensions/Publishing.kt +++ b/buildSrc/src/main/kotlin/io/github/flaxoos/ktor/extensions/Publishing.kt @@ -1,5 +1,6 @@ package io.github.flaxoos.ktor.extensions +import java.util.Base64 import org.gradle.api.Project import org.gradle.api.publish.PublishingExtension import org.gradle.api.publish.maven.MavenPublication @@ -14,7 +15,6 @@ import org.gradle.kotlin.dsl.withType import org.gradle.plugins.signing.Sign import org.gradle.plugins.signing.SigningExtension import org.jetbrains.dokka.gradle.AbstractDokkaTask -import java.util.Base64 private const val DOKKA = "dokka" private const val DOKKA_JAR_TASK_NAME = "${DOKKA}Jar" diff --git a/buildSrc/src/main/kotlin/io/github/flaxoos/ktor/extensions/VersionCatalog.kt b/buildSrc/src/main/kotlin/io/github/flaxoos/ktor/extensions/VersionCatalog.kt index 1fc8be3f..b6c17511 100644 --- a/buildSrc/src/main/kotlin/io/github/flaxoos/ktor/extensions/VersionCatalog.kt +++ b/buildSrc/src/main/kotlin/io/github/flaxoos/ktor/extensions/VersionCatalog.kt @@ -7,13 +7,36 @@ import org.gradle.kotlin.dsl.the fun Project.libs() = project.the().find("libs") fun Project.versionOf(version: String): String = - this.libs().get().findVersion(version).get().toString() + this + .libs() + .get() + .findVersion(version) + .get() + .toString() fun Project.library(name: String): String = - this.libs().get().findLibrary(name).get().get().toString() + this + .libs() + .get() + .findLibrary(name) + .get() + .get() + .toString() fun Project.bundle(name: String): String = - this.libs().get().findBundle(name).get().get().toString() + this + .libs() + .get() + .findBundle(name) + .get() + .get() + .toString() fun Project.plugin(name: String): String = - this.libs().get().findPlugin(name).get().get().pluginId \ No newline at end of file + this + .libs() + .get() + .findPlugin(name) + .get() + .get() + .pluginId diff --git a/common/build.gradle.kts b/common/build.gradle.kts index bc20b7ad..1200b610 100644 --- a/common/build.gradle.kts +++ b/common/build.gradle.kts @@ -1,6 +1,7 @@ import io.github.flaxoos.ktor.extensions.configurePublishing import io.github.flaxoos.ktor.extensions.targetJvm import io.github.flaxoos.ktor.extensions.targetNative +import org.jetbrains.kotlin.konan.target.HostManager plugins { kotlin("multiplatform") @@ -16,9 +17,15 @@ plugins { kotlin { targetJvm(project) targetNative() - macosArm64("native-macos") { - binaries { - staticLib() + // Check if running on macOS and macOS version is less than 15.0.1 + val macosVersion = System.getProperty("os.version")?.split(".")?.map { it.toIntOrNull() ?: 0 } + val isMacosCompatible = macosVersion != null && macosVersion[0] < 15 + + if (HostManager.hostIsMac && isMacosCompatible) { + macosArm64("native-macos") { + binaries { + staticLib() + } } } } diff --git a/documentation/mkdocs/docs/about/Motivation.md b/documentation/mkdocs/docs/about/Motivation.md index 1a930409..915ce47d 100644 --- a/documentation/mkdocs/docs/about/Motivation.md +++ b/documentation/mkdocs/docs/about/Motivation.md @@ -1 +1,3 @@ -While Kotlin is seeing widespread adoption, its web framework, Ktor, is sometimes overlooked, largely because Spring Boot still offers an exhaustive range of starters. To bridge this gap, we kotlin fans could contribute to enhancing Ktor's functionality, which will increase adoption and further stimulate contribution by others. \ No newline at end of file +While Kotlin is seeing widespread adoption, its web framework, Ktor, is sometimes overlooked, largely because Spring +Boot still offers an exhaustive range of starters. To bridge this gap, we kotlin fans could contribute to enhancing +Ktor's functionality, which will increase adoption and further stimulate contribution by others. diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-config/-circuit-breaker-builder/-circuit-breaker-builder.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-config/-circuit-breaker-builder/-circuit-breaker-builder.md index cf3e810d..ca2fed87 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-config/-circuit-breaker-builder/-circuit-breaker-builder.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-config/-circuit-breaker-builder/-circuit-breaker-builder.md @@ -1,14 +1,11 @@ --- title: CircuitBreakerBuilder --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](../../index.md)/[CircuitBreakerConfig](../index.md)/[CircuitBreakerBuilder](index.md)/[CircuitBreakerBuilder](-circuit-breaker-builder.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](../../index.md)/[CircuitBreakerConfig](../index.md)/[CircuitBreakerBuilder](index.md)/[CircuitBreakerBuilder](-circuit-breaker-builder.md) # CircuitBreakerBuilder - - [common]\ constructor() diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-config/-circuit-breaker-builder/failure-threshold.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-config/-circuit-breaker-builder/failure-threshold.md index c6dcf900..bb98160e 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-config/-circuit-breaker-builder/failure-threshold.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-config/-circuit-breaker-builder/failure-threshold.md @@ -1,19 +1,14 @@ --- title: failureThreshold --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](../../index.md)/[CircuitBreakerConfig](../index.md)/[CircuitBreakerBuilder](index.md)/[failureThreshold](failure-threshold.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](../../index.md)/[CircuitBreakerConfig](../index.md)/[CircuitBreakerBuilder](index.md)/[failureThreshold](failure-threshold.md) # failureThreshold - - [common]\ var [failureThreshold](failure-threshold.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) - - How many failures are to be tolerated before the circuit moves to HALF_OPEN. diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-config/-circuit-breaker-builder/failure-trigger.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-config/-circuit-breaker-builder/failure-trigger.md index 05efc4f2..22656ac1 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-config/-circuit-breaker-builder/failure-trigger.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-config/-circuit-breaker-builder/failure-trigger.md @@ -1,18 +1,14 @@ --- title: failureTrigger --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](../../index.md)/[CircuitBreakerConfig](../index.md)/[CircuitBreakerBuilder](index.md)/[failureTrigger](failure-trigger.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](../../index.md)/[CircuitBreakerConfig](../index.md)/[CircuitBreakerBuilder](index.md)/[failureTrigger](failure-trigger.md) # failureTrigger - - [common]\ -var [failureTrigger](failure-trigger.md): HttpResponse.() -> [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md) - - +var [failureTrigger](failure-trigger.md): HttpResponse.() +-> [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md) What is considered a failure. default is HttpResponse.status>= 300 diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-config/-circuit-breaker-builder/half-open-failure-threshold.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-config/-circuit-breaker-builder/half-open-failure-threshold.md index 72285416..82328a21 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-config/-circuit-breaker-builder/half-open-failure-threshold.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-config/-circuit-breaker-builder/half-open-failure-threshold.md @@ -1,19 +1,14 @@ --- title: halfOpenFailureThreshold --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](../../index.md)/[CircuitBreakerConfig](../index.md)/[CircuitBreakerBuilder](index.md)/[halfOpenFailureThreshold](half-open-failure-threshold.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](../../index.md)/[CircuitBreakerConfig](../index.md)/[CircuitBreakerBuilder](index.md)/[halfOpenFailureThreshold](half-open-failure-threshold.md) # halfOpenFailureThreshold - - [common]\ var [halfOpenFailureThreshold](half-open-failure-threshold.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) - - How many attempts are allowed in HALF_OPEN state. diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-config/-circuit-breaker-builder/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-config/-circuit-breaker-builder/index.md index bce42ba2..d0edb10f 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-config/-circuit-breaker-builder/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-config/-circuit-breaker-builder/index.md @@ -1,34 +1,26 @@ --- title: CircuitBreakerBuilder --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](../../index.md)/[CircuitBreakerConfig](../index.md)/[CircuitBreakerBuilder](index.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](../../index.md)/[CircuitBreakerConfig](../index.md)/[CircuitBreakerBuilder](index.md) # CircuitBreakerBuilder - - [common]\ class [CircuitBreakerBuilder](index.md) - - ## Constructors - -| | | -|---|---| +| | | +|------------------------------------------------------|---------------------------| | [CircuitBreakerBuilder](-circuit-breaker-builder.md) | [common]
constructor() | - ## Properties - -| Name | Summary | -|---|---| -| [failureThreshold](failure-threshold.md) | [common]
var [failureThreshold](failure-threshold.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)
How many failures are to be tolerated before the circuit moves to HALF_OPEN. | -| [failureTrigger](failure-trigger.md) | [common]
var [failureTrigger](failure-trigger.md): HttpResponse.() -> [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)
What is considered a failure. default is HttpResponse.status>= 300 | -| [halfOpenFailureThreshold](half-open-failure-threshold.md) | [common]
var [halfOpenFailureThreshold](half-open-failure-threshold.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)
How many attempts are allowed in HALF_OPEN state. | -| [resetInterval](reset-interval.md) | [common]
var [resetInterval](reset-interval.md): [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md)
How long to wait before moving from OPEN to HALF_OPEN. | +| Name | Summary | +|------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [failureThreshold](failure-threshold.md) | [common]
var [failureThreshold](failure-threshold.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)
How many failures are to be tolerated before the circuit moves to HALF_OPEN. | +| [failureTrigger](failure-trigger.md) | [common]
var [failureTrigger](failure-trigger.md): HttpResponse.() -> [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)
What is considered a failure. default is HttpResponse.status>= 300 | +| [halfOpenFailureThreshold](half-open-failure-threshold.md) | [common]
var [halfOpenFailureThreshold](half-open-failure-threshold.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)
How many attempts are allowed in HALF_OPEN state. | +| [resetInterval](reset-interval.md) | [common]
var [resetInterval](reset-interval.md): [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md)
How long to wait before moving from OPEN to HALF_OPEN. | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-config/-circuit-breaker-builder/reset-interval.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-config/-circuit-breaker-builder/reset-interval.md index 9168fb51..2db13bee 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-config/-circuit-breaker-builder/reset-interval.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-config/-circuit-breaker-builder/reset-interval.md @@ -1,19 +1,14 @@ --- title: resetInterval --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](../../index.md)/[CircuitBreakerConfig](../index.md)/[CircuitBreakerBuilder](index.md)/[resetInterval](reset-interval.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](../../index.md)/[CircuitBreakerConfig](../index.md)/[CircuitBreakerBuilder](index.md)/[resetInterval](reset-interval.md) # resetInterval - - [common]\ var [resetInterval](reset-interval.md): [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md) - - How long to wait before moving from OPEN to HALF_OPEN. diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-config/-circuit-breaker-config.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-config/-circuit-breaker-config.md index d56bdd05..f5d283c6 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-config/-circuit-breaker-config.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-config/-circuit-breaker-config.md @@ -1,14 +1,11 @@ --- title: CircuitBreakerConfig --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](../index.md)/[CircuitBreakerConfig](index.md)/[CircuitBreakerConfig](-circuit-breaker-config.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](../index.md)/[CircuitBreakerConfig](index.md)/[CircuitBreakerConfig](-circuit-breaker-config.md) # CircuitBreakerConfig - - [common]\ constructor() diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-config/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-config/index.md index a0571668..19c139b9 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-config/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-config/index.md @@ -1,42 +1,32 @@ --- title: CircuitBreakerConfig --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](../index.md)/[CircuitBreakerConfig](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](../index.md)/[CircuitBreakerConfig](index.md) # CircuitBreakerConfig - - [common]\ class [CircuitBreakerConfig](index.md) Configuration for CircuitBreaker. - - ## Constructors - -| | | -|---|---| +| | | +|----------------------------------------------------|---------------------------| | [CircuitBreakerConfig](-circuit-breaker-config.md) | [common]
constructor() | - ## Types - -| Name | Summary | -|---|---| +| Name | Summary | +|------------------------------------------------------------|------------------------------------------------------------------------------| | [CircuitBreakerBuilder](-circuit-breaker-builder/index.md) | [common]
class [CircuitBreakerBuilder](-circuit-breaker-builder/index.md) | - ## Functions - -| Name | Summary | -|---|---| -| [global](../global.md) | [common]
fun [CircuitBreakerConfig](index.md).[global](../global.md)(config: [CircuitBreakerConfig.CircuitBreakerBuilder](-circuit-breaker-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md))
Registers a global CircuitBreaker that is applied to the whole client | +| Name | Summary | +|----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [global](../global.md) | [common]
fun [CircuitBreakerConfig](index.md).[global](../global.md)(config: [CircuitBreakerConfig.CircuitBreakerBuilder](-circuit-breaker-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md))
Registers a global CircuitBreaker that is applied to the whole client | | [register](../register.md) | [common]
fun [CircuitBreakerConfig](index.md).[register](../register.md)(name: [CircuitBreakerName](../-circuit-breaker-name/index.md), config: [CircuitBreakerConfig.CircuitBreakerBuilder](-circuit-breaker-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md))
Register a CircuitBreaker with a given name | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-dsl/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-dsl/index.md index 2903e869..f9f0bb49 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-dsl/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-dsl/index.md @@ -1,19 +1,14 @@ --- title: CircuitBreakerDsl --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](../index.md)/[CircuitBreakerDsl](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](../index.md)/[CircuitBreakerDsl](index.md) # CircuitBreakerDsl - - [common]\ @[DslMarker](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-dsl-marker/index.md) - - annotation class [CircuitBreakerDsl](index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-exception/-circuit-breaker-exception.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-exception/-circuit-breaker-exception.md index 462cc8a1..873464d0 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-exception/-circuit-breaker-exception.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-exception/-circuit-breaker-exception.md @@ -1,14 +1,11 @@ --- title: CircuitBreakerException --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](../index.md)/[CircuitBreakerException](index.md)/[CircuitBreakerException](-circuit-breaker-exception.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](../index.md)/[CircuitBreakerException](index.md)/[CircuitBreakerException](-circuit-breaker-exception.md) # CircuitBreakerException - - [common]\ constructor(failureThreshold: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-exception/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-exception/index.md index d1e8c066..70aec36c 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-exception/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-exception/index.md @@ -1,32 +1,25 @@ --- title: CircuitBreakerException --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](../index.md)/[CircuitBreakerException](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](../index.md)/[CircuitBreakerException](index.md) # CircuitBreakerException - - [common]\ -class [CircuitBreakerException](index.md)(failureThreshold: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)) : [Exception](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.md) - - +class [CircuitBreakerException](index.md)( +failureThreshold: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)) : [Exception](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.md) ## Constructors - -| | | -|---|---| +| | | +|----------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------| | [CircuitBreakerException](-circuit-breaker-exception.md) | [common]
constructor(failureThreshold: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)) | - ## Properties - -| Name | Summary | -|---|---| -| [cause](index.md#-654012527%2FProperties%2F1182336650) | [common]
open val [cause](index.md#-654012527%2FProperties%2F1182336650): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.md)? | -| [message](index.md#1824300659%2FProperties%2F1182336650) | [common]
open val [message](index.md#1824300659%2FProperties%2F1182336650): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? | +| Name | Summary | +|----------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [cause](index.md#-654012527%2FProperties%2F1182336650) | [common]
open val [cause](index.md#-654012527%2FProperties%2F1182336650): [Throwable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-throwable/index.md)? | +| [message](index.md#1824300659%2FProperties%2F1182336650) | [common]
open val [message](index.md#1824300659%2FProperties%2F1182336650): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-name/-circuit-breaker-name.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-name/-circuit-breaker-name.md index f9f77b6f..46d2592f 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-name/-circuit-breaker-name.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-name/-circuit-breaker-name.md @@ -1,14 +1,11 @@ --- title: CircuitBreakerName --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](../index.md)/[CircuitBreakerName](index.md)/[CircuitBreakerName](-circuit-breaker-name.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](../index.md)/[CircuitBreakerName](index.md)/[CircuitBreakerName](-circuit-breaker-name.md) # CircuitBreakerName - - [common]\ constructor(value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-name/-companion/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-name/-companion/index.md index 5c82b51e..fac04dff 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-name/-companion/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-name/-companion/index.md @@ -1,23 +1,17 @@ --- title: Companion --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](../../index.md)/[CircuitBreakerName](../index.md)/[Companion](index.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](../../index.md)/[CircuitBreakerName](../index.md)/[Companion](index.md) # Companion - - [common]\ object [Companion](index.md) - - ## Functions - -| Name | Summary | -|---|---| +| Name | Summary | +|----------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [toCircuitBreakerName](to-circuit-breaker-name.md) | [common]
fun [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md).[toCircuitBreakerName](to-circuit-breaker-name.md)(): [CircuitBreakerName](../index.md) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-name/-companion/to-circuit-breaker-name.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-name/-companion/to-circuit-breaker-name.md index cf0d6c28..742bc53d 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-name/-companion/to-circuit-breaker-name.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-name/-companion/to-circuit-breaker-name.md @@ -1,14 +1,11 @@ --- title: toCircuitBreakerName --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](../../index.md)/[CircuitBreakerName](../index.md)/[Companion](index.md)/[toCircuitBreakerName](to-circuit-breaker-name.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](../../index.md)/[CircuitBreakerName](../index.md)/[Companion](index.md)/[toCircuitBreakerName](to-circuit-breaker-name.md) # toCircuitBreakerName - - [common]\ fun [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md).[toCircuitBreakerName](to-circuit-breaker-name.md)(): [CircuitBreakerName](../index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-name/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-name/index.md index 63b50249..4dbc8df5 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-name/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-name/index.md @@ -1,45 +1,34 @@ --- title: CircuitBreakerName --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](../index.md)/[CircuitBreakerName](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](../index.md)/[CircuitBreakerName](index.md) # CircuitBreakerName - - [common]\ @[JvmInline](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-inline/index.md) - - -value class [CircuitBreakerName](index.md)(val value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)) +value class [CircuitBreakerName](index.md)(val +value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)) Value class for a CircuitBreaker name - - ## Constructors - -| | | -|---|---| +| | | +|------------------------------------------------|----------------------------------------------------------------------------------------------------------------| | [CircuitBreakerName](-circuit-breaker-name.md) | [common]
constructor(value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)) | - ## Types - -| Name | Summary | -|---|---| +| Name | Summary | +|----------------------------------|-----------------------------------------------------| | [Companion](-companion/index.md) | [common]
object [Companion](-companion/index.md) | - ## Properties - -| Name | Summary | -|---|---| +| Name | Summary | +|-------------------|-------------------------------------------------------------------------------------------------------------------| | [value](value.md) | [common]
val [value](value.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-name/value.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-name/value.md index bbf92c98..e6b23638 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-name/value.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaker-name/value.md @@ -1,14 +1,11 @@ --- title: value --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](../index.md)/[CircuitBreakerName](index.md)/[value](value.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](../index.md)/[CircuitBreakerName](index.md)/[value](value.md) # value - - [common]\ val [value](value.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaking.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaking.md index ad1d276d..54350850 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaking.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/-circuit-breaking.md @@ -1,16 +1,14 @@ --- title: CircuitBreaking --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](index.md)/[CircuitBreaking](-circuit-breaking.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](index.md)/[CircuitBreaking](-circuit-breaking.md) # CircuitBreaking - - [common]\ -val [CircuitBreaking](-circuit-breaking.md): ClientPlugin<[CircuitBreakerConfig](-circuit-breaker-config/index.md)> +val [CircuitBreaking](-circuit-breaking.md): ClientPlugin<[CircuitBreakerConfig](-circuit-breaker-config/index.md) +> diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/global.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/global.md index 46ccb576..704e3c59 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/global.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/global.md @@ -1,18 +1,15 @@ --- title: global --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](index.md)/[global](global.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](index.md)/[global](global.md) # global - - [common]\ -fun [CircuitBreakerConfig](-circuit-breaker-config/index.md).[global](global.md)(config: [CircuitBreakerConfig.CircuitBreakerBuilder](-circuit-breaker-config/-circuit-breaker-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) - - +fun [CircuitBreakerConfig](-circuit-breaker-config/index.md).[global](global.md)( +config: [CircuitBreakerConfig.CircuitBreakerBuilder](-circuit-breaker-config/-circuit-breaker-builder/index.md).() +-> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) Registers a global CircuitBreaker that is applied to the whole client diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/index.md index 61a6df16..81b8e294 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/index.md @@ -1,40 +1,32 @@ --- title: io.github.flaxoos.ktor.client.plugins.circuitbreaker --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](index.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](index.md) # Package-level declarations - - ## Types - -| Name | Summary | -|---|---| -| [CircuitBreakerConfig](-circuit-breaker-config/index.md) | [common]
class [CircuitBreakerConfig](-circuit-breaker-config/index.md)
Configuration for CircuitBreaker. | -| [CircuitBreakerDsl](-circuit-breaker-dsl/index.md) | [common]
@[DslMarker](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-dsl-marker/index.md)
annotation class [CircuitBreakerDsl](-circuit-breaker-dsl/index.md) | -| [CircuitBreakerException](-circuit-breaker-exception/index.md) | [common]
class [CircuitBreakerException](-circuit-breaker-exception/index.md)(failureThreshold: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)) : [Exception](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.md) | -| [CircuitBreakerName](-circuit-breaker-name/index.md) | [common]
@[JvmInline](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-inline/index.md)
value class [CircuitBreakerName](-circuit-breaker-name/index.md)(val value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md))
Value class for a CircuitBreaker name | - +| Name | Summary | +|----------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [CircuitBreakerConfig](-circuit-breaker-config/index.md) | [common]
class [CircuitBreakerConfig](-circuit-breaker-config/index.md)
Configuration for CircuitBreaker. | +| [CircuitBreakerDsl](-circuit-breaker-dsl/index.md) | [common]
@[DslMarker](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-dsl-marker/index.md)
annotation class [CircuitBreakerDsl](-circuit-breaker-dsl/index.md) | +| [CircuitBreakerException](-circuit-breaker-exception/index.md) | [common]
class [CircuitBreakerException](-circuit-breaker-exception/index.md)(failureThreshold: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)) : [Exception](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-exception/index.md) | +| [CircuitBreakerName](-circuit-breaker-name/index.md) | [common]
@[JvmInline](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-inline/index.md)
value class [CircuitBreakerName](-circuit-breaker-name/index.md)(val value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md))
Value class for a CircuitBreaker name | ## Properties - -| Name | Summary | -|---|---| +| Name | Summary | +|-----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------| | [CircuitBreaking](-circuit-breaking.md) | [common]
val [CircuitBreaking](-circuit-breaking.md): ClientPlugin<[CircuitBreakerConfig](-circuit-breaker-config/index.md)> | - ## Functions - -| Name | Summary | -|---|---| -| [global](global.md) | [common]
fun [CircuitBreakerConfig](-circuit-breaker-config/index.md).[global](global.md)(config: [CircuitBreakerConfig.CircuitBreakerBuilder](-circuit-breaker-config/-circuit-breaker-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md))
Registers a global CircuitBreaker that is applied to the whole client | -| [register](register.md) | [common]
fun [CircuitBreakerConfig](-circuit-breaker-config/index.md).[register](register.md)(name: [CircuitBreakerName](-circuit-breaker-name/index.md), config: [CircuitBreakerConfig.CircuitBreakerBuilder](-circuit-breaker-config/-circuit-breaker-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md))
Register a CircuitBreaker with a given name | +| Name | Summary | +|--------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [global](global.md) | [common]
fun [CircuitBreakerConfig](-circuit-breaker-config/index.md).[global](global.md)(config: [CircuitBreakerConfig.CircuitBreakerBuilder](-circuit-breaker-config/-circuit-breaker-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md))
Registers a global CircuitBreaker that is applied to the whole client | +| [register](register.md) | [common]
fun [CircuitBreakerConfig](-circuit-breaker-config/index.md).[register](register.md)(name: [CircuitBreakerName](-circuit-breaker-name/index.md), config: [CircuitBreakerConfig.CircuitBreakerBuilder](-circuit-breaker-config/-circuit-breaker-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md))
Register a CircuitBreaker with a given name | | [requestWithCircuitBreaker](request-with-circuit-breaker.md) | [common]
suspend fun HttpClient.[requestWithCircuitBreaker](request-with-circuit-breaker.md)(name: [CircuitBreakerName](-circuit-breaker-name/index.md) = CIRCUIT_BREAKER_NAME_GLOBAL, block: HttpRequestBuilder.() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)): HttpResponse
Make a request with the CircuitBreaker with the given [CircuitBreakerName](-circuit-breaker-name/index.md) | -| [withCircuitBreaker](with-circuit-breaker.md) | [common]
fun HttpRequestBuilder.[withCircuitBreaker](with-circuit-breaker.md)(name: [CircuitBreakerName](-circuit-breaker-name/index.md) = CIRCUIT_BREAKER_NAME_GLOBAL)
Apply the CircuitBreaker with the given [CircuitBreakerName](-circuit-breaker-name/index.md) to the request or the global one if name is given | +| [withCircuitBreaker](with-circuit-breaker.md) | [common]
fun HttpRequestBuilder.[withCircuitBreaker](with-circuit-breaker.md)(name: [CircuitBreakerName](-circuit-breaker-name/index.md) = CIRCUIT_BREAKER_NAME_GLOBAL)
Apply the CircuitBreaker with the given [CircuitBreakerName](-circuit-breaker-name/index.md) to the request or the global one if name is given | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/register.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/register.md index 7f71f2db..17e7f111 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/register.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/register.md @@ -1,18 +1,16 @@ --- title: register --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](index.md)/[register](register.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](index.md)/[register](register.md) # register - - [common]\ -fun [CircuitBreakerConfig](-circuit-breaker-config/index.md).[register](register.md)(name: [CircuitBreakerName](-circuit-breaker-name/index.md), config: [CircuitBreakerConfig.CircuitBreakerBuilder](-circuit-breaker-config/-circuit-breaker-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) - - +fun [CircuitBreakerConfig](-circuit-breaker-config/index.md).[register](register.md)( +name: [CircuitBreakerName](-circuit-breaker-name/index.md), +config: [CircuitBreakerConfig.CircuitBreakerBuilder](-circuit-breaker-config/-circuit-breaker-builder/index.md).() +-> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) Register a CircuitBreaker with a given name diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/request-with-circuit-breaker.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/request-with-circuit-breaker.md index 5ff0cd90..33de6ad3 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/request-with-circuit-breaker.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/request-with-circuit-breaker.md @@ -1,18 +1,15 @@ --- title: requestWithCircuitBreaker --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](index.md)/[requestWithCircuitBreaker](request-with-circuit-breaker.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](index.md)/[requestWithCircuitBreaker](request-with-circuit-breaker.md) # requestWithCircuitBreaker - - [common]\ -suspend fun HttpClient.[requestWithCircuitBreaker](request-with-circuit-breaker.md)(name: [CircuitBreakerName](-circuit-breaker-name/index.md) = CIRCUIT_BREAKER_NAME_GLOBAL, block: HttpRequestBuilder.() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)): HttpResponse - - +suspend fun HttpClient.[requestWithCircuitBreaker](request-with-circuit-breaker.md)( +name: [CircuitBreakerName](-circuit-breaker-name/index.md) = CIRCUIT_BREAKER_NAME_GLOBAL, block: HttpRequestBuilder.() +-> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)): HttpResponse Make a request with the CircuitBreaker with the given [CircuitBreakerName](-circuit-breaker-name/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/with-circuit-breaker.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/with-circuit-breaker.md index d98bb3ae..26eb56e5 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/with-circuit-breaker.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/with-circuit-breaker.md @@ -1,20 +1,17 @@ --- title: withCircuitBreaker --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](index.md)/[withCircuitBreaker](with-circuit-breaker.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.client.plugins.circuitbreaker](index.md)/[withCircuitBreaker](with-circuit-breaker.md) # withCircuitBreaker - - [common]\ -fun HttpRequestBuilder.[withCircuitBreaker](with-circuit-breaker.md)(name: [CircuitBreakerName](-circuit-breaker-name/index.md) = CIRCUIT_BREAKER_NAME_GLOBAL) - - +fun HttpRequestBuilder.[withCircuitBreaker](with-circuit-breaker.md)( +name: [CircuitBreakerName](-circuit-breaker-name/index.md) = CIRCUIT_BREAKER_NAME_GLOBAL) -Apply the CircuitBreaker with the given [CircuitBreakerName](-circuit-breaker-name/index.md) to the request or the global one if name is given +Apply the CircuitBreaker with the given [CircuitBreakerName](-circuit-breaker-name/index.md) to the request or the +global one if name is given diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/-schema-registry-client/-schema-registry-client.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/-schema-registry-client/-schema-registry-client.md index 720d304c..2d11104d 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/-schema-registry-client/-schema-registry-client.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/-schema-registry-client/-schema-registry-client.md @@ -1,16 +1,15 @@ --- title: SchemaRegistryClient --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka.components](../index.md)/[SchemaRegistryClient](index.md)/[SchemaRegistryClient](-schema-registry-client.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka.components](../index.md)/[SchemaRegistryClient](index.md)/[SchemaRegistryClient](-schema-registry-client.md) # SchemaRegistryClient - - [jvm]\ -constructor(providedClient: HttpClient, schemaRegistryUrl: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), timeoutMs: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)) +constructor(providedClient: HttpClient, +schemaRegistryUrl: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), +timeoutMs: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/-schema-registry-client/client.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/-schema-registry-client/client.md index 2b9f9458..9561f152 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/-schema-registry-client/client.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/-schema-registry-client/client.md @@ -1,14 +1,11 @@ --- title: client --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka.components](../index.md)/[SchemaRegistryClient](index.md)/[client](client.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka.components](../index.md)/[SchemaRegistryClient](index.md)/[client](client.md) # client - - [jvm]\ val [client](client.md): HttpClient diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/-schema-registry-client/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/-schema-registry-client/index.md index 4a5ca60b..669bfa98 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/-schema-registry-client/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/-schema-registry-client/index.md @@ -1,40 +1,32 @@ --- title: SchemaRegistryClient --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka.components](../index.md)/[SchemaRegistryClient](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka.components](../index.md)/[SchemaRegistryClient](index.md) # SchemaRegistryClient - - [jvm]\ -class [SchemaRegistryClient](index.md)(providedClient: HttpClient, schemaRegistryUrl: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), timeoutMs: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)) - - +class [SchemaRegistryClient](index.md)(providedClient: HttpClient, +schemaRegistryUrl: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), +timeoutMs: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)) ## Constructors - -| | | -|---|---| +| | | +|----------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [SchemaRegistryClient](-schema-registry-client.md) | [jvm]
constructor(providedClient: HttpClient, schemaRegistryUrl: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), timeoutMs: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)) | - ## Properties - -| Name | Summary | -|---|---| +| Name | Summary | +|---------------------|----------------------------------------------| | [client](client.md) | [jvm]
val [client](client.md): HttpClient | - ## Functions - -| Name | Summary | -|---|---| -| [registerSchema](register-schema.md) | [jvm]
inline fun <[T](register-schema.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)> [registerSchema](register-schema.md)(klass: [KClass](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.md)<out [T](register-schema.md)>, topicName: [TopicName](../../io.github.flaxoos.ktor.server.plugins.kafka/-topic-name/index.md), noinline onConflict: () -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = {})
Register a schema to the schema registry using ktor client | -| [registerSchemas](register-schemas.md) | [jvm]
inline fun <[T](register-schemas.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)> [registerSchemas](register-schemas.md)(schemas: [MutableMap](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.md)<[KClass](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.md)<out [T](register-schemas.md)>, [TopicName](../../io.github.flaxoos.ktor.server.plugins.kafka/-topic-name/index.md)>) | +| Name | Summary | +|----------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [registerSchema](register-schema.md) | [jvm]
inline fun <[T](register-schema.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)> [registerSchema](register-schema.md)(klass: [KClass](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.md)<out [T](register-schema.md)>, topicName: [TopicName](../../io.github.flaxoos.ktor.server.plugins.kafka/-topic-name/index.md), noinline onConflict: () -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = {})
Register a schema to the schema registry using ktor client | +| [registerSchemas](register-schemas.md) | [jvm]
inline fun <[T](register-schemas.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)> [registerSchemas](register-schemas.md)(schemas: [MutableMap](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.md)<[KClass](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.md)<out [T](register-schemas.md)>, [TopicName](../../io.github.flaxoos.ktor.server.plugins.kafka/-topic-name/index.md)>) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/-schema-registry-client/register-schema.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/-schema-registry-client/register-schema.md index b22863ee..5459b9c2 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/-schema-registry-client/register-schema.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/-schema-registry-client/register-schema.md @@ -1,32 +1,29 @@ --- title: registerSchema --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka.components](../index.md)/[SchemaRegistryClient](index.md)/[registerSchema](register-schema.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka.components](../index.md)/[SchemaRegistryClient](index.md)/[registerSchema](register-schema.md) # registerSchema - - [jvm]\ -inline fun <[T](register-schema.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)> [registerSchema](register-schema.md)(klass: [KClass](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.md)<out [T](register-schema.md)>, topicName: [TopicName](../../io.github.flaxoos.ktor.server.plugins.kafka/-topic-name/index.md), noinline onConflict: () -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = {}) - - +inline fun <[T](register-schema.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md) +> [registerSchema](register-schema.md)( +klass: [KClass](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.md) +<out [T](register-schema.md)>, +topicName: [TopicName](../../io.github.flaxoos.ktor.server.plugins.kafka/-topic-name/index.md), noinline onConflict: () +-> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = {}) Register a schema to the schema registry using ktor client - - #### Parameters - jvm -| | | -|---|---| -| klass | the class to register, must be annotated with Serializable | -| topicName | the topic name to associate the schema with | +| | | +|------------|-----------------------------------------------------------------------------------| +| klass | the class to register, must be annotated with Serializable | +| topicName | the topic name to associate the schema with | | onConflict | the function to run if a schema with the same name already exists, defaults to do | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/-schema-registry-client/register-schemas.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/-schema-registry-client/register-schemas.md index 810728e3..4308445e 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/-schema-registry-client/register-schemas.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/-schema-registry-client/register-schemas.md @@ -1,16 +1,18 @@ --- title: registerSchemas --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka.components](../index.md)/[SchemaRegistryClient](index.md)/[registerSchemas](register-schemas.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka.components](../index.md)/[SchemaRegistryClient](index.md)/[registerSchemas](register-schemas.md) # registerSchemas - - [jvm]\ -inline fun <[T](register-schemas.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)> [registerSchemas](register-schemas.md)(schemas: [MutableMap](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.md)<[KClass](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.md)<out [T](register-schemas.md)>, [TopicName](../../io.github.flaxoos.ktor.server.plugins.kafka/-topic-name/index.md)>) +inline fun <[T](register-schemas.md) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md) +> [registerSchemas](register-schemas.md)( +schemas: [MutableMap](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.md) +<[KClass](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.md) +<out [T](register-schemas.md) +>, [TopicName](../../io.github.flaxoos.ktor.server.plugins.kafka/-topic-name/index.md)>) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/create-schema-registry-client.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/create-schema-registry-client.md index fd6c0ecb..09f10ff1 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/create-schema-registry-client.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/create-schema-registry-client.md @@ -1,16 +1,16 @@ --- title: createSchemaRegistryClient --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka.components](index.md)/[createSchemaRegistryClient](create-schema-registry-client.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka.components](index.md)/[createSchemaRegistryClient](create-schema-registry-client.md) # createSchemaRegistryClient - - [jvm]\ -fun [createSchemaRegistryClient](create-schema-registry-client.md)(schemaRegistryUrl: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), timeoutMs: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md), clientProvider: () -> HttpClient): [SchemaRegistryClient](-schema-registry-client/index.md) +fun [createSchemaRegistryClient](create-schema-registry-client.md)( +schemaRegistryUrl: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), +timeoutMs: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md), clientProvider: () -> +HttpClient): [SchemaRegistryClient](-schema-registry-client/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/from-record.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/from-record.md index db8c9624..1d6f1d60 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/from-record.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/from-record.md @@ -1,47 +1,32 @@ --- title: fromRecord --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka.components](index.md)/[fromRecord](from-record.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka.components](index.md)/[fromRecord](from-record.md) # fromRecord - - [jvm]\ inline fun <[T](from-record.md)> [fromRecord](from-record.md)(record: GenericRecord): [T](from-record.md) - - converts a GenericRecord to a [T](from-record.md) - - #### Return - - the resulting [T](from-record.md) must be annotated with Serializable - - #### Parameters - jvm -| | | -|---|---| +| | | +|--------|---------------| | record | GenericRecord | - - #### Throws - -| | | -|---|---| +| | | +|------------------------|------------------------| | SerializationException | if serialization fails | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/index.md index 148a2648..5939a0c9 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/index.md @@ -1,29 +1,23 @@ --- title: io.github.flaxoos.ktor.server.plugins.kafka.components --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka.components](index.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka.components](index.md) # Package-level declarations - - ## Types - -| Name | Summary | -|---|---| +| Name | Summary | +|----------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [SchemaRegistryClient](-schema-registry-client/index.md) | [jvm]
class [SchemaRegistryClient](-schema-registry-client/index.md)(providedClient: HttpClient, schemaRegistryUrl: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), timeoutMs: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)) | - ## Functions - -| Name | Summary | -|---|---| -| [createSchemaRegistryClient](create-schema-registry-client.md) | [jvm]
fun [createSchemaRegistryClient](create-schema-registry-client.md)(schemaRegistryUrl: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), timeoutMs: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md), clientProvider: () -> HttpClient): [SchemaRegistryClient](-schema-registry-client/index.md) | -| [fromRecord](from-record.md) | [jvm]
inline fun <[T](from-record.md)> [fromRecord](from-record.md)(record: GenericRecord): [T](from-record.md)
converts a GenericRecord to a [T](from-record.md) | -| [subscribe](subscribe.md) | [jvm]
fun Application.[subscribe](subscribe.md)(consumer: [Consumer](../io.github.flaxoos.ktor.server.plugins.kafka/-consumer/index.md), pollFrequency: [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md), topics: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<[TopicName](../io.github.flaxoos.ktor.server.plugins.kafka/-topic-name/index.md)>): Flow<ConsumerRecord<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), GenericRecord>>
Subscribes a [Consumer](../io.github.flaxoos.ktor.server.plugins.kafka/-consumer/index.md) to a list of topics, returning a flow of records | -| [toRecord](to-record.md) | [jvm]
inline fun <[T](to-record.md)> [T](to-record.md).[toRecord](to-record.md)(): GenericRecord
converts a [T](to-record.md) to a GenericRecord | +| Name | Summary | +|----------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [createSchemaRegistryClient](create-schema-registry-client.md) | [jvm]
fun [createSchemaRegistryClient](create-schema-registry-client.md)(schemaRegistryUrl: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), timeoutMs: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md), clientProvider: () -> HttpClient): [SchemaRegistryClient](-schema-registry-client/index.md) | +| [fromRecord](from-record.md) | [jvm]
inline fun <[T](from-record.md)> [fromRecord](from-record.md)(record: GenericRecord): [T](from-record.md)
converts a GenericRecord to a [T](from-record.md) | +| [subscribe](subscribe.md) | [jvm]
fun Application.[subscribe](subscribe.md)(consumer: [Consumer](../io.github.flaxoos.ktor.server.plugins.kafka/-consumer/index.md), pollFrequency: [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md), topics: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<[TopicName](../io.github.flaxoos.ktor.server.plugins.kafka/-topic-name/index.md)>): Flow<ConsumerRecord<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), GenericRecord>>
Subscribes a [Consumer](../io.github.flaxoos.ktor.server.plugins.kafka/-consumer/index.md) to a list of topics, returning a flow of records | +| [toRecord](to-record.md) | [jvm]
inline fun <[T](to-record.md)> [T](to-record.md).[toRecord](to-record.md)(): GenericRecord
converts a [T](to-record.md) to a GenericRecord | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/subscribe.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/subscribe.md index 021b6edb..6cbe1eee 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/subscribe.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/subscribe.md @@ -1,49 +1,40 @@ --- title: subscribe --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka.components](index.md)/[subscribe](subscribe.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka.components](index.md)/[subscribe](subscribe.md) # subscribe - - [jvm]\ -fun Application.[subscribe](subscribe.md)(consumer: [Consumer](../io.github.flaxoos.ktor.server.plugins.kafka/-consumer/index.md), pollFrequency: [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md), topics: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<[TopicName](../io.github.flaxoos.ktor.server.plugins.kafka/-topic-name/index.md)>): Flow<ConsumerRecord<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), GenericRecord>> - - - -Subscribes a [Consumer](../io.github.flaxoos.ktor.server.plugins.kafka/-consumer/index.md) to a list of topics, returning a flow of records - +fun Application.[subscribe](subscribe.md)( +consumer: [Consumer](../io.github.flaxoos.ktor.server.plugins.kafka/-consumer/index.md), +pollFrequency: [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md), +topics: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md) +<[TopicName](../io.github.flaxoos.ktor.server.plugins.kafka/-topic-name/index.md)>): +Flow<ConsumerRecord<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), +GenericRecord>> +Subscribes a [Consumer](../io.github.flaxoos.ktor.server.plugins.kafka/-consumer/index.md) to a list of topics, +returning a flow of records #### Receiver - - Application the ktor server application - - #### Return - - Flow of records - - #### Parameters - jvm -| | | -|---|---| -| consumer | [Consumer](../io.github.flaxoos.ktor.server.plugins.kafka/-consumer/index.md) to subscribe | +| | | +|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| consumer | [Consumer](../io.github.flaxoos.ktor.server.plugins.kafka/-consumer/index.md) to subscribe | | pollFrequency | [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md) at what frequency should the consumer poll, in practice the timeout passed to KafkaConsumer.poll | -| topics | [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md) of topics to subscribe to | +| topics | [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md) of topics to subscribe to | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/to-record.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/to-record.md index b6dd9196..1fcc20ca 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/to-record.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/to-record.md @@ -1,44 +1,28 @@ --- title: toRecord --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka.components](index.md)/[toRecord](to-record.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka.components](index.md)/[toRecord](to-record.md) # toRecord - - [jvm]\ inline fun <[T](to-record.md)> [T](to-record.md).[toRecord](to-record.md)(): GenericRecord - - converts a [T](to-record.md) to a GenericRecord - - #### Receiver - - the [T](to-record.md) to convert, must be annotated with Serializable - - #### Return - - the resulting GenericRecord - - #### Throws - -| | | -|---|---| +| | | +|------------------------|------------------------| | SerializationException | if serialization fails | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-abstract-kafka-config/consumer-config.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-abstract-kafka-config/consumer-config.md index 0d042c6c..18865815 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-abstract-kafka-config/consumer-config.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-abstract-kafka-config/consumer-config.md @@ -1,19 +1,14 @@ --- title: consumerConfig --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[AbstractKafkaConfig](index.md)/[consumerConfig](consumer-config.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[AbstractKafkaConfig](index.md)/[consumerConfig](consumer-config.md) # consumerConfig - - [jvm]\ var [consumerConfig](consumer-config.md): [KafkaConsumerConfig](../-kafka-consumer-config/index.md)? - - Because the consumer is operating in the background, it can be defined in the setup phase diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-abstract-kafka-config/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-abstract-kafka-config/index.md index 0c670fbe..3994f226 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-abstract-kafka-config/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-abstract-kafka-config/index.md @@ -1,9 +1,8 @@ --- title: AbstractKafkaConfig --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[AbstractKafkaConfig](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[AbstractKafkaConfig](index.md) # AbstractKafkaConfig @@ -11,28 +10,23 @@ sealed class [AbstractKafkaConfig](index.md) #### Inheritors - -| | -|---| -| [KafkaConfig](../-kafka-config/index.md) | +| | +|---------------------------------------------------| +| [KafkaConfig](../-kafka-config/index.md) | | [KafkaFileConfig](../-kafka-file-config/index.md) | - ## Properties - -| Name | Summary | -|---|---| -| [consumerConfig](consumer-config.md) | [jvm]
var [consumerConfig](consumer-config.md): [KafkaConsumerConfig](../-kafka-consumer-config/index.md)?
Because the consumer is operating in the background, it can be defined in the setup phase | -| [schemaRegistrationTimeoutMs](schema-registration-timeout-ms.md) | [jvm]
var [schemaRegistrationTimeoutMs](schema-registration-timeout-ms.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)
Schema registration timeout | -| [schemaRegistryUrl](schema-registry-url.md) | [jvm]
abstract val [schemaRegistryUrl](schema-registry-url.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?
The schema registry url, if set, a client will be created and can be accessed later to register schemas manually, if schemas is left empty | - +| Name | Summary | +|------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [consumerConfig](consumer-config.md) | [jvm]
var [consumerConfig](consumer-config.md): [KafkaConsumerConfig](../-kafka-consumer-config/index.md)?
Because the consumer is operating in the background, it can be defined in the setup phase | +| [schemaRegistrationTimeoutMs](schema-registration-timeout-ms.md) | [jvm]
var [schemaRegistrationTimeoutMs](schema-registration-timeout-ms.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)
Schema registration timeout | +| [schemaRegistryUrl](schema-registry-url.md) | [jvm]
abstract val [schemaRegistryUrl](schema-registry-url.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?
The schema registry url, if set, a client will be created and can be accessed later to register schemas manually, if schemas is left empty | ## Functions - -| Name | Summary | -|---|---| -| [consumerConfig](../consumer-config.md) | [jvm]
fun [AbstractKafkaConfig](index.md).[consumerConfig](../consumer-config.md)(configuration: [KafkaConsumerConfig](../-kafka-consumer-config/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { }) | +| Name | Summary | +|-------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [consumerConfig](../consumer-config.md) | [jvm]
fun [AbstractKafkaConfig](index.md).[consumerConfig](../consumer-config.md)(configuration: [KafkaConsumerConfig](../-kafka-consumer-config/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { }) | | [registerSchemas](../register-schemas.md) | [jvm]
fun [AbstractKafkaConfig](index.md).[registerSchemas](../register-schemas.md)(configuration: [SchemaRegistrationBuilder](../-schema-registration-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { SchemaRegistrationBuilder() }) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-abstract-kafka-config/schema-registration-timeout-ms.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-abstract-kafka-config/schema-registration-timeout-ms.md index d735b577..0e2f370e 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-abstract-kafka-config/schema-registration-timeout-ms.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-abstract-kafka-config/schema-registration-timeout-ms.md @@ -1,19 +1,14 @@ --- title: schemaRegistrationTimeoutMs --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[AbstractKafkaConfig](index.md)/[schemaRegistrationTimeoutMs](schema-registration-timeout-ms.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[AbstractKafkaConfig](index.md)/[schemaRegistrationTimeoutMs](schema-registration-timeout-ms.md) # schemaRegistrationTimeoutMs - - [jvm]\ var [schemaRegistrationTimeoutMs](schema-registration-timeout-ms.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) - - Schema registration timeout diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-abstract-kafka-config/schema-registry-url.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-abstract-kafka-config/schema-registry-url.md index cbc96b01..dab1092e 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-abstract-kafka-config/schema-registry-url.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-abstract-kafka-config/schema-registry-url.md @@ -1,20 +1,17 @@ --- title: schemaRegistryUrl --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[AbstractKafkaConfig](index.md)/[schemaRegistryUrl](schema-registry-url.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[AbstractKafkaConfig](index.md)/[schemaRegistryUrl](schema-registry-url.md) # schemaRegistryUrl - - [jvm]\ -abstract val [schemaRegistryUrl](schema-registry-url.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? - - +abstract +val [schemaRegistryUrl](schema-registry-url.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? -The schema registry url, if set, a client will be created and can be accessed later to register schemas manually, if schemas is left empty +The schema registry url, if set, a client will be created and can be accessed later to register schemas manually, if +schemas is left empty diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-admin-properties-builder/-admin-properties-builder.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-admin-properties-builder/-admin-properties-builder.md index ff35d52c..86f874b3 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-admin-properties-builder/-admin-properties-builder.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-admin-properties-builder/-admin-properties-builder.md @@ -1,14 +1,11 @@ --- title: AdminPropertiesBuilder --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[AdminPropertiesBuilder](index.md)/[AdminPropertiesBuilder](-admin-properties-builder.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[AdminPropertiesBuilder](index.md)/[AdminPropertiesBuilder](-admin-properties-builder.md) # AdminPropertiesBuilder - - [jvm]\ constructor() diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-admin-properties-builder/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-admin-properties-builder/index.md index 46344e36..c46d480a 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-admin-properties-builder/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-admin-properties-builder/index.md @@ -1,56 +1,46 @@ --- title: AdminPropertiesBuilder --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[AdminPropertiesBuilder](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[AdminPropertiesBuilder](index.md) # AdminPropertiesBuilder - - [jvm]\ class [AdminPropertiesBuilder](index.md) : [ClientPropertiesBuilder](../-client-properties-builder/index.md) - - ## Constructors - -| | | -|---|---| +| | | +|--------------------------------------------------------|------------------------| | [AdminPropertiesBuilder](-admin-properties-builder.md) | [jvm]
constructor() | - ## Properties - -| Name | Summary | -|---|---| -| [bootstrapServers](../-client-properties-builder/bootstrap-servers.md) | [jvm]
var [bootstrapServers](../-client-properties-builder/bootstrap-servers.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [clientDnsLookup](../-client-properties-builder/client-dns-lookup.md) | [jvm]
var [clientDnsLookup](../-client-properties-builder/client-dns-lookup.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [clientId](../-client-properties-builder/client-id.md) | [jvm]
var [clientId](../-client-properties-builder/client-id.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [clientRack](../-client-properties-builder/client-rack.md) | [jvm]
var [clientRack](../-client-properties-builder/client-rack.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [connectionsMaxIdleMs](../-client-properties-builder/connections-max-idle-ms.md) | [jvm]
var [connectionsMaxIdleMs](../-client-properties-builder/connections-max-idle-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [metadataMaxAge](../-client-properties-builder/metadata-max-age.md) | [jvm]
var [metadataMaxAge](../-client-properties-builder/metadata-max-age.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [metricReporterClasses](../-client-properties-builder/metric-reporter-classes.md) | [jvm]
var [metricReporterClasses](../-client-properties-builder/metric-reporter-classes.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [metricsNumSamples](../-client-properties-builder/metrics-num-samples.md) | [jvm]
var [metricsNumSamples](../-client-properties-builder/metrics-num-samples.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [metricsRecordingLevel](../-client-properties-builder/metrics-recording-level.md) | [jvm]
var [metricsRecordingLevel](../-client-properties-builder/metrics-recording-level.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| Name | Summary | +|------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [bootstrapServers](../-client-properties-builder/bootstrap-servers.md) | [jvm]
var [bootstrapServers](../-client-properties-builder/bootstrap-servers.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [clientDnsLookup](../-client-properties-builder/client-dns-lookup.md) | [jvm]
var [clientDnsLookup](../-client-properties-builder/client-dns-lookup.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [clientId](../-client-properties-builder/client-id.md) | [jvm]
var [clientId](../-client-properties-builder/client-id.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [clientRack](../-client-properties-builder/client-rack.md) | [jvm]
var [clientRack](../-client-properties-builder/client-rack.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [connectionsMaxIdleMs](../-client-properties-builder/connections-max-idle-ms.md) | [jvm]
var [connectionsMaxIdleMs](../-client-properties-builder/connections-max-idle-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [metadataMaxAge](../-client-properties-builder/metadata-max-age.md) | [jvm]
var [metadataMaxAge](../-client-properties-builder/metadata-max-age.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [metricReporterClasses](../-client-properties-builder/metric-reporter-classes.md) | [jvm]
var [metricReporterClasses](../-client-properties-builder/metric-reporter-classes.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [metricsNumSamples](../-client-properties-builder/metrics-num-samples.md) | [jvm]
var [metricsNumSamples](../-client-properties-builder/metrics-num-samples.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [metricsRecordingLevel](../-client-properties-builder/metrics-recording-level.md) | [jvm]
var [metricsRecordingLevel](../-client-properties-builder/metrics-recording-level.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | | [metricsSampleWindowMs](../-client-properties-builder/metrics-sample-window-ms.md) | [jvm]
var [metricsSampleWindowMs](../-client-properties-builder/metrics-sample-window-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [receiveBuffer](../-client-properties-builder/receive-buffer.md) | [jvm]
var [receiveBuffer](../-client-properties-builder/receive-buffer.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [receiveBuffer](../-client-properties-builder/receive-buffer.md) | [jvm]
var [receiveBuffer](../-client-properties-builder/receive-buffer.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | | [reconnectBackoffMaxMs](../-client-properties-builder/reconnect-backoff-max-ms.md) | [jvm]
var [reconnectBackoffMaxMs](../-client-properties-builder/reconnect-backoff-max-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [reconnectBackoffMs](../-client-properties-builder/reconnect-backoff-ms.md) | [jvm]
var [reconnectBackoffMs](../-client-properties-builder/reconnect-backoff-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [requestTimeoutMs](../-client-properties-builder/request-timeout-ms.md) | [jvm]
var [requestTimeoutMs](../-client-properties-builder/request-timeout-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [retries](../-client-properties-builder/retries.md) | [jvm]
var [retries](../-client-properties-builder/retries.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [retryBackoffMs](../-client-properties-builder/retry-backoff-ms.md) | [jvm]
var [retryBackoffMs](../-client-properties-builder/retry-backoff-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [securityProtocol](../-client-properties-builder/security-protocol.md) | [jvm]
var [securityProtocol](../-client-properties-builder/security-protocol.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [sendBuffer](../-client-properties-builder/send-buffer.md) | [jvm]
var [sendBuffer](../-client-properties-builder/send-buffer.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | - +| [reconnectBackoffMs](../-client-properties-builder/reconnect-backoff-ms.md) | [jvm]
var [reconnectBackoffMs](../-client-properties-builder/reconnect-backoff-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [requestTimeoutMs](../-client-properties-builder/request-timeout-ms.md) | [jvm]
var [requestTimeoutMs](../-client-properties-builder/request-timeout-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [retries](../-client-properties-builder/retries.md) | [jvm]
var [retries](../-client-properties-builder/retries.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [retryBackoffMs](../-client-properties-builder/retry-backoff-ms.md) | [jvm]
var [retryBackoffMs](../-client-properties-builder/retry-backoff-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [securityProtocol](../-client-properties-builder/security-protocol.md) | [jvm]
var [securityProtocol](../-client-properties-builder/security-protocol.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [sendBuffer](../-client-properties-builder/send-buffer.md) | [jvm]
var [sendBuffer](../-client-properties-builder/send-buffer.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | ## Functions - -| Name | Summary | -|---|---| +| Name | Summary | +|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [build](../-client-properties-builder/build.md) | [jvm]
open override fun [build](../-client-properties-builder/build.md)(): [MutableMap](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.md)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)?> | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-attributes/-admin-client-attribute-key.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-attributes/-admin-client-attribute-key.md index 3ab3f59c..284bb30e 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-attributes/-admin-client-attribute-key.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-attributes/-admin-client-attribute-key.md @@ -1,19 +1,14 @@ --- title: AdminClientAttributeKey --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[Attributes](index.md)/[AdminClientAttributeKey](-admin-client-attribute-key.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[Attributes](index.md)/[AdminClientAttributeKey](-admin-client-attribute-key.md) # AdminClientAttributeKey - - [jvm]\ val [AdminClientAttributeKey](-admin-client-attribute-key.md): AttributeKey<AdminClient> - - Attribute key for AdminClient diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-attributes/-consumer-attribute-key.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-attributes/-consumer-attribute-key.md index 3b1d23a2..3e05bd03 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-attributes/-consumer-attribute-key.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-attributes/-consumer-attribute-key.md @@ -1,18 +1,14 @@ --- title: ConsumerAttributeKey --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[Attributes](index.md)/[ConsumerAttributeKey](-consumer-attribute-key.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[Attributes](index.md)/[ConsumerAttributeKey](-consumer-attribute-key.md) # ConsumerAttributeKey - - [jvm]\ -val [ConsumerAttributeKey](-consumer-attribute-key.md): AttributeKey<KafkaConsumer<[KafkaRecordKey](../-kafka-record-key/index.md), GenericRecord>> - - +val [ConsumerAttributeKey](-consumer-attribute-key.md): +AttributeKey<KafkaConsumer<[KafkaRecordKey](../-kafka-record-key/index.md), GenericRecord>> Attribute key for [Consumer](../-consumer/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-attributes/-producer-attribute-key.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-attributes/-producer-attribute-key.md index 4956adc1..65ea4c76 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-attributes/-producer-attribute-key.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-attributes/-producer-attribute-key.md @@ -1,18 +1,14 @@ --- title: ProducerAttributeKey --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[Attributes](index.md)/[ProducerAttributeKey](-producer-attribute-key.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[Attributes](index.md)/[ProducerAttributeKey](-producer-attribute-key.md) # ProducerAttributeKey - - [jvm]\ -val [ProducerAttributeKey](-producer-attribute-key.md): AttributeKey<KafkaProducer<[KafkaRecordKey](../-kafka-record-key/index.md), GenericRecord>> - - +val [ProducerAttributeKey](-producer-attribute-key.md): +AttributeKey<KafkaProducer<[KafkaRecordKey](../-kafka-record-key/index.md), GenericRecord>> Attribute key for [Producer](../-producer/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-attributes/-schema-registry-client-key.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-attributes/-schema-registry-client-key.md index d3e0682f..963783c0 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-attributes/-schema-registry-client-key.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-attributes/-schema-registry-client-key.md @@ -1,18 +1,15 @@ --- title: SchemaRegistryClientKey --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[Attributes](index.md)/[SchemaRegistryClientKey](-schema-registry-client-key.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[Attributes](index.md)/[SchemaRegistryClientKey](-schema-registry-client-key.md) # SchemaRegistryClientKey - - [jvm]\ -val [SchemaRegistryClientKey](-schema-registry-client-key.md): AttributeKey<[SchemaRegistryClient](../../io.github.flaxoos.ktor.server.plugins.kafka.components/-schema-registry-client/index.md)> - - +val [SchemaRegistryClientKey](-schema-registry-client-key.md): +AttributeKey<[SchemaRegistryClient](../../io.github.flaxoos.ktor.server.plugins.kafka.components/-schema-registry-client/index.md) +> Attribute key for HttpClient used for registering Schemas to the configured schema registry diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-attributes/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-attributes/index.md index ed3fc65e..a5569658 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-attributes/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-attributes/index.md @@ -1,26 +1,20 @@ --- title: Attributes --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[Attributes](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[Attributes](index.md) # Attributes - - [jvm]\ object [Attributes](index.md) - - ## Properties - -| Name | Summary | -|---|---| -| [AdminClientAttributeKey](-admin-client-attribute-key.md) | [jvm]
val [AdminClientAttributeKey](-admin-client-attribute-key.md): AttributeKey<AdminClient>
Attribute key for AdminClient | -| [ConsumerAttributeKey](-consumer-attribute-key.md) | [jvm]
val [ConsumerAttributeKey](-consumer-attribute-key.md): AttributeKey<KafkaConsumer<[KafkaRecordKey](../-kafka-record-key/index.md), GenericRecord>>
Attribute key for [Consumer](../-consumer/index.md) | -| [ProducerAttributeKey](-producer-attribute-key.md) | [jvm]
val [ProducerAttributeKey](-producer-attribute-key.md): AttributeKey<KafkaProducer<[KafkaRecordKey](../-kafka-record-key/index.md), GenericRecord>>
Attribute key for [Producer](../-producer/index.md) | +| Name | Summary | +|-----------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [AdminClientAttributeKey](-admin-client-attribute-key.md) | [jvm]
val [AdminClientAttributeKey](-admin-client-attribute-key.md): AttributeKey<AdminClient>
Attribute key for AdminClient | +| [ConsumerAttributeKey](-consumer-attribute-key.md) | [jvm]
val [ConsumerAttributeKey](-consumer-attribute-key.md): AttributeKey<KafkaConsumer<[KafkaRecordKey](../-kafka-record-key/index.md), GenericRecord>>
Attribute key for [Consumer](../-consumer/index.md) | +| [ProducerAttributeKey](-producer-attribute-key.md) | [jvm]
val [ProducerAttributeKey](-producer-attribute-key.md): AttributeKey<KafkaProducer<[KafkaRecordKey](../-kafka-record-key/index.md), GenericRecord>>
Attribute key for [Producer](../-producer/index.md) | | [SchemaRegistryClientKey](-schema-registry-client-key.md) | [jvm]
val [SchemaRegistryClientKey](-schema-registry-client-key.md): AttributeKey<[SchemaRegistryClient](../../io.github.flaxoos.ktor.server.plugins.kafka.components/-schema-registry-client/index.md)>
Attribute key for HttpClient used for registering Schemas to the configured schema registry | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/bootstrap-servers.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/bootstrap-servers.md index 70bd4c50..ae2dae74 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/bootstrap-servers.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/bootstrap-servers.md @@ -1,14 +1,11 @@ --- title: bootstrapServers --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ClientPropertiesBuilder](index.md)/[bootstrapServers](bootstrap-servers.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ClientPropertiesBuilder](index.md)/[bootstrapServers](bootstrap-servers.md) # bootstrapServers - - [jvm]\ var [bootstrapServers](bootstrap-servers.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/build.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/build.md index d4649b0c..8b5d54e1 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/build.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/build.md @@ -1,16 +1,16 @@ --- title: build --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ClientPropertiesBuilder](index.md)/[build](build.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ClientPropertiesBuilder](index.md)/[build](build.md) # build - - [jvm]\ -open override fun [build](build.md)(): [MutableMap](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.md)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)?> +open override +fun [build](build.md)(): [MutableMap](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.md) +<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md) +?> diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/client-dns-lookup.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/client-dns-lookup.md index 90d3b974..9e5893d5 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/client-dns-lookup.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/client-dns-lookup.md @@ -1,14 +1,11 @@ --- title: clientDnsLookup --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ClientPropertiesBuilder](index.md)/[clientDnsLookup](client-dns-lookup.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ClientPropertiesBuilder](index.md)/[clientDnsLookup](client-dns-lookup.md) # clientDnsLookup - - [jvm]\ var [clientDnsLookup](client-dns-lookup.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/client-id.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/client-id.md index ea22747f..baba274b 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/client-id.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/client-id.md @@ -1,14 +1,11 @@ --- title: clientId --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ClientPropertiesBuilder](index.md)/[clientId](client-id.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ClientPropertiesBuilder](index.md)/[clientId](client-id.md) # clientId - - [jvm]\ var [clientId](client-id.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/client-rack.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/client-rack.md index 40d729e5..66efdb78 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/client-rack.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/client-rack.md @@ -1,14 +1,11 @@ --- title: clientRack --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ClientPropertiesBuilder](index.md)/[clientRack](client-rack.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ClientPropertiesBuilder](index.md)/[clientRack](client-rack.md) # clientRack - - [jvm]\ var [clientRack](client-rack.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/connections-max-idle-ms.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/connections-max-idle-ms.md index a0cc4878..e12d178f 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/connections-max-idle-ms.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/connections-max-idle-ms.md @@ -1,14 +1,11 @@ --- title: connectionsMaxIdleMs --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ClientPropertiesBuilder](index.md)/[connectionsMaxIdleMs](connections-max-idle-ms.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ClientPropertiesBuilder](index.md)/[connectionsMaxIdleMs](connections-max-idle-ms.md) # connectionsMaxIdleMs - - [jvm]\ var [connectionsMaxIdleMs](connections-max-idle-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/index.md index 3c0947f9..e12d0461 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/index.md @@ -1,9 +1,8 @@ --- title: ClientPropertiesBuilder --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ClientPropertiesBuilder](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ClientPropertiesBuilder](index.md) # ClientPropertiesBuilder @@ -11,48 +10,41 @@ sealed class [ClientPropertiesBuilder](index.md) : [KafkaPropertiesBuilder](../- see CommonClientConfigs - - #### Inheritors - -| | -|---| +| | +|--------------------------------------------------------------------------------| | [CommonClientPropertiesBuilder](../-common-client-properties-builder/index.md) | -| [AdminPropertiesBuilder](../-admin-properties-builder/index.md) | -| [ProducerPropertiesBuilder](../-producer-properties-builder/index.md) | -| [ConsumerPropertiesBuilder](../-consumer-properties-builder/index.md) | - +| [AdminPropertiesBuilder](../-admin-properties-builder/index.md) | +| [ProducerPropertiesBuilder](../-producer-properties-builder/index.md) | +| [ConsumerPropertiesBuilder](../-consumer-properties-builder/index.md) | ## Properties - -| Name | Summary | -|---|---| -| [bootstrapServers](bootstrap-servers.md) | [jvm]
var [bootstrapServers](bootstrap-servers.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [clientDnsLookup](client-dns-lookup.md) | [jvm]
var [clientDnsLookup](client-dns-lookup.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [clientId](client-id.md) | [jvm]
var [clientId](client-id.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [clientRack](client-rack.md) | [jvm]
var [clientRack](client-rack.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [connectionsMaxIdleMs](connections-max-idle-ms.md) | [jvm]
var [connectionsMaxIdleMs](connections-max-idle-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [metadataMaxAge](metadata-max-age.md) | [jvm]
var [metadataMaxAge](metadata-max-age.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [metricReporterClasses](metric-reporter-classes.md) | [jvm]
var [metricReporterClasses](metric-reporter-classes.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [metricsNumSamples](metrics-num-samples.md) | [jvm]
var [metricsNumSamples](metrics-num-samples.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [metricsRecordingLevel](metrics-recording-level.md) | [jvm]
var [metricsRecordingLevel](metrics-recording-level.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| Name | Summary | +|------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------| +| [bootstrapServers](bootstrap-servers.md) | [jvm]
var [bootstrapServers](bootstrap-servers.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [clientDnsLookup](client-dns-lookup.md) | [jvm]
var [clientDnsLookup](client-dns-lookup.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [clientId](client-id.md) | [jvm]
var [clientId](client-id.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [clientRack](client-rack.md) | [jvm]
var [clientRack](client-rack.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [connectionsMaxIdleMs](connections-max-idle-ms.md) | [jvm]
var [connectionsMaxIdleMs](connections-max-idle-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [metadataMaxAge](metadata-max-age.md) | [jvm]
var [metadataMaxAge](metadata-max-age.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [metricReporterClasses](metric-reporter-classes.md) | [jvm]
var [metricReporterClasses](metric-reporter-classes.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [metricsNumSamples](metrics-num-samples.md) | [jvm]
var [metricsNumSamples](metrics-num-samples.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [metricsRecordingLevel](metrics-recording-level.md) | [jvm]
var [metricsRecordingLevel](metrics-recording-level.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | | [metricsSampleWindowMs](metrics-sample-window-ms.md) | [jvm]
var [metricsSampleWindowMs](metrics-sample-window-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [receiveBuffer](receive-buffer.md) | [jvm]
var [receiveBuffer](receive-buffer.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [receiveBuffer](receive-buffer.md) | [jvm]
var [receiveBuffer](receive-buffer.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | | [reconnectBackoffMaxMs](reconnect-backoff-max-ms.md) | [jvm]
var [reconnectBackoffMaxMs](reconnect-backoff-max-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [reconnectBackoffMs](reconnect-backoff-ms.md) | [jvm]
var [reconnectBackoffMs](reconnect-backoff-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [requestTimeoutMs](request-timeout-ms.md) | [jvm]
var [requestTimeoutMs](request-timeout-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [retries](retries.md) | [jvm]
var [retries](retries.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [retryBackoffMs](retry-backoff-ms.md) | [jvm]
var [retryBackoffMs](retry-backoff-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [securityProtocol](security-protocol.md) | [jvm]
var [securityProtocol](security-protocol.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [sendBuffer](send-buffer.md) | [jvm]
var [sendBuffer](send-buffer.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | - +| [reconnectBackoffMs](reconnect-backoff-ms.md) | [jvm]
var [reconnectBackoffMs](reconnect-backoff-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [requestTimeoutMs](request-timeout-ms.md) | [jvm]
var [requestTimeoutMs](request-timeout-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [retries](retries.md) | [jvm]
var [retries](retries.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [retryBackoffMs](retry-backoff-ms.md) | [jvm]
var [retryBackoffMs](retry-backoff-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [securityProtocol](security-protocol.md) | [jvm]
var [securityProtocol](security-protocol.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [sendBuffer](send-buffer.md) | [jvm]
var [sendBuffer](send-buffer.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | ## Functions - -| Name | Summary | -|---|---| +| Name | Summary | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [build](build.md) | [jvm]
open override fun [build](build.md)(): [MutableMap](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.md)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)?> | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/metadata-max-age.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/metadata-max-age.md index d3e36aeb..ceacfa0f 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/metadata-max-age.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/metadata-max-age.md @@ -1,14 +1,11 @@ --- title: metadataMaxAge --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ClientPropertiesBuilder](index.md)/[metadataMaxAge](metadata-max-age.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ClientPropertiesBuilder](index.md)/[metadataMaxAge](metadata-max-age.md) # metadataMaxAge - - [jvm]\ var [metadataMaxAge](metadata-max-age.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/metric-reporter-classes.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/metric-reporter-classes.md index b828ad23..f3de2b23 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/metric-reporter-classes.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/metric-reporter-classes.md @@ -1,14 +1,11 @@ --- title: metricReporterClasses --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ClientPropertiesBuilder](index.md)/[metricReporterClasses](metric-reporter-classes.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ClientPropertiesBuilder](index.md)/[metricReporterClasses](metric-reporter-classes.md) # metricReporterClasses - - [jvm]\ var [metricReporterClasses](metric-reporter-classes.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/metrics-num-samples.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/metrics-num-samples.md index 889b4c46..058030e3 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/metrics-num-samples.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/metrics-num-samples.md @@ -1,14 +1,11 @@ --- title: metricsNumSamples --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ClientPropertiesBuilder](index.md)/[metricsNumSamples](metrics-num-samples.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ClientPropertiesBuilder](index.md)/[metricsNumSamples](metrics-num-samples.md) # metricsNumSamples - - [jvm]\ var [metricsNumSamples](metrics-num-samples.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/metrics-recording-level.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/metrics-recording-level.md index 439f82c2..2561e0db 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/metrics-recording-level.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/metrics-recording-level.md @@ -1,14 +1,11 @@ --- title: metricsRecordingLevel --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ClientPropertiesBuilder](index.md)/[metricsRecordingLevel](metrics-recording-level.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ClientPropertiesBuilder](index.md)/[metricsRecordingLevel](metrics-recording-level.md) # metricsRecordingLevel - - [jvm]\ var [metricsRecordingLevel](metrics-recording-level.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/metrics-sample-window-ms.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/metrics-sample-window-ms.md index 9bbb76a1..e3c492fb 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/metrics-sample-window-ms.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/metrics-sample-window-ms.md @@ -1,14 +1,11 @@ --- title: metricsSampleWindowMs --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ClientPropertiesBuilder](index.md)/[metricsSampleWindowMs](metrics-sample-window-ms.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ClientPropertiesBuilder](index.md)/[metricsSampleWindowMs](metrics-sample-window-ms.md) # metricsSampleWindowMs - - [jvm]\ var [metricsSampleWindowMs](metrics-sample-window-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/receive-buffer.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/receive-buffer.md index 88d7ff57..6bc56126 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/receive-buffer.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/receive-buffer.md @@ -1,14 +1,11 @@ --- title: receiveBuffer --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ClientPropertiesBuilder](index.md)/[receiveBuffer](receive-buffer.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ClientPropertiesBuilder](index.md)/[receiveBuffer](receive-buffer.md) # receiveBuffer - - [jvm]\ var [receiveBuffer](receive-buffer.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/reconnect-backoff-max-ms.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/reconnect-backoff-max-ms.md index b36cca1c..09191c8c 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/reconnect-backoff-max-ms.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/reconnect-backoff-max-ms.md @@ -1,14 +1,11 @@ --- title: reconnectBackoffMaxMs --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ClientPropertiesBuilder](index.md)/[reconnectBackoffMaxMs](reconnect-backoff-max-ms.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ClientPropertiesBuilder](index.md)/[reconnectBackoffMaxMs](reconnect-backoff-max-ms.md) # reconnectBackoffMaxMs - - [jvm]\ var [reconnectBackoffMaxMs](reconnect-backoff-max-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/reconnect-backoff-ms.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/reconnect-backoff-ms.md index f444f0bf..e11cebdb 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/reconnect-backoff-ms.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/reconnect-backoff-ms.md @@ -1,14 +1,11 @@ --- title: reconnectBackoffMs --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ClientPropertiesBuilder](index.md)/[reconnectBackoffMs](reconnect-backoff-ms.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ClientPropertiesBuilder](index.md)/[reconnectBackoffMs](reconnect-backoff-ms.md) # reconnectBackoffMs - - [jvm]\ var [reconnectBackoffMs](reconnect-backoff-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/request-timeout-ms.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/request-timeout-ms.md index 1b41b1fb..fad952e1 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/request-timeout-ms.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/request-timeout-ms.md @@ -1,14 +1,11 @@ --- title: requestTimeoutMs --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ClientPropertiesBuilder](index.md)/[requestTimeoutMs](request-timeout-ms.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ClientPropertiesBuilder](index.md)/[requestTimeoutMs](request-timeout-ms.md) # requestTimeoutMs - - [jvm]\ var [requestTimeoutMs](request-timeout-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/retries.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/retries.md index 184bff82..4ed5edaa 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/retries.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/retries.md @@ -1,14 +1,11 @@ --- title: retries --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ClientPropertiesBuilder](index.md)/[retries](retries.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ClientPropertiesBuilder](index.md)/[retries](retries.md) # retries - - [jvm]\ var [retries](retries.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/retry-backoff-ms.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/retry-backoff-ms.md index fbabd2d3..be46314d 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/retry-backoff-ms.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/retry-backoff-ms.md @@ -1,14 +1,11 @@ --- title: retryBackoffMs --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ClientPropertiesBuilder](index.md)/[retryBackoffMs](retry-backoff-ms.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ClientPropertiesBuilder](index.md)/[retryBackoffMs](retry-backoff-ms.md) # retryBackoffMs - - [jvm]\ var [retryBackoffMs](retry-backoff-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/security-protocol.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/security-protocol.md index 024c9a15..5da15dfd 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/security-protocol.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/security-protocol.md @@ -1,14 +1,11 @@ --- title: securityProtocol --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ClientPropertiesBuilder](index.md)/[securityProtocol](security-protocol.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ClientPropertiesBuilder](index.md)/[securityProtocol](security-protocol.md) # securityProtocol - - [jvm]\ var [securityProtocol](security-protocol.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/send-buffer.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/send-buffer.md index c0f5dec0..4f850897 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/send-buffer.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-client-properties-builder/send-buffer.md @@ -1,14 +1,11 @@ --- title: sendBuffer --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ClientPropertiesBuilder](index.md)/[sendBuffer](send-buffer.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ClientPropertiesBuilder](index.md)/[sendBuffer](send-buffer.md) # sendBuffer - - [jvm]\ var [sendBuffer](send-buffer.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-common-client-properties-builder/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-common-client-properties-builder/index.md index 9aa44763..22f3dd6a 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-common-client-properties-builder/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-common-client-properties-builder/index.md @@ -1,50 +1,44 @@ --- title: CommonClientPropertiesBuilder --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[CommonClientPropertiesBuilder](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[CommonClientPropertiesBuilder](index.md) # CommonClientPropertiesBuilder - - [jvm]\ -data object [CommonClientPropertiesBuilder](index.md) : [ClientPropertiesBuilder](../-client-properties-builder/index.md) - -Concrete implementation of [ClientPropertiesBuilder](../-client-properties-builder/index.md) to represent the common properties - +data +object [CommonClientPropertiesBuilder](index.md) : [ClientPropertiesBuilder](../-client-properties-builder/index.md) +Concrete implementation of [ClientPropertiesBuilder](../-client-properties-builder/index.md) to represent the common +properties ## Properties - -| Name | Summary | -|---|---| -| [bootstrapServers](../-client-properties-builder/bootstrap-servers.md) | [jvm]
var [bootstrapServers](../-client-properties-builder/bootstrap-servers.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [clientDnsLookup](../-client-properties-builder/client-dns-lookup.md) | [jvm]
var [clientDnsLookup](../-client-properties-builder/client-dns-lookup.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [clientId](../-client-properties-builder/client-id.md) | [jvm]
var [clientId](../-client-properties-builder/client-id.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [clientRack](../-client-properties-builder/client-rack.md) | [jvm]
var [clientRack](../-client-properties-builder/client-rack.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [connectionsMaxIdleMs](../-client-properties-builder/connections-max-idle-ms.md) | [jvm]
var [connectionsMaxIdleMs](../-client-properties-builder/connections-max-idle-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [metadataMaxAge](../-client-properties-builder/metadata-max-age.md) | [jvm]
var [metadataMaxAge](../-client-properties-builder/metadata-max-age.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [metricReporterClasses](../-client-properties-builder/metric-reporter-classes.md) | [jvm]
var [metricReporterClasses](../-client-properties-builder/metric-reporter-classes.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [metricsNumSamples](../-client-properties-builder/metrics-num-samples.md) | [jvm]
var [metricsNumSamples](../-client-properties-builder/metrics-num-samples.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [metricsRecordingLevel](../-client-properties-builder/metrics-recording-level.md) | [jvm]
var [metricsRecordingLevel](../-client-properties-builder/metrics-recording-level.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| Name | Summary | +|------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [bootstrapServers](../-client-properties-builder/bootstrap-servers.md) | [jvm]
var [bootstrapServers](../-client-properties-builder/bootstrap-servers.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [clientDnsLookup](../-client-properties-builder/client-dns-lookup.md) | [jvm]
var [clientDnsLookup](../-client-properties-builder/client-dns-lookup.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [clientId](../-client-properties-builder/client-id.md) | [jvm]
var [clientId](../-client-properties-builder/client-id.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [clientRack](../-client-properties-builder/client-rack.md) | [jvm]
var [clientRack](../-client-properties-builder/client-rack.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [connectionsMaxIdleMs](../-client-properties-builder/connections-max-idle-ms.md) | [jvm]
var [connectionsMaxIdleMs](../-client-properties-builder/connections-max-idle-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [metadataMaxAge](../-client-properties-builder/metadata-max-age.md) | [jvm]
var [metadataMaxAge](../-client-properties-builder/metadata-max-age.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [metricReporterClasses](../-client-properties-builder/metric-reporter-classes.md) | [jvm]
var [metricReporterClasses](../-client-properties-builder/metric-reporter-classes.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [metricsNumSamples](../-client-properties-builder/metrics-num-samples.md) | [jvm]
var [metricsNumSamples](../-client-properties-builder/metrics-num-samples.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [metricsRecordingLevel](../-client-properties-builder/metrics-recording-level.md) | [jvm]
var [metricsRecordingLevel](../-client-properties-builder/metrics-recording-level.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | | [metricsSampleWindowMs](../-client-properties-builder/metrics-sample-window-ms.md) | [jvm]
var [metricsSampleWindowMs](../-client-properties-builder/metrics-sample-window-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [receiveBuffer](../-client-properties-builder/receive-buffer.md) | [jvm]
var [receiveBuffer](../-client-properties-builder/receive-buffer.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [receiveBuffer](../-client-properties-builder/receive-buffer.md) | [jvm]
var [receiveBuffer](../-client-properties-builder/receive-buffer.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | | [reconnectBackoffMaxMs](../-client-properties-builder/reconnect-backoff-max-ms.md) | [jvm]
var [reconnectBackoffMaxMs](../-client-properties-builder/reconnect-backoff-max-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [reconnectBackoffMs](../-client-properties-builder/reconnect-backoff-ms.md) | [jvm]
var [reconnectBackoffMs](../-client-properties-builder/reconnect-backoff-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [requestTimeoutMs](../-client-properties-builder/request-timeout-ms.md) | [jvm]
var [requestTimeoutMs](../-client-properties-builder/request-timeout-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [retries](../-client-properties-builder/retries.md) | [jvm]
var [retries](../-client-properties-builder/retries.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [retryBackoffMs](../-client-properties-builder/retry-backoff-ms.md) | [jvm]
var [retryBackoffMs](../-client-properties-builder/retry-backoff-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [securityProtocol](../-client-properties-builder/security-protocol.md) | [jvm]
var [securityProtocol](../-client-properties-builder/security-protocol.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [sendBuffer](../-client-properties-builder/send-buffer.md) | [jvm]
var [sendBuffer](../-client-properties-builder/send-buffer.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | - +| [reconnectBackoffMs](../-client-properties-builder/reconnect-backoff-ms.md) | [jvm]
var [reconnectBackoffMs](../-client-properties-builder/reconnect-backoff-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [requestTimeoutMs](../-client-properties-builder/request-timeout-ms.md) | [jvm]
var [requestTimeoutMs](../-client-properties-builder/request-timeout-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [retries](../-client-properties-builder/retries.md) | [jvm]
var [retries](../-client-properties-builder/retries.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [retryBackoffMs](../-client-properties-builder/retry-backoff-ms.md) | [jvm]
var [retryBackoffMs](../-client-properties-builder/retry-backoff-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [securityProtocol](../-client-properties-builder/security-protocol.md) | [jvm]
var [securityProtocol](../-client-properties-builder/security-protocol.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [sendBuffer](../-client-properties-builder/send-buffer.md) | [jvm]
var [sendBuffer](../-client-properties-builder/send-buffer.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | ## Functions - -| Name | Summary | -|---|---| +| Name | Summary | +|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [build](../-client-properties-builder/build.md) | [jvm]
open override fun [build](../-client-properties-builder/build.md)(): [MutableMap](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.md)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)?> | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-compression-type/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-compression-type/index.md index 03573f82..68a01c03 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-compression-type/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-compression-type/index.md @@ -1,14 +1,11 @@ --- title: CompressionType --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[CompressionType](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[CompressionType](index.md) # CompressionType - - [jvm]\ typealias [CompressionType](index.md) = org.apache.kafka.common.record.CompressionType diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/-consumer-properties-builder.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/-consumer-properties-builder.md index ad049a8b..c068046c 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/-consumer-properties-builder.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/-consumer-properties-builder.md @@ -1,14 +1,11 @@ --- title: ConsumerPropertiesBuilder --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[ConsumerPropertiesBuilder](-consumer-properties-builder.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[ConsumerPropertiesBuilder](-consumer-properties-builder.md) # ConsumerPropertiesBuilder - - [jvm]\ constructor(schemaRegistryUrl: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = null) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/allow-auto-create-topics.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/allow-auto-create-topics.md index f9dd486c..5f4f620e 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/allow-auto-create-topics.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/allow-auto-create-topics.md @@ -1,14 +1,11 @@ --- title: allowAutoCreateTopics --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[allowAutoCreateTopics](allow-auto-create-topics.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[allowAutoCreateTopics](allow-auto-create-topics.md) # allowAutoCreateTopics - - [jvm]\ var [allowAutoCreateTopics](allow-auto-create-topics.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/auto-commit-interval-ms.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/auto-commit-interval-ms.md index a0aff151..d3b65cba 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/auto-commit-interval-ms.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/auto-commit-interval-ms.md @@ -1,14 +1,11 @@ --- title: autoCommitIntervalMs --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[autoCommitIntervalMs](auto-commit-interval-ms.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[autoCommitIntervalMs](auto-commit-interval-ms.md) # autoCommitIntervalMs - - [jvm]\ var [autoCommitIntervalMs](auto-commit-interval-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/auto-offset-reset.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/auto-offset-reset.md index 6bfbe2f3..8107c974 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/auto-offset-reset.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/auto-offset-reset.md @@ -1,14 +1,11 @@ --- title: autoOffsetReset --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[autoOffsetReset](auto-offset-reset.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[autoOffsetReset](auto-offset-reset.md) # autoOffsetReset - - [jvm]\ var [autoOffsetReset](auto-offset-reset.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/build.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/build.md index e949209f..5e13309f 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/build.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/build.md @@ -1,14 +1,11 @@ --- title: build --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[build](build.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[build](build.md) # build - - [jvm]\ open override fun [build](build.md)(): [KafkaProperties](../-kafka-properties/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/check-crcs.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/check-crcs.md index a3173b59..30c4f87b 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/check-crcs.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/check-crcs.md @@ -1,14 +1,11 @@ --- title: checkCrcs --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[checkCrcs](check-crcs.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[checkCrcs](check-crcs.md) # checkCrcs - - [jvm]\ var [checkCrcs](check-crcs.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/default-api-timeout-ms.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/default-api-timeout-ms.md index f35c6583..d1317ef7 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/default-api-timeout-ms.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/default-api-timeout-ms.md @@ -1,14 +1,11 @@ --- title: defaultApiTimeoutMs --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[defaultApiTimeoutMs](default-api-timeout-ms.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[defaultApiTimeoutMs](default-api-timeout-ms.md) # defaultApiTimeoutMs - - [jvm]\ var [defaultApiTimeoutMs](default-api-timeout-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/enable-auto-commit.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/enable-auto-commit.md index 398d7981..e64da2b4 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/enable-auto-commit.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/enable-auto-commit.md @@ -1,14 +1,11 @@ --- title: enableAutoCommit --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[enableAutoCommit](enable-auto-commit.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[enableAutoCommit](enable-auto-commit.md) # enableAutoCommit - - [jvm]\ var [enableAutoCommit](enable-auto-commit.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/exclude-internal-topics.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/exclude-internal-topics.md index c70f3e28..b50d4e6b 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/exclude-internal-topics.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/exclude-internal-topics.md @@ -1,14 +1,11 @@ --- title: excludeInternalTopics --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[excludeInternalTopics](exclude-internal-topics.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[excludeInternalTopics](exclude-internal-topics.md) # excludeInternalTopics - - [jvm]\ var [excludeInternalTopics](exclude-internal-topics.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/fetch-max-bytes.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/fetch-max-bytes.md index 1fbda1be..0bfcca7c 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/fetch-max-bytes.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/fetch-max-bytes.md @@ -1,14 +1,11 @@ --- title: fetchMaxBytes --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[fetchMaxBytes](fetch-max-bytes.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[fetchMaxBytes](fetch-max-bytes.md) # fetchMaxBytes - - [jvm]\ var [fetchMaxBytes](fetch-max-bytes.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/fetch-max-wait-ms.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/fetch-max-wait-ms.md index 953bfea6..400b06d1 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/fetch-max-wait-ms.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/fetch-max-wait-ms.md @@ -1,14 +1,11 @@ --- title: fetchMaxWaitMs --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[fetchMaxWaitMs](fetch-max-wait-ms.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[fetchMaxWaitMs](fetch-max-wait-ms.md) # fetchMaxWaitMs - - [jvm]\ var [fetchMaxWaitMs](fetch-max-wait-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/fetch-min-bytes.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/fetch-min-bytes.md index 6c847b92..d3004aa4 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/fetch-min-bytes.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/fetch-min-bytes.md @@ -1,14 +1,11 @@ --- title: fetchMinBytes --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[fetchMinBytes](fetch-min-bytes.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[fetchMinBytes](fetch-min-bytes.md) # fetchMinBytes - - [jvm]\ var [fetchMinBytes](fetch-min-bytes.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/group-id.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/group-id.md index 81086cc3..c498925e 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/group-id.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/group-id.md @@ -1,14 +1,11 @@ --- title: groupId --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[groupId](group-id.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[groupId](group-id.md) # groupId - - [jvm]\ var [groupId](group-id.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/group-instance-id.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/group-instance-id.md index 3ae11706..f658a876 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/group-instance-id.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/group-instance-id.md @@ -1,14 +1,11 @@ --- title: groupInstanceId --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[groupInstanceId](group-instance-id.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[groupInstanceId](group-instance-id.md) # groupInstanceId - - [jvm]\ var [groupInstanceId](group-instance-id.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/heartbeat-interval-ms.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/heartbeat-interval-ms.md index da42a9ac..56392dbb 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/heartbeat-interval-ms.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/heartbeat-interval-ms.md @@ -1,14 +1,11 @@ --- title: heartbeatIntervalMs --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[heartbeatIntervalMs](heartbeat-interval-ms.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[heartbeatIntervalMs](heartbeat-interval-ms.md) # heartbeatIntervalMs - - [jvm]\ var [heartbeatIntervalMs](heartbeat-interval-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/index.md index d3467815..242bdc4f 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/index.md @@ -1,81 +1,73 @@ --- title: ConsumerPropertiesBuilder --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md) # ConsumerPropertiesBuilder - - [jvm]\ -class [ConsumerPropertiesBuilder](index.md)(var schemaRegistryUrl: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = null) : [ClientPropertiesBuilder](../-client-properties-builder/index.md), SchemaRegistryProvider +class [ConsumerPropertiesBuilder](index.md)(var +schemaRegistryUrl: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = +null) : [ClientPropertiesBuilder](../-client-properties-builder/index.md), SchemaRegistryProvider see ConsumerConfig - - ## Constructors - -| | | -|---|---| +| | | +|--------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------| | [ConsumerPropertiesBuilder](-consumer-properties-builder.md) | [jvm]
constructor(schemaRegistryUrl: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = null) | - ## Properties - -| Name | Summary | -|---|---| -| [allowAutoCreateTopics](allow-auto-create-topics.md) | [jvm]
var [allowAutoCreateTopics](allow-auto-create-topics.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [autoCommitIntervalMs](auto-commit-interval-ms.md) | [jvm]
var [autoCommitIntervalMs](auto-commit-interval-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [autoOffsetReset](auto-offset-reset.md) | [jvm]
var [autoOffsetReset](auto-offset-reset.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [bootstrapServers](../-client-properties-builder/bootstrap-servers.md) | [jvm]
var [bootstrapServers](../-client-properties-builder/bootstrap-servers.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [checkCrcs](check-crcs.md) | [jvm]
var [checkCrcs](check-crcs.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [clientDnsLookup](../-client-properties-builder/client-dns-lookup.md) | [jvm]
var [clientDnsLookup](../-client-properties-builder/client-dns-lookup.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [clientId](../-client-properties-builder/client-id.md) | [jvm]
var [clientId](../-client-properties-builder/client-id.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [clientRack](../-client-properties-builder/client-rack.md) | [jvm]
var [clientRack](../-client-properties-builder/client-rack.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [connectionsMaxIdleMs](../-client-properties-builder/connections-max-idle-ms.md) | [jvm]
var [connectionsMaxIdleMs](../-client-properties-builder/connections-max-idle-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [defaultApiTimeoutMs](default-api-timeout-ms.md) | [jvm]
var [defaultApiTimeoutMs](default-api-timeout-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [enableAutoCommit](enable-auto-commit.md) | [jvm]
var [enableAutoCommit](enable-auto-commit.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [excludeInternalTopics](exclude-internal-topics.md) | [jvm]
var [excludeInternalTopics](exclude-internal-topics.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [fetchMaxBytes](fetch-max-bytes.md) | [jvm]
var [fetchMaxBytes](fetch-max-bytes.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [fetchMaxWaitMs](fetch-max-wait-ms.md) | [jvm]
var [fetchMaxWaitMs](fetch-max-wait-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [fetchMinBytes](fetch-min-bytes.md) | [jvm]
var [fetchMinBytes](fetch-min-bytes.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [groupId](group-id.md) | [jvm]
var [groupId](group-id.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [groupInstanceId](group-instance-id.md) | [jvm]
var [groupInstanceId](group-instance-id.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [heartbeatIntervalMs](heartbeat-interval-ms.md) | [jvm]
var [heartbeatIntervalMs](heartbeat-interval-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [interceptorClasses](interceptor-classes.md) | [jvm]
var [interceptorClasses](interceptor-classes.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [isolationLevel](isolation-level.md) | [jvm]
var [isolationLevel](isolation-level.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [keyDeserializerClass](key-deserializer-class.md) | [jvm]
var [keyDeserializerClass](key-deserializer-class.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [maxPartitionFetchBytes](max-partition-fetch-bytes.md) | [jvm]
var [maxPartitionFetchBytes](max-partition-fetch-bytes.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [maxPollIntervalMs](max-poll-interval-ms.md) | [jvm]
var [maxPollIntervalMs](max-poll-interval-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [maxPollRecords](max-poll-records.md) | [jvm]
var [maxPollRecords](max-poll-records.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [metadataMaxAge](../-client-properties-builder/metadata-max-age.md) | [jvm]
var [metadataMaxAge](../-client-properties-builder/metadata-max-age.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [metricReporterClasses](../-client-properties-builder/metric-reporter-classes.md) | [jvm]
var [metricReporterClasses](../-client-properties-builder/metric-reporter-classes.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [metricsNumSamples](../-client-properties-builder/metrics-num-samples.md) | [jvm]
var [metricsNumSamples](../-client-properties-builder/metrics-num-samples.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [metricsRecordingLevel](../-client-properties-builder/metrics-recording-level.md) | [jvm]
var [metricsRecordingLevel](../-client-properties-builder/metrics-recording-level.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| Name | Summary | +|------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [allowAutoCreateTopics](allow-auto-create-topics.md) | [jvm]
var [allowAutoCreateTopics](allow-auto-create-topics.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [autoCommitIntervalMs](auto-commit-interval-ms.md) | [jvm]
var [autoCommitIntervalMs](auto-commit-interval-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [autoOffsetReset](auto-offset-reset.md) | [jvm]
var [autoOffsetReset](auto-offset-reset.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [bootstrapServers](../-client-properties-builder/bootstrap-servers.md) | [jvm]
var [bootstrapServers](../-client-properties-builder/bootstrap-servers.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [checkCrcs](check-crcs.md) | [jvm]
var [checkCrcs](check-crcs.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [clientDnsLookup](../-client-properties-builder/client-dns-lookup.md) | [jvm]
var [clientDnsLookup](../-client-properties-builder/client-dns-lookup.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [clientId](../-client-properties-builder/client-id.md) | [jvm]
var [clientId](../-client-properties-builder/client-id.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [clientRack](../-client-properties-builder/client-rack.md) | [jvm]
var [clientRack](../-client-properties-builder/client-rack.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [connectionsMaxIdleMs](../-client-properties-builder/connections-max-idle-ms.md) | [jvm]
var [connectionsMaxIdleMs](../-client-properties-builder/connections-max-idle-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [defaultApiTimeoutMs](default-api-timeout-ms.md) | [jvm]
var [defaultApiTimeoutMs](default-api-timeout-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [enableAutoCommit](enable-auto-commit.md) | [jvm]
var [enableAutoCommit](enable-auto-commit.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [excludeInternalTopics](exclude-internal-topics.md) | [jvm]
var [excludeInternalTopics](exclude-internal-topics.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [fetchMaxBytes](fetch-max-bytes.md) | [jvm]
var [fetchMaxBytes](fetch-max-bytes.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [fetchMaxWaitMs](fetch-max-wait-ms.md) | [jvm]
var [fetchMaxWaitMs](fetch-max-wait-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [fetchMinBytes](fetch-min-bytes.md) | [jvm]
var [fetchMinBytes](fetch-min-bytes.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [groupId](group-id.md) | [jvm]
var [groupId](group-id.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [groupInstanceId](group-instance-id.md) | [jvm]
var [groupInstanceId](group-instance-id.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [heartbeatIntervalMs](heartbeat-interval-ms.md) | [jvm]
var [heartbeatIntervalMs](heartbeat-interval-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [interceptorClasses](interceptor-classes.md) | [jvm]
var [interceptorClasses](interceptor-classes.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [isolationLevel](isolation-level.md) | [jvm]
var [isolationLevel](isolation-level.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [keyDeserializerClass](key-deserializer-class.md) | [jvm]
var [keyDeserializerClass](key-deserializer-class.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [maxPartitionFetchBytes](max-partition-fetch-bytes.md) | [jvm]
var [maxPartitionFetchBytes](max-partition-fetch-bytes.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [maxPollIntervalMs](max-poll-interval-ms.md) | [jvm]
var [maxPollIntervalMs](max-poll-interval-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [maxPollRecords](max-poll-records.md) | [jvm]
var [maxPollRecords](max-poll-records.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [metadataMaxAge](../-client-properties-builder/metadata-max-age.md) | [jvm]
var [metadataMaxAge](../-client-properties-builder/metadata-max-age.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [metricReporterClasses](../-client-properties-builder/metric-reporter-classes.md) | [jvm]
var [metricReporterClasses](../-client-properties-builder/metric-reporter-classes.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [metricsNumSamples](../-client-properties-builder/metrics-num-samples.md) | [jvm]
var [metricsNumSamples](../-client-properties-builder/metrics-num-samples.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [metricsRecordingLevel](../-client-properties-builder/metrics-recording-level.md) | [jvm]
var [metricsRecordingLevel](../-client-properties-builder/metrics-recording-level.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | | [metricsSampleWindowMs](../-client-properties-builder/metrics-sample-window-ms.md) | [jvm]
var [metricsSampleWindowMs](../-client-properties-builder/metrics-sample-window-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [partitionAssignmentStrategy](partition-assignment-strategy.md) | [jvm]
var [partitionAssignmentStrategy](partition-assignment-strategy.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [receiveBuffer](../-client-properties-builder/receive-buffer.md) | [jvm]
var [receiveBuffer](../-client-properties-builder/receive-buffer.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [partitionAssignmentStrategy](partition-assignment-strategy.md) | [jvm]
var [partitionAssignmentStrategy](partition-assignment-strategy.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [receiveBuffer](../-client-properties-builder/receive-buffer.md) | [jvm]
var [receiveBuffer](../-client-properties-builder/receive-buffer.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | | [reconnectBackoffMaxMs](../-client-properties-builder/reconnect-backoff-max-ms.md) | [jvm]
var [reconnectBackoffMaxMs](../-client-properties-builder/reconnect-backoff-max-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [reconnectBackoffMs](../-client-properties-builder/reconnect-backoff-ms.md) | [jvm]
var [reconnectBackoffMs](../-client-properties-builder/reconnect-backoff-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [requestTimeoutMs](../-client-properties-builder/request-timeout-ms.md) | [jvm]
var [requestTimeoutMs](../-client-properties-builder/request-timeout-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [retries](../-client-properties-builder/retries.md) | [jvm]
var [retries](../-client-properties-builder/retries.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [retryBackoffMs](../-client-properties-builder/retry-backoff-ms.md) | [jvm]
var [retryBackoffMs](../-client-properties-builder/retry-backoff-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [schemaRegistryUrl](schema-registry-url.md) | [jvm]
open override var [schemaRegistryUrl](schema-registry-url.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? | -| [securityProtocol](../-client-properties-builder/security-protocol.md) | [jvm]
var [securityProtocol](../-client-properties-builder/security-protocol.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [sendBuffer](../-client-properties-builder/send-buffer.md) | [jvm]
var [sendBuffer](../-client-properties-builder/send-buffer.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [sessionTimeoutMs](session-timeout-ms.md) | [jvm]
var [sessionTimeoutMs](session-timeout-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [valueDeserializerClass](value-deserializer-class.md) | [jvm]
var [valueDeserializerClass](value-deserializer-class.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | - +| [reconnectBackoffMs](../-client-properties-builder/reconnect-backoff-ms.md) | [jvm]
var [reconnectBackoffMs](../-client-properties-builder/reconnect-backoff-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [requestTimeoutMs](../-client-properties-builder/request-timeout-ms.md) | [jvm]
var [requestTimeoutMs](../-client-properties-builder/request-timeout-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [retries](../-client-properties-builder/retries.md) | [jvm]
var [retries](../-client-properties-builder/retries.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [retryBackoffMs](../-client-properties-builder/retry-backoff-ms.md) | [jvm]
var [retryBackoffMs](../-client-properties-builder/retry-backoff-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [schemaRegistryUrl](schema-registry-url.md) | [jvm]
open override var [schemaRegistryUrl](schema-registry-url.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? | +| [securityProtocol](../-client-properties-builder/security-protocol.md) | [jvm]
var [securityProtocol](../-client-properties-builder/security-protocol.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [sendBuffer](../-client-properties-builder/send-buffer.md) | [jvm]
var [sendBuffer](../-client-properties-builder/send-buffer.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [sessionTimeoutMs](session-timeout-ms.md) | [jvm]
var [sessionTimeoutMs](session-timeout-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [valueDeserializerClass](value-deserializer-class.md) | [jvm]
var [valueDeserializerClass](value-deserializer-class.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | ## Functions - -| Name | Summary | -|---|---| +| Name | Summary | +|-------------------|--------------------------------------------------------------------------------------------------| | [build](build.md) | [jvm]
open override fun [build](build.md)(): [KafkaProperties](../-kafka-properties/index.md) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/interceptor-classes.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/interceptor-classes.md index cc86a7b1..70bccea0 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/interceptor-classes.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/interceptor-classes.md @@ -1,14 +1,11 @@ --- title: interceptorClasses --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[interceptorClasses](interceptor-classes.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[interceptorClasses](interceptor-classes.md) # interceptorClasses - - [jvm]\ var [interceptorClasses](interceptor-classes.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/isolation-level.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/isolation-level.md index c1d381cc..a5736930 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/isolation-level.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/isolation-level.md @@ -1,14 +1,11 @@ --- title: isolationLevel --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[isolationLevel](isolation-level.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[isolationLevel](isolation-level.md) # isolationLevel - - [jvm]\ var [isolationLevel](isolation-level.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/key-deserializer-class.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/key-deserializer-class.md index 1730095e..3b3da1a5 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/key-deserializer-class.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/key-deserializer-class.md @@ -1,14 +1,11 @@ --- title: keyDeserializerClass --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[keyDeserializerClass](key-deserializer-class.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[keyDeserializerClass](key-deserializer-class.md) # keyDeserializerClass - - [jvm]\ var [keyDeserializerClass](key-deserializer-class.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/max-partition-fetch-bytes.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/max-partition-fetch-bytes.md index 8f93d3d0..688bd5e4 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/max-partition-fetch-bytes.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/max-partition-fetch-bytes.md @@ -1,14 +1,11 @@ --- title: maxPartitionFetchBytes --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[maxPartitionFetchBytes](max-partition-fetch-bytes.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[maxPartitionFetchBytes](max-partition-fetch-bytes.md) # maxPartitionFetchBytes - - [jvm]\ var [maxPartitionFetchBytes](max-partition-fetch-bytes.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/max-poll-interval-ms.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/max-poll-interval-ms.md index 5c766416..93ff24d3 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/max-poll-interval-ms.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/max-poll-interval-ms.md @@ -1,14 +1,11 @@ --- title: maxPollIntervalMs --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[maxPollIntervalMs](max-poll-interval-ms.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[maxPollIntervalMs](max-poll-interval-ms.md) # maxPollIntervalMs - - [jvm]\ var [maxPollIntervalMs](max-poll-interval-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/max-poll-records.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/max-poll-records.md index 81ea60f5..df4e0b31 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/max-poll-records.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/max-poll-records.md @@ -1,14 +1,11 @@ --- title: maxPollRecords --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[maxPollRecords](max-poll-records.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[maxPollRecords](max-poll-records.md) # maxPollRecords - - [jvm]\ var [maxPollRecords](max-poll-records.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/partition-assignment-strategy.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/partition-assignment-strategy.md index 2d008012..fd5e6a5b 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/partition-assignment-strategy.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/partition-assignment-strategy.md @@ -1,14 +1,11 @@ --- title: partitionAssignmentStrategy --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[partitionAssignmentStrategy](partition-assignment-strategy.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[partitionAssignmentStrategy](partition-assignment-strategy.md) # partitionAssignmentStrategy - - [jvm]\ var [partitionAssignmentStrategy](partition-assignment-strategy.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/schema-registry-url.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/schema-registry-url.md index 38b118f9..1b090d86 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/schema-registry-url.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/schema-registry-url.md @@ -1,16 +1,14 @@ --- title: schemaRegistryUrl --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[schemaRegistryUrl](schema-registry-url.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[schemaRegistryUrl](schema-registry-url.md) # schemaRegistryUrl - - [jvm]\ -open override var [schemaRegistryUrl](schema-registry-url.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? +open override +var [schemaRegistryUrl](schema-registry-url.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/session-timeout-ms.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/session-timeout-ms.md index 3819574a..9dffb0e5 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/session-timeout-ms.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/session-timeout-ms.md @@ -1,14 +1,11 @@ --- title: sessionTimeoutMs --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[sessionTimeoutMs](session-timeout-ms.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[sessionTimeoutMs](session-timeout-ms.md) # sessionTimeoutMs - - [jvm]\ var [sessionTimeoutMs](session-timeout-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/value-deserializer-class.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/value-deserializer-class.md index 25277889..7a1abc7a 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/value-deserializer-class.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-properties-builder/value-deserializer-class.md @@ -1,14 +1,11 @@ --- title: valueDeserializerClass --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[valueDeserializerClass](value-deserializer-class.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerPropertiesBuilder](index.md)/[valueDeserializerClass](value-deserializer-class.md) # valueDeserializerClass - - [jvm]\ var [valueDeserializerClass](value-deserializer-class.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-record-handler/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-record-handler/index.md index 0e56f4e7..ca585c47 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-record-handler/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer-record-handler/index.md @@ -1,15 +1,14 @@ --- title: ConsumerRecordHandler --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerRecordHandler](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ConsumerRecordHandler](index.md) # ConsumerRecordHandler - - [jvm]\ -typealias [ConsumerRecordHandler](index.md) = suspend Application.(ConsumerRecord<[KafkaRecordKey](../-kafka-record-key/index.md), GenericRecord>) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) +typealias [ConsumerRecordHandler](index.md) = suspend Application.( +ConsumerRecord<[KafkaRecordKey](../-kafka-record-key/index.md), GenericRecord>) +-> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer/index.md index 7454bdc2..1edddf70 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-consumer/index.md @@ -1,14 +1,11 @@ --- title: Consumer --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[Consumer](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[Consumer](index.md) # Consumer - - [jvm]\ typealias [Consumer](index.md) = KafkaConsumer<[KafkaRecordKey](../-kafka-record-key/index.md), GenericRecord> diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-defaults/-d-e-f-a-u-l-t_-c-l-i-e-n-t_-i-d.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-defaults/-d-e-f-a-u-l-t_-c-l-i-e-n-t_-i-d.md index d3b1e109..e9390dfb 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-defaults/-d-e-f-a-u-l-t_-c-l-i-e-n-t_-i-d.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-defaults/-d-e-f-a-u-l-t_-c-l-i-e-n-t_-i-d.md @@ -1,16 +1,14 @@ --- title: DEFAULT_CLIENT_ID --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[Defaults](index.md)/[DEFAULT_CLIENT_ID](-d-e-f-a-u-l-t_-c-l-i-e-n-t_-i-d.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[Defaults](index.md)/[DEFAULT_CLIENT_ID](-d-e-f-a-u-l-t_-c-l-i-e-n-t_-i-d.md) # DEFAULT_CLIENT_ID - - [jvm]\ -const val [DEFAULT_CLIENT_ID](-d-e-f-a-u-l-t_-c-l-i-e-n-t_-i-d.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) +const +val [DEFAULT_CLIENT_ID](-d-e-f-a-u-l-t_-c-l-i-e-n-t_-i-d.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-defaults/-d-e-f-a-u-l-t_-c-o-n-f-i-g_-p-a-t-h.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-defaults/-d-e-f-a-u-l-t_-c-o-n-f-i-g_-p-a-t-h.md index 1ae3b6a5..9f59227c 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-defaults/-d-e-f-a-u-l-t_-c-o-n-f-i-g_-p-a-t-h.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-defaults/-d-e-f-a-u-l-t_-c-o-n-f-i-g_-p-a-t-h.md @@ -1,16 +1,14 @@ --- title: DEFAULT_CONFIG_PATH --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[Defaults](index.md)/[DEFAULT_CONFIG_PATH](-d-e-f-a-u-l-t_-c-o-n-f-i-g_-p-a-t-h.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[Defaults](index.md)/[DEFAULT_CONFIG_PATH](-d-e-f-a-u-l-t_-c-o-n-f-i-g_-p-a-t-h.md) # DEFAULT_CONFIG_PATH - - [jvm]\ -const val [DEFAULT_CONFIG_PATH](-d-e-f-a-u-l-t_-c-o-n-f-i-g_-p-a-t-h.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) +const +val [DEFAULT_CONFIG_PATH](-d-e-f-a-u-l-t_-c-o-n-f-i-g_-p-a-t-h.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-defaults/-d-e-f-a-u-l-t_-c-o-n-s-u-m-e-r_-p-o-l-l_-f-r-e-q-u-e-n-c-y_-m-s.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-defaults/-d-e-f-a-u-l-t_-c-o-n-s-u-m-e-r_-p-o-l-l_-f-r-e-q-u-e-n-c-y_-m-s.md index c3537708..43b8e2a0 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-defaults/-d-e-f-a-u-l-t_-c-o-n-s-u-m-e-r_-p-o-l-l_-f-r-e-q-u-e-n-c-y_-m-s.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-defaults/-d-e-f-a-u-l-t_-c-o-n-s-u-m-e-r_-p-o-l-l_-f-r-e-q-u-e-n-c-y_-m-s.md @@ -1,16 +1,15 @@ --- title: DEFAULT_CONSUMER_POLL_FREQUENCY_MS --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[Defaults](index.md)/[DEFAULT_CONSUMER_POLL_FREQUENCY_MS](-d-e-f-a-u-l-t_-c-o-n-s-u-m-e-r_-p-o-l-l_-f-r-e-q-u-e-n-c-y_-m-s.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[Defaults](index.md)/[DEFAULT_CONSUMER_POLL_FREQUENCY_MS](-d-e-f-a-u-l-t_-c-o-n-s-u-m-e-r_-p-o-l-l_-f-r-e-q-u-e-n-c-y_-m-s.md) # DEFAULT_CONSUMER_POLL_FREQUENCY_MS - - [jvm]\ -const val [DEFAULT_CONSUMER_POLL_FREQUENCY_MS](-d-e-f-a-u-l-t_-c-o-n-s-u-m-e-r_-p-o-l-l_-f-r-e-q-u-e-n-c-y_-m-s.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = 1000 +const +val [DEFAULT_CONSUMER_POLL_FREQUENCY_MS](-d-e-f-a-u-l-t_-c-o-n-s-u-m-e-r_-p-o-l-l_-f-r-e-q-u-e-n-c-y_-m-s.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = +1000 diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-defaults/-d-e-f-a-u-l-t_-g-r-o-u-p_-i-d.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-defaults/-d-e-f-a-u-l-t_-g-r-o-u-p_-i-d.md index 8e260b20..5bd34ee7 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-defaults/-d-e-f-a-u-l-t_-g-r-o-u-p_-i-d.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-defaults/-d-e-f-a-u-l-t_-g-r-o-u-p_-i-d.md @@ -1,16 +1,14 @@ --- title: DEFAULT_GROUP_ID --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[Defaults](index.md)/[DEFAULT_GROUP_ID](-d-e-f-a-u-l-t_-g-r-o-u-p_-i-d.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[Defaults](index.md)/[DEFAULT_GROUP_ID](-d-e-f-a-u-l-t_-g-r-o-u-p_-i-d.md) # DEFAULT_GROUP_ID - - [jvm]\ -const val [DEFAULT_GROUP_ID](-d-e-f-a-u-l-t_-g-r-o-u-p_-i-d.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) +const +val [DEFAULT_GROUP_ID](-d-e-f-a-u-l-t_-g-r-o-u-p_-i-d.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-defaults/-d-e-f-a-u-l-t_-s-c-h-e-m-a_-r-e-g-i-s-t-r-y_-c-l-i-e-n-t_-t-i-m-e-o-u-t_-m-s.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-defaults/-d-e-f-a-u-l-t_-s-c-h-e-m-a_-r-e-g-i-s-t-r-y_-c-l-i-e-n-t_-t-i-m-e-o-u-t_-m-s.md index 0b43f93b..9e82cc20 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-defaults/-d-e-f-a-u-l-t_-s-c-h-e-m-a_-r-e-g-i-s-t-r-y_-c-l-i-e-n-t_-t-i-m-e-o-u-t_-m-s.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-defaults/-d-e-f-a-u-l-t_-s-c-h-e-m-a_-r-e-g-i-s-t-r-y_-c-l-i-e-n-t_-t-i-m-e-o-u-t_-m-s.md @@ -1,16 +1,15 @@ --- title: DEFAULT_SCHEMA_REGISTRY_CLIENT_TIMEOUT_MS --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[Defaults](index.md)/[DEFAULT_SCHEMA_REGISTRY_CLIENT_TIMEOUT_MS](-d-e-f-a-u-l-t_-s-c-h-e-m-a_-r-e-g-i-s-t-r-y_-c-l-i-e-n-t_-t-i-m-e-o-u-t_-m-s.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[Defaults](index.md)/[DEFAULT_SCHEMA_REGISTRY_CLIENT_TIMEOUT_MS](-d-e-f-a-u-l-t_-s-c-h-e-m-a_-r-e-g-i-s-t-r-y_-c-l-i-e-n-t_-t-i-m-e-o-u-t_-m-s.md) # DEFAULT_SCHEMA_REGISTRY_CLIENT_TIMEOUT_MS - - [jvm]\ -const val [DEFAULT_SCHEMA_REGISTRY_CLIENT_TIMEOUT_MS](-d-e-f-a-u-l-t_-s-c-h-e-m-a_-r-e-g-i-s-t-r-y_-c-l-i-e-n-t_-t-i-m-e-o-u-t_-m-s.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = 30000 +const +val [DEFAULT_SCHEMA_REGISTRY_CLIENT_TIMEOUT_MS](-d-e-f-a-u-l-t_-s-c-h-e-m-a_-r-e-g-i-s-t-r-y_-c-l-i-e-n-t_-t-i-m-e-o-u-t_-m-s.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = +30000 diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-defaults/-d-e-f-a-u-l-t_-t-o-p-i-c_-p-a-r-t-i-t-i-o-n-s.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-defaults/-d-e-f-a-u-l-t_-t-o-p-i-c_-p-a-r-t-i-t-i-o-n-s.md index 8c0f5cb5..02db1a11 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-defaults/-d-e-f-a-u-l-t_-t-o-p-i-c_-p-a-r-t-i-t-i-o-n-s.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-defaults/-d-e-f-a-u-l-t_-t-o-p-i-c_-p-a-r-t-i-t-i-o-n-s.md @@ -1,16 +1,15 @@ --- title: DEFAULT_TOPIC_PARTITIONS --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[Defaults](index.md)/[DEFAULT_TOPIC_PARTITIONS](-d-e-f-a-u-l-t_-t-o-p-i-c_-p-a-r-t-i-t-i-o-n-s.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[Defaults](index.md)/[DEFAULT_TOPIC_PARTITIONS](-d-e-f-a-u-l-t_-t-o-p-i-c_-p-a-r-t-i-t-i-o-n-s.md) # DEFAULT_TOPIC_PARTITIONS - - [jvm]\ -const val [DEFAULT_TOPIC_PARTITIONS](-d-e-f-a-u-l-t_-t-o-p-i-c_-p-a-r-t-i-t-i-o-n-s.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = 1 +const +val [DEFAULT_TOPIC_PARTITIONS](-d-e-f-a-u-l-t_-t-o-p-i-c_-p-a-r-t-i-t-i-o-n-s.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = +1 diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-defaults/-d-e-f-a-u-l-t_-t-o-p-i-c_-r-e-p-l-i-c-a-s.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-defaults/-d-e-f-a-u-l-t_-t-o-p-i-c_-r-e-p-l-i-c-a-s.md index facf795b..12f9805c 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-defaults/-d-e-f-a-u-l-t_-t-o-p-i-c_-r-e-p-l-i-c-a-s.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-defaults/-d-e-f-a-u-l-t_-t-o-p-i-c_-r-e-p-l-i-c-a-s.md @@ -1,16 +1,14 @@ --- title: DEFAULT_TOPIC_REPLICAS --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[Defaults](index.md)/[DEFAULT_TOPIC_REPLICAS](-d-e-f-a-u-l-t_-t-o-p-i-c_-r-e-p-l-i-c-a-s.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[Defaults](index.md)/[DEFAULT_TOPIC_REPLICAS](-d-e-f-a-u-l-t_-t-o-p-i-c_-r-e-p-l-i-c-a-s.md) # DEFAULT_TOPIC_REPLICAS - - [jvm]\ -const val [DEFAULT_TOPIC_REPLICAS](-d-e-f-a-u-l-t_-t-o-p-i-c_-r-e-p-l-i-c-a-s.md): [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.md) +const +val [DEFAULT_TOPIC_REPLICAS](-d-e-f-a-u-l-t_-t-o-p-i-c_-r-e-p-l-i-c-a-s.md): [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-defaults/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-defaults/index.md index becb0c8d..aa26754f 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-defaults/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-defaults/index.md @@ -1,29 +1,23 @@ --- title: Defaults --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[Defaults](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[Defaults](index.md) # Defaults - - [jvm]\ object [Defaults](index.md) - - ## Properties - -| Name | Summary | -|---|---| -| [DEFAULT_CLIENT_ID](-d-e-f-a-u-l-t_-c-l-i-e-n-t_-i-d.md) | [jvm]
const val [DEFAULT_CLIENT_ID](-d-e-f-a-u-l-t_-c-l-i-e-n-t_-i-d.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | -| [DEFAULT_CONFIG_PATH](-d-e-f-a-u-l-t_-c-o-n-f-i-g_-p-a-t-h.md) | [jvm]
const val [DEFAULT_CONFIG_PATH](-d-e-f-a-u-l-t_-c-o-n-f-i-g_-p-a-t-h.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | -| [DEFAULT_CONSUMER_POLL_FREQUENCY_MS](-d-e-f-a-u-l-t_-c-o-n-s-u-m-e-r_-p-o-l-l_-f-r-e-q-u-e-n-c-y_-m-s.md) | [jvm]
const val [DEFAULT_CONSUMER_POLL_FREQUENCY_MS](-d-e-f-a-u-l-t_-c-o-n-s-u-m-e-r_-p-o-l-l_-f-r-e-q-u-e-n-c-y_-m-s.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = 1000 | -| [DEFAULT_GROUP_ID](-d-e-f-a-u-l-t_-g-r-o-u-p_-i-d.md) | [jvm]
const val [DEFAULT_GROUP_ID](-d-e-f-a-u-l-t_-g-r-o-u-p_-i-d.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | +| Name | Summary | +|-------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [DEFAULT_CLIENT_ID](-d-e-f-a-u-l-t_-c-l-i-e-n-t_-i-d.md) | [jvm]
const val [DEFAULT_CLIENT_ID](-d-e-f-a-u-l-t_-c-l-i-e-n-t_-i-d.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | +| [DEFAULT_CONFIG_PATH](-d-e-f-a-u-l-t_-c-o-n-f-i-g_-p-a-t-h.md) | [jvm]
const val [DEFAULT_CONFIG_PATH](-d-e-f-a-u-l-t_-c-o-n-f-i-g_-p-a-t-h.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | +| [DEFAULT_CONSUMER_POLL_FREQUENCY_MS](-d-e-f-a-u-l-t_-c-o-n-s-u-m-e-r_-p-o-l-l_-f-r-e-q-u-e-n-c-y_-m-s.md) | [jvm]
const val [DEFAULT_CONSUMER_POLL_FREQUENCY_MS](-d-e-f-a-u-l-t_-c-o-n-s-u-m-e-r_-p-o-l-l_-f-r-e-q-u-e-n-c-y_-m-s.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = 1000 | +| [DEFAULT_GROUP_ID](-d-e-f-a-u-l-t_-g-r-o-u-p_-i-d.md) | [jvm]
const val [DEFAULT_GROUP_ID](-d-e-f-a-u-l-t_-g-r-o-u-p_-i-d.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | | [DEFAULT_SCHEMA_REGISTRY_CLIENT_TIMEOUT_MS](-d-e-f-a-u-l-t_-s-c-h-e-m-a_-r-e-g-i-s-t-r-y_-c-l-i-e-n-t_-t-i-m-e-o-u-t_-m-s.md) | [jvm]
const val [DEFAULT_SCHEMA_REGISTRY_CLIENT_TIMEOUT_MS](-d-e-f-a-u-l-t_-s-c-h-e-m-a_-r-e-g-i-s-t-r-y_-c-l-i-e-n-t_-t-i-m-e-o-u-t_-m-s.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = 30000 | -| [DEFAULT_TOPIC_PARTITIONS](-d-e-f-a-u-l-t_-t-o-p-i-c_-p-a-r-t-i-t-i-o-n-s.md) | [jvm]
const val [DEFAULT_TOPIC_PARTITIONS](-d-e-f-a-u-l-t_-t-o-p-i-c_-p-a-r-t-i-t-i-o-n-s.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = 1 | -| [DEFAULT_TOPIC_REPLICAS](-d-e-f-a-u-l-t_-t-o-p-i-c_-r-e-p-l-i-c-a-s.md) | [jvm]
const val [DEFAULT_TOPIC_REPLICAS](-d-e-f-a-u-l-t_-t-o-p-i-c_-r-e-p-l-i-c-a-s.md): [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.md) | +| [DEFAULT_TOPIC_PARTITIONS](-d-e-f-a-u-l-t_-t-o-p-i-c_-p-a-r-t-i-t-i-o-n-s.md) | [jvm]
const val [DEFAULT_TOPIC_PARTITIONS](-d-e-f-a-u-l-t_-t-o-p-i-c_-p-a-r-t-i-t-i-o-n-s.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = 1 | +| [DEFAULT_TOPIC_REPLICAS](-d-e-f-a-u-l-t_-t-o-p-i-c_-r-e-p-l-i-c-a-s.md) | [jvm]
const val [DEFAULT_TOPIC_REPLICAS](-d-e-f-a-u-l-t_-t-o-p-i-c_-r-e-p-l-i-c-a-s.md): [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.md) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-file-config/-kafka.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-file-config/-kafka.md index f9d550e7..e61f72b1 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-file-config/-kafka.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-file-config/-kafka.md @@ -1,26 +1,19 @@ --- title: Kafka --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[FileConfig](index.md)/[Kafka](-kafka.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[FileConfig](index.md)/[Kafka](-kafka.md) # Kafka - - [jvm]\ -fun [Kafka](-kafka.md)(configurationPath: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): ApplicationPlugin<[KafkaFileConfig](../-kafka-file-config/index.md)> - - - - +fun [Kafka](-kafka.md)( +configurationPath: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): +ApplicationPlugin<[KafkaFileConfig](../-kafka-file-config/index.md)> [jvm]\ val [Kafka](-kafka.md): ApplicationPlugin<[KafkaFileConfig](../-kafka-file-config/index.md)> - - Plugin for setting up a kafka client, configured in application config file Example: ```kotlin diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-file-config/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-file-config/index.md index c483a288..c247fcd6 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-file-config/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-file-config/index.md @@ -1,32 +1,24 @@ --- title: FileConfig --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[FileConfig](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[FileConfig](index.md) # FileConfig - - [jvm]\ object [FileConfig](index.md) - - ## Properties - -| Name | Summary | -|---|---| +| Name | Summary | +|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Kafka](-kafka.md) | [jvm]
val [Kafka](-kafka.md): ApplicationPlugin<[KafkaFileConfig](../-kafka-file-config/index.md)>
Plugin for setting up a kafka client, configured in application config file Example: | - ## Functions - -| Name | Summary | -|---|---| -| [Kafka](-kafka.md) | [jvm]
fun [Kafka](-kafka.md)(configurationPath: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): ApplicationPlugin<[KafkaFileConfig](../-kafka-file-config/index.md)> | -| [kafka](kafka.md) | [jvm]
fun Application.[kafka](kafka.md)(configurationPath: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) = DEFAULT_CONFIG_PATH, config: [KafkaFileConfig](../-kafka-file-config/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md))
Installs the [Kafka](-kafka.md) plugin with the given [KafkaFileConfig](../-kafka-file-config/index.md) block | +| Name | Summary | +|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [Kafka](-kafka.md) | [jvm]
fun [Kafka](-kafka.md)(configurationPath: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): ApplicationPlugin<[KafkaFileConfig](../-kafka-file-config/index.md)> | +| [kafka](kafka.md) | [jvm]
fun Application.[kafka](kafka.md)(configurationPath: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) = DEFAULT_CONFIG_PATH, config: [KafkaFileConfig](../-kafka-file-config/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md))
Installs the [Kafka](-kafka.md) plugin with the given [KafkaFileConfig](../-kafka-file-config/index.md) block | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-file-config/kafka.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-file-config/kafka.md index 8ae1adde..3419fd6e 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-file-config/kafka.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-file-config/kafka.md @@ -1,18 +1,16 @@ --- title: kafka --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[FileConfig](index.md)/[kafka](kafka.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[FileConfig](index.md)/[kafka](kafka.md) # kafka - - [jvm]\ -fun Application.[kafka](kafka.md)(configurationPath: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) = DEFAULT_CONFIG_PATH, config: [KafkaFileConfig](../-kafka-file-config/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) - - +fun Application.[kafka](kafka.md)( +configurationPath: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) = DEFAULT_CONFIG_PATH, +config: [KafkaFileConfig](../-kafka-file-config/index.md).() +-> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) Installs the [Kafka](-kafka.md) plugin with the given [KafkaFileConfig](../-kafka-file-config/index.md) block diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-config/-kafka-config.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-config/-kafka-config.md index 265c5a64..44da651f 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-config/-kafka-config.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-config/-kafka-config.md @@ -1,14 +1,11 @@ --- title: KafkaConfig --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[KafkaConfig](index.md)/[KafkaConfig](-kafka-config.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[KafkaConfig](index.md)/[KafkaConfig](-kafka-config.md) # KafkaConfig - - [jvm]\ constructor() diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-config/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-config/index.md index 02f5dbc4..dc44fe3e 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-config/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-config/index.md @@ -1,47 +1,37 @@ --- title: KafkaConfig --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[KafkaConfig](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[KafkaConfig](index.md) # KafkaConfig - - [jvm]\ class [KafkaConfig](index.md) : [AbstractKafkaConfig](../-abstract-kafka-config/index.md) - - ## Constructors - -| | | -|---|---| +| | | +|---------------------------------|------------------------| | [KafkaConfig](-kafka-config.md) | [jvm]
constructor() | - ## Properties - -| Name | Summary | -|---|---| -| [consumerConfig](../-abstract-kafka-config/consumer-config.md) | [jvm]
var [consumerConfig](../-abstract-kafka-config/consumer-config.md): [KafkaConsumerConfig](../-kafka-consumer-config/index.md)?
Because the consumer is operating in the background, it can be defined in the setup phase | -| [schemaRegistrationTimeoutMs](../-abstract-kafka-config/schema-registration-timeout-ms.md) | [jvm]
var [schemaRegistrationTimeoutMs](../-abstract-kafka-config/schema-registration-timeout-ms.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)
Schema registration timeout | -| [schemaRegistryUrl](schema-registry-url.md) | [jvm]
open override var [schemaRegistryUrl](schema-registry-url.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?
The schema registry url, if set, a client will be created and can be accessed later to register schemas manually, if schemas is left empty | - +| Name | Summary | +|--------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [consumerConfig](../-abstract-kafka-config/consumer-config.md) | [jvm]
var [consumerConfig](../-abstract-kafka-config/consumer-config.md): [KafkaConsumerConfig](../-kafka-consumer-config/index.md)?
Because the consumer is operating in the background, it can be defined in the setup phase | +| [schemaRegistrationTimeoutMs](../-abstract-kafka-config/schema-registration-timeout-ms.md) | [jvm]
var [schemaRegistrationTimeoutMs](../-abstract-kafka-config/schema-registration-timeout-ms.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)
Schema registration timeout | +| [schemaRegistryUrl](schema-registry-url.md) | [jvm]
open override var [schemaRegistryUrl](schema-registry-url.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?
The schema registry url, if set, a client will be created and can be accessed later to register schemas manually, if schemas is left empty | ## Functions - -| Name | Summary | -|---|---| -| [admin](../admin.md) | [jvm]
fun [KafkaConfig](index.md).[admin](../admin.md)(configuration: [AdminPropertiesBuilder](../-admin-properties-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { AdminPropertiesBuilder() }) | -| [common](../common.md) | [jvm]
fun [KafkaConfig](index.md).[common](../common.md)(configuration: [CommonClientPropertiesBuilder](../-common-client-properties-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { CommonClientPropertiesBuilder }) | -| [consumer](../consumer.md) | [jvm]
fun [KafkaConfig](index.md).[consumer](../consumer.md)(configuration: [ConsumerPropertiesBuilder](../-consumer-properties-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { ConsumerPropertiesBuilder(schemaRegistryUrl) }) | -| [consumerConfig](../consumer-config.md) | [jvm]
fun [AbstractKafkaConfig](../-abstract-kafka-config/index.md).[consumerConfig](../consumer-config.md)(configuration: [KafkaConsumerConfig](../-kafka-consumer-config/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { }) | -| [producer](../producer.md) | [jvm]
fun [KafkaConfig](index.md).[producer](../producer.md)(configuration: [ProducerPropertiesBuilder](../-producer-properties-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { ProducerPropertiesBuilder(schemaRegistryUrl) }) | +| Name | Summary | +|-------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [admin](../admin.md) | [jvm]
fun [KafkaConfig](index.md).[admin](../admin.md)(configuration: [AdminPropertiesBuilder](../-admin-properties-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { AdminPropertiesBuilder() }) | +| [common](../common.md) | [jvm]
fun [KafkaConfig](index.md).[common](../common.md)(configuration: [CommonClientPropertiesBuilder](../-common-client-properties-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { CommonClientPropertiesBuilder }) | +| [consumer](../consumer.md) | [jvm]
fun [KafkaConfig](index.md).[consumer](../consumer.md)(configuration: [ConsumerPropertiesBuilder](../-consumer-properties-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { ConsumerPropertiesBuilder(schemaRegistryUrl) }) | +| [consumerConfig](../consumer-config.md) | [jvm]
fun [AbstractKafkaConfig](../-abstract-kafka-config/index.md).[consumerConfig](../consumer-config.md)(configuration: [KafkaConsumerConfig](../-kafka-consumer-config/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { }) | +| [producer](../producer.md) | [jvm]
fun [KafkaConfig](index.md).[producer](../producer.md)(configuration: [ProducerPropertiesBuilder](../-producer-properties-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { ProducerPropertiesBuilder(schemaRegistryUrl) }) | | [registerSchemas](../register-schemas.md) | [jvm]
fun [AbstractKafkaConfig](../-abstract-kafka-config/index.md).[registerSchemas](../register-schemas.md)(configuration: [SchemaRegistrationBuilder](../-schema-registration-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { SchemaRegistrationBuilder() }) | -| [topic](../topic.md) | [jvm]
fun [KafkaConfig](index.md).[topic](../topic.md)(name: [TopicName](../-topic-name/index.md), block: [TopicBuilder](../-topic-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) | +| [topic](../topic.md) | [jvm]
fun [KafkaConfig](index.md).[topic](../topic.md)(name: [TopicName](../-topic-name/index.md), block: [TopicBuilder](../-topic-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-config/schema-registry-url.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-config/schema-registry-url.md index a9b1fbfc..05fbb729 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-config/schema-registry-url.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-config/schema-registry-url.md @@ -1,20 +1,17 @@ --- title: schemaRegistryUrl --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[KafkaConfig](index.md)/[schemaRegistryUrl](schema-registry-url.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[KafkaConfig](index.md)/[schemaRegistryUrl](schema-registry-url.md) # schemaRegistryUrl - - [jvm]\ -open override var [schemaRegistryUrl](schema-registry-url.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? - - +open override +var [schemaRegistryUrl](schema-registry-url.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? -The schema registry url, if set, a client will be created and can be accessed later to register schemas manually, if schemas is left empty +The schema registry url, if set, a client will be created and can be accessed later to register schemas manually, if +schemas is left empty diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-consumer-config/-kafka-consumer-config.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-consumer-config/-kafka-consumer-config.md index 80fc3800..02fd2f15 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-consumer-config/-kafka-consumer-config.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-consumer-config/-kafka-consumer-config.md @@ -1,14 +1,11 @@ --- title: KafkaConsumerConfig --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[KafkaConsumerConfig](index.md)/[KafkaConsumerConfig](-kafka-consumer-config.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[KafkaConsumerConfig](index.md)/[KafkaConsumerConfig](-kafka-consumer-config.md) # KafkaConsumerConfig - - [jvm]\ constructor() diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-consumer-config/consumer-poll-frequency.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-consumer-config/consumer-poll-frequency.md index 71dfe688..a57755f7 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-consumer-config/consumer-poll-frequency.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-consumer-config/consumer-poll-frequency.md @@ -1,14 +1,11 @@ --- title: consumerPollFrequency --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[KafkaConsumerConfig](index.md)/[consumerPollFrequency](consumer-poll-frequency.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[KafkaConsumerConfig](index.md)/[consumerPollFrequency](consumer-poll-frequency.md) # consumerPollFrequency - - [jvm]\ val [consumerPollFrequency](consumer-poll-frequency.md): [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-consumer-config/consumer-record-handlers.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-consumer-config/consumer-record-handlers.md index 5a8ca3c3..9ac713e8 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-consumer-config/consumer-record-handlers.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-consumer-config/consumer-record-handlers.md @@ -1,16 +1,14 @@ --- title: consumerRecordHandlers --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[KafkaConsumerConfig](index.md)/[consumerRecordHandlers](consumer-record-handlers.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[KafkaConsumerConfig](index.md)/[consumerRecordHandlers](consumer-record-handlers.md) # consumerRecordHandlers - - [jvm]\ -val [consumerRecordHandlers](consumer-record-handlers.md): [MutableMap](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.md)<[TopicName](../-topic-name/index.md), [ConsumerRecordHandler](../-consumer-record-handler/index.md)> +val [consumerRecordHandlers](consumer-record-handlers.md): [MutableMap](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.md) +<[TopicName](../-topic-name/index.md), [ConsumerRecordHandler](../-consumer-record-handler/index.md)> diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-consumer-config/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-consumer-config/index.md index b3806cd3..7371fe6f 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-consumer-config/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-consumer-config/index.md @@ -1,40 +1,30 @@ --- title: KafkaConsumerConfig --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[KafkaConsumerConfig](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[KafkaConsumerConfig](index.md) # KafkaConsumerConfig - - [jvm]\ class [KafkaConsumerConfig](index.md) - - ## Constructors - -| | | -|---|---| +| | | +|--------------------------------------------------|------------------------| | [KafkaConsumerConfig](-kafka-consumer-config.md) | [jvm]
constructor() | - ## Properties - -| Name | Summary | -|---|---| -| [consumerPollFrequency](consumer-poll-frequency.md) | [jvm]
val [consumerPollFrequency](consumer-poll-frequency.md): [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md) | +| Name | Summary | +|-------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [consumerPollFrequency](consumer-poll-frequency.md) | [jvm]
val [consumerPollFrequency](consumer-poll-frequency.md): [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md) | | [consumerRecordHandlers](consumer-record-handlers.md) | [jvm]
val [consumerRecordHandlers](consumer-record-handlers.md): [MutableMap](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.md)<[TopicName](../-topic-name/index.md), [ConsumerRecordHandler](../-consumer-record-handler/index.md)> | - ## Functions - -| Name | Summary | -|---|---| +| Name | Summary | +|--------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [consumerRecordHandler](../consumer-record-handler.md) | [jvm]
fun [KafkaConsumerConfig](index.md).[consumerRecordHandler](../consumer-record-handler.md)(topicName: [TopicName](../-topic-name/index.md), handler: [ConsumerRecordHandler](../-consumer-record-handler/index.md)) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-dsl/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-dsl/index.md index 70726ecd..ad811564 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-dsl/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-dsl/index.md @@ -1,19 +1,14 @@ --- title: KafkaDsl --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[KafkaDsl](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[KafkaDsl](index.md) # KafkaDsl - - [jvm]\ @[DslMarker](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-dsl-marker/index.md) - - annotation class [KafkaDsl](index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-file-config/-kafka-file-config.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-file-config/-kafka-file-config.md index 20296b3f..cd8ffb39 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-file-config/-kafka-file-config.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-file-config/-kafka-file-config.md @@ -1,14 +1,11 @@ --- title: KafkaFileConfig --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[KafkaFileConfig](index.md)/[KafkaFileConfig](-kafka-file-config.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[KafkaFileConfig](index.md)/[KafkaFileConfig](-kafka-file-config.md) # KafkaFileConfig - - [jvm]\ constructor(config: ApplicationConfig) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-file-config/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-file-config/index.md index beeff362..e96de83a 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-file-config/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-file-config/index.md @@ -1,44 +1,34 @@ --- title: KafkaFileConfig --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[KafkaFileConfig](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[KafkaFileConfig](index.md) # KafkaFileConfig - - [jvm]\ class [KafkaFileConfig](index.md)(config: ApplicationConfig) : [AbstractKafkaConfig](../-abstract-kafka-config/index.md) Configuration for the Kafka plugin - - ## Constructors - -| | | -|---|---| +| | | +|------------------------------------------|-------------------------------------------------| | [KafkaFileConfig](-kafka-file-config.md) | [jvm]
constructor(config: ApplicationConfig) | - ## Properties - -| Name | Summary | -|---|---| -| [consumerConfig](../-abstract-kafka-config/consumer-config.md) | [jvm]
var [consumerConfig](../-abstract-kafka-config/consumer-config.md): [KafkaConsumerConfig](../-kafka-consumer-config/index.md)?
Because the consumer is operating in the background, it can be defined in the setup phase | -| [schemaRegistrationTimeoutMs](../-abstract-kafka-config/schema-registration-timeout-ms.md) | [jvm]
var [schemaRegistrationTimeoutMs](../-abstract-kafka-config/schema-registration-timeout-ms.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)
Schema registration timeout | -| [schemaRegistryUrl](schema-registry-url.md) | [jvm]
open override var [schemaRegistryUrl](schema-registry-url.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?
The schema registry url, if set, a client will be created and can be accessed later to register schemas manually, if schemas is left empty | - +| Name | Summary | +|--------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [consumerConfig](../-abstract-kafka-config/consumer-config.md) | [jvm]
var [consumerConfig](../-abstract-kafka-config/consumer-config.md): [KafkaConsumerConfig](../-kafka-consumer-config/index.md)?
Because the consumer is operating in the background, it can be defined in the setup phase | +| [schemaRegistrationTimeoutMs](../-abstract-kafka-config/schema-registration-timeout-ms.md) | [jvm]
var [schemaRegistrationTimeoutMs](../-abstract-kafka-config/schema-registration-timeout-ms.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)
Schema registration timeout | +| [schemaRegistryUrl](schema-registry-url.md) | [jvm]
open override var [schemaRegistryUrl](schema-registry-url.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?
The schema registry url, if set, a client will be created and can be accessed later to register schemas manually, if schemas is left empty | ## Functions - -| Name | Summary | -|---|---| -| [consumerConfig](../consumer-config.md) | [jvm]
fun [AbstractKafkaConfig](../-abstract-kafka-config/index.md).[consumerConfig](../consumer-config.md)(configuration: [KafkaConsumerConfig](../-kafka-consumer-config/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { }) | +| Name | Summary | +|-------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [consumerConfig](../consumer-config.md) | [jvm]
fun [AbstractKafkaConfig](../-abstract-kafka-config/index.md).[consumerConfig](../consumer-config.md)(configuration: [KafkaConsumerConfig](../-kafka-consumer-config/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { }) | | [registerSchemas](../register-schemas.md) | [jvm]
fun [AbstractKafkaConfig](../-abstract-kafka-config/index.md).[registerSchemas](../register-schemas.md)(configuration: [SchemaRegistrationBuilder](../-schema-registration-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { SchemaRegistrationBuilder() }) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-file-config/schema-registry-url.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-file-config/schema-registry-url.md index 13d2c414..6928bd1a 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-file-config/schema-registry-url.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-file-config/schema-registry-url.md @@ -1,20 +1,17 @@ --- title: schemaRegistryUrl --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[KafkaFileConfig](index.md)/[schemaRegistryUrl](schema-registry-url.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[KafkaFileConfig](index.md)/[schemaRegistryUrl](schema-registry-url.md) # schemaRegistryUrl - - [jvm]\ -open override var [schemaRegistryUrl](schema-registry-url.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? - - +open override +var [schemaRegistryUrl](schema-registry-url.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? -The schema registry url, if set, a client will be created and can be accessed later to register schemas manually, if schemas is left empty +The schema registry url, if set, a client will be created and can be accessed later to register schemas manually, if +schemas is left empty diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-properties-builder/build.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-properties-builder/build.md index 85298959..04560910 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-properties-builder/build.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-properties-builder/build.md @@ -1,14 +1,11 @@ --- title: build --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[KafkaPropertiesBuilder](index.md)/[build](build.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[KafkaPropertiesBuilder](index.md)/[build](build.md) # build - - [jvm]\ abstract fun [build](build.md)(): [KafkaProperties](../-kafka-properties/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-properties-builder/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-properties-builder/index.md index 04bd1f51..525b79fc 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-properties-builder/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-properties-builder/index.md @@ -1,9 +1,8 @@ --- title: KafkaPropertiesBuilder --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[KafkaPropertiesBuilder](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[KafkaPropertiesBuilder](index.md) # KafkaPropertiesBuilder @@ -11,21 +10,16 @@ interface [KafkaPropertiesBuilder](index.md) [KafkaDsl](../-kafka-dsl/index.md) Builder for [KafkaProperties](../-kafka-properties/index.md) - - #### Inheritors - -| | -|---| -| [TopicPropertiesBuilder](../-topic-properties-builder/index.md) | +| | +|-------------------------------------------------------------------| +| [TopicPropertiesBuilder](../-topic-properties-builder/index.md) | | [ClientPropertiesBuilder](../-client-properties-builder/index.md) | - ## Functions - -| Name | Summary | -|---|---| +| Name | Summary | +|-------------------|---------------------------------------------------------------------------------------------| | [build](build.md) | [jvm]
abstract fun [build](build.md)(): [KafkaProperties](../-kafka-properties/index.md) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-properties/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-properties/index.md index ac22e5ee..483099a7 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-properties/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-properties/index.md @@ -1,15 +1,14 @@ --- title: KafkaProperties --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[KafkaProperties](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[KafkaProperties](index.md) # KafkaProperties - - [jvm]\ -typealias [KafkaProperties](index.md) = [MutableMap](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.md)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)?> +typealias [KafkaProperties](index.md) = [MutableMap](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.md) +<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md) +?> diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-record-key/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-record-key/index.md index 7ea422c3..aa915d4e 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-record-key/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka-record-key/index.md @@ -1,14 +1,11 @@ --- title: KafkaRecordKey --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[KafkaRecordKey](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[KafkaRecordKey](index.md) # KafkaRecordKey - - [jvm]\ typealias [KafkaRecordKey](index.md) = [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka.md index 13de7a66..fdc155a2 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-kafka.md @@ -1,23 +1,16 @@ --- title: Kafka --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](index.md)/[Kafka](-kafka.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](index.md)/[Kafka](-kafka.md) # Kafka - - [jvm]\ val [Kafka](-kafka.md): ApplicationPlugin<[KafkaConfig](-kafka-config/index.md)> - - Plugin for setting up a kafka client - - Example: ```kotlin diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-message-timestamp-type/-create-time/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-message-timestamp-type/-create-time/index.md index 48b75cd8..548498d6 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-message-timestamp-type/-create-time/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-message-timestamp-type/-create-time/index.md @@ -1,24 +1,18 @@ --- title: CreateTime --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../../index.md)/[MessageTimestampType](../index.md)/[CreateTime](index.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../../index.md)/[MessageTimestampType](../index.md)/[CreateTime](index.md) # CreateTime - - [jvm]\ [CreateTime](index.md) - - ## Properties - -| Name | Summary | -|---|---| -| [name](../-log-append-time/index.md#-372974862%2FProperties%2F1975120172) | [jvm]
val [name](../-log-append-time/index.md#-372974862%2FProperties%2F1975120172): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | -| [ordinal](../-log-append-time/index.md#-739389684%2FProperties%2F1975120172) | [jvm]
val [ordinal](../-log-append-time/index.md#-739389684%2FProperties%2F1975120172): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) | +| Name | Summary | +|------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [name](../-log-append-time/index.md#-372974862%2FProperties%2F1975120172) | [jvm]
val [name](../-log-append-time/index.md#-372974862%2FProperties%2F1975120172): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | +| [ordinal](../-log-append-time/index.md#-739389684%2FProperties%2F1975120172) | [jvm]
val [ordinal](../-log-append-time/index.md#-739389684%2FProperties%2F1975120172): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-message-timestamp-type/-log-append-time/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-message-timestamp-type/-log-append-time/index.md index 8ca7af7c..30f673fa 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-message-timestamp-type/-log-append-time/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-message-timestamp-type/-log-append-time/index.md @@ -1,24 +1,18 @@ --- title: LogAppendTime --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../../index.md)/[MessageTimestampType](../index.md)/[LogAppendTime](index.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../../index.md)/[MessageTimestampType](../index.md)/[LogAppendTime](index.md) # LogAppendTime - - [jvm]\ [LogAppendTime](index.md) - - ## Properties - -| Name | Summary | -|---|---| -| [name](index.md#-372974862%2FProperties%2F1975120172) | [jvm]
val [name](index.md#-372974862%2FProperties%2F1975120172): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | -| [ordinal](index.md#-739389684%2FProperties%2F1975120172) | [jvm]
val [ordinal](index.md#-739389684%2FProperties%2F1975120172): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) | +| Name | Summary | +|----------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------| +| [name](index.md#-372974862%2FProperties%2F1975120172) | [jvm]
val [name](index.md#-372974862%2FProperties%2F1975120172): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | +| [ordinal](index.md#-739389684%2FProperties%2F1975120172) | [jvm]
val [ordinal](index.md#-739389684%2FProperties%2F1975120172): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-message-timestamp-type/entries.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-message-timestamp-type/entries.md index fc8fd8a9..f5d4405c 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-message-timestamp-type/entries.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-message-timestamp-type/entries.md @@ -1,23 +1,17 @@ --- title: entries --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[MessageTimestampType](index.md)/[entries](entries.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[MessageTimestampType](index.md)/[entries](entries.md) # entries - - [jvm]\ -val [entries](entries.md): [EnumEntries](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.enums/-enum-entries/index.md)<[MessageTimestampType](index.md)> - - +val [entries](entries.md): [EnumEntries](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.enums/-enum-entries/index.md) +<[MessageTimestampType](index.md)> Returns a representation of an immutable list of all enum entries, in the order they're declared. - - This method may be used to iterate over the enum entries. diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-message-timestamp-type/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-message-timestamp-type/index.md index c0221e61..2bbb3319 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-message-timestamp-type/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-message-timestamp-type/index.md @@ -1,43 +1,34 @@ --- title: MessageTimestampType --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[MessageTimestampType](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[MessageTimestampType](index.md) # MessageTimestampType - - [jvm]\ -enum [MessageTimestampType](index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.md)<[MessageTimestampType](index.md)> - - +enum [MessageTimestampType](index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.md) +<[MessageTimestampType](index.md)> ## Entries - -| | | -|---|---| -| [CreateTime](-create-time/index.md) | [jvm]
[CreateTime](-create-time/index.md) | +| | | +|--------------------------------------------|-----------------------------------------------------| +| [CreateTime](-create-time/index.md) | [jvm]
[CreateTime](-create-time/index.md) | | [LogAppendTime](-log-append-time/index.md) | [jvm]
[LogAppendTime](-log-append-time/index.md) | - ## Properties - -| Name | Summary | -|---|---| -| [entries](entries.md) | [jvm]
val [entries](entries.md): [EnumEntries](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.enums/-enum-entries/index.md)<[MessageTimestampType](index.md)>
Returns a representation of an immutable list of all enum entries, in the order they're declared. | -| [name](-log-append-time/index.md#-372974862%2FProperties%2F1975120172) | [jvm]
val [name](-log-append-time/index.md#-372974862%2FProperties%2F1975120172): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | -| [ordinal](-log-append-time/index.md#-739389684%2FProperties%2F1975120172) | [jvm]
val [ordinal](-log-append-time/index.md#-739389684%2FProperties%2F1975120172): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) | - +| Name | Summary | +|---------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [entries](entries.md) | [jvm]
val [entries](entries.md): [EnumEntries](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.enums/-enum-entries/index.md)<[MessageTimestampType](index.md)>
Returns a representation of an immutable list of all enum entries, in the order they're declared. | +| [name](-log-append-time/index.md#-372974862%2FProperties%2F1975120172) | [jvm]
val [name](-log-append-time/index.md#-372974862%2FProperties%2F1975120172): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | +| [ordinal](-log-append-time/index.md#-739389684%2FProperties%2F1975120172) | [jvm]
val [ordinal](-log-append-time/index.md#-739389684%2FProperties%2F1975120172): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) | ## Functions - -| Name | Summary | -|---|---| +| Name | Summary | +|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [valueOf](value-of.md) | [jvm]
fun [valueOf](value-of.md)(value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): [MessageTimestampType](index.md)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) | -| [values](values.md) | [jvm]
fun [values](values.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.md)<[MessageTimestampType](index.md)>
Returns an array containing the constants of this enum type, in the order they're declared. | +| [values](values.md) | [jvm]
fun [values](values.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.md)<[MessageTimestampType](index.md)>
Returns an array containing the constants of this enum type, in the order they're declared. | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-message-timestamp-type/value-of.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-message-timestamp-type/value-of.md index 0e79f9f2..cdbe00c7 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-message-timestamp-type/value-of.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-message-timestamp-type/value-of.md @@ -1,28 +1,22 @@ --- title: valueOf --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[MessageTimestampType](index.md)/[valueOf](value-of.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[MessageTimestampType](index.md)/[valueOf](value-of.md) # valueOf - - [jvm]\ -fun [valueOf](value-of.md)(value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): [MessageTimestampType](index.md) - - - -Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) - +fun [valueOf](value-of.md)( +value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): [MessageTimestampType](index.md) +Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to +declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) #### Throws - -| | | -|---|---| +| | | +|----------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------| | [IllegalArgumentException](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.md) | if this enum type has no constant with the specified name | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-message-timestamp-type/values.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-message-timestamp-type/values.md index 90b81c99..1794b9a1 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-message-timestamp-type/values.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-message-timestamp-type/values.md @@ -1,23 +1,17 @@ --- title: values --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[MessageTimestampType](index.md)/[values](values.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[MessageTimestampType](index.md)/[values](values.md) # values - - [jvm]\ -fun [values](values.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.md)<[MessageTimestampType](index.md)> - - +fun [values](values.md)(): [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.md) +<[MessageTimestampType](index.md)> Returns an array containing the constants of this enum type, in the order they're declared. - - This method may be used to iterate over the constants. diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/-producer-properties-builder.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/-producer-properties-builder.md index a43dfae3..f0595b76 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/-producer-properties-builder.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/-producer-properties-builder.md @@ -1,14 +1,11 @@ --- title: ProducerPropertiesBuilder --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ProducerPropertiesBuilder](index.md)/[ProducerPropertiesBuilder](-producer-properties-builder.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ProducerPropertiesBuilder](index.md)/[ProducerPropertiesBuilder](-producer-properties-builder.md) # ProducerPropertiesBuilder - - [jvm]\ constructor(schemaRegistryUrl: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = null) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/acks.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/acks.md index 2e9f44c8..a17f61f2 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/acks.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/acks.md @@ -1,14 +1,11 @@ --- title: acks --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ProducerPropertiesBuilder](index.md)/[acks](acks.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ProducerPropertiesBuilder](index.md)/[acks](acks.md) # acks - - [jvm]\ var [acks](acks.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/batch-size.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/batch-size.md index 5be9c6b9..129844ff 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/batch-size.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/batch-size.md @@ -1,14 +1,11 @@ --- title: batchSize --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ProducerPropertiesBuilder](index.md)/[batchSize](batch-size.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ProducerPropertiesBuilder](index.md)/[batchSize](batch-size.md) # batchSize - - [jvm]\ var [batchSize](batch-size.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/buffer-memory.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/buffer-memory.md index 6289c20b..8d6ab513 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/buffer-memory.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/buffer-memory.md @@ -1,14 +1,11 @@ --- title: bufferMemory --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ProducerPropertiesBuilder](index.md)/[bufferMemory](buffer-memory.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ProducerPropertiesBuilder](index.md)/[bufferMemory](buffer-memory.md) # bufferMemory - - [jvm]\ var [bufferMemory](buffer-memory.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/build.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/build.md index 2eee3cef..2347118c 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/build.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/build.md @@ -1,14 +1,11 @@ --- title: build --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ProducerPropertiesBuilder](index.md)/[build](build.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ProducerPropertiesBuilder](index.md)/[build](build.md) # build - - [jvm]\ open override fun [build](build.md)(): [KafkaProperties](../-kafka-properties/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/compression-type.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/compression-type.md index 64a97dd6..ab17fd34 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/compression-type.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/compression-type.md @@ -1,14 +1,11 @@ --- title: compressionType --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ProducerPropertiesBuilder](index.md)/[compressionType](compression-type.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ProducerPropertiesBuilder](index.md)/[compressionType](compression-type.md) # compressionType - - [jvm]\ var [compressionType](compression-type.md): [CompressionType](../-compression-type/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/delivery-timeout-ms.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/delivery-timeout-ms.md index 49081032..961b8ecd 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/delivery-timeout-ms.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/delivery-timeout-ms.md @@ -1,14 +1,11 @@ --- title: deliveryTimeoutMs --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ProducerPropertiesBuilder](index.md)/[deliveryTimeoutMs](delivery-timeout-ms.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ProducerPropertiesBuilder](index.md)/[deliveryTimeoutMs](delivery-timeout-ms.md) # deliveryTimeoutMs - - [jvm]\ var [deliveryTimeoutMs](delivery-timeout-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/enable-idempotence.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/enable-idempotence.md index 7f763a76..01617078 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/enable-idempotence.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/enable-idempotence.md @@ -1,14 +1,11 @@ --- title: enableIdempotence --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ProducerPropertiesBuilder](index.md)/[enableIdempotence](enable-idempotence.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ProducerPropertiesBuilder](index.md)/[enableIdempotence](enable-idempotence.md) # enableIdempotence - - [jvm]\ var [enableIdempotence](enable-idempotence.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/index.md index 20e1cfc4..69a4b13f 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/index.md @@ -1,75 +1,67 @@ --- title: ProducerPropertiesBuilder --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ProducerPropertiesBuilder](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ProducerPropertiesBuilder](index.md) # ProducerPropertiesBuilder - - [jvm]\ -class [ProducerPropertiesBuilder](index.md)(var schemaRegistryUrl: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = null) : [ClientPropertiesBuilder](../-client-properties-builder/index.md), SchemaRegistryProvider +class [ProducerPropertiesBuilder](index.md)(var +schemaRegistryUrl: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = +null) : [ClientPropertiesBuilder](../-client-properties-builder/index.md), SchemaRegistryProvider see ProducerConfig - - ## Constructors - -| | | -|---|---| +| | | +|--------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------| | [ProducerPropertiesBuilder](-producer-properties-builder.md) | [jvm]
constructor(schemaRegistryUrl: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = null) | - ## Properties - -| Name | Summary | -|---|---| -| [acks](acks.md) | [jvm]
var [acks](acks.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [batchSize](batch-size.md) | [jvm]
var [batchSize](batch-size.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [bootstrapServers](../-client-properties-builder/bootstrap-servers.md) | [jvm]
var [bootstrapServers](../-client-properties-builder/bootstrap-servers.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [bufferMemory](buffer-memory.md) | [jvm]
var [bufferMemory](buffer-memory.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [clientDnsLookup](../-client-properties-builder/client-dns-lookup.md) | [jvm]
var [clientDnsLookup](../-client-properties-builder/client-dns-lookup.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [clientId](../-client-properties-builder/client-id.md) | [jvm]
var [clientId](../-client-properties-builder/client-id.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [clientRack](../-client-properties-builder/client-rack.md) | [jvm]
var [clientRack](../-client-properties-builder/client-rack.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [compressionType](compression-type.md) | [jvm]
var [compressionType](compression-type.md): [CompressionType](../-compression-type/index.md)? | -| [connectionsMaxIdleMs](../-client-properties-builder/connections-max-idle-ms.md) | [jvm]
var [connectionsMaxIdleMs](../-client-properties-builder/connections-max-idle-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [deliveryTimeoutMs](delivery-timeout-ms.md) | [jvm]
var [deliveryTimeoutMs](delivery-timeout-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [enableIdempotence](enable-idempotence.md) | [jvm]
var [enableIdempotence](enable-idempotence.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [interceptorClasses](interceptor-classes.md) | [jvm]
var [interceptorClasses](interceptor-classes.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [keySerializerClass](key-serializer-class.md) | [jvm]
var [keySerializerClass](key-serializer-class.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [lingerMs](linger-ms.md) | [jvm]
var [lingerMs](linger-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [maxBlockMs](max-block-ms.md) | [jvm]
var [maxBlockMs](max-block-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [maxInFlightRequestsPerConnection](max-in-flight-requests-per-connection.md) | [jvm]
var [maxInFlightRequestsPerConnection](max-in-flight-requests-per-connection.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [maxRequestSize](max-request-size.md) | [jvm]
var [maxRequestSize](max-request-size.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [metadataMaxAge](../-client-properties-builder/metadata-max-age.md) | [jvm]
var [metadataMaxAge](../-client-properties-builder/metadata-max-age.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [metricReporterClasses](../-client-properties-builder/metric-reporter-classes.md) | [jvm]
var [metricReporterClasses](../-client-properties-builder/metric-reporter-classes.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [metricsNumSamples](../-client-properties-builder/metrics-num-samples.md) | [jvm]
var [metricsNumSamples](../-client-properties-builder/metrics-num-samples.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [metricsRecordingLevel](../-client-properties-builder/metrics-recording-level.md) | [jvm]
var [metricsRecordingLevel](../-client-properties-builder/metrics-recording-level.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| Name | Summary | +|------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [acks](acks.md) | [jvm]
var [acks](acks.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [batchSize](batch-size.md) | [jvm]
var [batchSize](batch-size.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [bootstrapServers](../-client-properties-builder/bootstrap-servers.md) | [jvm]
var [bootstrapServers](../-client-properties-builder/bootstrap-servers.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [bufferMemory](buffer-memory.md) | [jvm]
var [bufferMemory](buffer-memory.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [clientDnsLookup](../-client-properties-builder/client-dns-lookup.md) | [jvm]
var [clientDnsLookup](../-client-properties-builder/client-dns-lookup.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [clientId](../-client-properties-builder/client-id.md) | [jvm]
var [clientId](../-client-properties-builder/client-id.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [clientRack](../-client-properties-builder/client-rack.md) | [jvm]
var [clientRack](../-client-properties-builder/client-rack.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [compressionType](compression-type.md) | [jvm]
var [compressionType](compression-type.md): [CompressionType](../-compression-type/index.md)? | +| [connectionsMaxIdleMs](../-client-properties-builder/connections-max-idle-ms.md) | [jvm]
var [connectionsMaxIdleMs](../-client-properties-builder/connections-max-idle-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [deliveryTimeoutMs](delivery-timeout-ms.md) | [jvm]
var [deliveryTimeoutMs](delivery-timeout-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [enableIdempotence](enable-idempotence.md) | [jvm]
var [enableIdempotence](enable-idempotence.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [interceptorClasses](interceptor-classes.md) | [jvm]
var [interceptorClasses](interceptor-classes.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [keySerializerClass](key-serializer-class.md) | [jvm]
var [keySerializerClass](key-serializer-class.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [lingerMs](linger-ms.md) | [jvm]
var [lingerMs](linger-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [maxBlockMs](max-block-ms.md) | [jvm]
var [maxBlockMs](max-block-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [maxInFlightRequestsPerConnection](max-in-flight-requests-per-connection.md) | [jvm]
var [maxInFlightRequestsPerConnection](max-in-flight-requests-per-connection.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [maxRequestSize](max-request-size.md) | [jvm]
var [maxRequestSize](max-request-size.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [metadataMaxAge](../-client-properties-builder/metadata-max-age.md) | [jvm]
var [metadataMaxAge](../-client-properties-builder/metadata-max-age.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [metricReporterClasses](../-client-properties-builder/metric-reporter-classes.md) | [jvm]
var [metricReporterClasses](../-client-properties-builder/metric-reporter-classes.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [metricsNumSamples](../-client-properties-builder/metrics-num-samples.md) | [jvm]
var [metricsNumSamples](../-client-properties-builder/metrics-num-samples.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [metricsRecordingLevel](../-client-properties-builder/metrics-recording-level.md) | [jvm]
var [metricsRecordingLevel](../-client-properties-builder/metrics-recording-level.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | | [metricsSampleWindowMs](../-client-properties-builder/metrics-sample-window-ms.md) | [jvm]
var [metricsSampleWindowMs](../-client-properties-builder/metrics-sample-window-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [partitionerClass](partitioner-class.md) | [jvm]
var [partitionerClass](partitioner-class.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [receiveBuffer](../-client-properties-builder/receive-buffer.md) | [jvm]
var [receiveBuffer](../-client-properties-builder/receive-buffer.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [partitionerClass](partitioner-class.md) | [jvm]
var [partitionerClass](partitioner-class.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [receiveBuffer](../-client-properties-builder/receive-buffer.md) | [jvm]
var [receiveBuffer](../-client-properties-builder/receive-buffer.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | | [reconnectBackoffMaxMs](../-client-properties-builder/reconnect-backoff-max-ms.md) | [jvm]
var [reconnectBackoffMaxMs](../-client-properties-builder/reconnect-backoff-max-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [reconnectBackoffMs](../-client-properties-builder/reconnect-backoff-ms.md) | [jvm]
var [reconnectBackoffMs](../-client-properties-builder/reconnect-backoff-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [requestTimeoutMs](../-client-properties-builder/request-timeout-ms.md) | [jvm]
var [requestTimeoutMs](../-client-properties-builder/request-timeout-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [retries](../-client-properties-builder/retries.md) | [jvm]
var [retries](../-client-properties-builder/retries.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [retryBackoffMs](../-client-properties-builder/retry-backoff-ms.md) | [jvm]
var [retryBackoffMs](../-client-properties-builder/retry-backoff-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [schemaRegistryUrl](schema-registry-url.md) | [jvm]
open override var [schemaRegistryUrl](schema-registry-url.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? | -| [securityProtocol](../-client-properties-builder/security-protocol.md) | [jvm]
var [securityProtocol](../-client-properties-builder/security-protocol.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [sendBuffer](../-client-properties-builder/send-buffer.md) | [jvm]
var [sendBuffer](../-client-properties-builder/send-buffer.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [transactionalId](transactional-id.md) | [jvm]
var [transactionalId](transactional-id.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [transactionTimeout](transaction-timeout.md) | [jvm]
var [transactionTimeout](transaction-timeout.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | -| [valueSerializerClass](value-serializer-class.md) | [jvm]
var [valueSerializerClass](value-serializer-class.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | - +| [reconnectBackoffMs](../-client-properties-builder/reconnect-backoff-ms.md) | [jvm]
var [reconnectBackoffMs](../-client-properties-builder/reconnect-backoff-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [requestTimeoutMs](../-client-properties-builder/request-timeout-ms.md) | [jvm]
var [requestTimeoutMs](../-client-properties-builder/request-timeout-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [retries](../-client-properties-builder/retries.md) | [jvm]
var [retries](../-client-properties-builder/retries.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [retryBackoffMs](../-client-properties-builder/retry-backoff-ms.md) | [jvm]
var [retryBackoffMs](../-client-properties-builder/retry-backoff-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [schemaRegistryUrl](schema-registry-url.md) | [jvm]
open override var [schemaRegistryUrl](schema-registry-url.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? | +| [securityProtocol](../-client-properties-builder/security-protocol.md) | [jvm]
var [securityProtocol](../-client-properties-builder/security-protocol.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [sendBuffer](../-client-properties-builder/send-buffer.md) | [jvm]
var [sendBuffer](../-client-properties-builder/send-buffer.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [transactionalId](transactional-id.md) | [jvm]
var [transactionalId](transactional-id.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [transactionTimeout](transaction-timeout.md) | [jvm]
var [transactionTimeout](transaction-timeout.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | +| [valueSerializerClass](value-serializer-class.md) | [jvm]
var [valueSerializerClass](value-serializer-class.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? | ## Functions - -| Name | Summary | -|---|---| +| Name | Summary | +|-------------------|--------------------------------------------------------------------------------------------------| | [build](build.md) | [jvm]
open override fun [build](build.md)(): [KafkaProperties](../-kafka-properties/index.md) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/interceptor-classes.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/interceptor-classes.md index 752e913a..7417f087 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/interceptor-classes.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/interceptor-classes.md @@ -1,14 +1,11 @@ --- title: interceptorClasses --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ProducerPropertiesBuilder](index.md)/[interceptorClasses](interceptor-classes.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ProducerPropertiesBuilder](index.md)/[interceptorClasses](interceptor-classes.md) # interceptorClasses - - [jvm]\ var [interceptorClasses](interceptor-classes.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/key-serializer-class.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/key-serializer-class.md index a0a399a3..378054bd 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/key-serializer-class.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/key-serializer-class.md @@ -1,14 +1,11 @@ --- title: keySerializerClass --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ProducerPropertiesBuilder](index.md)/[keySerializerClass](key-serializer-class.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ProducerPropertiesBuilder](index.md)/[keySerializerClass](key-serializer-class.md) # keySerializerClass - - [jvm]\ var [keySerializerClass](key-serializer-class.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/linger-ms.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/linger-ms.md index ab223407..262234b3 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/linger-ms.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/linger-ms.md @@ -1,14 +1,11 @@ --- title: lingerMs --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ProducerPropertiesBuilder](index.md)/[lingerMs](linger-ms.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ProducerPropertiesBuilder](index.md)/[lingerMs](linger-ms.md) # lingerMs - - [jvm]\ var [lingerMs](linger-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/max-block-ms.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/max-block-ms.md index 35f19799..905a8b5d 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/max-block-ms.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/max-block-ms.md @@ -1,14 +1,11 @@ --- title: maxBlockMs --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ProducerPropertiesBuilder](index.md)/[maxBlockMs](max-block-ms.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ProducerPropertiesBuilder](index.md)/[maxBlockMs](max-block-ms.md) # maxBlockMs - - [jvm]\ var [maxBlockMs](max-block-ms.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/max-in-flight-requests-per-connection.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/max-in-flight-requests-per-connection.md index d65c3a9d..c818b2ad 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/max-in-flight-requests-per-connection.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/max-in-flight-requests-per-connection.md @@ -1,14 +1,11 @@ --- title: maxInFlightRequestsPerConnection --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ProducerPropertiesBuilder](index.md)/[maxInFlightRequestsPerConnection](max-in-flight-requests-per-connection.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ProducerPropertiesBuilder](index.md)/[maxInFlightRequestsPerConnection](max-in-flight-requests-per-connection.md) # maxInFlightRequestsPerConnection - - [jvm]\ var [maxInFlightRequestsPerConnection](max-in-flight-requests-per-connection.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/max-request-size.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/max-request-size.md index 03650731..ef320838 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/max-request-size.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/max-request-size.md @@ -1,14 +1,11 @@ --- title: maxRequestSize --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ProducerPropertiesBuilder](index.md)/[maxRequestSize](max-request-size.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ProducerPropertiesBuilder](index.md)/[maxRequestSize](max-request-size.md) # maxRequestSize - - [jvm]\ var [maxRequestSize](max-request-size.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/partitioner-class.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/partitioner-class.md index 00c09379..74af0b39 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/partitioner-class.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/partitioner-class.md @@ -1,14 +1,11 @@ --- title: partitionerClass --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ProducerPropertiesBuilder](index.md)/[partitionerClass](partitioner-class.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ProducerPropertiesBuilder](index.md)/[partitionerClass](partitioner-class.md) # partitionerClass - - [jvm]\ var [partitionerClass](partitioner-class.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/schema-registry-url.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/schema-registry-url.md index 46106222..fd4bc9a8 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/schema-registry-url.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/schema-registry-url.md @@ -1,16 +1,14 @@ --- title: schemaRegistryUrl --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ProducerPropertiesBuilder](index.md)/[schemaRegistryUrl](schema-registry-url.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ProducerPropertiesBuilder](index.md)/[schemaRegistryUrl](schema-registry-url.md) # schemaRegistryUrl - - [jvm]\ -open override var [schemaRegistryUrl](schema-registry-url.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? +open override +var [schemaRegistryUrl](schema-registry-url.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/transaction-timeout.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/transaction-timeout.md index 2c2c84c4..116428b8 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/transaction-timeout.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/transaction-timeout.md @@ -1,14 +1,11 @@ --- title: transactionTimeout --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ProducerPropertiesBuilder](index.md)/[transactionTimeout](transaction-timeout.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ProducerPropertiesBuilder](index.md)/[transactionTimeout](transaction-timeout.md) # transactionTimeout - - [jvm]\ var [transactionTimeout](transaction-timeout.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/transactional-id.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/transactional-id.md index 70de34a0..7be6cffc 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/transactional-id.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/transactional-id.md @@ -1,14 +1,11 @@ --- title: transactionalId --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ProducerPropertiesBuilder](index.md)/[transactionalId](transactional-id.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ProducerPropertiesBuilder](index.md)/[transactionalId](transactional-id.md) # transactionalId - - [jvm]\ var [transactionalId](transactional-id.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/value-serializer-class.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/value-serializer-class.md index 044e8efe..c5076320 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/value-serializer-class.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer-properties-builder/value-serializer-class.md @@ -1,14 +1,11 @@ --- title: valueSerializerClass --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ProducerPropertiesBuilder](index.md)/[valueSerializerClass](value-serializer-class.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[ProducerPropertiesBuilder](index.md)/[valueSerializerClass](value-serializer-class.md) # valueSerializerClass - - [jvm]\ var [valueSerializerClass](value-serializer-class.md): [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer/index.md index d63c241f..44d22f47 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-producer/index.md @@ -1,14 +1,11 @@ --- title: Producer --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[Producer](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[Producer](index.md) # Producer - - [jvm]\ typealias [Producer](index.md) = KafkaProducer<[KafkaRecordKey](../-kafka-record-key/index.md), GenericRecord> diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-schema-registration-builder/-schema-registration-builder.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-schema-registration-builder/-schema-registration-builder.md index d0141d9c..9f0b7ebf 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-schema-registration-builder/-schema-registration-builder.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-schema-registration-builder/-schema-registration-builder.md @@ -1,14 +1,11 @@ --- title: SchemaRegistrationBuilder --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[SchemaRegistrationBuilder](index.md)/[SchemaRegistrationBuilder](-schema-registration-builder.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[SchemaRegistrationBuilder](index.md)/[SchemaRegistrationBuilder](-schema-registration-builder.md) # SchemaRegistrationBuilder - - [jvm]\ constructor() diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-schema-registration-builder/at.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-schema-registration-builder/at.md index 837d38f6..451a3e8d 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-schema-registration-builder/at.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-schema-registration-builder/at.md @@ -1,16 +1,15 @@ --- title: at --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[SchemaRegistrationBuilder](index.md)/[at](at.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[SchemaRegistrationBuilder](index.md)/[at](at.md) # at - - [jvm]\ -infix fun [KClass](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.md)<out [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)>.[at](at.md)(topicName: [TopicName](../-topic-name/index.md)) +infix fun [KClass](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.md) +<out [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)>.[at](at.md)( +topicName: [TopicName](../-topic-name/index.md)) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-schema-registration-builder/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-schema-registration-builder/index.md index ef036428..b11634d6 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-schema-registration-builder/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-schema-registration-builder/index.md @@ -1,32 +1,24 @@ --- title: SchemaRegistrationBuilder --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[SchemaRegistrationBuilder](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[SchemaRegistrationBuilder](index.md) # SchemaRegistrationBuilder - - [jvm]\ class [SchemaRegistrationBuilder](index.md) - - ## Constructors - -| | | -|---|---| +| | | +|--------------------------------------------------------------|------------------------| | [SchemaRegistrationBuilder](-schema-registration-builder.md) | [jvm]
constructor() | - ## Functions - -| Name | Summary | -|---|---| -| [at](at.md) | [jvm]
infix fun [KClass](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.md)<out [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)>.[at](at.md)(topicName: [TopicName](../-topic-name/index.md)) | +| Name | Summary | +|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [at](at.md) | [jvm]
infix fun [KClass](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.md)<out [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)>.[at](at.md)(topicName: [TopicName](../-topic-name/index.md)) | | [using](using.md) | [jvm]
fun [using](using.md)(provider: () -> HttpClient)
optionally provide a client to register schemas, by default, CIO would be used. In any case, the following it would be configured with serialization json and the configured [AbstractKafkaConfig.schemaRegistrationTimeoutMs](../-abstract-kafka-config/schema-registration-timeout-ms.md) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-schema-registration-builder/using.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-schema-registration-builder/using.md index c811ec8b..4f69d352 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-schema-registration-builder/using.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-schema-registration-builder/using.md @@ -1,20 +1,17 @@ --- title: using --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[SchemaRegistrationBuilder](index.md)/[using](using.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[SchemaRegistrationBuilder](index.md)/[using](using.md) # using - - [jvm]\ fun [using](using.md)(provider: () -> HttpClient) - - -optionally provide a client to register schemas, by default, CIO would be used. In any case, the following it would be configured with serialization json and the configured [AbstractKafkaConfig.schemaRegistrationTimeoutMs](../-abstract-kafka-config/schema-registration-timeout-ms.md) +optionally provide a client to register schemas, by default, CIO would be used. In any case, the following it would be +configured with serialization json and the +configured [AbstractKafkaConfig.schemaRegistrationTimeoutMs](../-abstract-kafka-config/schema-registration-timeout-ms.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-builder/-companion/fro-map.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-builder/-companion/fro-map.md index 3c8b0f49..63cf98ad 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-builder/-companion/fro-map.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-builder/-companion/fro-map.md @@ -1,16 +1,15 @@ --- title: froMap --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../../index.md)/[TopicBuilder](../index.md)/[Companion](index.md)/[froMap](fro-map.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../../index.md)/[TopicBuilder](../index.md)/[Companion](index.md)/[froMap](fro-map.md) # froMap - - [jvm]\ -fun [froMap](fro-map.md)(map: [Map](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.md)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)?>): [TopicBuilder](../index.md) +fun [froMap](fro-map.md)(map: [Map](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.md) +<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md) +?>): [TopicBuilder](../index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-builder/-companion/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-builder/-companion/index.md index f17a5012..95d0f2af 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-builder/-companion/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-builder/-companion/index.md @@ -1,23 +1,17 @@ --- title: Companion --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../../index.md)/[TopicBuilder](../index.md)/[Companion](index.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../../index.md)/[TopicBuilder](../index.md)/[Companion](index.md) # Companion - - [jvm]\ object [Companion](index.md) - - ## Functions - -| Name | Summary | -|---|---| +| Name | Summary | +|----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [froMap](fro-map.md) | [jvm]
fun [froMap](fro-map.md)(map: [Map](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.md)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)?>): [TopicBuilder](../index.md) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-builder/-topic-builder.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-builder/-topic-builder.md index 26eed87b..ce745028 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-builder/-topic-builder.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-builder/-topic-builder.md @@ -1,14 +1,11 @@ --- title: TopicBuilder --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicBuilder](index.md)/[TopicBuilder](-topic-builder.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicBuilder](index.md)/[TopicBuilder](-topic-builder.md) # TopicBuilder - - [jvm]\ constructor(name: [TopicName](../-topic-name/index.md)) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-builder/configs.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-builder/configs.md index f688dadc..5bcc8630 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-builder/configs.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-builder/configs.md @@ -1,16 +1,14 @@ --- title: configs --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicBuilder](index.md)/[configs](configs.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicBuilder](index.md)/[configs](configs.md) # configs - - [jvm]\ -fun [configs](configs.md)(config: [TopicPropertiesBuilder](../-topic-properties-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) +fun [configs](configs.md)(config: [TopicPropertiesBuilder](../-topic-properties-builder/index.md).() +-> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-builder/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-builder/index.md index 93e21629..c88f7e56 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-builder/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-builder/index.md @@ -1,49 +1,37 @@ --- title: TopicBuilder --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicBuilder](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicBuilder](index.md) # TopicBuilder - - [jvm]\ class [TopicBuilder](index.md)(name: [TopicName](../-topic-name/index.md)) - - ## Constructors - -| | | -|---|---| +| | | +|-----------------------------------|------------------------------------------------------------------| | [TopicBuilder](-topic-builder.md) | [jvm]
constructor(name: [TopicName](../-topic-name/index.md)) | - ## Types - -| Name | Summary | -|---|---| +| Name | Summary | +|----------------------------------|--------------------------------------------------| | [Companion](-companion/index.md) | [jvm]
object [Companion](-companion/index.md) | - ## Properties - -| Name | Summary | -|---|---| -| [partitions](partitions.md) | [jvm]
var [partitions](partitions.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) | -| [replicas](replicas.md) | [jvm]
var [replicas](replicas.md): [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.md) | +| Name | Summary | +|------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [partitions](partitions.md) | [jvm]
var [partitions](partitions.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) | +| [replicas](replicas.md) | [jvm]
var [replicas](replicas.md): [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.md) | | [replicasAssignments](replicas-assignments.md) | [jvm]
var [replicasAssignments](replicas-assignments.md): [Map](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.md)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)?>>? | - ## Functions - -| Name | Summary | -|---|---| +| Name | Summary | +|-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [configs](configs.md) | [jvm]
fun [configs](configs.md)(config: [TopicPropertiesBuilder](../-topic-properties-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-builder/partitions.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-builder/partitions.md index f511c94e..93ff65e7 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-builder/partitions.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-builder/partitions.md @@ -1,14 +1,11 @@ --- title: partitions --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicBuilder](index.md)/[partitions](partitions.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicBuilder](index.md)/[partitions](partitions.md) # partitions - - [jvm]\ var [partitions](partitions.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-builder/replicas-assignments.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-builder/replicas-assignments.md index 1c63f5e1..de5756c8 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-builder/replicas-assignments.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-builder/replicas-assignments.md @@ -1,16 +1,15 @@ --- title: replicasAssignments --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicBuilder](index.md)/[replicasAssignments](replicas-assignments.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicBuilder](index.md)/[replicasAssignments](replicas-assignments.md) # replicasAssignments - - [jvm]\ -var [replicasAssignments](replicas-assignments.md): [Map](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.md)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)?>>? +var [replicasAssignments](replicas-assignments.md): [Map](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.md) +<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md) +<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)?>>? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-builder/replicas.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-builder/replicas.md index adf8c401..0ae56ecf 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-builder/replicas.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-builder/replicas.md @@ -1,14 +1,11 @@ --- title: replicas --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicBuilder](index.md)/[replicas](replicas.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicBuilder](index.md)/[replicas](replicas.md) # replicas - - [jvm]\ var [replicas](replicas.md): [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-name/-companion/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-name/-companion/index.md index a2068ee4..8e6c3ede 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-name/-companion/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-name/-companion/index.md @@ -1,23 +1,17 @@ --- title: Companion --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../../index.md)/[TopicName](../index.md)/[Companion](index.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../../index.md)/[TopicName](../index.md)/[Companion](index.md) # Companion - - [jvm]\ object [Companion](index.md) - - ## Functions - -| Name | Summary | -|---|---| +| Name | Summary | +|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------| | [named](named.md) | [jvm]
infix fun [named](named.md)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): [TopicName](../index.md) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-name/-companion/named.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-name/-companion/named.md index ff13f3b3..13bf6872 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-name/-companion/named.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-name/-companion/named.md @@ -1,16 +1,14 @@ --- title: named --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../../index.md)/[TopicName](../index.md)/[Companion](index.md)/[named](named.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../../index.md)/[TopicName](../index.md)/[Companion](index.md)/[named](named.md) # named - - [jvm]\ -infix fun [named](named.md)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): [TopicName](../index.md) +infix fun [named](named.md)( +name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): [TopicName](../index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-name/-topic-name.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-name/-topic-name.md index ecc5cc10..f0559bde 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-name/-topic-name.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-name/-topic-name.md @@ -1,14 +1,11 @@ --- title: TopicName --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicName](index.md)/[TopicName](-topic-name.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicName](index.md)/[TopicName](-topic-name.md) # TopicName - - [jvm]\ constructor(value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-name/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-name/index.md index 04860f22..aacb6473 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-name/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-name/index.md @@ -1,43 +1,32 @@ --- title: TopicName --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicName](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicName](index.md) # TopicName - - [jvm]\ @[JvmInline](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-inline/index.md) - - -value class [TopicName](index.md)(val value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)) - - +value class [TopicName](index.md)(val +value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)) ## Constructors - -| | | -|---|---| +| | | +|-----------------------------|-------------------------------------------------------------------------------------------------------------| | [TopicName](-topic-name.md) | [jvm]
constructor(value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)) | - ## Types - -| Name | Summary | -|---|---| +| Name | Summary | +|----------------------------------|--------------------------------------------------| | [Companion](-companion/index.md) | [jvm]
object [Companion](-companion/index.md) | - ## Properties - -| Name | Summary | -|---|---| +| Name | Summary | +|-------------------|----------------------------------------------------------------------------------------------------------------| | [value](value.md) | [jvm]
val [value](value.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-name/value.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-name/value.md index e64de8f4..4f6b340f 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-name/value.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-name/value.md @@ -1,14 +1,11 @@ --- title: value --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicName](index.md)/[value](value.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicName](index.md)/[value](value.md) # value - - [jvm]\ val [value](value.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/-topic-properties-builder.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/-topic-properties-builder.md index 965e18fe..1b4bdae2 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/-topic-properties-builder.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/-topic-properties-builder.md @@ -1,14 +1,11 @@ --- title: TopicPropertiesBuilder --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[TopicPropertiesBuilder](-topic-properties-builder.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[TopicPropertiesBuilder](-topic-properties-builder.md) # TopicPropertiesBuilder - - [jvm]\ constructor() diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/build.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/build.md index 1f8dc348..d2d8c65c 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/build.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/build.md @@ -1,14 +1,11 @@ --- title: build --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[build](build.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[build](build.md) # build - - [jvm]\ open override fun [build](build.md)(): [KafkaProperties](../-kafka-properties/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/cleanup-policy.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/cleanup-policy.md index e10d4350..b6415301 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/cleanup-policy.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/cleanup-policy.md @@ -1,14 +1,11 @@ --- title: cleanupPolicy --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[cleanupPolicy](cleanup-policy.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[cleanupPolicy](cleanup-policy.md) # cleanupPolicy - - [jvm]\ var [cleanupPolicy](cleanup-policy.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/compression-type.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/compression-type.md index 0e86d73f..0a31956a 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/compression-type.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/compression-type.md @@ -1,14 +1,11 @@ --- title: compressionType --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[compressionType](compression-type.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[compressionType](compression-type.md) # compressionType - - [jvm]\ var [compressionType](compression-type.md): [CompressionType](../-compression-type/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/delete-retention-ms.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/delete-retention-ms.md index adf26273..60006254 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/delete-retention-ms.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/delete-retention-ms.md @@ -1,14 +1,11 @@ --- title: deleteRetentionMs --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[deleteRetentionMs](delete-retention-ms.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[deleteRetentionMs](delete-retention-ms.md) # deleteRetentionMs - - [jvm]\ var [deleteRetentionMs](delete-retention-ms.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/file-delete-delay-ms.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/file-delete-delay-ms.md index 24e47078..b49318fd 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/file-delete-delay-ms.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/file-delete-delay-ms.md @@ -1,14 +1,11 @@ --- title: fileDeleteDelayMs --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[fileDeleteDelayMs](file-delete-delay-ms.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[fileDeleteDelayMs](file-delete-delay-ms.md) # fileDeleteDelayMs - - [jvm]\ var [fileDeleteDelayMs](file-delete-delay-ms.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/flush-messages-interval.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/flush-messages-interval.md index ccb31fc6..c11648a7 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/flush-messages-interval.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/flush-messages-interval.md @@ -1,14 +1,11 @@ --- title: flushMessagesInterval --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[flushMessagesInterval](flush-messages-interval.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[flushMessagesInterval](flush-messages-interval.md) # flushMessagesInterval - - [jvm]\ var [flushMessagesInterval](flush-messages-interval.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/flush-ms.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/flush-ms.md index dace75d3..597356d5 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/flush-ms.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/flush-ms.md @@ -1,14 +1,11 @@ --- title: flushMs --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[flushMs](flush-ms.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[flushMs](flush-ms.md) # flushMs - - [jvm]\ var [flushMs](flush-ms.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/index-interval-bytes.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/index-interval-bytes.md index f17543f5..66264830 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/index-interval-bytes.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/index-interval-bytes.md @@ -1,14 +1,11 @@ --- title: indexIntervalBytes --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[indexIntervalBytes](index-interval-bytes.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[indexIntervalBytes](index-interval-bytes.md) # indexIntervalBytes - - [jvm]\ var [indexIntervalBytes](index-interval-bytes.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/index.md index 0c85cb77..c9c39897 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/index.md @@ -1,64 +1,54 @@ --- title: TopicPropertiesBuilder --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md) # TopicPropertiesBuilder - - [jvm]\ class [TopicPropertiesBuilder](index.md) : [KafkaPropertiesBuilder](../-kafka-properties-builder/index.md) See TopicConfig - - ## Constructors - -| | | -|---|---| +| | | +|--------------------------------------------------------|------------------------| | [TopicPropertiesBuilder](-topic-properties-builder.md) | [jvm]
constructor() | - ## Properties - -| Name | Summary | -|---|---| -| [cleanupPolicy](cleanup-policy.md) | [jvm]
var [cleanupPolicy](cleanup-policy.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? | -| [compressionType](compression-type.md) | [jvm]
var [compressionType](compression-type.md): [CompressionType](../-compression-type/index.md)? | -| [deleteRetentionMs](delete-retention-ms.md) | [jvm]
var [deleteRetentionMs](delete-retention-ms.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)? | -| [fileDeleteDelayMs](file-delete-delay-ms.md) | [jvm]
var [fileDeleteDelayMs](file-delete-delay-ms.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)? | -| [flushMessagesInterval](flush-messages-interval.md) | [jvm]
var [flushMessagesInterval](flush-messages-interval.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)? | -| [flushMs](flush-ms.md) | [jvm]
var [flushMs](flush-ms.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)? | -| [indexIntervalBytes](index-interval-bytes.md) | [jvm]
var [indexIntervalBytes](index-interval-bytes.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)? | -| [maxCompactionLagMs](max-compaction-lag-ms.md) | [jvm]
var [maxCompactionLagMs](max-compaction-lag-ms.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)? | -| [maxMessageBytes](max-message-bytes.md) | [jvm]
var [maxMessageBytes](max-message-bytes.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)? | -| [messageDownconversionEnable](message-downconversion-enable.md) | [jvm]
var [messageDownconversionEnable](message-downconversion-enable.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)? | -| [messageFormatVersion](message-format-version.md) | [jvm]
var [messageFormatVersion](message-format-version.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? | +| Name | Summary | +|---------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [cleanupPolicy](cleanup-policy.md) | [jvm]
var [cleanupPolicy](cleanup-policy.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? | +| [compressionType](compression-type.md) | [jvm]
var [compressionType](compression-type.md): [CompressionType](../-compression-type/index.md)? | +| [deleteRetentionMs](delete-retention-ms.md) | [jvm]
var [deleteRetentionMs](delete-retention-ms.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)? | +| [fileDeleteDelayMs](file-delete-delay-ms.md) | [jvm]
var [fileDeleteDelayMs](file-delete-delay-ms.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)? | +| [flushMessagesInterval](flush-messages-interval.md) | [jvm]
var [flushMessagesInterval](flush-messages-interval.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)? | +| [flushMs](flush-ms.md) | [jvm]
var [flushMs](flush-ms.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)? | +| [indexIntervalBytes](index-interval-bytes.md) | [jvm]
var [indexIntervalBytes](index-interval-bytes.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)? | +| [maxCompactionLagMs](max-compaction-lag-ms.md) | [jvm]
var [maxCompactionLagMs](max-compaction-lag-ms.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)? | +| [maxMessageBytes](max-message-bytes.md) | [jvm]
var [maxMessageBytes](max-message-bytes.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)? | +| [messageDownconversionEnable](message-downconversion-enable.md) | [jvm]
var [messageDownconversionEnable](message-downconversion-enable.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)? | +| [messageFormatVersion](message-format-version.md) | [jvm]
var [messageFormatVersion](message-format-version.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? | | [messageTimestampDifferenceMaxMs](message-timestamp-difference-max-ms.md) | [jvm]
var [messageTimestampDifferenceMaxMs](message-timestamp-difference-max-ms.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)? | -| [messageTimestampType](message-timestamp-type.md) | [jvm]
var [messageTimestampType](message-timestamp-type.md): [MessageTimestampType](../-message-timestamp-type/index.md)? | -| [minCleanableDirtyRatio](min-cleanable-dirty-ratio.md) | [jvm]
var [minCleanableDirtyRatio](min-cleanable-dirty-ratio.md): [Float](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.md)? | -| [minCompactionLagMs](min-compaction-lag-ms.md) | [jvm]
var [minCompactionLagMs](min-compaction-lag-ms.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)? | -| [minInSyncReplicas](min-in-sync-replicas.md) | [jvm]
var [minInSyncReplicas](min-in-sync-replicas.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)? | -| [preallocate](preallocate.md) | [jvm]
var [preallocate](preallocate.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)? | -| [retentionBytes](retention-bytes.md) | [jvm]
var [retentionBytes](retention-bytes.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)? | -| [retentionMs](retention-ms.md) | [jvm]
var [retentionMs](retention-ms.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)? | -| [segmentBytes](segment-bytes.md) | [jvm]
var [segmentBytes](segment-bytes.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)? | -| [segmentIndexBytes](segment-index-bytes.md) | [jvm]
var [segmentIndexBytes](segment-index-bytes.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)? | -| [segmentJitterMs](segment-jitter-ms.md) | [jvm]
var [segmentJitterMs](segment-jitter-ms.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)? | -| [segmentMs](segment-ms.md) | [jvm]
var [segmentMs](segment-ms.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)? | -| [uncleanLeaderElectionEnable](unclean-leader-election-enable.md) | [jvm]
var [uncleanLeaderElectionEnable](unclean-leader-election-enable.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)? | - +| [messageTimestampType](message-timestamp-type.md) | [jvm]
var [messageTimestampType](message-timestamp-type.md): [MessageTimestampType](../-message-timestamp-type/index.md)? | +| [minCleanableDirtyRatio](min-cleanable-dirty-ratio.md) | [jvm]
var [minCleanableDirtyRatio](min-cleanable-dirty-ratio.md): [Float](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.md)? | +| [minCompactionLagMs](min-compaction-lag-ms.md) | [jvm]
var [minCompactionLagMs](min-compaction-lag-ms.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)? | +| [minInSyncReplicas](min-in-sync-replicas.md) | [jvm]
var [minInSyncReplicas](min-in-sync-replicas.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)? | +| [preallocate](preallocate.md) | [jvm]
var [preallocate](preallocate.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)? | +| [retentionBytes](retention-bytes.md) | [jvm]
var [retentionBytes](retention-bytes.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)? | +| [retentionMs](retention-ms.md) | [jvm]
var [retentionMs](retention-ms.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)? | +| [segmentBytes](segment-bytes.md) | [jvm]
var [segmentBytes](segment-bytes.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)? | +| [segmentIndexBytes](segment-index-bytes.md) | [jvm]
var [segmentIndexBytes](segment-index-bytes.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)? | +| [segmentJitterMs](segment-jitter-ms.md) | [jvm]
var [segmentJitterMs](segment-jitter-ms.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)? | +| [segmentMs](segment-ms.md) | [jvm]
var [segmentMs](segment-ms.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)? | +| [uncleanLeaderElectionEnable](unclean-leader-election-enable.md) | [jvm]
var [uncleanLeaderElectionEnable](unclean-leader-election-enable.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)? | ## Functions - -| Name | Summary | -|---|---| +| Name | Summary | +|-------------------|--------------------------------------------------------------------------------------------------| | [build](build.md) | [jvm]
open override fun [build](build.md)(): [KafkaProperties](../-kafka-properties/index.md) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/max-compaction-lag-ms.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/max-compaction-lag-ms.md index 2d6dfea6..85392768 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/max-compaction-lag-ms.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/max-compaction-lag-ms.md @@ -1,14 +1,11 @@ --- title: maxCompactionLagMs --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[maxCompactionLagMs](max-compaction-lag-ms.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[maxCompactionLagMs](max-compaction-lag-ms.md) # maxCompactionLagMs - - [jvm]\ var [maxCompactionLagMs](max-compaction-lag-ms.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/max-message-bytes.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/max-message-bytes.md index f10d51f0..ad19c81e 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/max-message-bytes.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/max-message-bytes.md @@ -1,14 +1,11 @@ --- title: maxMessageBytes --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[maxMessageBytes](max-message-bytes.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[maxMessageBytes](max-message-bytes.md) # maxMessageBytes - - [jvm]\ var [maxMessageBytes](max-message-bytes.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/message-downconversion-enable.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/message-downconversion-enable.md index f09ef579..85c42c3c 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/message-downconversion-enable.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/message-downconversion-enable.md @@ -1,14 +1,11 @@ --- title: messageDownconversionEnable --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[messageDownconversionEnable](message-downconversion-enable.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[messageDownconversionEnable](message-downconversion-enable.md) # messageDownconversionEnable - - [jvm]\ var [messageDownconversionEnable](message-downconversion-enable.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/message-format-version.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/message-format-version.md index f03c3f57..56ad1708 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/message-format-version.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/message-format-version.md @@ -1,14 +1,11 @@ --- title: messageFormatVersion --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[messageFormatVersion](message-format-version.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[messageFormatVersion](message-format-version.md) # messageFormatVersion - - [jvm]\ var [messageFormatVersion](message-format-version.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/message-timestamp-difference-max-ms.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/message-timestamp-difference-max-ms.md index d20c85dc..4f3f6f55 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/message-timestamp-difference-max-ms.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/message-timestamp-difference-max-ms.md @@ -1,14 +1,11 @@ --- title: messageTimestampDifferenceMaxMs --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[messageTimestampDifferenceMaxMs](message-timestamp-difference-max-ms.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[messageTimestampDifferenceMaxMs](message-timestamp-difference-max-ms.md) # messageTimestampDifferenceMaxMs - - [jvm]\ var [messageTimestampDifferenceMaxMs](message-timestamp-difference-max-ms.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/message-timestamp-type.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/message-timestamp-type.md index 62a0e567..9ee8af27 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/message-timestamp-type.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/message-timestamp-type.md @@ -1,14 +1,11 @@ --- title: messageTimestampType --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[messageTimestampType](message-timestamp-type.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[messageTimestampType](message-timestamp-type.md) # messageTimestampType - - [jvm]\ var [messageTimestampType](message-timestamp-type.md): [MessageTimestampType](../-message-timestamp-type/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/min-cleanable-dirty-ratio.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/min-cleanable-dirty-ratio.md index cd9a8c0c..94db07d8 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/min-cleanable-dirty-ratio.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/min-cleanable-dirty-ratio.md @@ -1,14 +1,11 @@ --- title: minCleanableDirtyRatio --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[minCleanableDirtyRatio](min-cleanable-dirty-ratio.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[minCleanableDirtyRatio](min-cleanable-dirty-ratio.md) # minCleanableDirtyRatio - - [jvm]\ var [minCleanableDirtyRatio](min-cleanable-dirty-ratio.md): [Float](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/min-compaction-lag-ms.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/min-compaction-lag-ms.md index 77e37f7e..569b8570 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/min-compaction-lag-ms.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/min-compaction-lag-ms.md @@ -1,14 +1,11 @@ --- title: minCompactionLagMs --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[minCompactionLagMs](min-compaction-lag-ms.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[minCompactionLagMs](min-compaction-lag-ms.md) # minCompactionLagMs - - [jvm]\ var [minCompactionLagMs](min-compaction-lag-ms.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/min-in-sync-replicas.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/min-in-sync-replicas.md index cab57c82..9a6358df 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/min-in-sync-replicas.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/min-in-sync-replicas.md @@ -1,14 +1,11 @@ --- title: minInSyncReplicas --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[minInSyncReplicas](min-in-sync-replicas.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[minInSyncReplicas](min-in-sync-replicas.md) # minInSyncReplicas - - [jvm]\ var [minInSyncReplicas](min-in-sync-replicas.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/preallocate.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/preallocate.md index 7556a812..11f02e87 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/preallocate.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/preallocate.md @@ -1,14 +1,11 @@ --- title: preallocate --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[preallocate](preallocate.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[preallocate](preallocate.md) # preallocate - - [jvm]\ var [preallocate](preallocate.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/retention-bytes.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/retention-bytes.md index ff50a49c..9afea1e9 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/retention-bytes.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/retention-bytes.md @@ -1,14 +1,11 @@ --- title: retentionBytes --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[retentionBytes](retention-bytes.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[retentionBytes](retention-bytes.md) # retentionBytes - - [jvm]\ var [retentionBytes](retention-bytes.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/retention-ms.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/retention-ms.md index 5927498d..9eae6fa6 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/retention-ms.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/retention-ms.md @@ -1,14 +1,11 @@ --- title: retentionMs --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[retentionMs](retention-ms.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[retentionMs](retention-ms.md) # retentionMs - - [jvm]\ var [retentionMs](retention-ms.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/segment-bytes.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/segment-bytes.md index a295f396..ac6d1309 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/segment-bytes.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/segment-bytes.md @@ -1,14 +1,11 @@ --- title: segmentBytes --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[segmentBytes](segment-bytes.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[segmentBytes](segment-bytes.md) # segmentBytes - - [jvm]\ var [segmentBytes](segment-bytes.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/segment-index-bytes.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/segment-index-bytes.md index ed7b537f..4763c7d3 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/segment-index-bytes.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/segment-index-bytes.md @@ -1,14 +1,11 @@ --- title: segmentIndexBytes --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[segmentIndexBytes](segment-index-bytes.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[segmentIndexBytes](segment-index-bytes.md) # segmentIndexBytes - - [jvm]\ var [segmentIndexBytes](segment-index-bytes.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/segment-jitter-ms.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/segment-jitter-ms.md index a770c41f..2a2ae1b0 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/segment-jitter-ms.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/segment-jitter-ms.md @@ -1,14 +1,11 @@ --- title: segmentJitterMs --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[segmentJitterMs](segment-jitter-ms.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[segmentJitterMs](segment-jitter-ms.md) # segmentJitterMs - - [jvm]\ var [segmentJitterMs](segment-jitter-ms.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/segment-ms.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/segment-ms.md index 983479d6..39783e13 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/segment-ms.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/segment-ms.md @@ -1,14 +1,11 @@ --- title: segmentMs --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[segmentMs](segment-ms.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[segmentMs](segment-ms.md) # segmentMs - - [jvm]\ var [segmentMs](segment-ms.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/unclean-leader-election-enable.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/unclean-leader-election-enable.md index eae57cc5..9d1a86bd 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/unclean-leader-election-enable.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/-topic-properties-builder/unclean-leader-election-enable.md @@ -1,14 +1,11 @@ --- title: uncleanLeaderElectionEnable --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[uncleanLeaderElectionEnable](unclean-leader-election-enable.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](../index.md)/[TopicPropertiesBuilder](index.md)/[uncleanLeaderElectionEnable](unclean-leader-election-enable.md) # uncleanLeaderElectionEnable - - [jvm]\ var [uncleanLeaderElectionEnable](unclean-leader-election-enable.md): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/admin.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/admin.md index 52124d90..e33edaae 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/admin.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/admin.md @@ -1,16 +1,15 @@ --- title: admin --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](index.md)/[admin](admin.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](index.md)/[admin](admin.md) # admin - - [jvm]\ -fun [KafkaConfig](-kafka-config/index.md).[admin](admin.md)(configuration: [AdminPropertiesBuilder](-admin-properties-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { AdminPropertiesBuilder() }) +fun [KafkaConfig](-kafka-config/index.md).[admin](admin.md)( +configuration: [AdminPropertiesBuilder](-admin-properties-builder/index.md).() +-> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { AdminPropertiesBuilder() }) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/common.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/common.md index 8af811b3..0e42c07d 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/common.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/common.md @@ -1,16 +1,15 @@ --- title: common --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](index.md)/[common](common.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](index.md)/[common](common.md) # common - - [jvm]\ -fun [KafkaConfig](-kafka-config/index.md).[common](common.md)(configuration: [CommonClientPropertiesBuilder](-common-client-properties-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { CommonClientPropertiesBuilder }) +fun [KafkaConfig](-kafka-config/index.md).[common](common.md)( +configuration: [CommonClientPropertiesBuilder](-common-client-properties-builder/index.md).() +-> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { CommonClientPropertiesBuilder }) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/consumer-config.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/consumer-config.md index 0c096a9b..f7a737c7 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/consumer-config.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/consumer-config.md @@ -1,16 +1,15 @@ --- title: consumerConfig --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](index.md)/[consumerConfig](consumer-config.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](index.md)/[consumerConfig](consumer-config.md) # consumerConfig - - [jvm]\ -fun [AbstractKafkaConfig](-abstract-kafka-config/index.md).[consumerConfig](consumer-config.md)(configuration: [KafkaConsumerConfig](-kafka-consumer-config/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { }) +fun [AbstractKafkaConfig](-abstract-kafka-config/index.md).[consumerConfig](consumer-config.md)( +configuration: [KafkaConsumerConfig](-kafka-consumer-config/index.md).() +-> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { }) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/consumer-record-handler.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/consumer-record-handler.md index 6d247925..37b754be 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/consumer-record-handler.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/consumer-record-handler.md @@ -1,16 +1,14 @@ --- title: consumerRecordHandler --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](index.md)/[consumerRecordHandler](consumer-record-handler.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](index.md)/[consumerRecordHandler](consumer-record-handler.md) # consumerRecordHandler - - [jvm]\ -fun [KafkaConsumerConfig](-kafka-consumer-config/index.md).[consumerRecordHandler](consumer-record-handler.md)(topicName: [TopicName](-topic-name/index.md), handler: [ConsumerRecordHandler](-consumer-record-handler/index.md)) +fun [KafkaConsumerConfig](-kafka-consumer-config/index.md).[consumerRecordHandler](consumer-record-handler.md)( +topicName: [TopicName](-topic-name/index.md), handler: [ConsumerRecordHandler](-consumer-record-handler/index.md)) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/consumer.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/consumer.md index 51c85ca2..e9de5b5a 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/consumer.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/consumer.md @@ -1,16 +1,16 @@ --- title: consumer --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](index.md)/[consumer](consumer.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](index.md)/[consumer](consumer.md) # consumer - - [jvm]\ -fun [KafkaConfig](-kafka-config/index.md).[consumer](consumer.md)(configuration: [ConsumerPropertiesBuilder](-consumer-properties-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { ConsumerPropertiesBuilder(schemaRegistryUrl) }) +fun [KafkaConfig](-kafka-config/index.md).[consumer](consumer.md)( +configuration: [ConsumerPropertiesBuilder](-consumer-properties-builder/index.md).() +-> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { ConsumerPropertiesBuilder( +schemaRegistryUrl) }) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/index.md index 99800e28..ac7afcde 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/index.md @@ -1,71 +1,63 @@ --- title: io.github.flaxoos.ktor.server.plugins.kafka --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](index.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](index.md) # Package-level declarations - - ## Types - -| Name | Summary | -|---|---| -| [AbstractKafkaConfig](-abstract-kafka-config/index.md) | [jvm]
sealed class [AbstractKafkaConfig](-abstract-kafka-config/index.md) | -| [AdminPropertiesBuilder](-admin-properties-builder/index.md) | [jvm]
class [AdminPropertiesBuilder](-admin-properties-builder/index.md) : [ClientPropertiesBuilder](-client-properties-builder/index.md) | -| [Attributes](-attributes/index.md) | [jvm]
object [Attributes](-attributes/index.md) | -| [ClientPropertiesBuilder](-client-properties-builder/index.md) | [jvm]
sealed class [ClientPropertiesBuilder](-client-properties-builder/index.md) : [KafkaPropertiesBuilder](-kafka-properties-builder/index.md)
see CommonClientConfigs | -| [CommonClientPropertiesBuilder](-common-client-properties-builder/index.md) | [jvm]
data object [CommonClientPropertiesBuilder](-common-client-properties-builder/index.md) : [ClientPropertiesBuilder](-client-properties-builder/index.md)
Concrete implementation of [ClientPropertiesBuilder](-client-properties-builder/index.md) to represent the common properties | -| [CompressionType](-compression-type/index.md) | [jvm]
typealias [CompressionType](-compression-type/index.md) = org.apache.kafka.common.record.CompressionType | -| [Consumer](-consumer/index.md) | [jvm]
typealias [Consumer](-consumer/index.md) = KafkaConsumer<[KafkaRecordKey](-kafka-record-key/index.md), GenericRecord> | -| [ConsumerPropertiesBuilder](-consumer-properties-builder/index.md) | [jvm]
class [ConsumerPropertiesBuilder](-consumer-properties-builder/index.md)(var schemaRegistryUrl: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = null) : [ClientPropertiesBuilder](-client-properties-builder/index.md), SchemaRegistryProvider
see ConsumerConfig | -| [ConsumerRecordHandler](-consumer-record-handler/index.md) | [jvm]
typealias [ConsumerRecordHandler](-consumer-record-handler/index.md) = suspend Application.(ConsumerRecord<[KafkaRecordKey](-kafka-record-key/index.md), GenericRecord>) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) | -| [Defaults](-defaults/index.md) | [jvm]
object [Defaults](-defaults/index.md) | -| [FileConfig](-file-config/index.md) | [jvm]
object [FileConfig](-file-config/index.md) | -| [KafkaConfig](-kafka-config/index.md) | [jvm]
class [KafkaConfig](-kafka-config/index.md) : [AbstractKafkaConfig](-abstract-kafka-config/index.md) | -| [KafkaConsumerConfig](-kafka-consumer-config/index.md) | [jvm]
class [KafkaConsumerConfig](-kafka-consumer-config/index.md) | -| [KafkaDsl](-kafka-dsl/index.md) | [jvm]
@[DslMarker](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-dsl-marker/index.md)
annotation class [KafkaDsl](-kafka-dsl/index.md) | -| [KafkaFileConfig](-kafka-file-config/index.md) | [jvm]
class [KafkaFileConfig](-kafka-file-config/index.md)(config: ApplicationConfig) : [AbstractKafkaConfig](-abstract-kafka-config/index.md)
Configuration for the Kafka plugin | -| [KafkaProperties](-kafka-properties/index.md) | [jvm]
typealias [KafkaProperties](-kafka-properties/index.md) = [MutableMap](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.md)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)?> | -| [KafkaPropertiesBuilder](-kafka-properties-builder/index.md) | [jvm]
interface [KafkaPropertiesBuilder](-kafka-properties-builder/index.md)
[KafkaDsl](-kafka-dsl/index.md) Builder for [KafkaProperties](-kafka-properties/index.md) | -| [KafkaRecordKey](-kafka-record-key/index.md) | [jvm]
typealias [KafkaRecordKey](-kafka-record-key/index.md) = [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | -| [MessageTimestampType](-message-timestamp-type/index.md) | [jvm]
enum [MessageTimestampType](-message-timestamp-type/index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.md)<[MessageTimestampType](-message-timestamp-type/index.md)> | -| [Producer](-producer/index.md) | [jvm]
typealias [Producer](-producer/index.md) = KafkaProducer<[KafkaRecordKey](-kafka-record-key/index.md), GenericRecord> | -| [ProducerPropertiesBuilder](-producer-properties-builder/index.md) | [jvm]
class [ProducerPropertiesBuilder](-producer-properties-builder/index.md)(var schemaRegistryUrl: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = null) : [ClientPropertiesBuilder](-client-properties-builder/index.md), SchemaRegistryProvider
see ProducerConfig | -| [SchemaRegistrationBuilder](-schema-registration-builder/index.md) | [jvm]
class [SchemaRegistrationBuilder](-schema-registration-builder/index.md) | -| [TopicBuilder](-topic-builder/index.md) | [jvm]
class [TopicBuilder](-topic-builder/index.md)(name: [TopicName](-topic-name/index.md)) | -| [TopicName](-topic-name/index.md) | [jvm]
@[JvmInline](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-inline/index.md)
value class [TopicName](-topic-name/index.md)(val value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)) | -| [TopicPropertiesBuilder](-topic-properties-builder/index.md) | [jvm]
class [TopicPropertiesBuilder](-topic-properties-builder/index.md) : [KafkaPropertiesBuilder](-kafka-properties-builder/index.md)
See TopicConfig | - +| Name | Summary | +|-----------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [AbstractKafkaConfig](-abstract-kafka-config/index.md) | [jvm]
sealed class [AbstractKafkaConfig](-abstract-kafka-config/index.md) | +| [AdminPropertiesBuilder](-admin-properties-builder/index.md) | [jvm]
class [AdminPropertiesBuilder](-admin-properties-builder/index.md) : [ClientPropertiesBuilder](-client-properties-builder/index.md) | +| [Attributes](-attributes/index.md) | [jvm]
object [Attributes](-attributes/index.md) | +| [ClientPropertiesBuilder](-client-properties-builder/index.md) | [jvm]
sealed class [ClientPropertiesBuilder](-client-properties-builder/index.md) : [KafkaPropertiesBuilder](-kafka-properties-builder/index.md)
see CommonClientConfigs | +| [CommonClientPropertiesBuilder](-common-client-properties-builder/index.md) | [jvm]
data object [CommonClientPropertiesBuilder](-common-client-properties-builder/index.md) : [ClientPropertiesBuilder](-client-properties-builder/index.md)
Concrete implementation of [ClientPropertiesBuilder](-client-properties-builder/index.md) to represent the common properties | +| [CompressionType](-compression-type/index.md) | [jvm]
typealias [CompressionType](-compression-type/index.md) = org.apache.kafka.common.record.CompressionType | +| [Consumer](-consumer/index.md) | [jvm]
typealias [Consumer](-consumer/index.md) = KafkaConsumer<[KafkaRecordKey](-kafka-record-key/index.md), GenericRecord> | +| [ConsumerPropertiesBuilder](-consumer-properties-builder/index.md) | [jvm]
class [ConsumerPropertiesBuilder](-consumer-properties-builder/index.md)(var schemaRegistryUrl: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = null) : [ClientPropertiesBuilder](-client-properties-builder/index.md), SchemaRegistryProvider
see ConsumerConfig | +| [ConsumerRecordHandler](-consumer-record-handler/index.md) | [jvm]
typealias [ConsumerRecordHandler](-consumer-record-handler/index.md) = suspend Application.(ConsumerRecord<[KafkaRecordKey](-kafka-record-key/index.md), GenericRecord>) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) | +| [Defaults](-defaults/index.md) | [jvm]
object [Defaults](-defaults/index.md) | +| [FileConfig](-file-config/index.md) | [jvm]
object [FileConfig](-file-config/index.md) | +| [KafkaConfig](-kafka-config/index.md) | [jvm]
class [KafkaConfig](-kafka-config/index.md) : [AbstractKafkaConfig](-abstract-kafka-config/index.md) | +| [KafkaConsumerConfig](-kafka-consumer-config/index.md) | [jvm]
class [KafkaConsumerConfig](-kafka-consumer-config/index.md) | +| [KafkaDsl](-kafka-dsl/index.md) | [jvm]
@[DslMarker](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-dsl-marker/index.md)
annotation class [KafkaDsl](-kafka-dsl/index.md) | +| [KafkaFileConfig](-kafka-file-config/index.md) | [jvm]
class [KafkaFileConfig](-kafka-file-config/index.md)(config: ApplicationConfig) : [AbstractKafkaConfig](-abstract-kafka-config/index.md)
Configuration for the Kafka plugin | +| [KafkaProperties](-kafka-properties/index.md) | [jvm]
typealias [KafkaProperties](-kafka-properties/index.md) = [MutableMap](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.md)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)?> | +| [KafkaPropertiesBuilder](-kafka-properties-builder/index.md) | [jvm]
interface [KafkaPropertiesBuilder](-kafka-properties-builder/index.md)
[KafkaDsl](-kafka-dsl/index.md) Builder for [KafkaProperties](-kafka-properties/index.md) | +| [KafkaRecordKey](-kafka-record-key/index.md) | [jvm]
typealias [KafkaRecordKey](-kafka-record-key/index.md) = [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | +| [MessageTimestampType](-message-timestamp-type/index.md) | [jvm]
enum [MessageTimestampType](-message-timestamp-type/index.md) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.md)<[MessageTimestampType](-message-timestamp-type/index.md)> | +| [Producer](-producer/index.md) | [jvm]
typealias [Producer](-producer/index.md) = KafkaProducer<[KafkaRecordKey](-kafka-record-key/index.md), GenericRecord> | +| [ProducerPropertiesBuilder](-producer-properties-builder/index.md) | [jvm]
class [ProducerPropertiesBuilder](-producer-properties-builder/index.md)(var schemaRegistryUrl: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = null) : [ClientPropertiesBuilder](-client-properties-builder/index.md), SchemaRegistryProvider
see ProducerConfig | +| [SchemaRegistrationBuilder](-schema-registration-builder/index.md) | [jvm]
class [SchemaRegistrationBuilder](-schema-registration-builder/index.md) | +| [TopicBuilder](-topic-builder/index.md) | [jvm]
class [TopicBuilder](-topic-builder/index.md)(name: [TopicName](-topic-name/index.md)) | +| [TopicName](-topic-name/index.md) | [jvm]
@[JvmInline](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-inline/index.md)
value class [TopicName](-topic-name/index.md)(val value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)) | +| [TopicPropertiesBuilder](-topic-properties-builder/index.md) | [jvm]
class [TopicPropertiesBuilder](-topic-properties-builder/index.md) : [KafkaPropertiesBuilder](-kafka-properties-builder/index.md)
See TopicConfig | ## Properties - -| Name | Summary | -|---|---| -| [Kafka](-kafka.md) | [jvm]
val [Kafka](-kafka.md): ApplicationPlugin<[KafkaConfig](-kafka-config/index.md)>
Plugin for setting up a kafka client | -| [kafkaAdminClient](kafka-admin-client.md) | [jvm]
val Application.[kafkaAdminClient](kafka-admin-client.md): AdminClient?
The kafka admin client created by the [Kafka](-kafka.md) plugin | -| [kafkaConsumer](kafka-consumer.md) | [jvm]
val Application.[kafkaConsumer](kafka-consumer.md): KafkaConsumer<[KafkaRecordKey](-kafka-record-key/index.md), GenericRecord>?
The kafka consumer created by the [Kafka](-kafka.md) plugin | -| [kafkaConsumerJob](kafka-consumer-job.md) | [jvm]
val Application.[kafkaConsumerJob](kafka-consumer-job.md): Job?
The kafka consumer job created by the [Kafka](-kafka.md) plugin | -| [kafkaProducer](kafka-producer.md) | [jvm]
val Application.[kafkaProducer](kafka-producer.md): KafkaProducer<[KafkaRecordKey](-kafka-record-key/index.md), GenericRecord>?
The kafka producer created by the [Kafka](-kafka.md) plugin | +| Name | Summary | +|---------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [Kafka](-kafka.md) | [jvm]
val [Kafka](-kafka.md): ApplicationPlugin<[KafkaConfig](-kafka-config/index.md)>
Plugin for setting up a kafka client | +| [kafkaAdminClient](kafka-admin-client.md) | [jvm]
val Application.[kafkaAdminClient](kafka-admin-client.md): AdminClient?
The kafka admin client created by the [Kafka](-kafka.md) plugin | +| [kafkaConsumer](kafka-consumer.md) | [jvm]
val Application.[kafkaConsumer](kafka-consumer.md): KafkaConsumer<[KafkaRecordKey](-kafka-record-key/index.md), GenericRecord>?
The kafka consumer created by the [Kafka](-kafka.md) plugin | +| [kafkaConsumerJob](kafka-consumer-job.md) | [jvm]
val Application.[kafkaConsumerJob](kafka-consumer-job.md): Job?
The kafka consumer job created by the [Kafka](-kafka.md) plugin | +| [kafkaProducer](kafka-producer.md) | [jvm]
val Application.[kafkaProducer](kafka-producer.md): KafkaProducer<[KafkaRecordKey](-kafka-record-key/index.md), GenericRecord>?
The kafka producer created by the [Kafka](-kafka.md) plugin | | [schemaRegistryClient](schema-registry-client.md) | [jvm]
val Application.[schemaRegistryClient](schema-registry-client.md): [SchemaRegistryClient](../io.github.flaxoos.ktor.server.plugins.kafka.components/-schema-registry-client/index.md)?
The schema registry client created by the [Kafka](-kafka.md) plugin if the schema registry url is set and schemas to register are set | - ## Functions - -| Name | Summary | -|---|---| -| [admin](admin.md) | [jvm]
fun [KafkaConfig](-kafka-config/index.md).[admin](admin.md)(configuration: [AdminPropertiesBuilder](-admin-properties-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { AdminPropertiesBuilder() }) | -| [common](common.md) | [jvm]
fun [KafkaConfig](-kafka-config/index.md).[common](common.md)(configuration: [CommonClientPropertiesBuilder](-common-client-properties-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { CommonClientPropertiesBuilder }) | -| [consumer](consumer.md) | [jvm]
fun [KafkaConfig](-kafka-config/index.md).[consumer](consumer.md)(configuration: [ConsumerPropertiesBuilder](-consumer-properties-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { ConsumerPropertiesBuilder(schemaRegistryUrl) }) | -| [consumerConfig](consumer-config.md) | [jvm]
fun [AbstractKafkaConfig](-abstract-kafka-config/index.md).[consumerConfig](consumer-config.md)(configuration: [KafkaConsumerConfig](-kafka-consumer-config/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { }) | -| [consumerRecordHandler](consumer-record-handler.md) | [jvm]
fun [KafkaConsumerConfig](-kafka-consumer-config/index.md).[consumerRecordHandler](consumer-record-handler.md)(topicName: [TopicName](-topic-name/index.md), handler: [ConsumerRecordHandler](-consumer-record-handler/index.md)) | -| [installKafka](install-kafka.md) | [jvm]
fun Application.[installKafka](install-kafka.md)(config: [KafkaConfig](-kafka-config/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md))
Installs the [Kafka](-kafka.md) plugin with the given [KafkaConfig](-kafka-config/index.md) block | -| [producer](producer.md) | [jvm]
fun [KafkaConfig](-kafka-config/index.md).[producer](producer.md)(configuration: [ProducerPropertiesBuilder](-producer-properties-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { ProducerPropertiesBuilder(schemaRegistryUrl) }) | -| [registerSchemas](register-schemas.md) | [jvm]
fun [AbstractKafkaConfig](-abstract-kafka-config/index.md).[registerSchemas](register-schemas.md)(configuration: [SchemaRegistrationBuilder](-schema-registration-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { SchemaRegistrationBuilder() }) | -| [topic](topic.md) | [jvm]
fun [KafkaConfig](-kafka-config/index.md).[topic](topic.md)(name: [TopicName](-topic-name/index.md), block: [TopicBuilder](-topic-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) | +| Name | Summary | +|-----------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [admin](admin.md) | [jvm]
fun [KafkaConfig](-kafka-config/index.md).[admin](admin.md)(configuration: [AdminPropertiesBuilder](-admin-properties-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { AdminPropertiesBuilder() }) | +| [common](common.md) | [jvm]
fun [KafkaConfig](-kafka-config/index.md).[common](common.md)(configuration: [CommonClientPropertiesBuilder](-common-client-properties-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { CommonClientPropertiesBuilder }) | +| [consumer](consumer.md) | [jvm]
fun [KafkaConfig](-kafka-config/index.md).[consumer](consumer.md)(configuration: [ConsumerPropertiesBuilder](-consumer-properties-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { ConsumerPropertiesBuilder(schemaRegistryUrl) }) | +| [consumerConfig](consumer-config.md) | [jvm]
fun [AbstractKafkaConfig](-abstract-kafka-config/index.md).[consumerConfig](consumer-config.md)(configuration: [KafkaConsumerConfig](-kafka-consumer-config/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { }) | +| [consumerRecordHandler](consumer-record-handler.md) | [jvm]
fun [KafkaConsumerConfig](-kafka-consumer-config/index.md).[consumerRecordHandler](consumer-record-handler.md)(topicName: [TopicName](-topic-name/index.md), handler: [ConsumerRecordHandler](-consumer-record-handler/index.md)) | +| [installKafka](install-kafka.md) | [jvm]
fun Application.[installKafka](install-kafka.md)(config: [KafkaConfig](-kafka-config/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md))
Installs the [Kafka](-kafka.md) plugin with the given [KafkaConfig](-kafka-config/index.md) block | +| [producer](producer.md) | [jvm]
fun [KafkaConfig](-kafka-config/index.md).[producer](producer.md)(configuration: [ProducerPropertiesBuilder](-producer-properties-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { ProducerPropertiesBuilder(schemaRegistryUrl) }) | +| [registerSchemas](register-schemas.md) | [jvm]
fun [AbstractKafkaConfig](-abstract-kafka-config/index.md).[registerSchemas](register-schemas.md)(configuration: [SchemaRegistrationBuilder](-schema-registration-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { SchemaRegistrationBuilder() }) | +| [topic](topic.md) | [jvm]
fun [KafkaConfig](-kafka-config/index.md).[topic](topic.md)(name: [TopicName](-topic-name/index.md), block: [TopicBuilder](-topic-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/install-kafka.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/install-kafka.md index 6aa6aadf..7a2571d1 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/install-kafka.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/install-kafka.md @@ -1,18 +1,14 @@ --- title: installKafka --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](index.md)/[installKafka](install-kafka.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](index.md)/[installKafka](install-kafka.md) # installKafka - - [jvm]\ -fun Application.[installKafka](install-kafka.md)(config: [KafkaConfig](-kafka-config/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) - - +fun Application.[installKafka](install-kafka.md)(config: [KafkaConfig](-kafka-config/index.md).() +-> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) Installs the [Kafka](-kafka.md) plugin with the given [KafkaConfig](-kafka-config/index.md) block diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/kafka-admin-client.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/kafka-admin-client.md index 9b242c2d..29cfb395 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/kafka-admin-client.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/kafka-admin-client.md @@ -1,19 +1,14 @@ --- title: kafkaAdminClient --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](index.md)/[kafkaAdminClient](kafka-admin-client.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](index.md)/[kafkaAdminClient](kafka-admin-client.md) # kafkaAdminClient - - [jvm]\ val Application.[kafkaAdminClient](kafka-admin-client.md): AdminClient? - - The kafka admin client created by the [Kafka](-kafka.md) plugin diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/kafka-consumer-job.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/kafka-consumer-job.md index e7958e7d..0a1a7608 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/kafka-consumer-job.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/kafka-consumer-job.md @@ -1,19 +1,14 @@ --- title: kafkaConsumerJob --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](index.md)/[kafkaConsumerJob](kafka-consumer-job.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](index.md)/[kafkaConsumerJob](kafka-consumer-job.md) # kafkaConsumerJob - - [jvm]\ val Application.[kafkaConsumerJob](kafka-consumer-job.md): Job? - - The kafka consumer job created by the [Kafka](-kafka.md) plugin diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/kafka-consumer.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/kafka-consumer.md index 99fd91e5..c4db59ba 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/kafka-consumer.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/kafka-consumer.md @@ -1,18 +1,14 @@ --- title: kafkaConsumer --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](index.md)/[kafkaConsumer](kafka-consumer.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](index.md)/[kafkaConsumer](kafka-consumer.md) # kafkaConsumer - - [jvm]\ -val Application.[kafkaConsumer](kafka-consumer.md): KafkaConsumer<[KafkaRecordKey](-kafka-record-key/index.md), GenericRecord>? - - +val Application.[kafkaConsumer](kafka-consumer.md): KafkaConsumer<[KafkaRecordKey](-kafka-record-key/index.md), +GenericRecord>? The kafka consumer created by the [Kafka](-kafka.md) plugin diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/kafka-producer.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/kafka-producer.md index b8c2b1db..4a815921 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/kafka-producer.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/kafka-producer.md @@ -1,18 +1,14 @@ --- title: kafkaProducer --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](index.md)/[kafkaProducer](kafka-producer.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](index.md)/[kafkaProducer](kafka-producer.md) # kafkaProducer - - [jvm]\ -val Application.[kafkaProducer](kafka-producer.md): KafkaProducer<[KafkaRecordKey](-kafka-record-key/index.md), GenericRecord>? - - +val Application.[kafkaProducer](kafka-producer.md): KafkaProducer<[KafkaRecordKey](-kafka-record-key/index.md), +GenericRecord>? The kafka producer created by the [Kafka](-kafka.md) plugin diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/producer.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/producer.md index e59bc5cd..d22e6dfb 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/producer.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/producer.md @@ -1,16 +1,16 @@ --- title: producer --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](index.md)/[producer](producer.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](index.md)/[producer](producer.md) # producer - - [jvm]\ -fun [KafkaConfig](-kafka-config/index.md).[producer](producer.md)(configuration: [ProducerPropertiesBuilder](-producer-properties-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { ProducerPropertiesBuilder(schemaRegistryUrl) }) +fun [KafkaConfig](-kafka-config/index.md).[producer](producer.md)( +configuration: [ProducerPropertiesBuilder](-producer-properties-builder/index.md).() +-> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { ProducerPropertiesBuilder( +schemaRegistryUrl) }) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/register-schemas.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/register-schemas.md index e8c2f512..29ecf26c 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/register-schemas.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/register-schemas.md @@ -1,16 +1,15 @@ --- title: registerSchemas --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](index.md)/[registerSchemas](register-schemas.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](index.md)/[registerSchemas](register-schemas.md) # registerSchemas - - [jvm]\ -fun [AbstractKafkaConfig](-abstract-kafka-config/index.md).[registerSchemas](register-schemas.md)(configuration: [SchemaRegistrationBuilder](-schema-registration-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { SchemaRegistrationBuilder() }) +fun [AbstractKafkaConfig](-abstract-kafka-config/index.md).[registerSchemas](register-schemas.md)( +configuration: [SchemaRegistrationBuilder](-schema-registration-builder/index.md).() +-> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) = { SchemaRegistrationBuilder() }) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/schema-registry-client.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/schema-registry-client.md index 8a215d45..1f3d8129 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/schema-registry-client.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/schema-registry-client.md @@ -1,20 +1,17 @@ --- title: schemaRegistryClient --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](index.md)/[schemaRegistryClient](schema-registry-client.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](index.md)/[schemaRegistryClient](schema-registry-client.md) # schemaRegistryClient - - [jvm]\ -val Application.[schemaRegistryClient](schema-registry-client.md): [SchemaRegistryClient](../io.github.flaxoos.ktor.server.plugins.kafka.components/-schema-registry-client/index.md)? - - +val +Application.[schemaRegistryClient](schema-registry-client.md): [SchemaRegistryClient](../io.github.flaxoos.ktor.server.plugins.kafka.components/-schema-registry-client/index.md)? -The schema registry client created by the [Kafka](-kafka.md) plugin if the schema registry url is set and schemas to register are set +The schema registry client created by the [Kafka](-kafka.md) plugin if the schema registry url is set and schemas to +register are set diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/topic.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/topic.md index 33de5257..cd39fb41 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/topic.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/topic.md @@ -1,16 +1,15 @@ --- title: topic --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](index.md)/[topic](topic.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.kafka](index.md)/[topic](topic.md) # topic - - [jvm]\ -fun [KafkaConfig](-kafka-config/index.md).[topic](topic.md)(name: [TopicName](-topic-name/index.md), block: [TopicBuilder](-topic-builder/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) +fun [KafkaConfig](-kafka-config/index.md).[topic](topic.md)(name: [TopicName](-topic-name/index.md), +block: [TopicBuilder](-topic-builder/index.md).() +-> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-bucket/capacity.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-bucket/capacity.md index 186db583..c546afa8 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-bucket/capacity.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-bucket/capacity.md @@ -1,19 +1,14 @@ --- title: capacity --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[Bucket](index.md)/[capacity](capacity.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[Bucket](index.md)/[capacity](capacity.md) # capacity - - [common]\ override val [capacity](capacity.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) - - The maximum capacity, as measured in CallVolumeUnit.Calls or CallVolumeUnit.Bytes diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-bucket/clock.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-bucket/clock.md index 183ec7a3..3ada9223 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-bucket/clock.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-bucket/clock.md @@ -1,19 +1,14 @@ --- title: clock --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[Bucket](index.md)/[clock](clock.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[Bucket](index.md)/[clock](clock.md) # clock - - [common]\ override val [clock](clock.md): () -> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) - - A time provider in milliseconds diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-bucket/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-bucket/index.md index 6105d7e7..0598cfd2 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-bucket/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-bucket/index.md @@ -1,39 +1,34 @@ --- title: Bucket --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[Bucket](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[Bucket](index.md) # Bucket -sealed class [Bucket](index.md) : [RateLimiter](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/index.md) +sealed +class [Bucket](index.md) : [RateLimiter](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/index.md) #### Inheritors - -| | -|---| +| | +|------------------------------------------| | [LeakyBucket](../-leaky-bucket/index.md) | | [TokenBucket](../-token-bucket/index.md) | - ## Properties - -| Name | Summary | -|---|---| +| Name | Summary | +|-------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [callVolumeUnit](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/call-volume-unit.md) | [common]
abstract val [callVolumeUnit](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/call-volume-unit.md): [CallVolumeUnit](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/index.md)
In what unit are calls measured | -| [capacity](capacity.md) | [common]
override val [capacity](capacity.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)
The maximum capacity, as measured in CallVolumeUnit.Calls or CallVolumeUnit.Bytes | -| [clock](clock.md) | [common]
override val [clock](clock.md): () -> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)
A time provider in milliseconds | -| [rate](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/rate.md) | [common]
abstract val [rate](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/rate.md): [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md)
Desired change over time | - +| [capacity](capacity.md) | [common]
override val [capacity](capacity.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)
The maximum capacity, as measured in CallVolumeUnit.Calls or CallVolumeUnit.Bytes | +| [clock](clock.md) | [common]
override val [clock](clock.md): () -> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)
A time provider in milliseconds | +| [rate](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/rate.md) | [common]
abstract val [rate](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/rate.md): [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md)
Desired change over time | ## Functions - -| Name | Summary | -|---|---| -| [id](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/id.md) | [common]
fun ApplicationCall.[id](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/id.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | +| Name | Summary | +|--------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [id](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/id.md) | [common]
fun ApplicationCall.[id](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/id.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | | [tryAccept](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/try-accept.md) | [common]
abstract suspend fun [tryAccept](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/try-accept.md)(call: ApplicationCall): [RateLimiterResponse](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/index.md)
Try to accept a call | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-concurrent-fixed-size-weighted-queue/-concurrent-fixed-size-weighted-queue.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-concurrent-fixed-size-weighted-queue/-concurrent-fixed-size-weighted-queue.md index 5359c2a4..61269278 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-concurrent-fixed-size-weighted-queue/-concurrent-fixed-size-weighted-queue.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-concurrent-fixed-size-weighted-queue/-concurrent-fixed-size-weighted-queue.md @@ -1,14 +1,11 @@ --- title: ConcurrentFixedSizeWeightedQueue --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[ConcurrentFixedSizeWeightedQueue](index.md)/[ConcurrentFixedSizeWeightedQueue](-concurrent-fixed-size-weighted-queue.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[ConcurrentFixedSizeWeightedQueue](index.md)/[ConcurrentFixedSizeWeightedQueue](-concurrent-fixed-size-weighted-queue.md) # ConcurrentFixedSizeWeightedQueue - - [common]\ constructor(maxWeight: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-concurrent-fixed-size-weighted-queue/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-concurrent-fixed-size-weighted-queue/index.md index 128ce8f6..7bd88d31 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-concurrent-fixed-size-weighted-queue/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-concurrent-fixed-size-weighted-queue/index.md @@ -1,36 +1,29 @@ --- title: ConcurrentFixedSizeWeightedQueue --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[ConcurrentFixedSizeWeightedQueue](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[ConcurrentFixedSizeWeightedQueue](index.md) # ConcurrentFixedSizeWeightedQueue - - [common]\ -class [ConcurrentFixedSizeWeightedQueue](index.md)<[T](index.md)>(maxWeight: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)) +class [ConcurrentFixedSizeWeightedQueue](index.md)<[T](index.md)>( +maxWeight: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)) A fixed size queue of weighted entries with safe access - - ## Constructors - -| | | -|---|---| +| | | +|------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------| | [ConcurrentFixedSizeWeightedQueue](-concurrent-fixed-size-weighted-queue.md) | [common]
constructor(maxWeight: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)) | - ## Functions - -| Name | Summary | -|---|---| -| [peekNext](peek-next.md) | [common]
fun [peekNext](peek-next.md)(): [Pair](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.md)<[T](index.md), [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.md)>? | -| [toString](to-string.md) | [common]
open override fun [toString](to-string.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | +| Name | Summary | +|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [peekNext](peek-next.md) | [common]
fun [peekNext](peek-next.md)(): [Pair](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.md)<[T](index.md), [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.md)>? | +| [toString](to-string.md) | [common]
open override fun [toString](to-string.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | | [trimWhere](trim-where.md) | [common]
fun [trimWhere](trim-where.md)(comparison: ([T](index.md)) -> [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [MutableList](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.md)<[Pair](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.md)<[T](index.md), [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.md)>>? | -| [tryAdd](try-add.md) | [common]
fun [tryAdd](try-add.md)(t: [T](index.md), weight: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.md) = 1.0): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md) | +| [tryAdd](try-add.md) | [common]
fun [tryAdd](try-add.md)(t: [T](index.md), weight: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.md) = 1.0): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-concurrent-fixed-size-weighted-queue/peek-next.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-concurrent-fixed-size-weighted-queue/peek-next.md index 9da8844c..d251b487 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-concurrent-fixed-size-weighted-queue/peek-next.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-concurrent-fixed-size-weighted-queue/peek-next.md @@ -1,16 +1,14 @@ --- title: peekNext --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[ConcurrentFixedSizeWeightedQueue](index.md)/[peekNext](peek-next.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[ConcurrentFixedSizeWeightedQueue](index.md)/[peekNext](peek-next.md) # peekNext - - [common]\ -fun [peekNext](peek-next.md)(): [Pair](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.md)<[T](index.md), [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.md)>? +fun [peekNext](peek-next.md)(): [Pair](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.md) +<[T](index.md), [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.md)>? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-concurrent-fixed-size-weighted-queue/to-string.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-concurrent-fixed-size-weighted-queue/to-string.md index 112db019..a7bc7a41 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-concurrent-fixed-size-weighted-queue/to-string.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-concurrent-fixed-size-weighted-queue/to-string.md @@ -1,16 +1,14 @@ --- title: toString --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[ConcurrentFixedSizeWeightedQueue](index.md)/[toString](to-string.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[ConcurrentFixedSizeWeightedQueue](index.md)/[toString](to-string.md) # toString - - [common]\ -open override fun [toString](to-string.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) +open override +fun [toString](to-string.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-concurrent-fixed-size-weighted-queue/trim-where.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-concurrent-fixed-size-weighted-queue/trim-where.md index 579453ac..403399c3 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-concurrent-fixed-size-weighted-queue/trim-where.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-concurrent-fixed-size-weighted-queue/trim-where.md @@ -1,16 +1,16 @@ --- title: trimWhere --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[ConcurrentFixedSizeWeightedQueue](index.md)/[trimWhere](trim-where.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[ConcurrentFixedSizeWeightedQueue](index.md)/[trimWhere](trim-where.md) # trimWhere - - [common]\ -fun [trimWhere](trim-where.md)(comparison: ([T](index.md)) -> [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [MutableList](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.md)<[Pair](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.md)<[T](index.md), [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.md)>>? +fun [trimWhere](trim-where.md)(comparison: ([T](index.md)) +-> [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [MutableList](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-list/index.md) +<[Pair](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.md) +<[T](index.md), [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.md)>>? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-concurrent-fixed-size-weighted-queue/try-add.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-concurrent-fixed-size-weighted-queue/try-add.md index e4ae95e9..33f58b85 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-concurrent-fixed-size-weighted-queue/try-add.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-concurrent-fixed-size-weighted-queue/try-add.md @@ -1,16 +1,15 @@ --- title: tryAdd --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[ConcurrentFixedSizeWeightedQueue](index.md)/[tryAdd](try-add.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[ConcurrentFixedSizeWeightedQueue](index.md)/[tryAdd](try-add.md) # tryAdd - - [common]\ -fun [tryAdd](try-add.md)(t: [T](index.md), weight: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.md) = 1.0): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md) +fun [tryAdd](try-add.md)(t: [T](index.md), +weight: [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.md) = +1.0): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-leaky-bucket/-leaky-bucket.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-leaky-bucket/-leaky-bucket.md index e5a03e61..e5356ed8 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-leaky-bucket/-leaky-bucket.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-leaky-bucket/-leaky-bucket.md @@ -1,16 +1,17 @@ --- title: LeakyBucket --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[LeakyBucket](index.md)/[LeakyBucket](-leaky-bucket.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[LeakyBucket](index.md)/[LeakyBucket](-leaky-bucket.md) # LeakyBucket - - [common]\ -constructor(log: KLogger = logger, rate: [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md), capacity: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), clock: () -> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = { Clock.System.now().toEpochMilliseconds() }) +constructor(log: KLogger = logger, +rate: [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md), +capacity: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), clock: () +-> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = { Clock.System.now() +.toEpochMilliseconds() }) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-leaky-bucket/call-volume-unit.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-leaky-bucket/call-volume-unit.md index 45ab4422..e8037828 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-leaky-bucket/call-volume-unit.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-leaky-bucket/call-volume-unit.md @@ -1,18 +1,14 @@ --- title: callVolumeUnit --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[LeakyBucket](index.md)/[callVolumeUnit](call-volume-unit.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[LeakyBucket](index.md)/[callVolumeUnit](call-volume-unit.md) # callVolumeUnit - - [common]\ -open override val [callVolumeUnit](call-volume-unit.md): [CallVolumeUnit](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/index.md) - - +open override +val [callVolumeUnit](call-volume-unit.md): [CallVolumeUnit](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/index.md) In what unit are calls measured diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-leaky-bucket/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-leaky-bucket/index.md index 1390622c..a32010bc 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-leaky-bucket/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-leaky-bucket/index.md @@ -1,53 +1,46 @@ --- title: LeakyBucket --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[LeakyBucket](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[LeakyBucket](index.md) # LeakyBucket - - [common]\ -class [LeakyBucket](index.md)(log: KLogger = logger, val rate: [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md), val capacity: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), val clock: () -> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = { Clock.System.now().toEpochMilliseconds() }) : [Bucket](../-bucket/index.md) +class [LeakyBucket](index.md)(log: KLogger = logger, val +rate: [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md), val +capacity: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), val clock: () +-> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = { Clock.System.now() +.toEpochMilliseconds() }) : [Bucket](../-bucket/index.md) Leaky Bucket, allows for constant rate of delivery, Fair distribution between clients, but not ideal for handling bursts - - -The configured [rate](rate.md) will be the rate in which requests will leak from the bucket, when not empty. This means the call will be suspended until it leaks out of the bucket, at which point the [tryAccept](try-accept.md) function would return. No timeout is set, so the call can be suspended indefinitely in theory, and it is up to the server or client to implement a timeout. - - +The configured [rate](rate.md) will be the rate in which requests will leak from the bucket, when not empty. This means +the call will be suspended until it leaks out of the bucket, at which point the [tryAccept](try-accept.md) function +would return. No timeout is set, so the call can be suspended indefinitely in theory, and it is up to the server or +client to implement a timeout. CallVolumeUnit is always Calls with weighting of 1.0. - - ## Constructors - -| | | -|---|---| +| | | +|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [LeakyBucket](-leaky-bucket.md) | [common]
constructor(log: KLogger = logger, rate: [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md), capacity: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), clock: () -> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = { Clock.System.now().toEpochMilliseconds() }) | - ## Properties - -| Name | Summary | -|---|---| -| [callVolumeUnit](call-volume-unit.md) | [common]
open override val [callVolumeUnit](call-volume-unit.md): [CallVolumeUnit](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/index.md)
In what unit are calls measured | -| [capacity](../-bucket/capacity.md) | [common]
override val [capacity](../-bucket/capacity.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)
The maximum capacity, as measured in CallVolumeUnit.Calls or CallVolumeUnit.Bytes | -| [clock](../-bucket/clock.md) | [common]
override val [clock](../-bucket/clock.md): () -> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)
A time provider in milliseconds | -| [rate](rate.md) | [common]
open override val [rate](rate.md): [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md)
Desired change over time | - +| Name | Summary | +|---------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [callVolumeUnit](call-volume-unit.md) | [common]
open override val [callVolumeUnit](call-volume-unit.md): [CallVolumeUnit](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/index.md)
In what unit are calls measured | +| [capacity](../-bucket/capacity.md) | [common]
override val [capacity](../-bucket/capacity.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)
The maximum capacity, as measured in CallVolumeUnit.Calls or CallVolumeUnit.Bytes | +| [clock](../-bucket/clock.md) | [common]
override val [clock](../-bucket/clock.md): () -> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)
A time provider in milliseconds | +| [rate](rate.md) | [common]
open override val [rate](rate.md): [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md)
Desired change over time | ## Functions - -| Name | Summary | -|---|---| -| [id](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/id.md) | [common]
fun ApplicationCall.[id](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/id.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | -| [tryAccept](try-accept.md) | [common]
open suspend override fun [tryAccept](try-accept.md)(call: ApplicationCall): [RateLimiterResponse](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/index.md)
Try to accept a call | +| Name | Summary | +|-----------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [id](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/id.md) | [common]
fun ApplicationCall.[id](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/id.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | +| [tryAccept](try-accept.md) | [common]
open suspend override fun [tryAccept](try-accept.md)(call: ApplicationCall): [RateLimiterResponse](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/index.md)
Try to accept a call | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-leaky-bucket/rate.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-leaky-bucket/rate.md index 20ba5cfd..7161c496 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-leaky-bucket/rate.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-leaky-bucket/rate.md @@ -1,18 +1,14 @@ --- title: rate --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[LeakyBucket](index.md)/[rate](rate.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[LeakyBucket](index.md)/[rate](rate.md) # rate - - [common]\ -open override val [rate](rate.md): [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md) - - +open override +val [rate](rate.md): [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md) Desired change over time diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-leaky-bucket/try-accept.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-leaky-bucket/try-accept.md index c843f64e..94acfa53 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-leaky-bucket/try-accept.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-leaky-bucket/try-accept.md @@ -1,38 +1,27 @@ --- title: tryAccept --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[LeakyBucket](index.md)/[tryAccept](try-accept.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[LeakyBucket](index.md)/[tryAccept](try-accept.md) # tryAccept - - [common]\ -open suspend override fun [tryAccept](try-accept.md)(call: ApplicationCall): [RateLimiterResponse](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/index.md) - - +open suspend override fun [tryAccept](try-accept.md)(call: +ApplicationCall): [RateLimiterResponse](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/index.md) Try to accept a call - - #### Return - - response detailing if the call was accepted and details in the case of rejection - - #### Parameters - common -| | | -|---|---| +| | | +|------|--------------------| | call | the call to accept | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-sliding-window/-sliding-window.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-sliding-window/-sliding-window.md index 64208e7a..333a38bc 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-sliding-window/-sliding-window.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-sliding-window/-sliding-window.md @@ -1,16 +1,17 @@ --- title: SlidingWindow --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[SlidingWindow](index.md)/[SlidingWindow](-sliding-window.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[SlidingWindow](index.md)/[SlidingWindow](-sliding-window.md) # SlidingWindow - - [common]\ -constructor(rate: [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md), capacity: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), callVolumeUnit: [CallVolumeUnit](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/index.md), clock: () -> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = { now().toEpochMilliseconds() }) +constructor(rate: [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md), +capacity: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), +callVolumeUnit: [CallVolumeUnit](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/index.md), +clock: () -> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = { now() +.toEpochMilliseconds() }) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-sliding-window/call-volume-unit.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-sliding-window/call-volume-unit.md index 05150fca..80de9007 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-sliding-window/call-volume-unit.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-sliding-window/call-volume-unit.md @@ -1,18 +1,14 @@ --- title: callVolumeUnit --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[SlidingWindow](index.md)/[callVolumeUnit](call-volume-unit.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[SlidingWindow](index.md)/[callVolumeUnit](call-volume-unit.md) # callVolumeUnit - - [common]\ -open override val [callVolumeUnit](call-volume-unit.md): [CallVolumeUnit](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/index.md) - - +open override +val [callVolumeUnit](call-volume-unit.md): [CallVolumeUnit](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/index.md) In what unit are calls measured diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-sliding-window/capacity.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-sliding-window/capacity.md index 8b80210e..52d0a6a6 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-sliding-window/capacity.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-sliding-window/capacity.md @@ -1,20 +1,17 @@ --- title: capacity --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[SlidingWindow](index.md)/[capacity](capacity.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[SlidingWindow](index.md)/[capacity](capacity.md) # capacity - - [common]\ open override val [capacity](capacity.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) - - -The maximum capacity, as measured in [CallVolumeUnit.Calls](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-calls/index.md) or [CallVolumeUnit.Bytes](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-bytes/index.md) +The maximum capacity, as measured +in [CallVolumeUnit.Calls](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-calls/index.md) +or [CallVolumeUnit.Bytes](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-bytes/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-sliding-window/clock.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-sliding-window/clock.md index cfb73e51..b00b62e3 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-sliding-window/clock.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-sliding-window/clock.md @@ -1,19 +1,14 @@ --- title: clock --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[SlidingWindow](index.md)/[clock](clock.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[SlidingWindow](index.md)/[clock](clock.md) # clock - - [common]\ open override val [clock](clock.md): () -> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) - - A time provider diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-sliding-window/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-sliding-window/index.md index cdcd3e74..f55da92f 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-sliding-window/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-sliding-window/index.md @@ -1,49 +1,43 @@ --- title: SlidingWindow --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[SlidingWindow](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[SlidingWindow](index.md) # SlidingWindow - - [common]\ -data class [SlidingWindow](index.md)(val rate: [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md), val capacity: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), val callVolumeUnit: [CallVolumeUnit](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/index.md), val clock: () -> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = { now().toEpochMilliseconds() }) : [RateLimiter](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/index.md) +data class [SlidingWindow](index.md)(val +rate: [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md), val +capacity: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), val +callVolumeUnit: [CallVolumeUnit](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/index.md), +val clock: () -> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = { now() +.toEpochMilliseconds() }) : [RateLimiter](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/index.md) Sliding window, allows a given weight of calls to be made over a given duration. - - -The configured [rate](rate.md) will be the time window over which the calls will be counted. The call weight is defined by the [callVolumeUnit](call-volume-unit.md) - - +The configured [rate](rate.md) will be the time window over which the calls will be counted. The call weight is defined +by the [callVolumeUnit](call-volume-unit.md) ## Constructors - -| | | -|---|---| +| | | +|-------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [SlidingWindow](-sliding-window.md) | [common]
constructor(rate: [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md), capacity: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), callVolumeUnit: [CallVolumeUnit](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/index.md), clock: () -> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = { now().toEpochMilliseconds() }) | - ## Properties - -| Name | Summary | -|---|---| -| [callVolumeUnit](call-volume-unit.md) | [common]
open override val [callVolumeUnit](call-volume-unit.md): [CallVolumeUnit](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/index.md)
In what unit are calls measured | -| [capacity](capacity.md) | [common]
open override val [capacity](capacity.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)
The maximum capacity, as measured in [CallVolumeUnit.Calls](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-calls/index.md) or [CallVolumeUnit.Bytes](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-bytes/index.md) | -| [clock](clock.md) | [common]
open override val [clock](clock.md): () -> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)
A time provider | -| [rate](rate.md) | [common]
open override val [rate](rate.md): [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md)
Desired change over time | - +| Name | Summary | +|---------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [callVolumeUnit](call-volume-unit.md) | [common]
open override val [callVolumeUnit](call-volume-unit.md): [CallVolumeUnit](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/index.md)
In what unit are calls measured | +| [capacity](capacity.md) | [common]
open override val [capacity](capacity.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)
The maximum capacity, as measured in [CallVolumeUnit.Calls](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-calls/index.md) or [CallVolumeUnit.Bytes](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-bytes/index.md) | +| [clock](clock.md) | [common]
open override val [clock](clock.md): () -> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)
A time provider | +| [rate](rate.md) | [common]
open override val [rate](rate.md): [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md)
Desired change over time | ## Functions - -| Name | Summary | -|---|---| -| [id](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/id.md) | [common]
fun ApplicationCall.[id](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/id.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | -| [tryAccept](try-accept.md) | [common]
open suspend override fun [tryAccept](try-accept.md)(call: ApplicationCall): [RateLimiterResponse](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/index.md)
Try to accept a call | +| Name | Summary | +|-----------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [id](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/id.md) | [common]
fun ApplicationCall.[id](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/id.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | +| [tryAccept](try-accept.md) | [common]
open suspend override fun [tryAccept](try-accept.md)(call: ApplicationCall): [RateLimiterResponse](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/index.md)
Try to accept a call | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-sliding-window/rate.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-sliding-window/rate.md index 0dd220c7..e223957c 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-sliding-window/rate.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-sliding-window/rate.md @@ -1,18 +1,14 @@ --- title: rate --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[SlidingWindow](index.md)/[rate](rate.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[SlidingWindow](index.md)/[rate](rate.md) # rate - - [common]\ -open override val [rate](rate.md): [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md) - - +open override +val [rate](rate.md): [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md) Desired change over time diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-sliding-window/try-accept.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-sliding-window/try-accept.md index 204c46a6..7d239749 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-sliding-window/try-accept.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-sliding-window/try-accept.md @@ -1,38 +1,27 @@ --- title: tryAccept --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[SlidingWindow](index.md)/[tryAccept](try-accept.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[SlidingWindow](index.md)/[tryAccept](try-accept.md) # tryAccept - - [common]\ -open suspend override fun [tryAccept](try-accept.md)(call: ApplicationCall): [RateLimiterResponse](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/index.md) - - +open suspend override fun [tryAccept](try-accept.md)(call: +ApplicationCall): [RateLimiterResponse](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/index.md) Try to accept a call - - #### Return - - response detailing if the call was accepted and details in the case of rejection - - #### Parameters - common -| | | -|---|---| +| | | +|------|--------------------| | call | the call to accept | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-token-bucket/-token-bucket.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-token-bucket/-token-bucket.md index 94234206..999bc3b5 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-token-bucket/-token-bucket.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-token-bucket/-token-bucket.md @@ -1,16 +1,18 @@ --- title: TokenBucket --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[TokenBucket](index.md)/[TokenBucket](-token-bucket.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[TokenBucket](index.md)/[TokenBucket](-token-bucket.md) # TokenBucket - - [common]\ -constructor(log: KLogger = logger, rate: [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md), callVolumeUnit: [CallVolumeUnit](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/index.md) = CallVolumeUnit.Calls(), capacity: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), clock: () -> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = { Clock.System.now().toEpochMilliseconds() }) +constructor(log: KLogger = logger, +rate: [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md), +callVolumeUnit: [CallVolumeUnit](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/index.md) = +CallVolumeUnit.Calls(), capacity: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), clock: () +-> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = { Clock.System.now() +.toEpochMilliseconds() }) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-token-bucket/call-volume-unit.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-token-bucket/call-volume-unit.md index ba4c1391..7bd36db2 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-token-bucket/call-volume-unit.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-token-bucket/call-volume-unit.md @@ -1,20 +1,20 @@ --- title: callVolumeUnit --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[TokenBucket](index.md)/[callVolumeUnit](call-volume-unit.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[TokenBucket](index.md)/[callVolumeUnit](call-volume-unit.md) # callVolumeUnit - - [common]\ -open override val [callVolumeUnit](call-volume-unit.md): [CallVolumeUnit](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/index.md) - - - -The token to be added at every refill, can be [CallVolumeUnit.Calls](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-calls/index.md) with optional call weight factor, or [CallVolumeUnit.Bytes](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-bytes/index.md), specifying how many bytes to add at every refill +open override +val [callVolumeUnit](call-volume-unit.md): [CallVolumeUnit](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/index.md) + +The token to be added at every refill, can +be [CallVolumeUnit.Calls](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-calls/index.md) +with optional call weight factor, +or [CallVolumeUnit.Bytes](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-bytes/index.md), +specifying how many bytes to add at every refill diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-token-bucket/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-token-bucket/index.md index d018f9c8..b5e61825 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-token-bucket/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-token-bucket/index.md @@ -1,53 +1,49 @@ --- title: TokenBucket --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[TokenBucket](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[TokenBucket](index.md) # TokenBucket - - [common]\ -class [TokenBucket](index.md)(log: KLogger = logger, val rate: [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md), val callVolumeUnit: [CallVolumeUnit](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/index.md) = CallVolumeUnit.Calls(), val capacity: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), val clock: () -> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = { Clock.System.now().toEpochMilliseconds() }) : [Bucket](../-bucket/index.md) - -Token Bucket, allows varying rate of delivery, Better for handling bursts, but can be exploited by malicious clients to consume all the capacity at once. - +class [TokenBucket](index.md)(log: KLogger = logger, val +rate: [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md), val +callVolumeUnit: [CallVolumeUnit](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/index.md) = +CallVolumeUnit.Calls(), val capacity: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), val +clock: () -> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = { Clock.System.now() +.toEpochMilliseconds() }) : [Bucket](../-bucket/index.md) +Token Bucket, allows varying rate of delivery, Better for handling bursts, but can be exploited by malicious clients to +consume all the capacity at once. The configured Bucket.rate will be the rate at which tokens will be added to the bucket, until full. - - -CallVolumeUnit can be [CallVolumeUnit.Calls](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-calls/index.md) with optional call weight factor, or [CallVolumeUnit.Bytes](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-bytes/index.md), specifying how many bytes to add at every refill - - +CallVolumeUnit can +be [CallVolumeUnit.Calls](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-calls/index.md) +with optional call weight factor, +or [CallVolumeUnit.Bytes](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-bytes/index.md), +specifying how many bytes to add at every refill ## Constructors - -| | | -|---|---| +| | | +|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [TokenBucket](-token-bucket.md) | [common]
constructor(log: KLogger = logger, rate: [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md), callVolumeUnit: [CallVolumeUnit](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/index.md) = CallVolumeUnit.Calls(), capacity: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), clock: () -> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = { Clock.System.now().toEpochMilliseconds() }) | - ## Properties - -| Name | Summary | -|---|---| +| Name | Summary | +|---------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [callVolumeUnit](call-volume-unit.md) | [common]
open override val [callVolumeUnit](call-volume-unit.md): [CallVolumeUnit](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/index.md)
The token to be added at every refill, can be [CallVolumeUnit.Calls](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-calls/index.md) with optional call weight factor, or [CallVolumeUnit.Bytes](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-bytes/index.md), specifying how many bytes to add at every refill | -| [capacity](../-bucket/capacity.md) | [common]
override val [capacity](../-bucket/capacity.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)
The maximum capacity, as measured in CallVolumeUnit.Calls or CallVolumeUnit.Bytes | -| [clock](../-bucket/clock.md) | [common]
override val [clock](../-bucket/clock.md): () -> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)
A time provider in milliseconds | -| [rate](rate.md) | [common]
open override val [rate](rate.md): [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md)
At what rate should token be added to the bucket | - +| [capacity](../-bucket/capacity.md) | [common]
override val [capacity](../-bucket/capacity.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)
The maximum capacity, as measured in CallVolumeUnit.Calls or CallVolumeUnit.Bytes | +| [clock](../-bucket/clock.md) | [common]
override val [clock](../-bucket/clock.md): () -> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)
A time provider in milliseconds | +| [rate](rate.md) | [common]
open override val [rate](rate.md): [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md)
At what rate should token be added to the bucket | ## Functions - -| Name | Summary | -|---|---| -| [id](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/id.md) | [common]
fun ApplicationCall.[id](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/id.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | -| [tryAccept](try-accept.md) | [common]
open suspend override fun [tryAccept](try-accept.md)(call: ApplicationCall): [RateLimiterResponse](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/index.md)
Try to accept a call | +| Name | Summary | +|-----------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [id](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/id.md) | [common]
fun ApplicationCall.[id](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/id.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | +| [tryAccept](try-accept.md) | [common]
open suspend override fun [tryAccept](try-accept.md)(call: ApplicationCall): [RateLimiterResponse](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/index.md)
Try to accept a call | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-token-bucket/rate.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-token-bucket/rate.md index ae49a6a0..4bc2eff3 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-token-bucket/rate.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-token-bucket/rate.md @@ -1,18 +1,14 @@ --- title: rate --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[TokenBucket](index.md)/[rate](rate.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[TokenBucket](index.md)/[rate](rate.md) # rate - - [common]\ -open override val [rate](rate.md): [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md) - - +open override +val [rate](rate.md): [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md) At what rate should token be added to the bucket diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-token-bucket/try-accept.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-token-bucket/try-accept.md index 8f76b0ca..9ce6d4c1 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-token-bucket/try-accept.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-token-bucket/try-accept.md @@ -1,38 +1,27 @@ --- title: tryAccept --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[TokenBucket](index.md)/[tryAccept](try-accept.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](../index.md)/[TokenBucket](index.md)/[tryAccept](try-accept.md) # tryAccept - - [common]\ -open suspend override fun [tryAccept](try-accept.md)(call: ApplicationCall): [RateLimiterResponse](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/index.md) - - +open suspend override fun [tryAccept](try-accept.md)(call: +ApplicationCall): [RateLimiterResponse](../../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/index.md) Try to accept a call - - #### Return - - response detailing if the call was accepted and details in the case of rejection - - #### Parameters - common -| | | -|---|---| +| | | +|------|--------------------| | call | the call to accept | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/index.md index e020769a..de3158ae 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/index.md @@ -1,22 +1,18 @@ --- title: io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](index.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](index.md) # Package-level declarations - - ## Types - -| Name | Summary | -|---|---| -| [Bucket](-bucket/index.md) | [common]
sealed class [Bucket](-bucket/index.md) : [RateLimiter](../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/index.md) | -| [ConcurrentFixedSizeWeightedQueue](-concurrent-fixed-size-weighted-queue/index.md) | [common]
class [ConcurrentFixedSizeWeightedQueue](-concurrent-fixed-size-weighted-queue/index.md)<[T](-concurrent-fixed-size-weighted-queue/index.md)>(maxWeight: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md))
A fixed size queue of weighted entries with safe access | -| [LeakyBucket](-leaky-bucket/index.md) | [common]
class [LeakyBucket](-leaky-bucket/index.md)(log: KLogger = logger, val rate: [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md), val capacity: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), val clock: () -> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = { Clock.System.now().toEpochMilliseconds() }) : [Bucket](-bucket/index.md)
Leaky Bucket, allows for constant rate of delivery, Fair distribution between clients, but not ideal for handling bursts | -| [SlidingWindow](-sliding-window/index.md) | [common]
data class [SlidingWindow](-sliding-window/index.md)(val rate: [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md), val capacity: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), val callVolumeUnit: [CallVolumeUnit](../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/index.md), val clock: () -> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = { now().toEpochMilliseconds() }) : [RateLimiter](../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/index.md)
Sliding window, allows a given weight of calls to be made over a given duration. | -| [TokenBucket](-token-bucket/index.md) | [common]
class [TokenBucket](-token-bucket/index.md)(log: KLogger = logger, val rate: [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md), val callVolumeUnit: [CallVolumeUnit](../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/index.md) = CallVolumeUnit.Calls(), val capacity: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), val clock: () -> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = { Clock.System.now().toEpochMilliseconds() }) : [Bucket](-bucket/index.md)
Token Bucket, allows varying rate of delivery, Better for handling bursts, but can be exploited by malicious clients to consume all the capacity at once. | +| Name | Summary | +|------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [Bucket](-bucket/index.md) | [common]
sealed class [Bucket](-bucket/index.md) : [RateLimiter](../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/index.md) | +| [ConcurrentFixedSizeWeightedQueue](-concurrent-fixed-size-weighted-queue/index.md) | [common]
class [ConcurrentFixedSizeWeightedQueue](-concurrent-fixed-size-weighted-queue/index.md)<[T](-concurrent-fixed-size-weighted-queue/index.md)>(maxWeight: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md))
A fixed size queue of weighted entries with safe access | +| [LeakyBucket](-leaky-bucket/index.md) | [common]
class [LeakyBucket](-leaky-bucket/index.md)(log: KLogger = logger, val rate: [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md), val capacity: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), val clock: () -> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = { Clock.System.now().toEpochMilliseconds() }) : [Bucket](-bucket/index.md)
Leaky Bucket, allows for constant rate of delivery, Fair distribution between clients, but not ideal for handling bursts | +| [SlidingWindow](-sliding-window/index.md) | [common]
data class [SlidingWindow](-sliding-window/index.md)(val rate: [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md), val capacity: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), val callVolumeUnit: [CallVolumeUnit](../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/index.md), val clock: () -> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = { now().toEpochMilliseconds() }) : [RateLimiter](../io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/index.md)
Sliding window, allows a given weight of calls to be made over a given duration. | +| [TokenBucket](-token-bucket/index.md) | [common]
class [TokenBucket](-token-bucket/index.md)(log: KLogger = logger, val rate: [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md), val callVolumeUnit: [CallVolumeUnit](../io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/index.md) = CallVolumeUnit.Calls(), val capacity: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), val clock: () -> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = { Clock.System.now().toEpochMilliseconds() }) : [Bucket](-bucket/index.md)
Token Bucket, allows varying rate of delivery, Better for handling bursts, but can be exploited by malicious clients to consume all the capacity at once. | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-bytes/-bytes.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-bytes/-bytes.md index 40ea2fb5..d042f1fe 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-bytes/-bytes.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-bytes/-bytes.md @@ -1,14 +1,11 @@ --- title: Bytes --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[CallVolumeUnit](../index.md)/[Bytes](index.md)/[Bytes](-bytes.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[CallVolumeUnit](../index.md)/[Bytes](index.md)/[Bytes](-bytes.md) # Bytes - - [common]\ constructor(size: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-bytes/call-size.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-bytes/call-size.md index 00de5da0..607ebd12 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-bytes/call-size.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-bytes/call-size.md @@ -1,18 +1,14 @@ --- title: callSize --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[CallVolumeUnit](../index.md)/[Bytes](index.md)/[callSize](call-size.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[CallVolumeUnit](../index.md)/[Bytes](index.md)/[callSize](call-size.md) # callSize - - [common]\ -open suspend override fun [callSize](call-size.md)(call: ApplicationCall): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.md) - - +open suspend override fun [callSize](call-size.md)(call: +ApplicationCall): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.md) Size of the given call as measured by this unit diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-bytes/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-bytes/index.md index fc320c70..8fe53211 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-bytes/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-bytes/index.md @@ -1,47 +1,36 @@ --- title: Bytes --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[CallVolumeUnit](../index.md)/[Bytes](index.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[CallVolumeUnit](../index.md)/[Bytes](index.md) # Bytes - - [common]\ @[JvmInline](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-inline/index.md) - - -value class [Bytes](index.md)(val size: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)) : [CallVolumeUnit](../index.md) +value class [Bytes](index.md)(val +size: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)) : [CallVolumeUnit](../index.md) Volume is measured in number of bytes of request - - ## Constructors - -| | | -|---|---| +| | | +|--------------------|---------------------------------------------------------------------------------------------------------| | [Bytes](-bytes.md) | [common]
constructor(size: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)) | - ## Properties - -| Name | Summary | -|---|---| +| Name | Summary | +|-----------------|-------------------------------------------------------------------------------------------------------------------------------| | [name](name.md) | [common]
open override val [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | -| [size](size.md) | [common]
open override val [size](size.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) | - +| [size](size.md) | [common]
open override val [size](size.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) | ## Functions - -| Name | Summary | -|---|---| +| Name | Summary | +|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [callSize](call-size.md) | [common]
open suspend override fun [callSize](call-size.md)(call: ApplicationCall): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.md)
Size of the given call as measured by this unit | -| [size](../size.md) | [common]
open fun [size](../size.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.md)
Size as Double | +| [size](../size.md) | [common]
open fun [size](../size.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.md)
Size as Double | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-bytes/name.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-bytes/name.md index 0face12d..a8c70196 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-bytes/name.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-bytes/name.md @@ -1,14 +1,11 @@ --- title: name --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[CallVolumeUnit](../index.md)/[Bytes](index.md)/[name](name.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[CallVolumeUnit](../index.md)/[Bytes](index.md)/[name](name.md) # name - - [common]\ open override val [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-bytes/size.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-bytes/size.md index 9d34c013..983b9c99 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-bytes/size.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-bytes/size.md @@ -1,14 +1,11 @@ --- title: size --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[CallVolumeUnit](../index.md)/[Bytes](index.md)/[size](size.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[CallVolumeUnit](../index.md)/[Bytes](index.md)/[size](size.md) # size - - [common]\ open override val [size](size.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-calls/-calls.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-calls/-calls.md index 23338962..15c17604 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-calls/-calls.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-calls/-calls.md @@ -1,16 +1,14 @@ --- title: Calls --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[CallVolumeUnit](../index.md)/[Calls](index.md)/[Calls](-calls.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[CallVolumeUnit](../index.md)/[Calls](index.md)/[Calls](-calls.md) # Calls - - [common]\ -constructor(callWeighting: ApplicationCall.() -> [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.md) = { 1.0 }) +constructor(callWeighting: ApplicationCall.() +-> [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.md) = { 1.0 }) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-calls/call-size.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-calls/call-size.md index 62628dbe..945582be 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-calls/call-size.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-calls/call-size.md @@ -1,18 +1,14 @@ --- title: callSize --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[CallVolumeUnit](../index.md)/[Calls](index.md)/[callSize](call-size.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[CallVolumeUnit](../index.md)/[Calls](index.md)/[callSize](call-size.md) # callSize - - [common]\ -open suspend override fun [callSize](call-size.md)(call: ApplicationCall): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.md) - - +open suspend override fun [callSize](call-size.md)(call: +ApplicationCall): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.md) Size of the given call as measured by this unit diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-calls/call-weighting.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-calls/call-weighting.md index 8f64156c..5deb2cf7 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-calls/call-weighting.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-calls/call-weighting.md @@ -1,16 +1,14 @@ --- title: callWeighting --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[CallVolumeUnit](../index.md)/[Calls](index.md)/[callWeighting](call-weighting.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[CallVolumeUnit](../index.md)/[Calls](index.md)/[callWeighting](call-weighting.md) # callWeighting - - [common]\ -val [callWeighting](call-weighting.md): ApplicationCall.() -> [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.md) +val [callWeighting](call-weighting.md): ApplicationCall.() +-> [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-calls/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-calls/index.md index 2ceb802a..2f641b2b 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-calls/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-calls/index.md @@ -1,44 +1,37 @@ --- title: Calls --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[CallVolumeUnit](../index.md)/[Calls](index.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[CallVolumeUnit](../index.md)/[Calls](index.md) # Calls - - [common]\ -open class [Calls](index.md)(val callWeighting: ApplicationCall.() -> [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.md) = { 1.0 }) : [CallVolumeUnit](../index.md) - -Volume is measured in number of calls, with an optional call weighting function to give more weight to a call based on any of it's properties - +open class [Calls](index.md)(val callWeighting: ApplicationCall.() +-> [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.md) = { +1.0 }) : [CallVolumeUnit](../index.md) +Volume is measured in number of calls, with an optional call weighting function to give more weight to a call based on +any of it's properties ## Constructors - -| | | -|---|---| +| | | +|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| | [Calls](-calls.md) | [common]
constructor(callWeighting: ApplicationCall.() -> [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.md) = { 1.0 }) | - ## Properties - -| Name | Summary | -|---|---| +| Name | Summary | +|------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| | [callWeighting](call-weighting.md) | [common]
val [callWeighting](call-weighting.md): ApplicationCall.() -> [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.md) | -| [name](name.md) | [common]
open override val [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | -| [size](size.md) | [common]
open override val [size](size.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = 1 | - +| [name](name.md) | [common]
open override val [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | +| [size](size.md) | [common]
open override val [size](size.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = 1 | ## Functions - -| Name | Summary | -|---|---| +| Name | Summary | +|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [callSize](call-size.md) | [common]
open suspend override fun [callSize](call-size.md)(call: ApplicationCall): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.md)
Size of the given call as measured by this unit | -| [size](../size.md) | [common]
open fun [size](../size.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.md)
Size as Double | +| [size](../size.md) | [common]
open fun [size](../size.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.md)
Size as Double | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-calls/name.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-calls/name.md index 6b45f43c..158e2982 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-calls/name.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-calls/name.md @@ -1,14 +1,11 @@ --- title: name --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[CallVolumeUnit](../index.md)/[Calls](index.md)/[name](name.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[CallVolumeUnit](../index.md)/[Calls](index.md)/[name](name.md) # name - - [common]\ open override val [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-calls/size.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-calls/size.md index a79aeb0f..ad1c817a 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-calls/size.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/-calls/size.md @@ -1,14 +1,11 @@ --- title: size --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[CallVolumeUnit](../index.md)/[Calls](index.md)/[size](size.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[CallVolumeUnit](../index.md)/[Calls](index.md)/[size](size.md) # size - - [common]\ open override val [size](size.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = 1 diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/call-size.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/call-size.md index da97dc4d..c647949e 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/call-size.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/call-size.md @@ -1,18 +1,14 @@ --- title: callSize --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[CallVolumeUnit](index.md)/[callSize](call-size.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[CallVolumeUnit](index.md)/[callSize](call-size.md) # callSize - - [common]\ -abstract suspend fun [callSize](call-size.md)(call: ApplicationCall): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.md) - - +abstract suspend fun [callSize](call-size.md)(call: +ApplicationCall): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.md) Size of the given call as measured by this unit diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/index.md index a4e57857..f9e4f962 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/index.md @@ -1,9 +1,8 @@ --- title: CallVolumeUnit --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[CallVolumeUnit](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[CallVolumeUnit](index.md) # CallVolumeUnit @@ -11,36 +10,29 @@ interface [CallVolumeUnit](index.md) #### Inheritors - -| | -|---| +| | +|--------------------------| | [Calls](-calls/index.md) | | [Bytes](-bytes/index.md) | - ## Types - -| Name | Summary | -|---|---| -| [Bytes](-bytes/index.md) | [common]
@[JvmInline](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-inline/index.md)
value class [Bytes](-bytes/index.md)(val size: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)) : [CallVolumeUnit](index.md)
Volume is measured in number of bytes of request | +| Name | Summary | +|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [Bytes](-bytes/index.md) | [common]
@[JvmInline](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-inline/index.md)
value class [Bytes](-bytes/index.md)(val size: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)) : [CallVolumeUnit](index.md)
Volume is measured in number of bytes of request | | [Calls](-calls/index.md) | [common]
open class [Calls](-calls/index.md)(val callWeighting: ApplicationCall.() -> [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.md) = { 1.0 }) : [CallVolumeUnit](index.md)
Volume is measured in number of calls, with an optional call weighting function to give more weight to a call based on any of it's properties | - ## Properties - -| Name | Summary | -|---|---| +| Name | Summary | +|-----------------|--------------------------------------------------------------------------------------------------------------------------| | [name](name.md) | [common]
abstract val [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | -| [size](size.md) | [common]
abstract val [size](size.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) | - +| [size](size.md) | [common]
abstract val [size](size.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) | ## Functions - -| Name | Summary | -|---|---| +| Name | Summary | +|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [callSize](call-size.md) | [common]
abstract suspend fun [callSize](call-size.md)(call: ApplicationCall): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.md)
Size of the given call as measured by this unit | -| [size](size.md) | [common]
open fun [size](size.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.md)
Size as Double | +| [size](size.md) | [common]
open fun [size](size.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.md)
Size as Double | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/name.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/name.md index b55fbaea..d5500a87 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/name.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/name.md @@ -1,14 +1,11 @@ --- title: name --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[CallVolumeUnit](index.md)/[name](name.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[CallVolumeUnit](index.md)/[name](name.md) # name - - [common]\ abstract val [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/size.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/size.md index e6fe818e..421f9395 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/size.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-call-volume-unit/size.md @@ -1,25 +1,16 @@ --- title: size --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[CallVolumeUnit](index.md)/[size](size.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[CallVolumeUnit](index.md)/[size](size.md) # size - - [common]\ open fun [size](size.md)(): [Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.md) - - Size as Double - - - - [common]\ abstract val [size](size.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/-limited-by/-limited-by.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/-limited-by/-limited-by.md index 9e1917f5..af8add13 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/-limited-by/-limited-by.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/-limited-by/-limited-by.md @@ -1,16 +1,16 @@ --- title: LimitedBy --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[RateLimiterResponse](../index.md)/[LimitedBy](index.md)/[LimitedBy](-limited-by.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[RateLimiterResponse](../index.md)/[LimitedBy](index.md)/[LimitedBy](-limited-by.md) # LimitedBy - - [common]\ -constructor(rateLimiter: [RateLimiter](../../-rate-limiter/index.md), exceededBy: [Number](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.md), resetIn: [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)) +constructor(rateLimiter: [RateLimiter](../../-rate-limiter/index.md), +exceededBy: [Number](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.md), +resetIn: [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md), +message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/-limited-by/exceeded-by.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/-limited-by/exceeded-by.md index 76e1270f..300eb6f8 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/-limited-by/exceeded-by.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/-limited-by/exceeded-by.md @@ -1,14 +1,11 @@ --- title: exceededBy --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[RateLimiterResponse](../index.md)/[LimitedBy](index.md)/[exceededBy](exceeded-by.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[RateLimiterResponse](../index.md)/[LimitedBy](index.md)/[exceededBy](exceeded-by.md) # exceededBy - - [common]\ val [exceededBy](exceeded-by.md): [Number](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/-limited-by/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/-limited-by/index.md index 7eb070d0..2f398903 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/-limited-by/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/-limited-by/index.md @@ -1,34 +1,29 @@ --- title: LimitedBy --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[RateLimiterResponse](../index.md)/[LimitedBy](index.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[RateLimiterResponse](../index.md)/[LimitedBy](index.md) # LimitedBy - - [common]\ -data class [LimitedBy](index.md)(val rateLimiter: [RateLimiter](../../-rate-limiter/index.md), val exceededBy: [Number](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.md), val resetIn: [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md), val message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)) : [RateLimiterResponse](../index.md) - - +data class [LimitedBy](index.md)(val rateLimiter: [RateLimiter](../../-rate-limiter/index.md), val +exceededBy: [Number](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.md), val +resetIn: [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md), val +message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)) : [RateLimiterResponse](../index.md) ## Constructors - -| | | -|---|---| +| | | +|-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [LimitedBy](-limited-by.md) | [common]
constructor(rateLimiter: [RateLimiter](../../-rate-limiter/index.md), exceededBy: [Number](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.md), resetIn: [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md), message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)) | - ## Properties - -| Name | Summary | -|---|---| -| [exceededBy](exceeded-by.md) | [common]
val [exceededBy](exceeded-by.md): [Number](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.md) | -| [message](message.md) | [common]
val [message](message.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | -| [rateLimiter](rate-limiter.md) | [common]
open override val [rateLimiter](rate-limiter.md): [RateLimiter](../../-rate-limiter/index.md) | -| [resetIn](reset-in.md) | [common]
val [resetIn](reset-in.md): [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md) | +| Name | Summary | +|--------------------------------|---------------------------------------------------------------------------------------------------------------------------------| +| [exceededBy](exceeded-by.md) | [common]
val [exceededBy](exceeded-by.md): [Number](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.md) | +| [message](message.md) | [common]
val [message](message.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | +| [rateLimiter](rate-limiter.md) | [common]
open override val [rateLimiter](rate-limiter.md): [RateLimiter](../../-rate-limiter/index.md) | +| [resetIn](reset-in.md) | [common]
val [resetIn](reset-in.md): [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/-limited-by/message.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/-limited-by/message.md index 837686ff..1a5661a6 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/-limited-by/message.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/-limited-by/message.md @@ -1,14 +1,11 @@ --- title: message --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[RateLimiterResponse](../index.md)/[LimitedBy](index.md)/[message](message.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[RateLimiterResponse](../index.md)/[LimitedBy](index.md)/[message](message.md) # message - - [common]\ val [message](message.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/-limited-by/rate-limiter.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/-limited-by/rate-limiter.md index 5cc90e7a..fdf6f318 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/-limited-by/rate-limiter.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/-limited-by/rate-limiter.md @@ -1,14 +1,11 @@ --- title: rateLimiter --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[RateLimiterResponse](../index.md)/[LimitedBy](index.md)/[rateLimiter](rate-limiter.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[RateLimiterResponse](../index.md)/[LimitedBy](index.md)/[rateLimiter](rate-limiter.md) # rateLimiter - - [common]\ open override val [rateLimiter](rate-limiter.md): [RateLimiter](../../-rate-limiter/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/-limited-by/reset-in.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/-limited-by/reset-in.md index 38f23e38..503d4d10 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/-limited-by/reset-in.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/-limited-by/reset-in.md @@ -1,14 +1,11 @@ --- title: resetIn --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[RateLimiterResponse](../index.md)/[LimitedBy](index.md)/[resetIn](reset-in.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[RateLimiterResponse](../index.md)/[LimitedBy](index.md)/[resetIn](reset-in.md) # resetIn - - [common]\ val [resetIn](reset-in.md): [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/-not-limited/-not-limited.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/-not-limited/-not-limited.md index e538b36c..1d9e9589 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/-not-limited/-not-limited.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/-not-limited/-not-limited.md @@ -1,16 +1,14 @@ --- title: NotLimited --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[RateLimiterResponse](../index.md)/[NotLimited](index.md)/[NotLimited](-not-limited.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[RateLimiterResponse](../index.md)/[NotLimited](index.md)/[NotLimited](-not-limited.md) # NotLimited - - [common]\ -constructor(rateLimiter: [RateLimiter](../../-rate-limiter/index.md), remaining: [Number](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.md)? = null) +constructor(rateLimiter: [RateLimiter](../../-rate-limiter/index.md), +remaining: [Number](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.md)? = null) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/-not-limited/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/-not-limited/index.md index c595d190..55188ffe 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/-not-limited/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/-not-limited/index.md @@ -1,32 +1,26 @@ --- title: NotLimited --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[RateLimiterResponse](../index.md)/[NotLimited](index.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[RateLimiterResponse](../index.md)/[NotLimited](index.md) # NotLimited - - [common]\ -data class [NotLimited](index.md)(val rateLimiter: [RateLimiter](../../-rate-limiter/index.md), val remaining: [Number](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.md)? = null) : [RateLimiterResponse](../index.md) - - +data class [NotLimited](index.md)(val rateLimiter: [RateLimiter](../../-rate-limiter/index.md), val +remaining: [Number](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.md)? = +null) : [RateLimiterResponse](../index.md) ## Constructors - -| | | -|---|---| +| | | +|-------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [NotLimited](-not-limited.md) | [common]
constructor(rateLimiter: [RateLimiter](../../-rate-limiter/index.md), remaining: [Number](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.md)? = null) | - ## Properties - -| Name | Summary | -|---|---| -| [rateLimiter](rate-limiter.md) | [common]
open override val [rateLimiter](rate-limiter.md): [RateLimiter](../../-rate-limiter/index.md) | -| [remaining](remaining.md) | [common]
val [remaining](remaining.md): [Number](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.md)? = null | +| Name | Summary | +|--------------------------------|-----------------------------------------------------------------------------------------------------------------------------------| +| [rateLimiter](rate-limiter.md) | [common]
open override val [rateLimiter](rate-limiter.md): [RateLimiter](../../-rate-limiter/index.md) | +| [remaining](remaining.md) | [common]
val [remaining](remaining.md): [Number](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.md)? = null | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/-not-limited/rate-limiter.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/-not-limited/rate-limiter.md index 870a01da..cf9f9fe9 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/-not-limited/rate-limiter.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/-not-limited/rate-limiter.md @@ -1,14 +1,11 @@ --- title: rateLimiter --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[RateLimiterResponse](../index.md)/[NotLimited](index.md)/[rateLimiter](rate-limiter.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[RateLimiterResponse](../index.md)/[NotLimited](index.md)/[rateLimiter](rate-limiter.md) # rateLimiter - - [common]\ open override val [rateLimiter](rate-limiter.md): [RateLimiter](../../-rate-limiter/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/-not-limited/remaining.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/-not-limited/remaining.md index 741229f8..605bc2ed 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/-not-limited/remaining.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/-not-limited/remaining.md @@ -1,14 +1,11 @@ --- title: remaining --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[RateLimiterResponse](../index.md)/[NotLimited](index.md)/[remaining](remaining.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[RateLimiterResponse](../index.md)/[NotLimited](index.md)/[remaining](remaining.md) # remaining - - [common]\ val [remaining](remaining.md): [Number](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.md)? = null diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/index.md index af15aa0b..51630cf9 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/index.md @@ -1,9 +1,8 @@ --- title: RateLimiterResponse --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimiterResponse](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimiterResponse](index.md) # RateLimiterResponse @@ -11,26 +10,21 @@ interface [RateLimiterResponse](index.md) #### Inheritors - -| | -|---| +| | +|-------------------------------------| | [NotLimited](-not-limited/index.md) | -| [LimitedBy](-limited-by/index.md) | - +| [LimitedBy](-limited-by/index.md) | ## Types - -| Name | Summary | -|---|---| -| [LimitedBy](-limited-by/index.md) | [common]
data class [LimitedBy](-limited-by/index.md)(val rateLimiter: [RateLimiter](../-rate-limiter/index.md), val exceededBy: [Number](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.md), val resetIn: [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md), val message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)) : [RateLimiterResponse](index.md) | -| [NotLimited](-not-limited/index.md) | [common]
data class [NotLimited](-not-limited/index.md)(val rateLimiter: [RateLimiter](../-rate-limiter/index.md), val remaining: [Number](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.md)? = null) : [RateLimiterResponse](index.md) | - +| Name | Summary | +|-------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [LimitedBy](-limited-by/index.md) | [common]
data class [LimitedBy](-limited-by/index.md)(val rateLimiter: [RateLimiter](../-rate-limiter/index.md), val exceededBy: [Number](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.md), val resetIn: [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md), val message: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)) : [RateLimiterResponse](index.md) | +| [NotLimited](-not-limited/index.md) | [common]
data class [NotLimited](-not-limited/index.md)(val rateLimiter: [RateLimiter](../-rate-limiter/index.md), val remaining: [Number](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-number/index.md)? = null) : [RateLimiterResponse](index.md) | ## Properties - -| Name | Summary | -|---|---| +| Name | Summary | +|--------------------------------|---------------------------------------------------------------------------------------------------| | [rateLimiter](rate-limiter.md) | [common]
abstract val [rateLimiter](rate-limiter.md): [RateLimiter](../-rate-limiter/index.md) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/rate-limiter.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/rate-limiter.md index 95492f2e..42b1b8cb 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/rate-limiter.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter-response/rate-limiter.md @@ -1,14 +1,11 @@ --- title: rateLimiter --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimiterResponse](index.md)/[rateLimiter](rate-limiter.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimiterResponse](index.md)/[rateLimiter](rate-limiter.md) # rateLimiter - - [common]\ abstract val [rateLimiter](rate-limiter.md): [RateLimiter](../-rate-limiter/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/-rate-limiter.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/-rate-limiter.md index feea26e4..a35e6975 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/-rate-limiter.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/-rate-limiter.md @@ -1,14 +1,11 @@ --- title: RateLimiter --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimiter](index.md)/[RateLimiter](-rate-limiter.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimiter](index.md)/[RateLimiter](-rate-limiter.md) # RateLimiter - - [common]\ constructor() diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/call-volume-unit.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/call-volume-unit.md index d8111ff6..c5f55713 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/call-volume-unit.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/call-volume-unit.md @@ -1,19 +1,14 @@ --- title: callVolumeUnit --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimiter](index.md)/[callVolumeUnit](call-volume-unit.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimiter](index.md)/[callVolumeUnit](call-volume-unit.md) # callVolumeUnit - - [common]\ abstract val [callVolumeUnit](call-volume-unit.md): [CallVolumeUnit](../-call-volume-unit/index.md) - - In what unit are calls measured diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/capacity.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/capacity.md index 9e7dc530..e2f4e14d 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/capacity.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/capacity.md @@ -1,20 +1,16 @@ --- title: capacity --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimiter](index.md)/[capacity](capacity.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimiter](index.md)/[capacity](capacity.md) # capacity - - [common]\ abstract val [capacity](capacity.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) - - -The maximum capacity, as measured in [CallVolumeUnit.Calls](../-call-volume-unit/-calls/index.md) or [CallVolumeUnit.Bytes](../-call-volume-unit/-bytes/index.md) +The maximum capacity, as measured in [CallVolumeUnit.Calls](../-call-volume-unit/-calls/index.md) +or [CallVolumeUnit.Bytes](../-call-volume-unit/-bytes/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/clock.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/clock.md index c41b5642..27e885c7 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/clock.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/clock.md @@ -1,19 +1,14 @@ --- title: clock --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimiter](index.md)/[clock](clock.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimiter](index.md)/[clock](clock.md) # clock - - [common]\ open val [clock](clock.md): () -> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) - - A time provider in milliseconds diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/id.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/id.md index 85eff440..7e8f429b 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/id.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/id.md @@ -1,14 +1,11 @@ --- title: id --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimiter](index.md)/[id](id.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimiter](index.md)/[id](id.md) # id - - [common]\ fun ApplicationCall.[id](id.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/index.md index 9ee12ee3..f51bb661 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/index.md @@ -1,9 +1,8 @@ --- title: RateLimiter --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimiter](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimiter](index.md) # RateLimiter @@ -11,37 +10,30 @@ abstract class [RateLimiter](index.md) #### Inheritors - -| | -|---| -| [Bucket](../../io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-bucket/index.md) | +| | +|-------------------------------------------------------------------------------------------------------------------| +| [Bucket](../../io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-bucket/index.md) | | [SlidingWindow](../../io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-sliding-window/index.md) | - ## Constructors - -| | | -|---|---| +| | | +|---------------------------------|---------------------------| | [RateLimiter](-rate-limiter.md) | [common]
constructor() | - ## Properties - -| Name | Summary | -|---|---| -| [callVolumeUnit](call-volume-unit.md) | [common]
abstract val [callVolumeUnit](call-volume-unit.md): [CallVolumeUnit](../-call-volume-unit/index.md)
In what unit are calls measured | -| [capacity](capacity.md) | [common]
abstract val [capacity](capacity.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)
The maximum capacity, as measured in [CallVolumeUnit.Calls](../-call-volume-unit/-calls/index.md) or [CallVolumeUnit.Bytes](../-call-volume-unit/-bytes/index.md) | -| [clock](clock.md) | [common]
open val [clock](clock.md): () -> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)
A time provider in milliseconds | -| [rate](rate.md) | [common]
abstract val [rate](rate.md): [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md)
Desired change over time | - +| Name | Summary | +|---------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [callVolumeUnit](call-volume-unit.md) | [common]
abstract val [callVolumeUnit](call-volume-unit.md): [CallVolumeUnit](../-call-volume-unit/index.md)
In what unit are calls measured | +| [capacity](capacity.md) | [common]
abstract val [capacity](capacity.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)
The maximum capacity, as measured in [CallVolumeUnit.Calls](../-call-volume-unit/-calls/index.md) or [CallVolumeUnit.Bytes](../-call-volume-unit/-bytes/index.md) | +| [clock](clock.md) | [common]
open val [clock](clock.md): () -> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)
A time provider in milliseconds | +| [rate](rate.md) | [common]
abstract val [rate](rate.md): [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md)
Desired change over time | ## Functions - -| Name | Summary | -|---|---| -| [id](id.md) | [common]
fun ApplicationCall.[id](id.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | +| Name | Summary | +|----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [id](id.md) | [common]
fun ApplicationCall.[id](id.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | | [tryAccept](try-accept.md) | [common]
abstract suspend fun [tryAccept](try-accept.md)(call: ApplicationCall): [RateLimiterResponse](../-rate-limiter-response/index.md)
Try to accept a call | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/rate.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/rate.md index 405f7b54..e5ec4520 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/rate.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/rate.md @@ -1,19 +1,14 @@ --- title: rate --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimiter](index.md)/[rate](rate.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimiter](index.md)/[rate](rate.md) # rate - - [common]\ abstract val [rate](rate.md): [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md) - - Desired change over time diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/try-accept.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/try-accept.md index 458da4b5..004b4a32 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/try-accept.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiter/try-accept.md @@ -1,38 +1,27 @@ --- title: tryAccept --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimiter](index.md)/[tryAccept](try-accept.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimiter](index.md)/[tryAccept](try-accept.md) # tryAccept - - [common]\ -abstract suspend fun [tryAccept](try-accept.md)(call: ApplicationCall): [RateLimiterResponse](../-rate-limiter-response/index.md) - - +abstract suspend fun [tryAccept](try-accept.md)(call: +ApplicationCall): [RateLimiterResponse](../-rate-limiter-response/index.md) Try to accept a call - - #### Return - - response detailing if the call was accepted and details in the case of rejection - - #### Parameters - common -| | | -|---|---| +| | | +|------|--------------------| | call | the call to accept | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/-rate-limiter-configuration/-rate-limiter-configuration.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/-rate-limiter-configuration/-rate-limiter-configuration.md index 90fa9b8c..8977fe8f 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/-rate-limiter-configuration/-rate-limiter-configuration.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/-rate-limiter-configuration/-rate-limiter-configuration.md @@ -1,16 +1,18 @@ --- title: RateLimiterConfiguration --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[RateLimitingConfiguration](../index.md)/[RateLimiterConfiguration](index.md)/[RateLimiterConfiguration](-rate-limiter-configuration.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[RateLimitingConfiguration](../index.md)/[RateLimiterConfiguration](index.md)/[RateLimiterConfiguration](-rate-limiter-configuration.md) # RateLimiterConfiguration - - [common]\ -constructor(type: [KClass](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.md)<out [RateLimiter](../../-rate-limiter/index.md)> = TokenBucket::class, rate: [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md) = INFINITE, capacity: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = Int.MAX_VALUE, clock: () -> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = { now().toEpochMilliseconds() }, callVolumeUnit: [CallVolumeUnit](../../-call-volume-unit/index.md) = CallVolumeUnit.Calls()) +constructor(type: [KClass](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.md) +<out [RateLimiter](../../-rate-limiter/index.md)> = TokenBucket::class, +rate: [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md) = INFINITE, +capacity: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = Int.MAX_VALUE, clock: () +-> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = { now().toEpochMilliseconds() }, +callVolumeUnit: [CallVolumeUnit](../../-call-volume-unit/index.md) = CallVolumeUnit.Calls()) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/-rate-limiter-configuration/call-volume-unit.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/-rate-limiter-configuration/call-volume-unit.md index 4642353f..1ecc980d 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/-rate-limiter-configuration/call-volume-unit.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/-rate-limiter-configuration/call-volume-unit.md @@ -1,20 +1,16 @@ --- title: callVolumeUnit --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[RateLimitingConfiguration](../index.md)/[RateLimiterConfiguration](index.md)/[callVolumeUnit](call-volume-unit.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[RateLimitingConfiguration](../index.md)/[RateLimiterConfiguration](index.md)/[callVolumeUnit](call-volume-unit.md) # callVolumeUnit - - [common]\ var [callVolumeUnit](call-volume-unit.md): [CallVolumeUnit](../../-call-volume-unit/index.md) - - -The unit by which the rate limiter capacity is measured, not applicable for [LeakyBucket](../../../io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-leaky-bucket/index.md) +The unit by which the rate limiter capacity is measured, not applicable +for [LeakyBucket](../../../io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-leaky-bucket/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/-rate-limiter-configuration/capacity.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/-rate-limiter-configuration/capacity.md index 28114f6d..82c4a26c 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/-rate-limiter-configuration/capacity.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/-rate-limiter-configuration/capacity.md @@ -1,19 +1,14 @@ --- title: capacity --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[RateLimitingConfiguration](../index.md)/[RateLimiterConfiguration](index.md)/[capacity](capacity.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[RateLimitingConfiguration](../index.md)/[RateLimiterConfiguration](index.md)/[capacity](capacity.md) # capacity - - [common]\ var [capacity](capacity.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) - - The rate limiter capacity diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/-rate-limiter-configuration/clock.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/-rate-limiter-configuration/clock.md index 5cda0773..9c302d22 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/-rate-limiter-configuration/clock.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/-rate-limiter-configuration/clock.md @@ -1,19 +1,14 @@ --- title: clock --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[RateLimitingConfiguration](../index.md)/[RateLimiterConfiguration](index.md)/[clock](clock.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[RateLimitingConfiguration](../index.md)/[RateLimiterConfiguration](index.md)/[clock](clock.md) # clock - - [common]\ var [clock](clock.md): () -> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) - - A time provider in milliseconds diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/-rate-limiter-configuration/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/-rate-limiter-configuration/index.md index edd1d66e..05aa03b3 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/-rate-limiter-configuration/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/-rate-limiter-configuration/index.md @@ -1,35 +1,33 @@ --- title: RateLimiterConfiguration --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[RateLimitingConfiguration](../index.md)/[RateLimiterConfiguration](index.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[RateLimitingConfiguration](../index.md)/[RateLimiterConfiguration](index.md) # RateLimiterConfiguration - - [common]\ -class [RateLimiterConfiguration](index.md)(var type: [KClass](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.md)<out [RateLimiter](../../-rate-limiter/index.md)> = TokenBucket::class, var rate: [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md) = INFINITE, var capacity: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = Int.MAX_VALUE, var clock: () -> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = { now().toEpochMilliseconds() }, var callVolumeUnit: [CallVolumeUnit](../../-call-volume-unit/index.md) = CallVolumeUnit.Calls()) - - +class [RateLimiterConfiguration](index.md)(var +type: [KClass](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.md) +<out [RateLimiter](../../-rate-limiter/index.md)> = TokenBucket::class, var +rate: [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md) = INFINITE, var +capacity: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = Int.MAX_VALUE, var clock: () +-> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = { now().toEpochMilliseconds() }, var +callVolumeUnit: [CallVolumeUnit](../../-call-volume-unit/index.md) = CallVolumeUnit.Calls()) ## Constructors - -| | | -|---|---| +| | | +|------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [RateLimiterConfiguration](-rate-limiter-configuration.md) | [common]
constructor(type: [KClass](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.md)<out [RateLimiter](../../-rate-limiter/index.md)> = TokenBucket::class, rate: [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md) = INFINITE, capacity: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = Int.MAX_VALUE, clock: () -> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = { now().toEpochMilliseconds() }, callVolumeUnit: [CallVolumeUnit](../../-call-volume-unit/index.md) = CallVolumeUnit.Calls()) | - ## Properties - -| Name | Summary | -|---|---| +| Name | Summary | +|---------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [callVolumeUnit](call-volume-unit.md) | [common]
var [callVolumeUnit](call-volume-unit.md): [CallVolumeUnit](../../-call-volume-unit/index.md)
The unit by which the rate limiter capacity is measured, not applicable for [LeakyBucket](../../../io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/-leaky-bucket/index.md) | -| [capacity](capacity.md) | [common]
var [capacity](capacity.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)
The rate limiter capacity | -| [clock](clock.md) | [common]
var [clock](clock.md): () -> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)
A time provider in milliseconds | -| [rate](rate.md) | [common]
var [rate](rate.md): [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md)
The rate limiter rate | -| [type](type.md) | [common]
var [type](type.md): [KClass](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.md)<out [RateLimiter](../../-rate-limiter/index.md)>
The rate limiter implementation | +| [capacity](capacity.md) | [common]
var [capacity](capacity.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)
The rate limiter capacity | +| [clock](clock.md) | [common]
var [clock](clock.md): () -> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)
A time provider in milliseconds | +| [rate](rate.md) | [common]
var [rate](rate.md): [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md)
The rate limiter rate | +| [type](type.md) | [common]
var [type](type.md): [KClass](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.md)<out [RateLimiter](../../-rate-limiter/index.md)>
The rate limiter implementation | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/-rate-limiter-configuration/rate.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/-rate-limiter-configuration/rate.md index 7b2fe2b3..cc3ed72f 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/-rate-limiter-configuration/rate.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/-rate-limiter-configuration/rate.md @@ -1,19 +1,14 @@ --- title: rate --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[RateLimitingConfiguration](../index.md)/[RateLimiterConfiguration](index.md)/[rate](rate.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[RateLimitingConfiguration](../index.md)/[RateLimiterConfiguration](index.md)/[rate](rate.md) # rate - - [common]\ var [rate](rate.md): [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md) - - The rate limiter rate diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/-rate-limiter-configuration/type.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/-rate-limiter-configuration/type.md index bc5aa99e..959e5192 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/-rate-limiter-configuration/type.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/-rate-limiter-configuration/type.md @@ -1,18 +1,14 @@ --- title: type --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[RateLimitingConfiguration](../index.md)/[RateLimiterConfiguration](index.md)/[type](type.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../../index.md)/[RateLimitingConfiguration](../index.md)/[RateLimiterConfiguration](index.md)/[type](type.md) # type - - [common]\ -var [type](type.md): [KClass](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.md)<out [RateLimiter](../../-rate-limiter/index.md)> - - +var [type](type.md): [KClass](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.md) +<out [RateLimiter](../../-rate-limiter/index.md)> The rate limiter implementation diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/-rate-limiting-configuration.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/-rate-limiting-configuration.md index 76e88ece..44412e5f 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/-rate-limiting-configuration.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/-rate-limiting-configuration.md @@ -1,14 +1,11 @@ --- title: RateLimitingConfiguration --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimitingConfiguration](index.md)/[RateLimitingConfiguration](-rate-limiting-configuration.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimitingConfiguration](index.md)/[RateLimitingConfiguration](-rate-limiting-configuration.md) # RateLimitingConfiguration - - [common]\ constructor() diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/black-listed-agents.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/black-listed-agents.md index ea86db0c..74d6d5cd 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/black-listed-agents.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/black-listed-agents.md @@ -1,20 +1,17 @@ --- title: blackListedAgents --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimitingConfiguration](index.md)/[blackListedAgents](black-listed-agents.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimitingConfiguration](index.md)/[blackListedAgents](black-listed-agents.md) # blackListedAgents - - [common]\ -var [blackListedAgents](black-listed-agents.md): [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.md)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)> - - +var [blackListedAgents](black-listed-agents.md): [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.md) +<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)> -Any user-agents that are blacklisted, i.e. will not be allowed through in any case, handled by [blackListedCallerCallHandler](black-listed-caller-call-handler.md) +Any user-agents that are blacklisted, i.e. will not be allowed through in any case, handled +by [blackListedCallerCallHandler](black-listed-caller-call-handler.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/black-listed-caller-call-handler.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/black-listed-caller-call-handler.md index fe6db4f6..fc36e0c6 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/black-listed-caller-call-handler.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/black-listed-caller-call-handler.md @@ -1,20 +1,17 @@ --- title: blackListedCallerCallHandler --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimitingConfiguration](index.md)/[blackListedCallerCallHandler](black-listed-caller-call-handler.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimitingConfiguration](index.md)/[blackListedCallerCallHandler](black-listed-caller-call-handler.md) # blackListedCallerCallHandler - - [common]\ -var [blackListedCallerCallHandler](black-listed-caller-call-handler.md): suspend [RateLimitingConfiguration](index.md).(ApplicationCall) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) - - +var [blackListedCallerCallHandler](black-listed-caller-call-handler.md): suspend [RateLimitingConfiguration](index.md).( +ApplicationCall) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) -The call handler for blacklisted Callers, use to define the response for blacklisted Callers, default is respond with 403 +The call handler for blacklisted Callers, use to define the response for blacklisted Callers, default is respond with +403 diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/black-listed-hosts.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/black-listed-hosts.md index 9acf181f..42d3e8ec 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/black-listed-hosts.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/black-listed-hosts.md @@ -1,20 +1,17 @@ --- title: blackListedHosts --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimitingConfiguration](index.md)/[blackListedHosts](black-listed-hosts.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimitingConfiguration](index.md)/[blackListedHosts](black-listed-hosts.md) # blackListedHosts - - [common]\ -var [blackListedHosts](black-listed-hosts.md): [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.md)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)> - - +var [blackListedHosts](black-listed-hosts.md): [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.md) +<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)> -Any Hosts that are blacklisted, i.e. will not be allowed through in any case, handled by [blackListedCallerCallHandler](black-listed-caller-call-handler.md) +Any Hosts that are blacklisted, i.e. will not be allowed through in any case, handled +by [blackListedCallerCallHandler](black-listed-caller-call-handler.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/black-listed-principals.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/black-listed-principals.md index de4b0dfc..84226e38 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/black-listed-principals.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/black-listed-principals.md @@ -1,20 +1,17 @@ --- title: blackListedPrincipals --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimitingConfiguration](index.md)/[blackListedPrincipals](black-listed-principals.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimitingConfiguration](index.md)/[blackListedPrincipals](black-listed-principals.md) # blackListedPrincipals - - [common]\ -var [blackListedPrincipals](black-listed-principals.md): [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.md)<Principal> - - +var [blackListedPrincipals](black-listed-principals.md): [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.md) +<Principal> -Any Principals that are blacklisted, i.e. will not be allowed through in any case, handled by [blackListedCallerCallHandler](black-listed-caller-call-handler.md) +Any Principals that are blacklisted, i.e. will not be allowed through in any case, handled +by [blackListedCallerCallHandler](black-listed-caller-call-handler.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/call-accepted-handler.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/call-accepted-handler.md index 43cda767..ec6cfb18 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/call-accepted-handler.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/call-accepted-handler.md @@ -1,20 +1,18 @@ --- title: callAcceptedHandler --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimitingConfiguration](index.md)/[callAcceptedHandler](call-accepted-handler.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimitingConfiguration](index.md)/[callAcceptedHandler](call-accepted-handler.md) # callAcceptedHandler - - [common]\ -val [callAcceptedHandler](call-accepted-handler.md): suspend ApplicationCall.([RateLimiterResponse.NotLimited](../-rate-limiter-response/-not-limited/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) - - +val [callAcceptedHandler](call-accepted-handler.md): suspend +ApplicationCall.([RateLimiterResponse.NotLimited](../-rate-limiter-response/-not-limited/index.md)) +-> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) -The call handler for accepted calls, use to define the response for accepted calls, by default, adds appropriate X-RateLimit headers +The call handler for accepted calls, use to define the response for accepted calls, by default, adds appropriate +X-RateLimit headers diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/exclude-paths.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/exclude-paths.md index f57b4127..78aa1e56 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/exclude-paths.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/exclude-paths.md @@ -1,18 +1,14 @@ --- title: excludePaths --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimitingConfiguration](index.md)/[excludePaths](exclude-paths.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimitingConfiguration](index.md)/[excludePaths](exclude-paths.md) # excludePaths - - [common]\ -var [excludePaths](exclude-paths.md): [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.md)<[Regex](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.text/-regex/index.md)> - - +var [excludePaths](exclude-paths.md): [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.md) +<[Regex](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.text/-regex/index.md)> Regexes for paths to exclude from this rate limiter diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/index.md index 2e344075..5a601b9c 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/index.md @@ -1,62 +1,49 @@ --- title: RateLimitingConfiguration --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimitingConfiguration](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimitingConfiguration](index.md) # RateLimitingConfiguration - - [common]\ class [RateLimitingConfiguration](index.md) Rate limit plugin configuration. - - -Be careful using whitelisting, as the caller can abuse it by overriding the host or user-agent by manipulating the headers, it is safest to use Principal whitelisting, as it relies on authentication. - - +Be careful using whitelisting, as the caller can abuse it by overriding the host or user-agent by manipulating the +headers, it is safest to use Principal whitelisting, as it relies on authentication. ## Constructors - -| | | -|---|---| +| | | +|--------------------------------------------------------------|---------------------------| | [RateLimitingConfiguration](-rate-limiting-configuration.md) | [common]
constructor() | - ## Types - -| Name | Summary | -|---|---| +| Name | Summary | +|------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [RateLimiterConfiguration](-rate-limiter-configuration/index.md) | [common]
class [RateLimiterConfiguration](-rate-limiter-configuration/index.md)(var type: [KClass](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.md)<out [RateLimiter](../-rate-limiter/index.md)> = TokenBucket::class, var rate: [Duration](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.md) = INFINITE, var capacity: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = Int.MAX_VALUE, var clock: () -> [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = { now().toEpochMilliseconds() }, var callVolumeUnit: [CallVolumeUnit](../-call-volume-unit/index.md) = CallVolumeUnit.Calls()) | - ## Properties - -| Name | Summary | -|---|---| -| [blackListedAgents](black-listed-agents.md) | [common]
var [blackListedAgents](black-listed-agents.md): [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.md)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)>
Any user-agents that are blacklisted, i.e. will not be allowed through in any case, handled by [blackListedCallerCallHandler](black-listed-caller-call-handler.md) | -| [blackListedCallerCallHandler](black-listed-caller-call-handler.md) | [common]
var [blackListedCallerCallHandler](black-listed-caller-call-handler.md): suspend [RateLimitingConfiguration](index.md).(ApplicationCall) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)
The call handler for blacklisted Callers, use to define the response for blacklisted Callers, default is respond with 403 | -| [blackListedHosts](black-listed-hosts.md) | [common]
var [blackListedHosts](black-listed-hosts.md): [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.md)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)>
Any Hosts that are blacklisted, i.e. will not be allowed through in any case, handled by [blackListedCallerCallHandler](black-listed-caller-call-handler.md) | -| [blackListedPrincipals](black-listed-principals.md) | [common]
var [blackListedPrincipals](black-listed-principals.md): [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.md)<Principal>
Any Principals that are blacklisted, i.e. will not be allowed through in any case, handled by [blackListedCallerCallHandler](black-listed-caller-call-handler.md) | -| [callAcceptedHandler](call-accepted-handler.md) | [common]
val [callAcceptedHandler](call-accepted-handler.md): suspend ApplicationCall.([RateLimiterResponse.NotLimited](../-rate-limiter-response/-not-limited/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)
The call handler for accepted calls, use to define the response for accepted calls, by default, adds appropriate X-RateLimit headers | -| [excludePaths](exclude-paths.md) | [common]
var [excludePaths](exclude-paths.md): [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.md)<[Regex](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.text/-regex/index.md)>
Regexes for paths to exclude from this rate limiter | -| [rateLimitExceededHandler](rate-limit-exceeded-handler.md) | [common]
val [rateLimitExceededHandler](rate-limit-exceeded-handler.md): suspend ApplicationCall.([RateLimiterResponse.LimitedBy](../-rate-limiter-response/-limited-by/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)
The call handler for rate limited IPs, use to define the response for rate limited IPs. The default is to respond with 429 and appropriate X-RateLimit headers | -| [whiteListedAgents](white-listed-agents.md) | [common]
var [whiteListedAgents](white-listed-agents.md): [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.md)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)>
Any user-agents that are whitelisted, i.e. will be allowed through without rate limiting | -| [whiteListedHosts](white-listed-hosts.md) | [common]
var [whiteListedHosts](white-listed-hosts.md): [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.md)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)>
Any Hosts that are whitelisted, i.e. will be allowed through without rate limiting | -| [whiteListedPrincipals](white-listed-principals.md) | [common]
var [whiteListedPrincipals](white-listed-principals.md): [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.md)<Principal>
Any Principals that are whitelisted, i.e. will be allowed through without rate limiting | - +| Name | Summary | +|---------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [blackListedAgents](black-listed-agents.md) | [common]
var [blackListedAgents](black-listed-agents.md): [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.md)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)>
Any user-agents that are blacklisted, i.e. will not be allowed through in any case, handled by [blackListedCallerCallHandler](black-listed-caller-call-handler.md) | +| [blackListedCallerCallHandler](black-listed-caller-call-handler.md) | [common]
var [blackListedCallerCallHandler](black-listed-caller-call-handler.md): suspend [RateLimitingConfiguration](index.md).(ApplicationCall) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)
The call handler for blacklisted Callers, use to define the response for blacklisted Callers, default is respond with 403 | +| [blackListedHosts](black-listed-hosts.md) | [common]
var [blackListedHosts](black-listed-hosts.md): [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.md)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)>
Any Hosts that are blacklisted, i.e. will not be allowed through in any case, handled by [blackListedCallerCallHandler](black-listed-caller-call-handler.md) | +| [blackListedPrincipals](black-listed-principals.md) | [common]
var [blackListedPrincipals](black-listed-principals.md): [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.md)<Principal>
Any Principals that are blacklisted, i.e. will not be allowed through in any case, handled by [blackListedCallerCallHandler](black-listed-caller-call-handler.md) | +| [callAcceptedHandler](call-accepted-handler.md) | [common]
val [callAcceptedHandler](call-accepted-handler.md): suspend ApplicationCall.([RateLimiterResponse.NotLimited](../-rate-limiter-response/-not-limited/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)
The call handler for accepted calls, use to define the response for accepted calls, by default, adds appropriate X-RateLimit headers | +| [excludePaths](exclude-paths.md) | [common]
var [excludePaths](exclude-paths.md): [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.md)<[Regex](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.text/-regex/index.md)>
Regexes for paths to exclude from this rate limiter | +| [rateLimitExceededHandler](rate-limit-exceeded-handler.md) | [common]
val [rateLimitExceededHandler](rate-limit-exceeded-handler.md): suspend ApplicationCall.([RateLimiterResponse.LimitedBy](../-rate-limiter-response/-limited-by/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)
The call handler for rate limited IPs, use to define the response for rate limited IPs. The default is to respond with 429 and appropriate X-RateLimit headers | +| [whiteListedAgents](white-listed-agents.md) | [common]
var [whiteListedAgents](white-listed-agents.md): [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.md)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)>
Any user-agents that are whitelisted, i.e. will be allowed through without rate limiting | +| [whiteListedHosts](white-listed-hosts.md) | [common]
var [whiteListedHosts](white-listed-hosts.md): [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.md)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)>
Any Hosts that are whitelisted, i.e. will be allowed through without rate limiting | +| [whiteListedPrincipals](white-listed-principals.md) | [common]
var [whiteListedPrincipals](white-listed-principals.md): [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.md)<Principal>
Any Principals that are whitelisted, i.e. will be allowed through without rate limiting | ## Functions - -| Name | Summary | -|---|---| +| Name | Summary | +|--------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [rateLimiter](rate-limiter.md) | [common]
fun [rateLimiter](rate-limiter.md)(configuration: [RateLimitingConfiguration.RateLimiterConfiguration](-rate-limiter-configuration/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/rate-limit-exceeded-handler.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/rate-limit-exceeded-handler.md index 8dd9f5d2..feb093c9 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/rate-limit-exceeded-handler.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/rate-limit-exceeded-handler.md @@ -1,20 +1,18 @@ --- title: rateLimitExceededHandler --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimitingConfiguration](index.md)/[rateLimitExceededHandler](rate-limit-exceeded-handler.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimitingConfiguration](index.md)/[rateLimitExceededHandler](rate-limit-exceeded-handler.md) # rateLimitExceededHandler - - [common]\ -val [rateLimitExceededHandler](rate-limit-exceeded-handler.md): suspend ApplicationCall.([RateLimiterResponse.LimitedBy](../-rate-limiter-response/-limited-by/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) - - +val [rateLimitExceededHandler](rate-limit-exceeded-handler.md): suspend +ApplicationCall.([RateLimiterResponse.LimitedBy](../-rate-limiter-response/-limited-by/index.md)) +-> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) -The call handler for rate limited IPs, use to define the response for rate limited IPs. The default is to respond with 429 and appropriate X-RateLimit headers +The call handler for rate limited IPs, use to define the response for rate limited IPs. The default is to respond with +429 and appropriate X-RateLimit headers diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/rate-limiter.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/rate-limiter.md index d2349aa2..f7b42e87 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/rate-limiter.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/rate-limiter.md @@ -1,16 +1,15 @@ --- title: rateLimiter --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimitingConfiguration](index.md)/[rateLimiter](rate-limiter.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimitingConfiguration](index.md)/[rateLimiter](rate-limiter.md) # rateLimiter - - [common]\ -fun [rateLimiter](rate-limiter.md)(configuration: [RateLimitingConfiguration.RateLimiterConfiguration](-rate-limiter-configuration/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) +fun [rateLimiter](rate-limiter.md)( +configuration: [RateLimitingConfiguration.RateLimiterConfiguration](-rate-limiter-configuration/index.md).() +-> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/white-listed-agents.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/white-listed-agents.md index 0af34d32..a2e2ec9b 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/white-listed-agents.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/white-listed-agents.md @@ -1,18 +1,14 @@ --- title: whiteListedAgents --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimitingConfiguration](index.md)/[whiteListedAgents](white-listed-agents.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimitingConfiguration](index.md)/[whiteListedAgents](white-listed-agents.md) # whiteListedAgents - - [common]\ -var [whiteListedAgents](white-listed-agents.md): [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.md)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)> - - +var [whiteListedAgents](white-listed-agents.md): [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.md) +<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)> Any user-agents that are whitelisted, i.e. will be allowed through without rate limiting diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/white-listed-hosts.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/white-listed-hosts.md index ae886ddf..b5a43397 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/white-listed-hosts.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/white-listed-hosts.md @@ -1,18 +1,14 @@ --- title: whiteListedHosts --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimitingConfiguration](index.md)/[whiteListedHosts](white-listed-hosts.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimitingConfiguration](index.md)/[whiteListedHosts](white-listed-hosts.md) # whiteListedHosts - - [common]\ -var [whiteListedHosts](white-listed-hosts.md): [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.md)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)> - - +var [whiteListedHosts](white-listed-hosts.md): [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.md) +<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)> Any Hosts that are whitelisted, i.e. will be allowed through without rate limiting diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/white-listed-principals.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/white-listed-principals.md index fc274dbf..6ed31220 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/white-listed-principals.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-configuration/white-listed-principals.md @@ -1,18 +1,14 @@ --- title: whiteListedPrincipals --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimitingConfiguration](index.md)/[whiteListedPrincipals](white-listed-principals.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimitingConfiguration](index.md)/[whiteListedPrincipals](white-listed-principals.md) # whiteListedPrincipals - - [common]\ -var [whiteListedPrincipals](white-listed-principals.md): [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.md)<Principal> - - +var [whiteListedPrincipals](white-listed-principals.md): [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.md) +<Principal> Any Principals that are whitelisted, i.e. will be allowed through without rate limiting diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-dsl/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-dsl/index.md index a8caf7fb..c6cb1d15 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-dsl/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting-dsl/index.md @@ -1,19 +1,14 @@ --- title: RateLimitingDsl --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimitingDsl](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](../index.md)/[RateLimitingDsl](index.md) # RateLimitingDsl - - [common]\ @[DslMarker](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-dsl-marker/index.md) - - annotation class [RateLimitingDsl](index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting.md index c9a91ca9..dd178623 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/-rate-limiting.md @@ -1,20 +1,17 @@ --- title: RateLimiting --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](index.md)/[RateLimiting](-rate-limiting.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](index.md)/[RateLimiting](-rate-limiting.md) # RateLimiting - - [common]\ -val [RateLimiting](-rate-limiting.md): RouteScopedPlugin<[RateLimitingConfiguration](-rate-limiting-configuration/index.md)> - - +val [RateLimiting](-rate-limiting.md): +RouteScopedPlugin<[RateLimitingConfiguration](-rate-limiting-configuration/index.md)> -Rate limiting plugin, apply to route to provide route scoped rate limiting, see [RateLimitingConfiguration](-rate-limiting-configuration/index.md) for details on how to configure +Rate limiting plugin, apply to route to provide route scoped rate limiting, +see [RateLimitingConfiguration](-rate-limiting-configuration/index.md) for details on how to configure diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/index.md index 09f33afe..a059b935 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/index.md @@ -1,30 +1,24 @@ --- title: io.github.flaxoos.ktor.server.plugins.ratelimiter --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](index.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.ratelimiter](index.md) # Package-level declarations - - ## Types - -| Name | Summary | -|---|---| -| [CallVolumeUnit](-call-volume-unit/index.md) | [common]
interface [CallVolumeUnit](-call-volume-unit/index.md) | -| [RateLimiter](-rate-limiter/index.md) | [common]
abstract class [RateLimiter](-rate-limiter/index.md) | -| [RateLimiterResponse](-rate-limiter-response/index.md) | [common]
interface [RateLimiterResponse](-rate-limiter-response/index.md) | -| [RateLimitingConfiguration](-rate-limiting-configuration/index.md) | [common]
class [RateLimitingConfiguration](-rate-limiting-configuration/index.md)
Rate limit plugin configuration. | -| [RateLimitingDsl](-rate-limiting-dsl/index.md) | [common]
@[DslMarker](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-dsl-marker/index.md)
annotation class [RateLimitingDsl](-rate-limiting-dsl/index.md) | - +| Name | Summary | +|--------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [CallVolumeUnit](-call-volume-unit/index.md) | [common]
interface [CallVolumeUnit](-call-volume-unit/index.md) | +| [RateLimiter](-rate-limiter/index.md) | [common]
abstract class [RateLimiter](-rate-limiter/index.md) | +| [RateLimiterResponse](-rate-limiter-response/index.md) | [common]
interface [RateLimiterResponse](-rate-limiter-response/index.md) | +| [RateLimitingConfiguration](-rate-limiting-configuration/index.md) | [common]
class [RateLimitingConfiguration](-rate-limiting-configuration/index.md)
Rate limit plugin configuration. | +| [RateLimitingDsl](-rate-limiting-dsl/index.md) | [common]
@[DslMarker](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-dsl-marker/index.md)
annotation class [RateLimitingDsl](-rate-limiting-dsl/index.md) | ## Properties - -| Name | Summary | -|---|---| +| Name | Summary | +|-----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [RateLimiting](-rate-limiting.md) | [common]
val [RateLimiting](-rate-limiting.md): RouteScopedPlugin<[RateLimitingConfiguration](-rate-limiting-configuration/index.md)>
Rate limiting plugin, apply to route to provide route scoped rate limiting, see [RateLimitingConfiguration](-rate-limiting-configuration/index.md) for details on how to configure | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager-configuration/-database-task-lock-manager-configuration.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager-configuration/-database-task-lock-manager-configuration.md index 5a7e7dd7..967d3d6d 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager-configuration/-database-task-lock-manager-configuration.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager-configuration/-database-task-lock-manager-configuration.md @@ -1,14 +1,11 @@ --- title: DatabaseTaskLockManagerConfiguration --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[DatabaseTaskLockManagerConfiguration](index.md)/[DatabaseTaskLockManagerConfiguration](-database-task-lock-manager-configuration.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[DatabaseTaskLockManagerConfiguration](index.md)/[DatabaseTaskLockManagerConfiguration](-database-task-lock-manager-configuration.md) # DatabaseTaskLockManagerConfiguration - - [common]\ constructor() diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager-configuration/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager-configuration/index.md index b05a0c8c..0eef73a9 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager-configuration/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager-configuration/index.md @@ -1,43 +1,38 @@ --- title: DatabaseTaskLockManagerConfiguration --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[DatabaseTaskLockManagerConfiguration](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[DatabaseTaskLockManagerConfiguration](index.md) # DatabaseTaskLockManagerConfiguration -abstract class [DatabaseTaskLockManagerConfiguration](index.md)<[DB_TASK_LOCK_KEY](index.md) : [DatabaseTaskLock](../-database-task-lock/index.md)> : [TaskLockManagerConfiguration](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager-configuration/index.md)<[DB_TASK_LOCK_KEY](index.md)> +abstract class [DatabaseTaskLockManagerConfiguration](index.md) +<[DB_TASK_LOCK_KEY](index.md) : [DatabaseTaskLock](../-database-task-lock/index.md) +> : [TaskLockManagerConfiguration](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager-configuration/index.md) +<[DB_TASK_LOCK_KEY](index.md)> #### Inheritors - -| | -|---| -| JdbcJobLockManagerConfiguration | +| | +|------------------------------------| +| JdbcJobLockManagerConfiguration | | MongoDBJobLockManagerConfiguration | - ## Constructors - -| | | -|---|---| +| | | +|--------------------------------------------------------------------------------------|---------------------------| | [DatabaseTaskLockManagerConfiguration](-database-task-lock-manager-configuration.md) | [common]
constructor() | - ## Properties - -| Name | Summary | -|---|---| +| Name | Summary | +|-----------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [name](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/name.md) | [common]
var [name](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?
The name of the task manager, will be used to identify the task manager when assigning tasks to it if none is provided, it will be considered the default one. only one default task manager is allowed. | - ## Functions - -| Name | Summary | -|---|---| +| Name | Summary | +|---------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [createTaskManager](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/create-task-manager.md) | [common]
abstract fun [createTaskManager](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/create-task-manager.md)(application: Application): [TaskManager](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/index.md)<out [TaskExecutionToken](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-execution-token/index.md)>
Create the [TaskManager](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/index.md) that this configuration is for | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager/-database-task-lock-manager.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager/-database-task-lock-manager.md index 3444dff4..21abd62a 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager/-database-task-lock-manager.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager/-database-task-lock-manager.md @@ -1,14 +1,11 @@ --- title: DatabaseTaskLockManager --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[DatabaseTaskLockManager](index.md)/[DatabaseTaskLockManager](-database-task-lock-manager.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[DatabaseTaskLockManager](index.md)/[DatabaseTaskLockManager](-database-task-lock-manager.md) # DatabaseTaskLockManager - - [common]\ constructor() diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager/acquire-lock-key.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager/acquire-lock-key.md index e480891a..00bf5b3e 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager/acquire-lock-key.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager/acquire-lock-key.md @@ -1,18 +1,15 @@ --- title: acquireLockKey --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[DatabaseTaskLockManager](index.md)/[acquireLockKey](acquire-lock-key.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[DatabaseTaskLockManager](index.md)/[acquireLockKey](acquire-lock-key.md) # acquireLockKey - - [common]\ -suspend override fun [acquireLockKey](acquire-lock-key.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), executionTime: DateTime, concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [DB_TASK_LOCK_KEY](index.md)? - - +suspend override fun [acquireLockKey](acquire-lock-key.md)( +task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), executionTime: DateTime, +concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [DB_TASK_LOCK_KEY](index.md)? Get permission to execute the task diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager/index.md index 3898b123..5d3f0df3 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager/index.md @@ -1,55 +1,50 @@ --- title: DatabaseTaskLockManager --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[DatabaseTaskLockManager](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[DatabaseTaskLockManager](index.md) # DatabaseTaskLockManager -abstract class [DatabaseTaskLockManager](index.md)<[DB_TASK_LOCK_KEY](index.md) : [DatabaseTaskLock](../-database-task-lock/index.md)> : [TaskLockManager](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/index.md)<[DB_TASK_LOCK_KEY](index.md)> - -An abstract implementation of [TaskLockManager](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/index.md) using a database as the lock store - +abstract class [DatabaseTaskLockManager](index.md) +<[DB_TASK_LOCK_KEY](index.md) : [DatabaseTaskLock](../-database-task-lock/index.md) +> : [TaskLockManager](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/index.md) +<[DB_TASK_LOCK_KEY](index.md)> +An abstract implementation +of [TaskLockManager](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/index.md) +using a database as the lock store #### Inheritors - -| | -|---| -| JdbcLockManager | +| | +|--------------------| +| JdbcLockManager | | MongoDBLockManager | - ## Constructors - -| | | -|---|---| +| | | +|-----------------------------------------------------------|---------------------------| | [DatabaseTaskLockManager](-database-task-lock-manager.md) | [common]
constructor() | - ## Properties - -| Name | Summary | -|---|---| -| [application](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/application.md) | [common]
abstract val [application](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/application.md): Application | -| [name](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/name.md) | [common]
abstract val [name](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/name.md): [TaskManagerConfiguration.TaskManagerName](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md) | - +| Name | Summary | +|-----------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [application](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/application.md) | [common]
abstract val [application](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/application.md): Application | +| [name](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/name.md) | [common]
abstract val [name](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/name.md): [TaskManagerConfiguration.TaskManagerName](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md) | ## Functions - -| Name | Summary | -|---|---| -| [acquireLockKey](acquire-lock-key.md) | [common]
suspend override fun [acquireLockKey](acquire-lock-key.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), executionTime: DateTime, concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [DB_TASK_LOCK_KEY](index.md)?
Get permission to execute the task | -| [attemptExecute](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/attempt-execute.md) | [common]
open suspend override fun [attemptExecute](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/attempt-execute.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), executionTime: DateTime, concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [DB_TASK_LOCK_KEY](index.md)?
Try executing the given task at the given execution time with the given concurrency index | -| [close](index.md#539526881%2FFunctions%2F1182336650) | [common]
expect abstract fun [close](index.md#539526881%2FFunctions%2F1182336650)() | -| [init](init.md) | [common]
suspend override fun [init](init.md)(tasks: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<[Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md)>)
Initialize the TaskManager with the given tasks it manages | -| [initTaskLockTable](init-task-lock-table.md) | [common]
abstract suspend fun [initTaskLockTable](init-task-lock-table.md)()
Create the task lock key table in the database | -| [insertTaskLock](insert-task-lock.md) | [common]
abstract suspend fun [insertTaskLock](insert-task-lock.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), taskConcurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)
Insert a new task lock key into the database | -| [markExecuted](index.md#-1803818116%2FFunctions%2F1182336650) | [common]
open suspend override fun [markExecuted](index.md#-1803818116%2FFunctions%2F1182336650)(key: [DB_TASK_LOCK_KEY](index.md))
Mark this task as, provided a key was acquired | -| [updateTaskLock](update-task-lock.md) | [common]
abstract suspend fun [updateTaskLock](update-task-lock.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), executionTime: DateTime): [DB_TASK_LOCK_KEY](index.md)?
Try to update the task lock entry in the database, where the key is the combination of task name and concurrency index and execution time different from the given execution time, returning the updated entry or null if none was updated | +| Name | Summary | +|----------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [acquireLockKey](acquire-lock-key.md) | [common]
suspend override fun [acquireLockKey](acquire-lock-key.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), executionTime: DateTime, concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [DB_TASK_LOCK_KEY](index.md)?
Get permission to execute the task | +| [attemptExecute](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/attempt-execute.md) | [common]
open suspend override fun [attemptExecute](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/attempt-execute.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), executionTime: DateTime, concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [DB_TASK_LOCK_KEY](index.md)?
Try executing the given task at the given execution time with the given concurrency index | +| [close](index.md#539526881%2FFunctions%2F1182336650) | [common]
expect abstract fun [close](index.md#539526881%2FFunctions%2F1182336650)() | +| [init](init.md) | [common]
suspend override fun [init](init.md)(tasks: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<[Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md)>)
Initialize the TaskManager with the given tasks it manages | +| [initTaskLockTable](init-task-lock-table.md) | [common]
abstract suspend fun [initTaskLockTable](init-task-lock-table.md)()
Create the task lock key table in the database | +| [insertTaskLock](insert-task-lock.md) | [common]
abstract suspend fun [insertTaskLock](insert-task-lock.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), taskConcurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)
Insert a new task lock key into the database | +| [markExecuted](index.md#-1803818116%2FFunctions%2F1182336650) | [common]
open suspend override fun [markExecuted](index.md#-1803818116%2FFunctions%2F1182336650)(key: [DB_TASK_LOCK_KEY](index.md))
Mark this task as, provided a key was acquired | +| [updateTaskLock](update-task-lock.md) | [common]
abstract suspend fun [updateTaskLock](update-task-lock.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), executionTime: DateTime): [DB_TASK_LOCK_KEY](index.md)?
Try to update the task lock entry in the database, where the key is the combination of task name and concurrency index and execution time different from the given execution time, returning the updated entry or null if none was updated | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager/init-task-lock-table.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager/init-task-lock-table.md index f285afcf..bf9af4ec 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager/init-task-lock-table.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager/init-task-lock-table.md @@ -1,19 +1,14 @@ --- title: initTaskLockTable --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[DatabaseTaskLockManager](index.md)/[initTaskLockTable](init-task-lock-table.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[DatabaseTaskLockManager](index.md)/[initTaskLockTable](init-task-lock-table.md) # initTaskLockTable - - [common]\ abstract suspend fun [initTaskLockTable](init-task-lock-table.md)() - - Create the task lock key table in the database diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager/init.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager/init.md index 90d226a3..ac3a7da2 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager/init.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager/init.md @@ -1,18 +1,15 @@ --- title: init --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[DatabaseTaskLockManager](index.md)/[init](init.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[DatabaseTaskLockManager](index.md)/[init](init.md) # init - - [common]\ -suspend override fun [init](init.md)(tasks: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<[Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md)>) - - +suspend override fun [init](init.md)( +tasks: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md) +<[Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md)>) Initialize the TaskManager with the given tasks it manages diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager/insert-task-lock.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager/insert-task-lock.md index d9aa3f2f..b4c63a4c 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager/insert-task-lock.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager/insert-task-lock.md @@ -1,18 +1,15 @@ --- title: insertTaskLock --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[DatabaseTaskLockManager](index.md)/[insertTaskLock](insert-task-lock.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[DatabaseTaskLockManager](index.md)/[insertTaskLock](insert-task-lock.md) # insertTaskLock - - [common]\ -abstract suspend fun [insertTaskLock](insert-task-lock.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), taskConcurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md) - - +abstract suspend fun [insertTaskLock](insert-task-lock.md)( +task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), +taskConcurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md) Insert a new task lock key into the database diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager/update-task-lock.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager/update-task-lock.md index d3a26378..3f56ee31 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager/update-task-lock.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager/update-task-lock.md @@ -1,20 +1,19 @@ --- title: updateTaskLock --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[DatabaseTaskLockManager](index.md)/[updateTaskLock](update-task-lock.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[DatabaseTaskLockManager](index.md)/[updateTaskLock](update-task-lock.md) # updateTaskLock - - [common]\ -abstract suspend fun [updateTaskLock](update-task-lock.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), executionTime: DateTime): [DB_TASK_LOCK_KEY](index.md)? - - +abstract suspend fun [updateTaskLock](update-task-lock.md)( +task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), +concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), executionTime: +DateTime): [DB_TASK_LOCK_KEY](index.md)? -Try to update the task lock entry in the database, where the key is the combination of task name and concurrency index and execution time different from the given execution time, returning the updated entry or null if none was updated +Try to update the task lock entry in the database, where the key is the combination of task name and concurrency index +and execution time different from the given execution time, returning the updated entry or null if none was updated diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock/index.md index 6390f6ed..6f21d531 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock/index.md @@ -1,9 +1,8 @@ --- title: DatabaseTaskLock --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[DatabaseTaskLock](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[DatabaseTaskLock](index.md) # DatabaseTaskLock @@ -11,19 +10,16 @@ interface [DatabaseTaskLock](index.md) : [TaskLock](../../io.github.flaxoos.ktor #### Inheritors - -| | -|---| -| JdbcTaskLock | +| | +|-----------------| +| JdbcTaskLock | | MongoDbTaskLock | - ## Properties - -| Name | Summary | -|---|---| +| Name | Summary | +|------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [concurrencyIndex](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-execution-token/concurrency-index.md) | [common]
abstract val [concurrencyIndex](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-execution-token/concurrency-index.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) | -| [lockedAt](locked-at.md) | [common]
abstract val [lockedAt](locked-at.md): DateTime | -| [name](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-execution-token/name.md) | [common]
abstract val [name](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-execution-token/name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | +| [lockedAt](locked-at.md) | [common]
abstract val [lockedAt](locked-at.md): DateTime | +| [name](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-execution-token/name.md) | [common]
abstract val [name](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-execution-token/name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock/locked-at.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock/locked-at.md index 4171f34b..b6df0062 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock/locked-at.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock/locked-at.md @@ -1,14 +1,11 @@ --- title: lockedAt --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[DatabaseTaskLock](index.md)/[lockedAt](locked-at.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[DatabaseTaskLock](index.md)/[lockedAt](locked-at.md) # lockedAt - - [common]\ abstract val [lockedAt](locked-at.md): DateTime diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-exposed-task-lock-table/-exposed-task-lock-table.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-exposed-task-lock-table/-exposed-task-lock-table.md index 59c4a793..570616e5 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-exposed-task-lock-table/-exposed-task-lock-table.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-exposed-task-lock-table/-exposed-task-lock-table.md @@ -1,14 +1,11 @@ --- title: ExposedTaskLockTable --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[ExposedTaskLockTable](index.md)/[ExposedTaskLockTable](-exposed-task-lock-table.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[ExposedTaskLockTable](index.md)/[ExposedTaskLockTable](-exposed-task-lock-table.md) # ExposedTaskLockTable - - [jvm]\ constructor(tableName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-exposed-task-lock-table/concurrency-index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-exposed-task-lock-table/concurrency-index.md index ca1d14de..8991805e 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-exposed-task-lock-table/concurrency-index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-exposed-task-lock-table/concurrency-index.md @@ -1,16 +1,14 @@ --- title: concurrencyIndex --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[ExposedTaskLockTable](index.md)/[concurrencyIndex](concurrency-index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[ExposedTaskLockTable](index.md)/[concurrencyIndex](concurrency-index.md) # concurrencyIndex - - [jvm]\ -abstract val [concurrencyIndex](concurrency-index.md): Column<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)> +abstract val [concurrencyIndex](concurrency-index.md): +Column<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)> diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-exposed-task-lock-table/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-exposed-task-lock-table/index.md index 174859ff..31986805 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-exposed-task-lock-table/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-exposed-task-lock-table/index.md @@ -1,112 +1,103 @@ --- title: ExposedTaskLockTable --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[ExposedTaskLockTable](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[ExposedTaskLockTable](index.md) # ExposedTaskLockTable - - [jvm]\ -abstract class [ExposedTaskLockTable](index.md)(tableName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)) : Table - - +abstract class [ExposedTaskLockTable](index.md)( +tableName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)) : Table ## Constructors - -| | | -|---|---| +| | | +|-----------------------------------------------------|-----------------------------------------------------------------------------------------------------------------| | [ExposedTaskLockTable](-exposed-task-lock-table.md) | [jvm]
constructor(tableName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)) | - ## Properties - -| Name | Summary | -|---|---| -| [autoIncColumn](index.md#-119017270%2FProperties%2F1975120172) | [jvm]
val [autoIncColumn](index.md#-119017270%2FProperties%2F1975120172): Column<*>? | -| [columns](index.md#-527477422%2FProperties%2F1975120172) | [jvm]
open override val [columns](index.md#-527477422%2FProperties%2F1975120172): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<Column<*>> | -| [concurrencyIndex](concurrency-index.md) | [jvm]
abstract val [concurrencyIndex](concurrency-index.md): Column<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)> | -| [ddl](index.md#-98631389%2FProperties%2F1975120172) | [jvm]
val [ddl](index.md#-98631389%2FProperties%2F1975120172): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)> | -| [fields](index.md#1767535600%2FProperties%2F1975120172) | [jvm]
open override val [fields](index.md#1767535600%2FProperties%2F1975120172): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<Expression<*>> | -| [foreignKeys](index.md#-1277801049%2FProperties%2F1975120172) | [jvm]
val [foreignKeys](index.md#-1277801049%2FProperties%2F1975120172): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<ForeignKeyConstraint> | -| [indices](index.md#-1684006712%2FProperties%2F1975120172) | [jvm]
val [indices](index.md#-1684006712%2FProperties%2F1975120172): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<Index> | -| [lockedAt](locked-at.md) | [jvm]
abstract val [lockedAt](locked-at.md): Column<Instant> | -| [name](name.md) | [jvm]
abstract val [name](name.md): Column<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)> | -| [primaryKey](index.md#-479487666%2FProperties%2F1975120172) | [jvm]
open val [primaryKey](index.md#-479487666%2FProperties%2F1975120172): Table.PrimaryKey? | -| [realFields](index.md#-1960918000%2FProperties%2F1975120172) | [jvm]
open val [realFields](index.md#-1960918000%2FProperties%2F1975120172): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<Expression<*>> | -| [schemaName](index.md#441115999%2FProperties%2F1975120172) | [jvm]
val [schemaName](index.md#441115999%2FProperties%2F1975120172): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? | -| [source](index.md#1676246222%2FProperties%2F1975120172) | [jvm]
open override val [source](index.md#1676246222%2FProperties%2F1975120172): ColumnSet | -| [tableName](index.md#886371510%2FProperties%2F1975120172) | [jvm]
open val [tableName](index.md#886371510%2FProperties%2F1975120172): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | - +| Name | Summary | +|----------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [autoIncColumn](index.md#-119017270%2FProperties%2F1975120172) | [jvm]
val [autoIncColumn](index.md#-119017270%2FProperties%2F1975120172): Column<*>? | +| [columns](index.md#-527477422%2FProperties%2F1975120172) | [jvm]
open override val [columns](index.md#-527477422%2FProperties%2F1975120172): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<Column<*>> | +| [concurrencyIndex](concurrency-index.md) | [jvm]
abstract val [concurrencyIndex](concurrency-index.md): Column<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)> | +| [ddl](index.md#-98631389%2FProperties%2F1975120172) | [jvm]
val [ddl](index.md#-98631389%2FProperties%2F1975120172): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)> | +| [fields](index.md#1767535600%2FProperties%2F1975120172) | [jvm]
open override val [fields](index.md#1767535600%2FProperties%2F1975120172): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<Expression<*>> | +| [foreignKeys](index.md#-1277801049%2FProperties%2F1975120172) | [jvm]
val [foreignKeys](index.md#-1277801049%2FProperties%2F1975120172): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<ForeignKeyConstraint> | +| [indices](index.md#-1684006712%2FProperties%2F1975120172) | [jvm]
val [indices](index.md#-1684006712%2FProperties%2F1975120172): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<Index> | +| [lockedAt](locked-at.md) | [jvm]
abstract val [lockedAt](locked-at.md): Column<Instant> | +| [name](name.md) | [jvm]
abstract val [name](name.md): Column<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)> | +| [primaryKey](index.md#-479487666%2FProperties%2F1975120172) | [jvm]
open val [primaryKey](index.md#-479487666%2FProperties%2F1975120172): Table.PrimaryKey? | +| [realFields](index.md#-1960918000%2FProperties%2F1975120172) | [jvm]
open val [realFields](index.md#-1960918000%2FProperties%2F1975120172): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<Expression<*>> | +| [schemaName](index.md#441115999%2FProperties%2F1975120172) | [jvm]
val [schemaName](index.md#441115999%2FProperties%2F1975120172): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? | +| [source](index.md#1676246222%2FProperties%2F1975120172) | [jvm]
open override val [source](index.md#1676246222%2FProperties%2F1975120172): ColumnSet | +| [tableName](index.md#886371510%2FProperties%2F1975120172) | [jvm]
open val [tableName](index.md#886371510%2FProperties%2F1975120172): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | ## Functions - -| Name | Summary | -|---|---| -| [autoGenerate](index.md#1908081876%2FExtensions%2F1975120172) | [jvm]
fun Column<[UUID](https://docs.oracle.com/javase/8/docs/api/java/util/UUID.md)>.[autoGenerate](index.md#1908081876%2FExtensions%2F1975120172)(): Column<[UUID](https://docs.oracle.com/javase/8/docs/api/java/util/UUID.md)> | -| [autoinc](index.md#1325297933%2FExtensions%2F1975120172) | [jvm]
fun <[N](index.md#1325297933%2FExtensions%2F1975120172) : [Comparable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.md)<[N](index.md#1325297933%2FExtensions%2F1975120172)>> Column<EntityID<[N](index.md#1325297933%2FExtensions%2F1975120172)>>.[autoinc](index.md#1325297933%2FExtensions%2F1975120172)(idSeqName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?): Column<EntityID<[N](index.md#1325297933%2FExtensions%2F1975120172)>> | -| [autoIncrement](index.md#1732389443%2FExtensions%2F1975120172) | [jvm]
fun <[N](index.md#1732389443%2FExtensions%2F1975120172) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)> Column<[N](index.md#1732389443%2FExtensions%2F1975120172)>.[autoIncrement](index.md#1732389443%2FExtensions%2F1975120172)(idSeqName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?): Column<[N](index.md#1732389443%2FExtensions%2F1975120172)> | -| [binary](index.md#1058154362%2FFunctions%2F1975120172) | [jvm]
fun [binary](index.md#1058154362%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): Column<[ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.md)>
fun [binary](index.md#547677603%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), length: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): Column<[ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.md)> | -| [blob](index.md#62882454%2FFunctions%2F1975120172) | [jvm]
fun [blob](index.md#62882454%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): Column<ExposedBlob> | -| [bool](index.md#-2086032349%2FFunctions%2F1975120172) | [jvm]
fun [bool](index.md#-2086032349%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): Column<[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)> | -| [byte](index.md#913984449%2FFunctions%2F1975120172) | [jvm]
fun [byte](index.md#913984449%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): Column<[Byte](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte/index.md)> | -| [char](index.md#-1525656689%2FFunctions%2F1975120172) | [jvm]
fun [char](index.md#-1525656689%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): Column<[Char](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char/index.md)>
fun [char](index.md#1285168752%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), length: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), collate: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?): Column<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)> | -| [check](index.md#1203492787%2FFunctions%2F1975120172) | [jvm]
fun [check](index.md#1203492787%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), op: SqlExpressionBuilder.() -> Op<[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)>) | -| [check](index.md#-467711850%2FExtensions%2F1975120172) | [jvm]
fun <[T](index.md#-467711850%2FExtensions%2F1975120172)> Column<[T](index.md#-467711850%2FExtensions%2F1975120172)>.[check](index.md#-467711850%2FExtensions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), op: SqlExpressionBuilder.(Column<[T](index.md#-467711850%2FExtensions%2F1975120172)>) -> Op<[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)>): Column<[T](index.md#-467711850%2FExtensions%2F1975120172)> | -| [clientDefault](index.md#1445495208%2FExtensions%2F1975120172) | [jvm]
fun <[T](index.md#1445495208%2FExtensions%2F1975120172)> Column<[T](index.md#1445495208%2FExtensions%2F1975120172)>.[clientDefault](index.md#1445495208%2FExtensions%2F1975120172)(defaultValue: () -> [T](index.md#1445495208%2FExtensions%2F1975120172)): Column<[T](index.md#1445495208%2FExtensions%2F1975120172)> | -| [createStatement](index.md#1499019292%2FFunctions%2F1975120172) | [jvm]
open override fun [createStatement](index.md#1499019292%2FFunctions%2F1975120172)(): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)> | -| [crossJoin](index.md#-134578527%2FFunctions%2F1975120172) | [jvm]
open infix override fun [crossJoin](index.md#-134578527%2FFunctions%2F1975120172)(otherTable: ColumnSet): Join | -| [customEnumeration](index.md#67934265%2FFunctions%2F1975120172) | [jvm]
fun <[T](index.md#67934265%2FFunctions%2F1975120172) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.md)<[T](index.md#67934265%2FFunctions%2F1975120172)>> [customEnumeration](index.md#67934265%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), sql: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?, fromDb: ([Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)) -> [T](index.md#67934265%2FFunctions%2F1975120172), toDb: ([T](index.md#67934265%2FFunctions%2F1975120172)) -> [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)): Column<[T](index.md#67934265%2FFunctions%2F1975120172)> | -| [databaseGenerated](index.md#-1946041873%2FExtensions%2F1975120172) | [jvm]
fun <[T](index.md#-1946041873%2FExtensions%2F1975120172)> Column<[T](index.md#-1946041873%2FExtensions%2F1975120172)>.[databaseGenerated](index.md#-1946041873%2FExtensions%2F1975120172)(): Column<[T](index.md#-1946041873%2FExtensions%2F1975120172)> | -| [decimal](index.md#650705094%2FFunctions%2F1975120172) | [jvm]
fun [decimal](index.md#650705094%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), precision: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), scale: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): Column<[BigDecimal](https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.md)> | -| [default](index.md#-1554466462%2FExtensions%2F1975120172) | [jvm]
fun <[T](index.md#-1554466462%2FExtensions%2F1975120172)> Column<[T](index.md#-1554466462%2FExtensions%2F1975120172)>.[default](index.md#-1554466462%2FExtensions%2F1975120172)(defaultValue: [T](index.md#-1554466462%2FExtensions%2F1975120172)): Column<[T](index.md#-1554466462%2FExtensions%2F1975120172)>
fun <[T](index.md#-1018229975%2FExtensions%2F1975120172)> CompositeColumn<[T](index.md#-1018229975%2FExtensions%2F1975120172)>.[default](index.md#-1018229975%2FExtensions%2F1975120172)(defaultValue: [T](index.md#-1018229975%2FExtensions%2F1975120172)): CompositeColumn<[T](index.md#-1018229975%2FExtensions%2F1975120172)> | -| [defaultExpression](index.md#-1090095358%2FExtensions%2F1975120172) | [jvm]
fun <[T](index.md#-1090095358%2FExtensions%2F1975120172)> Column<[T](index.md#-1090095358%2FExtensions%2F1975120172)>.[defaultExpression](index.md#-1090095358%2FExtensions%2F1975120172)(defaultValue: Expression<[T](index.md#-1090095358%2FExtensions%2F1975120172)>): Column<[T](index.md#-1090095358%2FExtensions%2F1975120172)> | -| [describe](index.md#304080744%2FFunctions%2F1975120172) | [jvm]
open override fun [describe](index.md#304080744%2FFunctions%2F1975120172)(s: Transaction, queryBuilder: QueryBuilder) | -| [double](index.md#638663498%2FFunctions%2F1975120172) | [jvm]
fun [double](index.md#638663498%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): Column<[Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.md)> | -| [dropStatement](index.md#-1545038385%2FFunctions%2F1975120172) | [jvm]
open override fun [dropStatement](index.md#-1545038385%2FFunctions%2F1975120172)(): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)> | -| [entityId](index.md#-1176101151%2FFunctions%2F1975120172) | [jvm]
fun <[ID](index.md#-1176101151%2FFunctions%2F1975120172) : [Comparable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.md)<[ID](index.md#-1176101151%2FFunctions%2F1975120172)>> [entityId](index.md#-1176101151%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), table: IdTable<[ID](index.md#-1176101151%2FFunctions%2F1975120172)>): Column<EntityID<[ID](index.md#-1176101151%2FFunctions%2F1975120172)>>
fun <[ID](index.md#1579776871%2FFunctions%2F1975120172) : [Comparable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.md)<[ID](index.md#1579776871%2FFunctions%2F1975120172)>> [entityId](index.md#1579776871%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), originalColumn: Column<[ID](index.md#1579776871%2FFunctions%2F1975120172)>): Column<EntityID<[ID](index.md#1579776871%2FFunctions%2F1975120172)>> | -| [entityId](index.md#1298102606%2FExtensions%2F1975120172) | [jvm]
fun <[T](index.md#1298102606%2FExtensions%2F1975120172) : [Comparable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.md)<[T](index.md#1298102606%2FExtensions%2F1975120172)>> Column<[T](index.md#1298102606%2FExtensions%2F1975120172)>.[entityId](index.md#1298102606%2FExtensions%2F1975120172)(): Column<EntityID<[T](index.md#1298102606%2FExtensions%2F1975120172)>> | -| [enumeration](index.md#-1375150884%2FFunctions%2F1975120172) | [jvm]
inline fun <[T](index.md#-1375150884%2FFunctions%2F1975120172) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.md)<[T](index.md#-1375150884%2FFunctions%2F1975120172)>> [enumeration](index.md#-1375150884%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): Column<[T](index.md#-1375150884%2FFunctions%2F1975120172)>
fun <[T](index.md#310280626%2FFunctions%2F1975120172) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.md)<[T](index.md#310280626%2FFunctions%2F1975120172)>> [enumeration](index.md#310280626%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), klass: [KClass](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.md)<[T](index.md#310280626%2FFunctions%2F1975120172)>): Column<[T](index.md#310280626%2FFunctions%2F1975120172)> | -| [enumerationByName](index.md#-2069184673%2FFunctions%2F1975120172) | [jvm]
inline fun <[T](index.md#-2069184673%2FFunctions%2F1975120172) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.md)<[T](index.md#-2069184673%2FFunctions%2F1975120172)>> [enumerationByName](index.md#-2069184673%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), length: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): Column<[T](index.md#-2069184673%2FFunctions%2F1975120172)>
fun <[T](index.md#967420533%2FFunctions%2F1975120172) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.md)<[T](index.md#967420533%2FFunctions%2F1975120172)>> [enumerationByName](index.md#967420533%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), length: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), klass: [KClass](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.md)<[T](index.md#967420533%2FFunctions%2F1975120172)>): Column<[T](index.md#967420533%2FFunctions%2F1975120172)> | -| [equals](index.md#-1257999178%2FFunctions%2F1975120172) | [jvm]
open operator override fun [equals](index.md#-1257999178%2FFunctions%2F1975120172)(other: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)?): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md) | -| [float](index.md#-1280710735%2FFunctions%2F1975120172) | [jvm]
fun [float](index.md#-1280710735%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): Column<[Float](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.md)> | -| [foreignKey](index.md#753676639%2FFunctions%2F1975120172) | [jvm]
fun [foreignKey](index.md#753676639%2FFunctions%2F1975120172)(vararg references: [Pair](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.md)<Column<*>, Column<*>>, onUpdate: ReferenceOption?, onDelete: ReferenceOption?, name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?)
fun [foreignKey](index.md#-1550008214%2FFunctions%2F1975120172)(vararg from: Column<*>, target: Table.PrimaryKey, onUpdate: ReferenceOption?, onDelete: ReferenceOption?, name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?) | -| [fullJoin](index.md#-1482579372%2FFunctions%2F1975120172) | [jvm]
open infix override fun [fullJoin](index.md#-1482579372%2FFunctions%2F1975120172)(otherTable: ColumnSet): Join | -| [hashCode](index.md#-822775952%2FFunctions%2F1975120172) | [jvm]
open override fun [hashCode](index.md#-822775952%2FFunctions%2F1975120172)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) | -| [index](index.md#977532225%2FFunctions%2F1975120172) | [jvm]
fun [index](index.md#977532225%2FFunctions%2F1975120172)(isUnique: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md), vararg columns: Column<*>)
fun [index](index.md#-89973378%2FFunctions%2F1975120172)(customIndexName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?, isUnique: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md), vararg columns: Column<*>, functions: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<ExpressionWithColumnType<*>>?, indexType: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?, filterCondition: FilterCondition) | -| [index](index.md#-1206961544%2FExtensions%2F1975120172) | [jvm]
fun <[T](index.md#-1206961544%2FExtensions%2F1975120172)> Column<[T](index.md#-1206961544%2FExtensions%2F1975120172)>.[index](index.md#-1206961544%2FExtensions%2F1975120172)(customIndexName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?, isUnique: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)): Column<[T](index.md#-1206961544%2FExtensions%2F1975120172)> | -| [innerJoin](index.md#907117751%2FFunctions%2F1975120172) | [jvm]
open infix override fun [innerJoin](index.md#907117751%2FFunctions%2F1975120172)(otherTable: ColumnSet): Join | -| [integer](index.md#-1079359085%2FFunctions%2F1975120172) | [jvm]
fun [integer](index.md#-1079359085%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): Column<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)> | -| [join](index.md#-759475769%2FFunctions%2F1975120172) | [jvm]
open override fun [join](index.md#-759475769%2FFunctions%2F1975120172)(otherTable: ColumnSet, joinType: JoinType, onColumn: Expression<*>?, otherColumn: Expression<*>?, additionalConstraint: SqlExpressionBuilder.() -> Op<[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)>?): Join | -| [largeText](index.md#-831337277%2FFunctions%2F1975120172) | [jvm]
fun [largeText](index.md#-831337277%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), collate: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?, eagerLoading: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)): Column<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)> | -| [leftJoin](index.md#-2030280756%2FFunctions%2F1975120172) | [jvm]
open infix override fun [leftJoin](index.md#-2030280756%2FFunctions%2F1975120172)(otherTable: ColumnSet): Join | -| [long](index.md#-1988429259%2FFunctions%2F1975120172) | [jvm]
fun [long](index.md#-1988429259%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): Column<[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)> | -| [mediumText](index.md#-326748191%2FFunctions%2F1975120172) | [jvm]
fun [mediumText](index.md#-326748191%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), collate: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?, eagerLoading: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)): Column<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)> | -| [modifyStatement](index.md#1323802714%2FFunctions%2F1975120172) | [jvm]
open override fun [modifyStatement](index.md#1323802714%2FFunctions%2F1975120172)(): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)> | -| [nameInDatabaseCase](index.md#496714128%2FFunctions%2F1975120172) | [jvm]
fun [nameInDatabaseCase](index.md#496714128%2FFunctions%2F1975120172)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | -| [nameInDatabaseCaseUnquoted](index.md#207155279%2FFunctions%2F1975120172) | [jvm]
fun [nameInDatabaseCaseUnquoted](index.md#207155279%2FFunctions%2F1975120172)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | -| [nullable](index.md#1935788434%2FExtensions%2F1975120172) | [jvm]
fun <[T](index.md#1935788434%2FExtensions%2F1975120172) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md), [C](index.md#1935788434%2FExtensions%2F1975120172) : CompositeColumn<[T](index.md#1935788434%2FExtensions%2F1975120172)>> [C](index.md#1935788434%2FExtensions%2F1975120172).[nullable](index.md#1935788434%2FExtensions%2F1975120172)(): CompositeColumn<[T](index.md#1935788434%2FExtensions%2F1975120172)?>
fun <[T](index.md#1445138239%2FExtensions%2F1975120172) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)> Column<[T](index.md#1445138239%2FExtensions%2F1975120172)>.[nullable](index.md#1445138239%2FExtensions%2F1975120172)(): Column<[T](index.md#1445138239%2FExtensions%2F1975120172)?> | -| [optReference](index.md#-930485673%2FFunctions%2F1975120172) | [jvm]
fun <[T](index.md#-930485673%2FFunctions%2F1975120172) : [Comparable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.md)<[T](index.md#-930485673%2FFunctions%2F1975120172)>> [optReference](index.md#-930485673%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), foreign: IdTable<[T](index.md#-930485673%2FFunctions%2F1975120172)>, onDelete: ReferenceOption?, onUpdate: ReferenceOption?, fkName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?): Column<EntityID<[T](index.md#-930485673%2FFunctions%2F1975120172)>?>
fun <[T](index.md#478693009%2FFunctions%2F1975120172) : [Comparable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.md)<[T](index.md#478693009%2FFunctions%2F1975120172)>> [optReference](index.md#478693009%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), refColumn: Column<[T](index.md#478693009%2FFunctions%2F1975120172)>, onDelete: ReferenceOption?, onUpdate: ReferenceOption?, fkName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?): Column<[T](index.md#478693009%2FFunctions%2F1975120172)?>
fun <[T](index.md#37241246%2FFunctions%2F1975120172) : [Comparable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.md)<[T](index.md#37241246%2FFunctions%2F1975120172)>, [E](index.md#37241246%2FFunctions%2F1975120172) : EntityID<[T](index.md#37241246%2FFunctions%2F1975120172)>> [optReference](index.md#37241246%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), refColumn: Column<[E](index.md#37241246%2FFunctions%2F1975120172)>, onDelete: ReferenceOption?, onUpdate: ReferenceOption?, fkName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?): Column<[E](index.md#37241246%2FFunctions%2F1975120172)?> | -| [reference](index.md#1107315878%2FFunctions%2F1975120172) | [jvm]
fun <[T](index.md#1107315878%2FFunctions%2F1975120172) : [Comparable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.md)<[T](index.md#1107315878%2FFunctions%2F1975120172)>> [reference](index.md#1107315878%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), foreign: IdTable<[T](index.md#1107315878%2FFunctions%2F1975120172)>, onDelete: ReferenceOption?, onUpdate: ReferenceOption?, fkName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?): Column<EntityID<[T](index.md#1107315878%2FFunctions%2F1975120172)>>
fun <[T](index.md#1148332128%2FFunctions%2F1975120172) : [Comparable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.md)<[T](index.md#1148332128%2FFunctions%2F1975120172)>> [reference](index.md#1148332128%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), refColumn: Column<[T](index.md#1148332128%2FFunctions%2F1975120172)>, onDelete: ReferenceOption?, onUpdate: ReferenceOption?, fkName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?): Column<[T](index.md#1148332128%2FFunctions%2F1975120172)>
fun <[T](index.md#-439391507%2FFunctions%2F1975120172) : [Comparable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.md)<[T](index.md#-439391507%2FFunctions%2F1975120172)>, [E](index.md#-439391507%2FFunctions%2F1975120172) : EntityID<[T](index.md#-439391507%2FFunctions%2F1975120172)>> [reference](index.md#-439391507%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), refColumn: Column<[E](index.md#-439391507%2FFunctions%2F1975120172)>, onDelete: ReferenceOption?, onUpdate: ReferenceOption?, fkName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?): Column<[E](index.md#-439391507%2FFunctions%2F1975120172)> | -| [references](index.md#1648963011%2FExtensions%2F1975120172) | [jvm]
infix fun <[T](index.md#1648963011%2FExtensions%2F1975120172) : [Comparable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.md)<[T](index.md#1648963011%2FExtensions%2F1975120172)>, [S](index.md#1648963011%2FExtensions%2F1975120172) : [T](index.md#1648963011%2FExtensions%2F1975120172), [C](index.md#1648963011%2FExtensions%2F1975120172) : Column<[S](index.md#1648963011%2FExtensions%2F1975120172)>> [C](index.md#1648963011%2FExtensions%2F1975120172).[references](index.md#1648963011%2FExtensions%2F1975120172)(ref: Column<[T](index.md#1648963011%2FExtensions%2F1975120172)>): [C](index.md#1648963011%2FExtensions%2F1975120172)
fun <[T](index.md#125179067%2FExtensions%2F1975120172) : [Comparable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.md)<[T](index.md#125179067%2FExtensions%2F1975120172)>, [S](index.md#125179067%2FExtensions%2F1975120172) : [T](index.md#125179067%2FExtensions%2F1975120172), [C](index.md#125179067%2FExtensions%2F1975120172) : Column<[S](index.md#125179067%2FExtensions%2F1975120172)>> [C](index.md#125179067%2FExtensions%2F1975120172).[references](index.md#125179067%2FExtensions%2F1975120172)(ref: Column<[T](index.md#125179067%2FExtensions%2F1975120172)>, onDelete: ReferenceOption?, onUpdate: ReferenceOption?, fkName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?): [C](index.md#125179067%2FExtensions%2F1975120172)
fun <[T](index.md#1785396338%2FExtensions%2F1975120172) : [Comparable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.md)<[T](index.md#1785396338%2FExtensions%2F1975120172)>, [S](index.md#1785396338%2FExtensions%2F1975120172) : [T](index.md#1785396338%2FExtensions%2F1975120172), [C](index.md#1785396338%2FExtensions%2F1975120172) : Column<[S](index.md#1785396338%2FExtensions%2F1975120172)>> [C](index.md#1785396338%2FExtensions%2F1975120172).[references](index.md#1785396338%2FExtensions%2F1975120172)(ref: Column<EntityID<[T](index.md#1785396338%2FExtensions%2F1975120172)>>, onDelete: ReferenceOption?, onUpdate: ReferenceOption?, fkName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?): [C](index.md#1785396338%2FExtensions%2F1975120172) | -| [registerColumn](index.md#-1341512564%2FFunctions%2F1975120172) | [jvm]
fun <[T](index.md#-1341512564%2FFunctions%2F1975120172)> [registerColumn](index.md#-1341512564%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), type: IColumnType): Column<[T](index.md#-1341512564%2FFunctions%2F1975120172)> | -| [registerCompositeColumn](index.md#1191287290%2FFunctions%2F1975120172) | [jvm]
fun <[R](index.md#1191287290%2FFunctions%2F1975120172), [T](index.md#1191287290%2FFunctions%2F1975120172) : CompositeColumn<[R](index.md#1191287290%2FFunctions%2F1975120172)>> [registerCompositeColumn](index.md#1191287290%2FFunctions%2F1975120172)(column: [T](index.md#1191287290%2FFunctions%2F1975120172)): [T](index.md#1191287290%2FFunctions%2F1975120172) | -| [replaceColumn](index.md#270889164%2FFunctions%2F1975120172) | [jvm]
fun <[TColumn](index.md#270889164%2FFunctions%2F1975120172) : Column<*>> [replaceColumn](index.md#270889164%2FFunctions%2F1975120172)(oldColumn: Column<*>, newColumn: [TColumn](index.md#270889164%2FFunctions%2F1975120172)): [TColumn](index.md#270889164%2FFunctions%2F1975120172) | -| [rightJoin](index.md#2072823933%2FFunctions%2F1975120172) | [jvm]
open infix override fun [rightJoin](index.md#2072823933%2FFunctions%2F1975120172)(otherTable: ColumnSet): Join | -| [short](index.md#56930769%2FFunctions%2F1975120172) | [jvm]
fun [short](index.md#56930769%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): Column<[Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.md)> | -| [slice](index.md#1462474289%2FFunctions%2F1975120172) | [jvm]
fun [slice](index.md#1462474289%2FFunctions%2F1975120172)(columns: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<Expression<*>>): FieldSet
fun [slice](index.md#-1167701894%2FFunctions%2F1975120172)(column: Expression<*>, vararg columns: Expression<*>): FieldSet | -| [text](index.md#-60221748%2FFunctions%2F1975120172) | [jvm]
fun [text](index.md#-60221748%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), collate: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?, eagerLoading: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)): Column<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)> | -| [ubyte](index.md#116876178%2FFunctions%2F1975120172) | [jvm]
fun [ubyte](index.md#116876178%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): Column<[UByte](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.md)> | -| [uinteger](index.md#-857680862%2FFunctions%2F1975120172) | [jvm]
fun [uinteger](index.md#-857680862%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): Column<[UInt](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.md)> | -| [ulong](index.md#1509429766%2FFunctions%2F1975120172) | [jvm]
fun [ulong](index.md#1509429766%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): Column<[ULong](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-long/index.md)> | -| [uniqueIndex](index.md#-1434313059%2FFunctions%2F1975120172) | [jvm]
fun [uniqueIndex](index.md#-1434313059%2FFunctions%2F1975120172)(vararg columns: Column<*>, filterCondition: FilterCondition)
fun [uniqueIndex](index.md#252970649%2FFunctions%2F1975120172)(customIndexName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?, vararg columns: Column<*>, functions: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<ExpressionWithColumnType<*>>?, filterCondition: FilterCondition) | -| [uniqueIndex](index.md#-17665861%2FExtensions%2F1975120172) | [jvm]
fun <[T](index.md#-17665861%2FExtensions%2F1975120172)> Column<[T](index.md#-17665861%2FExtensions%2F1975120172)>.[uniqueIndex](index.md#-17665861%2FExtensions%2F1975120172)(customIndexName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?): Column<[T](index.md#-17665861%2FExtensions%2F1975120172)> | -| [ushort](index.md#1116378144%2FFunctions%2F1975120172) | [jvm]
fun [ushort](index.md#1116378144%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): Column<[UShort](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.md)> | -| [uuid](index.md#154288180%2FFunctions%2F1975120172) | [jvm]
fun [uuid](index.md#154288180%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): Column<[UUID](https://docs.oracle.com/javase/8/docs/api/java/util/UUID.md)> | -| [varchar](index.md#1923632435%2FFunctions%2F1975120172) | [jvm]
fun [varchar](index.md#1923632435%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), length: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), collate: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?): Column<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)> | +| Name | Summary | +|---------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [autoGenerate](index.md#1908081876%2FExtensions%2F1975120172) | [jvm]
fun Column<[UUID](https://docs.oracle.com/javase/8/docs/api/java/util/UUID.md)>.[autoGenerate](index.md#1908081876%2FExtensions%2F1975120172)(): Column<[UUID](https://docs.oracle.com/javase/8/docs/api/java/util/UUID.md)> | +| [autoinc](index.md#1325297933%2FExtensions%2F1975120172) | [jvm]
fun <[N](index.md#1325297933%2FExtensions%2F1975120172) : [Comparable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.md)<[N](index.md#1325297933%2FExtensions%2F1975120172)>> Column<EntityID<[N](index.md#1325297933%2FExtensions%2F1975120172)>>.[autoinc](index.md#1325297933%2FExtensions%2F1975120172)(idSeqName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?): Column<EntityID<[N](index.md#1325297933%2FExtensions%2F1975120172)>> | +| [autoIncrement](index.md#1732389443%2FExtensions%2F1975120172) | [jvm]
fun <[N](index.md#1732389443%2FExtensions%2F1975120172) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)> Column<[N](index.md#1732389443%2FExtensions%2F1975120172)>.[autoIncrement](index.md#1732389443%2FExtensions%2F1975120172)(idSeqName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?): Column<[N](index.md#1732389443%2FExtensions%2F1975120172)> | +| [binary](index.md#1058154362%2FFunctions%2F1975120172) | [jvm]
fun [binary](index.md#1058154362%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): Column<[ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.md)>
fun [binary](index.md#547677603%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), length: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): Column<[ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.md)> | +| [blob](index.md#62882454%2FFunctions%2F1975120172) | [jvm]
fun [blob](index.md#62882454%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): Column<ExposedBlob> | +| [bool](index.md#-2086032349%2FFunctions%2F1975120172) | [jvm]
fun [bool](index.md#-2086032349%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): Column<[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)> | +| [byte](index.md#913984449%2FFunctions%2F1975120172) | [jvm]
fun [byte](index.md#913984449%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): Column<[Byte](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte/index.md)> | +| [char](index.md#-1525656689%2FFunctions%2F1975120172) | [jvm]
fun [char](index.md#-1525656689%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): Column<[Char](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char/index.md)>
fun [char](index.md#1285168752%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), length: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), collate: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?): Column<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)> | +| [check](index.md#1203492787%2FFunctions%2F1975120172) | [jvm]
fun [check](index.md#1203492787%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), op: SqlExpressionBuilder.() -> Op<[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)>) | +| [check](index.md#-467711850%2FExtensions%2F1975120172) | [jvm]
fun <[T](index.md#-467711850%2FExtensions%2F1975120172)> Column<[T](index.md#-467711850%2FExtensions%2F1975120172)>.[check](index.md#-467711850%2FExtensions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), op: SqlExpressionBuilder.(Column<[T](index.md#-467711850%2FExtensions%2F1975120172)>) -> Op<[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)>): Column<[T](index.md#-467711850%2FExtensions%2F1975120172)> | +| [clientDefault](index.md#1445495208%2FExtensions%2F1975120172) | [jvm]
fun <[T](index.md#1445495208%2FExtensions%2F1975120172)> Column<[T](index.md#1445495208%2FExtensions%2F1975120172)>.[clientDefault](index.md#1445495208%2FExtensions%2F1975120172)(defaultValue: () -> [T](index.md#1445495208%2FExtensions%2F1975120172)): Column<[T](index.md#1445495208%2FExtensions%2F1975120172)> | +| [createStatement](index.md#1499019292%2FFunctions%2F1975120172) | [jvm]
open override fun [createStatement](index.md#1499019292%2FFunctions%2F1975120172)(): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)> | +| [crossJoin](index.md#-134578527%2FFunctions%2F1975120172) | [jvm]
open infix override fun [crossJoin](index.md#-134578527%2FFunctions%2F1975120172)(otherTable: ColumnSet): Join | +| [customEnumeration](index.md#67934265%2FFunctions%2F1975120172) | [jvm]
fun <[T](index.md#67934265%2FFunctions%2F1975120172) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.md)<[T](index.md#67934265%2FFunctions%2F1975120172)>> [customEnumeration](index.md#67934265%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), sql: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?, fromDb: ([Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)) -> [T](index.md#67934265%2FFunctions%2F1975120172), toDb: ([T](index.md#67934265%2FFunctions%2F1975120172)) -> [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)): Column<[T](index.md#67934265%2FFunctions%2F1975120172)> | +| [databaseGenerated](index.md#-1946041873%2FExtensions%2F1975120172) | [jvm]
fun <[T](index.md#-1946041873%2FExtensions%2F1975120172)> Column<[T](index.md#-1946041873%2FExtensions%2F1975120172)>.[databaseGenerated](index.md#-1946041873%2FExtensions%2F1975120172)(): Column<[T](index.md#-1946041873%2FExtensions%2F1975120172)> | +| [decimal](index.md#650705094%2FFunctions%2F1975120172) | [jvm]
fun [decimal](index.md#650705094%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), precision: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), scale: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): Column<[BigDecimal](https://docs.oracle.com/javase/8/docs/api/java/math/BigDecimal.md)> | +| [default](index.md#-1554466462%2FExtensions%2F1975120172) | [jvm]
fun <[T](index.md#-1554466462%2FExtensions%2F1975120172)> Column<[T](index.md#-1554466462%2FExtensions%2F1975120172)>.[default](index.md#-1554466462%2FExtensions%2F1975120172)(defaultValue: [T](index.md#-1554466462%2FExtensions%2F1975120172)): Column<[T](index.md#-1554466462%2FExtensions%2F1975120172)>
fun <[T](index.md#-1018229975%2FExtensions%2F1975120172)> CompositeColumn<[T](index.md#-1018229975%2FExtensions%2F1975120172)>.[default](index.md#-1018229975%2FExtensions%2F1975120172)(defaultValue: [T](index.md#-1018229975%2FExtensions%2F1975120172)): CompositeColumn<[T](index.md#-1018229975%2FExtensions%2F1975120172)> | +| [defaultExpression](index.md#-1090095358%2FExtensions%2F1975120172) | [jvm]
fun <[T](index.md#-1090095358%2FExtensions%2F1975120172)> Column<[T](index.md#-1090095358%2FExtensions%2F1975120172)>.[defaultExpression](index.md#-1090095358%2FExtensions%2F1975120172)(defaultValue: Expression<[T](index.md#-1090095358%2FExtensions%2F1975120172)>): Column<[T](index.md#-1090095358%2FExtensions%2F1975120172)> | +| [describe](index.md#304080744%2FFunctions%2F1975120172) | [jvm]
open override fun [describe](index.md#304080744%2FFunctions%2F1975120172)(s: Transaction, queryBuilder: QueryBuilder) | +| [double](index.md#638663498%2FFunctions%2F1975120172) | [jvm]
fun [double](index.md#638663498%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): Column<[Double](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.md)> | +| [dropStatement](index.md#-1545038385%2FFunctions%2F1975120172) | [jvm]
open override fun [dropStatement](index.md#-1545038385%2FFunctions%2F1975120172)(): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)> | +| [entityId](index.md#-1176101151%2FFunctions%2F1975120172) | [jvm]
fun <[ID](index.md#-1176101151%2FFunctions%2F1975120172) : [Comparable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.md)<[ID](index.md#-1176101151%2FFunctions%2F1975120172)>> [entityId](index.md#-1176101151%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), table: IdTable<[ID](index.md#-1176101151%2FFunctions%2F1975120172)>): Column<EntityID<[ID](index.md#-1176101151%2FFunctions%2F1975120172)>>
fun <[ID](index.md#1579776871%2FFunctions%2F1975120172) : [Comparable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.md)<[ID](index.md#1579776871%2FFunctions%2F1975120172)>> [entityId](index.md#1579776871%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), originalColumn: Column<[ID](index.md#1579776871%2FFunctions%2F1975120172)>): Column<EntityID<[ID](index.md#1579776871%2FFunctions%2F1975120172)>> | +| [entityId](index.md#1298102606%2FExtensions%2F1975120172) | [jvm]
fun <[T](index.md#1298102606%2FExtensions%2F1975120172) : [Comparable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.md)<[T](index.md#1298102606%2FExtensions%2F1975120172)>> Column<[T](index.md#1298102606%2FExtensions%2F1975120172)>.[entityId](index.md#1298102606%2FExtensions%2F1975120172)(): Column<EntityID<[T](index.md#1298102606%2FExtensions%2F1975120172)>> | +| [enumeration](index.md#-1375150884%2FFunctions%2F1975120172) | [jvm]
inline fun <[T](index.md#-1375150884%2FFunctions%2F1975120172) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.md)<[T](index.md#-1375150884%2FFunctions%2F1975120172)>> [enumeration](index.md#-1375150884%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): Column<[T](index.md#-1375150884%2FFunctions%2F1975120172)>
fun <[T](index.md#310280626%2FFunctions%2F1975120172) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.md)<[T](index.md#310280626%2FFunctions%2F1975120172)>> [enumeration](index.md#310280626%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), klass: [KClass](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.md)<[T](index.md#310280626%2FFunctions%2F1975120172)>): Column<[T](index.md#310280626%2FFunctions%2F1975120172)> | +| [enumerationByName](index.md#-2069184673%2FFunctions%2F1975120172) | [jvm]
inline fun <[T](index.md#-2069184673%2FFunctions%2F1975120172) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.md)<[T](index.md#-2069184673%2FFunctions%2F1975120172)>> [enumerationByName](index.md#-2069184673%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), length: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): Column<[T](index.md#-2069184673%2FFunctions%2F1975120172)>
fun <[T](index.md#967420533%2FFunctions%2F1975120172) : [Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.md)<[T](index.md#967420533%2FFunctions%2F1975120172)>> [enumerationByName](index.md#967420533%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), length: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), klass: [KClass](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.md)<[T](index.md#967420533%2FFunctions%2F1975120172)>): Column<[T](index.md#967420533%2FFunctions%2F1975120172)> | +| [equals](index.md#-1257999178%2FFunctions%2F1975120172) | [jvm]
open operator override fun [equals](index.md#-1257999178%2FFunctions%2F1975120172)(other: [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)?): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md) | +| [float](index.md#-1280710735%2FFunctions%2F1975120172) | [jvm]
fun [float](index.md#-1280710735%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): Column<[Float](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.md)> | +| [foreignKey](index.md#753676639%2FFunctions%2F1975120172) | [jvm]
fun [foreignKey](index.md#753676639%2FFunctions%2F1975120172)(vararg references: [Pair](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-pair/index.md)<Column<*>, Column<*>>, onUpdate: ReferenceOption?, onDelete: ReferenceOption?, name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?)
fun [foreignKey](index.md#-1550008214%2FFunctions%2F1975120172)(vararg from: Column<*>, target: Table.PrimaryKey, onUpdate: ReferenceOption?, onDelete: ReferenceOption?, name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?) | +| [fullJoin](index.md#-1482579372%2FFunctions%2F1975120172) | [jvm]
open infix override fun [fullJoin](index.md#-1482579372%2FFunctions%2F1975120172)(otherTable: ColumnSet): Join | +| [hashCode](index.md#-822775952%2FFunctions%2F1975120172) | [jvm]
open override fun [hashCode](index.md#-822775952%2FFunctions%2F1975120172)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) | +| [index](index.md#977532225%2FFunctions%2F1975120172) | [jvm]
fun [index](index.md#977532225%2FFunctions%2F1975120172)(isUnique: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md), vararg columns: Column<*>)
fun [index](index.md#-89973378%2FFunctions%2F1975120172)(customIndexName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?, isUnique: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md), vararg columns: Column<*>, functions: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<ExpressionWithColumnType<*>>?, indexType: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?, filterCondition: FilterCondition) | +| [index](index.md#-1206961544%2FExtensions%2F1975120172) | [jvm]
fun <[T](index.md#-1206961544%2FExtensions%2F1975120172)> Column<[T](index.md#-1206961544%2FExtensions%2F1975120172)>.[index](index.md#-1206961544%2FExtensions%2F1975120172)(customIndexName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?, isUnique: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)): Column<[T](index.md#-1206961544%2FExtensions%2F1975120172)> | +| [innerJoin](index.md#907117751%2FFunctions%2F1975120172) | [jvm]
open infix override fun [innerJoin](index.md#907117751%2FFunctions%2F1975120172)(otherTable: ColumnSet): Join | +| [integer](index.md#-1079359085%2FFunctions%2F1975120172) | [jvm]
fun [integer](index.md#-1079359085%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): Column<[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)> | +| [join](index.md#-759475769%2FFunctions%2F1975120172) | [jvm]
open override fun [join](index.md#-759475769%2FFunctions%2F1975120172)(otherTable: ColumnSet, joinType: JoinType, onColumn: Expression<*>?, otherColumn: Expression<*>?, additionalConstraint: SqlExpressionBuilder.() -> Op<[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)>?): Join | +| [largeText](index.md#-831337277%2FFunctions%2F1975120172) | [jvm]
fun [largeText](index.md#-831337277%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), collate: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?, eagerLoading: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)): Column<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)> | +| [leftJoin](index.md#-2030280756%2FFunctions%2F1975120172) | [jvm]
open infix override fun [leftJoin](index.md#-2030280756%2FFunctions%2F1975120172)(otherTable: ColumnSet): Join | +| [long](index.md#-1988429259%2FFunctions%2F1975120172) | [jvm]
fun [long](index.md#-1988429259%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): Column<[Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)> | +| [mediumText](index.md#-326748191%2FFunctions%2F1975120172) | [jvm]
fun [mediumText](index.md#-326748191%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), collate: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?, eagerLoading: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)): Column<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)> | +| [modifyStatement](index.md#1323802714%2FFunctions%2F1975120172) | [jvm]
open override fun [modifyStatement](index.md#1323802714%2FFunctions%2F1975120172)(): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)> | +| [nameInDatabaseCase](index.md#496714128%2FFunctions%2F1975120172) | [jvm]
fun [nameInDatabaseCase](index.md#496714128%2FFunctions%2F1975120172)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | +| [nameInDatabaseCaseUnquoted](index.md#207155279%2FFunctions%2F1975120172) | [jvm]
fun [nameInDatabaseCaseUnquoted](index.md#207155279%2FFunctions%2F1975120172)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | +| [nullable](index.md#1935788434%2FExtensions%2F1975120172) | [jvm]
fun <[T](index.md#1935788434%2FExtensions%2F1975120172) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md), [C](index.md#1935788434%2FExtensions%2F1975120172) : CompositeColumn<[T](index.md#1935788434%2FExtensions%2F1975120172)>> [C](index.md#1935788434%2FExtensions%2F1975120172).[nullable](index.md#1935788434%2FExtensions%2F1975120172)(): CompositeColumn<[T](index.md#1935788434%2FExtensions%2F1975120172)?>
fun <[T](index.md#1445138239%2FExtensions%2F1975120172) : [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.md)> Column<[T](index.md#1445138239%2FExtensions%2F1975120172)>.[nullable](index.md#1445138239%2FExtensions%2F1975120172)(): Column<[T](index.md#1445138239%2FExtensions%2F1975120172)?> | +| [optReference](index.md#-930485673%2FFunctions%2F1975120172) | [jvm]
fun <[T](index.md#-930485673%2FFunctions%2F1975120172) : [Comparable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.md)<[T](index.md#-930485673%2FFunctions%2F1975120172)>> [optReference](index.md#-930485673%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), foreign: IdTable<[T](index.md#-930485673%2FFunctions%2F1975120172)>, onDelete: ReferenceOption?, onUpdate: ReferenceOption?, fkName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?): Column<EntityID<[T](index.md#-930485673%2FFunctions%2F1975120172)>?>
fun <[T](index.md#478693009%2FFunctions%2F1975120172) : [Comparable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.md)<[T](index.md#478693009%2FFunctions%2F1975120172)>> [optReference](index.md#478693009%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), refColumn: Column<[T](index.md#478693009%2FFunctions%2F1975120172)>, onDelete: ReferenceOption?, onUpdate: ReferenceOption?, fkName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?): Column<[T](index.md#478693009%2FFunctions%2F1975120172)?>
fun <[T](index.md#37241246%2FFunctions%2F1975120172) : [Comparable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.md)<[T](index.md#37241246%2FFunctions%2F1975120172)>, [E](index.md#37241246%2FFunctions%2F1975120172) : EntityID<[T](index.md#37241246%2FFunctions%2F1975120172)>> [optReference](index.md#37241246%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), refColumn: Column<[E](index.md#37241246%2FFunctions%2F1975120172)>, onDelete: ReferenceOption?, onUpdate: ReferenceOption?, fkName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?): Column<[E](index.md#37241246%2FFunctions%2F1975120172)?> | +| [reference](index.md#1107315878%2FFunctions%2F1975120172) | [jvm]
fun <[T](index.md#1107315878%2FFunctions%2F1975120172) : [Comparable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.md)<[T](index.md#1107315878%2FFunctions%2F1975120172)>> [reference](index.md#1107315878%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), foreign: IdTable<[T](index.md#1107315878%2FFunctions%2F1975120172)>, onDelete: ReferenceOption?, onUpdate: ReferenceOption?, fkName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?): Column<EntityID<[T](index.md#1107315878%2FFunctions%2F1975120172)>>
fun <[T](index.md#1148332128%2FFunctions%2F1975120172) : [Comparable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.md)<[T](index.md#1148332128%2FFunctions%2F1975120172)>> [reference](index.md#1148332128%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), refColumn: Column<[T](index.md#1148332128%2FFunctions%2F1975120172)>, onDelete: ReferenceOption?, onUpdate: ReferenceOption?, fkName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?): Column<[T](index.md#1148332128%2FFunctions%2F1975120172)>
fun <[T](index.md#-439391507%2FFunctions%2F1975120172) : [Comparable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.md)<[T](index.md#-439391507%2FFunctions%2F1975120172)>, [E](index.md#-439391507%2FFunctions%2F1975120172) : EntityID<[T](index.md#-439391507%2FFunctions%2F1975120172)>> [reference](index.md#-439391507%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), refColumn: Column<[E](index.md#-439391507%2FFunctions%2F1975120172)>, onDelete: ReferenceOption?, onUpdate: ReferenceOption?, fkName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?): Column<[E](index.md#-439391507%2FFunctions%2F1975120172)> | +| [references](index.md#1648963011%2FExtensions%2F1975120172) | [jvm]
infix fun <[T](index.md#1648963011%2FExtensions%2F1975120172) : [Comparable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.md)<[T](index.md#1648963011%2FExtensions%2F1975120172)>, [S](index.md#1648963011%2FExtensions%2F1975120172) : [T](index.md#1648963011%2FExtensions%2F1975120172), [C](index.md#1648963011%2FExtensions%2F1975120172) : Column<[S](index.md#1648963011%2FExtensions%2F1975120172)>> [C](index.md#1648963011%2FExtensions%2F1975120172).[references](index.md#1648963011%2FExtensions%2F1975120172)(ref: Column<[T](index.md#1648963011%2FExtensions%2F1975120172)>): [C](index.md#1648963011%2FExtensions%2F1975120172)
fun <[T](index.md#125179067%2FExtensions%2F1975120172) : [Comparable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.md)<[T](index.md#125179067%2FExtensions%2F1975120172)>, [S](index.md#125179067%2FExtensions%2F1975120172) : [T](index.md#125179067%2FExtensions%2F1975120172), [C](index.md#125179067%2FExtensions%2F1975120172) : Column<[S](index.md#125179067%2FExtensions%2F1975120172)>> [C](index.md#125179067%2FExtensions%2F1975120172).[references](index.md#125179067%2FExtensions%2F1975120172)(ref: Column<[T](index.md#125179067%2FExtensions%2F1975120172)>, onDelete: ReferenceOption?, onUpdate: ReferenceOption?, fkName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?): [C](index.md#125179067%2FExtensions%2F1975120172)
fun <[T](index.md#1785396338%2FExtensions%2F1975120172) : [Comparable](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-comparable/index.md)<[T](index.md#1785396338%2FExtensions%2F1975120172)>, [S](index.md#1785396338%2FExtensions%2F1975120172) : [T](index.md#1785396338%2FExtensions%2F1975120172), [C](index.md#1785396338%2FExtensions%2F1975120172) : Column<[S](index.md#1785396338%2FExtensions%2F1975120172)>> [C](index.md#1785396338%2FExtensions%2F1975120172).[references](index.md#1785396338%2FExtensions%2F1975120172)(ref: Column<EntityID<[T](index.md#1785396338%2FExtensions%2F1975120172)>>, onDelete: ReferenceOption?, onUpdate: ReferenceOption?, fkName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?): [C](index.md#1785396338%2FExtensions%2F1975120172) | +| [registerColumn](index.md#-1341512564%2FFunctions%2F1975120172) | [jvm]
fun <[T](index.md#-1341512564%2FFunctions%2F1975120172)> [registerColumn](index.md#-1341512564%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), type: IColumnType): Column<[T](index.md#-1341512564%2FFunctions%2F1975120172)> | +| [registerCompositeColumn](index.md#1191287290%2FFunctions%2F1975120172) | [jvm]
fun <[R](index.md#1191287290%2FFunctions%2F1975120172), [T](index.md#1191287290%2FFunctions%2F1975120172) : CompositeColumn<[R](index.md#1191287290%2FFunctions%2F1975120172)>> [registerCompositeColumn](index.md#1191287290%2FFunctions%2F1975120172)(column: [T](index.md#1191287290%2FFunctions%2F1975120172)): [T](index.md#1191287290%2FFunctions%2F1975120172) | +| [replaceColumn](index.md#270889164%2FFunctions%2F1975120172) | [jvm]
fun <[TColumn](index.md#270889164%2FFunctions%2F1975120172) : Column<*>> [replaceColumn](index.md#270889164%2FFunctions%2F1975120172)(oldColumn: Column<*>, newColumn: [TColumn](index.md#270889164%2FFunctions%2F1975120172)): [TColumn](index.md#270889164%2FFunctions%2F1975120172) | +| [rightJoin](index.md#2072823933%2FFunctions%2F1975120172) | [jvm]
open infix override fun [rightJoin](index.md#2072823933%2FFunctions%2F1975120172)(otherTable: ColumnSet): Join | +| [short](index.md#56930769%2FFunctions%2F1975120172) | [jvm]
fun [short](index.md#56930769%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): Column<[Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.md)> | +| [slice](index.md#1462474289%2FFunctions%2F1975120172) | [jvm]
fun [slice](index.md#1462474289%2FFunctions%2F1975120172)(columns: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<Expression<*>>): FieldSet
fun [slice](index.md#-1167701894%2FFunctions%2F1975120172)(column: Expression<*>, vararg columns: Expression<*>): FieldSet | +| [text](index.md#-60221748%2FFunctions%2F1975120172) | [jvm]
fun [text](index.md#-60221748%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), collate: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?, eagerLoading: [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)): Column<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)> | +| [ubyte](index.md#116876178%2FFunctions%2F1975120172) | [jvm]
fun [ubyte](index.md#116876178%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): Column<[UByte](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.md)> | +| [uinteger](index.md#-857680862%2FFunctions%2F1975120172) | [jvm]
fun [uinteger](index.md#-857680862%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): Column<[UInt](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.md)> | +| [ulong](index.md#1509429766%2FFunctions%2F1975120172) | [jvm]
fun [ulong](index.md#1509429766%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): Column<[ULong](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-long/index.md)> | +| [uniqueIndex](index.md#-1434313059%2FFunctions%2F1975120172) | [jvm]
fun [uniqueIndex](index.md#-1434313059%2FFunctions%2F1975120172)(vararg columns: Column<*>, filterCondition: FilterCondition)
fun [uniqueIndex](index.md#252970649%2FFunctions%2F1975120172)(customIndexName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?, vararg columns: Column<*>, functions: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<ExpressionWithColumnType<*>>?, filterCondition: FilterCondition) | +| [uniqueIndex](index.md#-17665861%2FExtensions%2F1975120172) | [jvm]
fun <[T](index.md#-17665861%2FExtensions%2F1975120172)> Column<[T](index.md#-17665861%2FExtensions%2F1975120172)>.[uniqueIndex](index.md#-17665861%2FExtensions%2F1975120172)(customIndexName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?): Column<[T](index.md#-17665861%2FExtensions%2F1975120172)> | +| [ushort](index.md#1116378144%2FFunctions%2F1975120172) | [jvm]
fun [ushort](index.md#1116378144%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): Column<[UShort](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.md)> | +| [uuid](index.md#154288180%2FFunctions%2F1975120172) | [jvm]
fun [uuid](index.md#154288180%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): Column<[UUID](https://docs.oracle.com/javase/8/docs/api/java/util/UUID.md)> | +| [varchar](index.md#1923632435%2FFunctions%2F1975120172) | [jvm]
fun [varchar](index.md#1923632435%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), length: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), collate: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?): Column<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)> | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-exposed-task-lock-table/locked-at.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-exposed-task-lock-table/locked-at.md index 2935240f..d853ce1e 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-exposed-task-lock-table/locked-at.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-exposed-task-lock-table/locked-at.md @@ -1,14 +1,11 @@ --- title: lockedAt --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[ExposedTaskLockTable](index.md)/[lockedAt](locked-at.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[ExposedTaskLockTable](index.md)/[lockedAt](locked-at.md) # lockedAt - - [jvm]\ abstract val [lockedAt](locked-at.md): Column<Instant> diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-exposed-task-lock-table/name.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-exposed-task-lock-table/name.md index 3f0cf66f..870eda19 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-exposed-task-lock-table/name.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-exposed-task-lock-table/name.md @@ -1,16 +1,14 @@ --- title: name --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[ExposedTaskLockTable](index.md)/[name](name.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[ExposedTaskLockTable](index.md)/[name](name.md) # name - - [jvm]\ -abstract val [name](name.md): Column<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)> +abstract val [name](name.md): Column<[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) +> diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-job-lock-manager-configuration/-jdbc-job-lock-manager-configuration.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-job-lock-manager-configuration/-jdbc-job-lock-manager-configuration.md index 12c78ff7..c83682cc 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-job-lock-manager-configuration/-jdbc-job-lock-manager-configuration.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-job-lock-manager-configuration/-jdbc-job-lock-manager-configuration.md @@ -1,14 +1,11 @@ --- title: JdbcJobLockManagerConfiguration --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[JdbcJobLockManagerConfiguration](index.md)/[JdbcJobLockManagerConfiguration](-jdbc-job-lock-manager-configuration.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[JdbcJobLockManagerConfiguration](index.md)/[JdbcJobLockManagerConfiguration](-jdbc-job-lock-manager-configuration.md) # JdbcJobLockManagerConfiguration - - [jvm]\ constructor() diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-job-lock-manager-configuration/create-task-manager.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-job-lock-manager-configuration/create-task-manager.md index 19cdbd5e..5603976f 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-job-lock-manager-configuration/create-task-manager.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-job-lock-manager-configuration/create-task-manager.md @@ -1,16 +1,14 @@ --- title: createTaskManager --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[JdbcJobLockManagerConfiguration](index.md)/[createTaskManager](create-task-manager.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[JdbcJobLockManagerConfiguration](index.md)/[createTaskManager](create-task-manager.md) # createTaskManager - - [jvm]\ -open override fun [createTaskManager](create-task-manager.md)(application: Application): [JdbcLockManager](../-jdbc-lock-manager/index.md) +open override fun [createTaskManager](create-task-manager.md)(application: +Application): [JdbcLockManager](../-jdbc-lock-manager/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-job-lock-manager-configuration/database.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-job-lock-manager-configuration/database.md index 8f19f94c..73d3ad9d 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-job-lock-manager-configuration/database.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-job-lock-manager-configuration/database.md @@ -1,14 +1,11 @@ --- title: database --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[JdbcJobLockManagerConfiguration](index.md)/[database](database.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[JdbcJobLockManagerConfiguration](index.md)/[database](database.md) # database - - [jvm]\ var [database](database.md): Database diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-job-lock-manager-configuration/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-job-lock-manager-configuration/index.md index d8046ee6..6a12cbb8 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-job-lock-manager-configuration/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-job-lock-manager-configuration/index.md @@ -1,40 +1,31 @@ --- title: JdbcJobLockManagerConfiguration --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[JdbcJobLockManagerConfiguration](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[JdbcJobLockManagerConfiguration](index.md) # JdbcJobLockManagerConfiguration - - [jvm]\ -class [JdbcJobLockManagerConfiguration](index.md) : [DatabaseTaskLockManagerConfiguration](../-database-task-lock-manager-configuration/index.md)<[JdbcTaskLock](../-jdbc-task-lock/index.md)> - - +class [JdbcJobLockManagerConfiguration](index.md) : [DatabaseTaskLockManagerConfiguration](../-database-task-lock-manager-configuration/index.md) +<[JdbcTaskLock](../-jdbc-task-lock/index.md)> ## Constructors - -| | | -|---|---| +| | | +|----------------------------------------------------------------------------|------------------------| | [JdbcJobLockManagerConfiguration](-jdbc-job-lock-manager-configuration.md) | [jvm]
constructor() | - ## Properties - -| Name | Summary | -|---|---| -| [database](database.md) | [jvm]
var [database](database.md): Database | +| Name | Summary | +|-----------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [database](database.md) | [jvm]
var [database](database.md): Database | | [name](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/name.md) | [jvm]
var [name](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? | - ## Functions - -| Name | Summary | -|---|---| +| Name | Summary | +|---------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------| | [createTaskManager](create-task-manager.md) | [jvm]
open override fun [createTaskManager](create-task-manager.md)(application: Application): [JdbcLockManager](../-jdbc-lock-manager/index.md) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-lock-manager/-jdbc-lock-manager.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-lock-manager/-jdbc-lock-manager.md index af104ff9..960fcc4a 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-lock-manager/-jdbc-lock-manager.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-lock-manager/-jdbc-lock-manager.md @@ -1,16 +1,16 @@ --- title: JdbcLockManager --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[JdbcLockManager](index.md)/[JdbcLockManager](-jdbc-lock-manager.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[JdbcLockManager](index.md)/[JdbcLockManager](-jdbc-lock-manager.md) # JdbcLockManager - - [jvm]\ -constructor(name: [TaskManagerConfiguration.TaskManagerName](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md), application: Application, database: Database, taskLockTable: [ExposedTaskLockTable](../-exposed-task-lock-table/index.md) = DefaultTaskLockTable) +constructor( +name: [TaskManagerConfiguration.TaskManagerName](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md), +application: Application, database: Database, +taskLockTable: [ExposedTaskLockTable](../-exposed-task-lock-table/index.md) = DefaultTaskLockTable) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-lock-manager/application.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-lock-manager/application.md index e58ee997..29335709 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-lock-manager/application.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-lock-manager/application.md @@ -1,14 +1,11 @@ --- title: application --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[JdbcLockManager](index.md)/[application](application.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[JdbcLockManager](index.md)/[application](application.md) # application - - [jvm]\ open override val [application](application.md): Application diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-lock-manager/close.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-lock-manager/close.md index beb1e20e..5b8e6a70 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-lock-manager/close.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-lock-manager/close.md @@ -1,14 +1,11 @@ --- title: close --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[JdbcLockManager](index.md)/[close](close.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[JdbcLockManager](index.md)/[close](close.md) # close - - [jvm]\ open override fun [close](close.md)() diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-lock-manager/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-lock-manager/index.md index bc57ce38..9324fffa 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-lock-manager/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-lock-manager/index.md @@ -1,49 +1,47 @@ --- title: JdbcLockManager --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[JdbcLockManager](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[JdbcLockManager](index.md) # JdbcLockManager - - [jvm]\ -class [JdbcLockManager](index.md)(val name: [TaskManagerConfiguration.TaskManagerName](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md), val application: Application, database: Database, taskLockTable: [ExposedTaskLockTable](../-exposed-task-lock-table/index.md) = DefaultTaskLockTable) : [DatabaseTaskLockManager](../-database-task-lock-manager/index.md)<[JdbcTaskLock](../-jdbc-task-lock/index.md)> - -An implementation of [DatabaseTaskLockManager](../-database-task-lock-manager/index.md) using JDBC and Exposed as the lock store The manager will take care of generating the lock table using the SchemaUtils and the DefaultTaskLockTable. the schema utils should handle the case where the table already exists. TODO: test this Alternatively, you can use implement the [ExposedTaskLockTable](../-exposed-task-lock-table/index.md) yourself and provide it instead - - +class [JdbcLockManager](index.md)(val +name: [TaskManagerConfiguration.TaskManagerName](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md), +val application: Application, database: Database, +taskLockTable: [ExposedTaskLockTable](../-exposed-task-lock-table/index.md) = +DefaultTaskLockTable) : [DatabaseTaskLockManager](../-database-task-lock-manager/index.md) +<[JdbcTaskLock](../-jdbc-task-lock/index.md)> + +An implementation of [DatabaseTaskLockManager](../-database-task-lock-manager/index.md) using JDBC and Exposed as the +lock store The manager will take care of generating the lock table using the SchemaUtils and the DefaultTaskLockTable. +the schema utils should handle the case where the table already exists. TODO: test this Alternatively, you can use +implement the [ExposedTaskLockTable](../-exposed-task-lock-table/index.md) yourself and provide it instead ## Constructors - -| | | -|---|---| +| | | +|------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [JdbcLockManager](-jdbc-lock-manager.md) | [jvm]
constructor(name: [TaskManagerConfiguration.TaskManagerName](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md), application: Application, database: Database, taskLockTable: [ExposedTaskLockTable](../-exposed-task-lock-table/index.md) = DefaultTaskLockTable) | - ## Properties - -| Name | Summary | -|---|---| -| [application](application.md) | [jvm]
open override val [application](application.md): Application | -| [name](name.md) | [jvm]
open override val [name](name.md): [TaskManagerConfiguration.TaskManagerName](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md) | - +| Name | Summary | +|-------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [application](application.md) | [jvm]
open override val [application](application.md): Application | +| [name](name.md) | [jvm]
open override val [name](name.md): [TaskManagerConfiguration.TaskManagerName](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md) | ## Functions - -| Name | Summary | -|---|---| -| [acquireLockKey](../-database-task-lock-manager/acquire-lock-key.md) | [jvm]
suspend override fun [acquireLockKey](../-database-task-lock-manager/acquire-lock-key.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), executionTime: DateTime, concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [JdbcTaskLock](../-jdbc-task-lock/index.md)? | +| Name | Summary | +|----------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [acquireLockKey](../-database-task-lock-manager/acquire-lock-key.md) | [jvm]
suspend override fun [acquireLockKey](../-database-task-lock-manager/acquire-lock-key.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), executionTime: DateTime, concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [JdbcTaskLock](../-jdbc-task-lock/index.md)? | | [attemptExecute](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/attempt-execute.md) | [jvm]
open suspend override fun [attemptExecute](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/attempt-execute.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), executionTime: DateTime, concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [JdbcTaskLock](../-jdbc-task-lock/index.md)? | -| [close](close.md) | [jvm]
open override fun [close](close.md)() | -| [init](../-database-task-lock-manager/init.md) | [jvm]
suspend override fun [init](../-database-task-lock-manager/init.md)(tasks: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<[Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md)>) | -| [initTaskLockTable](init-task-lock-table.md) | [jvm]
open suspend override fun [initTaskLockTable](init-task-lock-table.md)() | -| [insertTaskLock](insert-task-lock.md) | [jvm]
open suspend override fun [insertTaskLock](insert-task-lock.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), taskConcurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md) | -| [markExecuted](index.md#1666649552%2FFunctions%2F1975120172) | [jvm]
open suspend override fun [markExecuted](index.md#1666649552%2FFunctions%2F1975120172)(key: [JdbcTaskLock](../-jdbc-task-lock/index.md)) | -| [updateTaskLock](update-task-lock.md) | [jvm]
open suspend override fun [updateTaskLock](update-task-lock.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), executionTime: DateTime): [JdbcTaskLock](../-jdbc-task-lock/index.md)? | +| [close](close.md) | [jvm]
open override fun [close](close.md)() | +| [init](../-database-task-lock-manager/init.md) | [jvm]
suspend override fun [init](../-database-task-lock-manager/init.md)(tasks: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<[Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md)>) | +| [initTaskLockTable](init-task-lock-table.md) | [jvm]
open suspend override fun [initTaskLockTable](init-task-lock-table.md)() | +| [insertTaskLock](insert-task-lock.md) | [jvm]
open suspend override fun [insertTaskLock](insert-task-lock.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), taskConcurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md) | +| [markExecuted](index.md#1666649552%2FFunctions%2F1975120172) | [jvm]
open suspend override fun [markExecuted](index.md#1666649552%2FFunctions%2F1975120172)(key: [JdbcTaskLock](../-jdbc-task-lock/index.md)) | +| [updateTaskLock](update-task-lock.md) | [jvm]
open suspend override fun [updateTaskLock](update-task-lock.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), executionTime: DateTime): [JdbcTaskLock](../-jdbc-task-lock/index.md)? | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-lock-manager/init-task-lock-table.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-lock-manager/init-task-lock-table.md index 79791a2d..faf6c7b2 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-lock-manager/init-task-lock-table.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-lock-manager/init-task-lock-table.md @@ -1,14 +1,11 @@ --- title: initTaskLockTable --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[JdbcLockManager](index.md)/[initTaskLockTable](init-task-lock-table.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[JdbcLockManager](index.md)/[initTaskLockTable](init-task-lock-table.md) # initTaskLockTable - - [jvm]\ open suspend override fun [initTaskLockTable](init-task-lock-table.md)() diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-lock-manager/insert-task-lock.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-lock-manager/insert-task-lock.md index 3850d2cf..87b85836 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-lock-manager/insert-task-lock.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-lock-manager/insert-task-lock.md @@ -1,16 +1,15 @@ --- title: insertTaskLock --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[JdbcLockManager](index.md)/[insertTaskLock](insert-task-lock.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[JdbcLockManager](index.md)/[insertTaskLock](insert-task-lock.md) # insertTaskLock - - [jvm]\ -open suspend override fun [insertTaskLock](insert-task-lock.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), taskConcurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md) +open suspend override fun [insertTaskLock](insert-task-lock.md)( +task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), +taskConcurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-lock-manager/name.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-lock-manager/name.md index 86f53ad4..19dc92c7 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-lock-manager/name.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-lock-manager/name.md @@ -1,16 +1,14 @@ --- title: name --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[JdbcLockManager](index.md)/[name](name.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[JdbcLockManager](index.md)/[name](name.md) # name - - [jvm]\ -open override val [name](name.md): [TaskManagerConfiguration.TaskManagerName](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md) +open override +val [name](name.md): [TaskManagerConfiguration.TaskManagerName](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-lock-manager/update-task-lock.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-lock-manager/update-task-lock.md index 51c2e929..2745c43a 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-lock-manager/update-task-lock.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-lock-manager/update-task-lock.md @@ -1,16 +1,16 @@ --- title: updateTaskLock --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[JdbcLockManager](index.md)/[updateTaskLock](update-task-lock.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[JdbcLockManager](index.md)/[updateTaskLock](update-task-lock.md) # updateTaskLock - - [jvm]\ -open suspend override fun [updateTaskLock](update-task-lock.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), executionTime: DateTime): [JdbcTaskLock](../-jdbc-task-lock/index.md)? +open suspend override fun [updateTaskLock](update-task-lock.md)( +task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), +concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), executionTime: +DateTime): [JdbcTaskLock](../-jdbc-task-lock/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-task-lock/-jdbc-task-lock.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-task-lock/-jdbc-task-lock.md index 962fdb89..34d41a0b 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-task-lock/-jdbc-task-lock.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-task-lock/-jdbc-task-lock.md @@ -1,16 +1,14 @@ --- title: JdbcTaskLock --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[JdbcTaskLock](index.md)/[JdbcTaskLock](-jdbc-task-lock.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[JdbcTaskLock](index.md)/[JdbcTaskLock](-jdbc-task-lock.md) # JdbcTaskLock - - [jvm]\ -constructor(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), lockedAt: DateTime) +constructor(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), +concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), lockedAt: DateTime) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-task-lock/concurrency-index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-task-lock/concurrency-index.md index 9ec71b2b..d471b2bc 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-task-lock/concurrency-index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-task-lock/concurrency-index.md @@ -1,16 +1,14 @@ --- title: concurrencyIndex --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[JdbcTaskLock](index.md)/[concurrencyIndex](concurrency-index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[JdbcTaskLock](index.md)/[concurrencyIndex](concurrency-index.md) # concurrencyIndex - - [jvm]\ -open override val [concurrencyIndex](concurrency-index.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) +open override +val [concurrencyIndex](concurrency-index.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-task-lock/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-task-lock/index.md index 830c7c4a..aaff9d01 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-task-lock/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-task-lock/index.md @@ -1,41 +1,33 @@ --- title: JdbcTaskLock --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[JdbcTaskLock](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[JdbcTaskLock](index.md) # JdbcTaskLock - - [jvm]\ -class [JdbcTaskLock](index.md)(val name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), val concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), val lockedAt: DateTime) : [DatabaseTaskLock](../-database-task-lock/index.md) - - +class [JdbcTaskLock](index.md)(val name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), +val concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), val lockedAt: +DateTime) : [DatabaseTaskLock](../-database-task-lock/index.md) ## Constructors - -| | | -|---|---| +| | | +|------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [JdbcTaskLock](-jdbc-task-lock.md) | [jvm]
constructor(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), lockedAt: DateTime) | - ## Properties - -| Name | Summary | -|---|---| +| Name | Summary | +|------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------| | [concurrencyIndex](concurrency-index.md) | [jvm]
open override val [concurrencyIndex](concurrency-index.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) | -| [lockedAt](locked-at.md) | [jvm]
open override val [lockedAt](locked-at.md): DateTime | -| [name](name.md) | [jvm]
open override val [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | - +| [lockedAt](locked-at.md) | [jvm]
open override val [lockedAt](locked-at.md): DateTime | +| [name](name.md) | [jvm]
open override val [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | ## Functions - -| Name | Summary | -|---|---| +| Name | Summary | +|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------| | [toString](to-string.md) | [jvm]
open override fun [toString](to-string.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-task-lock/locked-at.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-task-lock/locked-at.md index c7f606ae..a1666516 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-task-lock/locked-at.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-task-lock/locked-at.md @@ -1,14 +1,11 @@ --- title: lockedAt --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[JdbcTaskLock](index.md)/[lockedAt](locked-at.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[JdbcTaskLock](index.md)/[lockedAt](locked-at.md) # lockedAt - - [jvm]\ open override val [lockedAt](locked-at.md): DateTime diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-task-lock/name.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-task-lock/name.md index 20bc547b..d4eeb767 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-task-lock/name.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-task-lock/name.md @@ -1,14 +1,11 @@ --- title: name --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[JdbcTaskLock](index.md)/[name](name.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[JdbcTaskLock](index.md)/[name](name.md) # name - - [jvm]\ open override val [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-task-lock/to-string.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-task-lock/to-string.md index cb657ebb..81fbb41c 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-task-lock/to-string.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-task-lock/to-string.md @@ -1,16 +1,14 @@ --- title: toString --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[JdbcTaskLock](index.md)/[toString](to-string.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[JdbcTaskLock](index.md)/[toString](to-string.md) # toString - - [jvm]\ -open override fun [toString](to-string.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) +open override +fun [toString](to-string.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-job-lock-manager-configuration/-mongo-d-b-job-lock-manager-configuration.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-job-lock-manager-configuration/-mongo-d-b-job-lock-manager-configuration.md index b003578d..9fdccad7 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-job-lock-manager-configuration/-mongo-d-b-job-lock-manager-configuration.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-job-lock-manager-configuration/-mongo-d-b-job-lock-manager-configuration.md @@ -1,14 +1,11 @@ --- title: MongoDBJobLockManagerConfiguration --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[MongoDBJobLockManagerConfiguration](index.md)/[MongoDBJobLockManagerConfiguration](-mongo-d-b-job-lock-manager-configuration.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[MongoDBJobLockManagerConfiguration](index.md)/[MongoDBJobLockManagerConfiguration](-mongo-d-b-job-lock-manager-configuration.md) # MongoDBJobLockManagerConfiguration - - [jvm]\ constructor() diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-job-lock-manager-configuration/client.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-job-lock-manager-configuration/client.md index f351fd90..dfa79653 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-job-lock-manager-configuration/client.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-job-lock-manager-configuration/client.md @@ -1,14 +1,11 @@ --- title: client --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[MongoDBJobLockManagerConfiguration](index.md)/[client](client.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[MongoDBJobLockManagerConfiguration](index.md)/[client](client.md) # client - - [jvm]\ var [client](client.md): MongoClient diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-job-lock-manager-configuration/create-task-manager.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-job-lock-manager-configuration/create-task-manager.md index 3097a629..6841c9ad 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-job-lock-manager-configuration/create-task-manager.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-job-lock-manager-configuration/create-task-manager.md @@ -1,16 +1,14 @@ --- title: createTaskManager --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[MongoDBJobLockManagerConfiguration](index.md)/[createTaskManager](create-task-manager.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[MongoDBJobLockManagerConfiguration](index.md)/[createTaskManager](create-task-manager.md) # createTaskManager - - [jvm]\ -open override fun [createTaskManager](create-task-manager.md)(application: Application): [MongoDBLockManager](../-mongo-d-b-lock-manager/index.md) +open override fun [createTaskManager](create-task-manager.md)(application: +Application): [MongoDBLockManager](../-mongo-d-b-lock-manager/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-job-lock-manager-configuration/database-name.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-job-lock-manager-configuration/database-name.md index c40c5ba7..cc2c5f01 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-job-lock-manager-configuration/database-name.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-job-lock-manager-configuration/database-name.md @@ -1,14 +1,11 @@ --- title: databaseName --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[MongoDBJobLockManagerConfiguration](index.md)/[databaseName](database-name.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[MongoDBJobLockManagerConfiguration](index.md)/[databaseName](database-name.md) # databaseName - - [jvm]\ var [databaseName](database-name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-job-lock-manager-configuration/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-job-lock-manager-configuration/index.md index 5fd77bdf..1a520d95 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-job-lock-manager-configuration/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-job-lock-manager-configuration/index.md @@ -1,41 +1,32 @@ --- title: MongoDBJobLockManagerConfiguration --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[MongoDBJobLockManagerConfiguration](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[MongoDBJobLockManagerConfiguration](index.md) # MongoDBJobLockManagerConfiguration - - [jvm]\ -class [MongoDBJobLockManagerConfiguration](index.md) : [DatabaseTaskLockManagerConfiguration](../-database-task-lock-manager-configuration/index.md)<[MongoDbTaskLock](../-mongo-db-task-lock/index.md)> - - +class [MongoDBJobLockManagerConfiguration](index.md) : [DatabaseTaskLockManagerConfiguration](../-database-task-lock-manager-configuration/index.md) +<[MongoDbTaskLock](../-mongo-db-task-lock/index.md)> ## Constructors - -| | | -|---|---| +| | | +|------------------------------------------------------------------------------------|------------------------| | [MongoDBJobLockManagerConfiguration](-mongo-d-b-job-lock-manager-configuration.md) | [jvm]
constructor() | - ## Properties - -| Name | Summary | -|---|---| -| [client](client.md) | [jvm]
var [client](client.md): MongoClient | -| [databaseName](database-name.md) | [jvm]
var [databaseName](database-name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | +| Name | Summary | +|-----------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [client](client.md) | [jvm]
var [client](client.md): MongoClient | +| [databaseName](database-name.md) | [jvm]
var [databaseName](database-name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | | [name](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/name.md) | [jvm]
var [name](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? | - ## Functions - -| Name | Summary | -|---|---| +| Name | Summary | +|---------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| | [createTaskManager](create-task-manager.md) | [jvm]
open override fun [createTaskManager](create-task-manager.md)(application: Application): [MongoDBLockManager](../-mongo-d-b-lock-manager/index.md) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-lock-manager/-mongo-d-b-lock-manager.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-lock-manager/-mongo-d-b-lock-manager.md index e670af27..801cf136 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-lock-manager/-mongo-d-b-lock-manager.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-lock-manager/-mongo-d-b-lock-manager.md @@ -1,16 +1,16 @@ --- title: MongoDBLockManager --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[MongoDBLockManager](index.md)/[MongoDBLockManager](-mongo-d-b-lock-manager.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[MongoDBLockManager](index.md)/[MongoDBLockManager](-mongo-d-b-lock-manager.md) # MongoDBLockManager - - [jvm]\ -constructor(name: [TaskManagerConfiguration.TaskManagerName](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md), application: Application, client: MongoClient, databaseName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)) +constructor( +name: [TaskManagerConfiguration.TaskManagerName](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md), +application: Application, client: MongoClient, +databaseName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-lock-manager/application.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-lock-manager/application.md index 17fb6417..158f89af 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-lock-manager/application.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-lock-manager/application.md @@ -1,14 +1,11 @@ --- title: application --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[MongoDBLockManager](index.md)/[application](application.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[MongoDBLockManager](index.md)/[application](application.md) # application - - [jvm]\ open override val [application](application.md): Application diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-lock-manager/close.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-lock-manager/close.md index dd84a487..a8b86717 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-lock-manager/close.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-lock-manager/close.md @@ -1,14 +1,11 @@ --- title: close --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[MongoDBLockManager](index.md)/[close](close.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[MongoDBLockManager](index.md)/[close](close.md) # close - - [jvm]\ open override fun [close](close.md)() diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-lock-manager/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-lock-manager/index.md index ed99e9b7..2d028a99 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-lock-manager/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-lock-manager/index.md @@ -1,49 +1,43 @@ --- title: MongoDBLockManager --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[MongoDBLockManager](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[MongoDBLockManager](index.md) # MongoDBLockManager - - [jvm]\ -class [MongoDBLockManager](index.md)(val name: [TaskManagerConfiguration.TaskManagerName](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md), val application: Application, client: MongoClient, databaseName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)) : [DatabaseTaskLockManager](../-database-task-lock-manager/index.md)<[MongoDbTaskLock](../-mongo-db-task-lock/index.md)> +class [MongoDBLockManager](index.md)(val +name: [TaskManagerConfiguration.TaskManagerName](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md), +val application: Application, client: MongoClient, +databaseName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)) : [DatabaseTaskLockManager](../-database-task-lock-manager/index.md) +<[MongoDbTaskLock](../-mongo-db-task-lock/index.md)> An implementation of [DatabaseTaskLockManager](../-database-task-lock-manager/index.md) using MongoDB as the lock store - - ## Constructors - -| | | -|---|---| +| | | +|--------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [MongoDBLockManager](-mongo-d-b-lock-manager.md) | [jvm]
constructor(name: [TaskManagerConfiguration.TaskManagerName](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md), application: Application, client: MongoClient, databaseName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)) | - ## Properties - -| Name | Summary | -|---|---| -| [application](application.md) | [jvm]
open override val [application](application.md): Application | -| [name](name.md) | [jvm]
open override val [name](name.md): [TaskManagerConfiguration.TaskManagerName](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md) | - +| Name | Summary | +|-------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [application](application.md) | [jvm]
open override val [application](application.md): Application | +| [name](name.md) | [jvm]
open override val [name](name.md): [TaskManagerConfiguration.TaskManagerName](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md) | ## Functions - -| Name | Summary | -|---|---| -| [acquireLockKey](../-database-task-lock-manager/acquire-lock-key.md) | [jvm]
suspend override fun [acquireLockKey](../-database-task-lock-manager/acquire-lock-key.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), executionTime: DateTime, concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [MongoDbTaskLock](../-mongo-db-task-lock/index.md)? | +| Name | Summary | +|----------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [acquireLockKey](../-database-task-lock-manager/acquire-lock-key.md) | [jvm]
suspend override fun [acquireLockKey](../-database-task-lock-manager/acquire-lock-key.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), executionTime: DateTime, concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [MongoDbTaskLock](../-mongo-db-task-lock/index.md)? | | [attemptExecute](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/attempt-execute.md) | [jvm]
open suspend override fun [attemptExecute](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/attempt-execute.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), executionTime: DateTime, concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [MongoDbTaskLock](../-mongo-db-task-lock/index.md)? | -| [close](close.md) | [jvm]
open override fun [close](close.md)() | -| [init](../-database-task-lock-manager/init.md) | [jvm]
suspend override fun [init](../-database-task-lock-manager/init.md)(tasks: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<[Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md)>) | -| [initTaskLockTable](init-task-lock-table.md) | [jvm]
open suspend override fun [initTaskLockTable](init-task-lock-table.md)() | -| [insertTaskLock](insert-task-lock.md) | [jvm]
open suspend override fun [insertTaskLock](insert-task-lock.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), taskConcurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md) | -| [markExecuted](index.md#-661344251%2FFunctions%2F1975120172) | [jvm]
open suspend override fun [markExecuted](index.md#-661344251%2FFunctions%2F1975120172)(key: [MongoDbTaskLock](../-mongo-db-task-lock/index.md)) | -| [updateTaskLock](update-task-lock.md) | [jvm]
open suspend override fun [updateTaskLock](update-task-lock.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), executionTime: DateTime): [MongoDbTaskLock](../-mongo-db-task-lock/index.md)? | +| [close](close.md) | [jvm]
open override fun [close](close.md)() | +| [init](../-database-task-lock-manager/init.md) | [jvm]
suspend override fun [init](../-database-task-lock-manager/init.md)(tasks: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<[Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md)>) | +| [initTaskLockTable](init-task-lock-table.md) | [jvm]
open suspend override fun [initTaskLockTable](init-task-lock-table.md)() | +| [insertTaskLock](insert-task-lock.md) | [jvm]
open suspend override fun [insertTaskLock](insert-task-lock.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), taskConcurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md) | +| [markExecuted](index.md#-661344251%2FFunctions%2F1975120172) | [jvm]
open suspend override fun [markExecuted](index.md#-661344251%2FFunctions%2F1975120172)(key: [MongoDbTaskLock](../-mongo-db-task-lock/index.md)) | +| [updateTaskLock](update-task-lock.md) | [jvm]
open suspend override fun [updateTaskLock](update-task-lock.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), executionTime: DateTime): [MongoDbTaskLock](../-mongo-db-task-lock/index.md)? | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-lock-manager/init-task-lock-table.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-lock-manager/init-task-lock-table.md index a4e17771..fc190b50 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-lock-manager/init-task-lock-table.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-lock-manager/init-task-lock-table.md @@ -1,14 +1,11 @@ --- title: initTaskLockTable --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[MongoDBLockManager](index.md)/[initTaskLockTable](init-task-lock-table.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[MongoDBLockManager](index.md)/[initTaskLockTable](init-task-lock-table.md) # initTaskLockTable - - [jvm]\ open suspend override fun [initTaskLockTable](init-task-lock-table.md)() diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-lock-manager/insert-task-lock.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-lock-manager/insert-task-lock.md index 3aed92a6..18b84ae9 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-lock-manager/insert-task-lock.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-lock-manager/insert-task-lock.md @@ -1,16 +1,15 @@ --- title: insertTaskLock --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[MongoDBLockManager](index.md)/[insertTaskLock](insert-task-lock.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[MongoDBLockManager](index.md)/[insertTaskLock](insert-task-lock.md) # insertTaskLock - - [jvm]\ -open suspend override fun [insertTaskLock](insert-task-lock.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), taskConcurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md) +open suspend override fun [insertTaskLock](insert-task-lock.md)( +task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), +taskConcurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-lock-manager/name.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-lock-manager/name.md index 55d8c121..cfb7774b 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-lock-manager/name.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-lock-manager/name.md @@ -1,16 +1,14 @@ --- title: name --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[MongoDBLockManager](index.md)/[name](name.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[MongoDBLockManager](index.md)/[name](name.md) # name - - [jvm]\ -open override val [name](name.md): [TaskManagerConfiguration.TaskManagerName](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md) +open override +val [name](name.md): [TaskManagerConfiguration.TaskManagerName](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-lock-manager/update-task-lock.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-lock-manager/update-task-lock.md index 986157c9..f5aacb84 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-lock-manager/update-task-lock.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-lock-manager/update-task-lock.md @@ -1,16 +1,16 @@ --- title: updateTaskLock --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[MongoDBLockManager](index.md)/[updateTaskLock](update-task-lock.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[MongoDBLockManager](index.md)/[updateTaskLock](update-task-lock.md) # updateTaskLock - - [jvm]\ -open suspend override fun [updateTaskLock](update-task-lock.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), executionTime: DateTime): [MongoDbTaskLock](../-mongo-db-task-lock/index.md)? +open suspend override fun [updateTaskLock](update-task-lock.md)( +task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), +concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), executionTime: +DateTime): [MongoDbTaskLock](../-mongo-db-task-lock/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-db-task-lock/-mongo-db-task-lock.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-db-task-lock/-mongo-db-task-lock.md index 31dcba16..8d413cbc 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-db-task-lock/-mongo-db-task-lock.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-db-task-lock/-mongo-db-task-lock.md @@ -1,16 +1,14 @@ --- title: MongoDbTaskLock --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[MongoDbTaskLock](index.md)/[MongoDbTaskLock](-mongo-db-task-lock.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[MongoDbTaskLock](index.md)/[MongoDbTaskLock](-mongo-db-task-lock.md) # MongoDbTaskLock - - [jvm]\ -constructor(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), lockedAt: DateTime) +constructor(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), +concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), lockedAt: DateTime) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-db-task-lock/concurrency-index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-db-task-lock/concurrency-index.md index 2b23364f..3f0f9f86 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-db-task-lock/concurrency-index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-db-task-lock/concurrency-index.md @@ -1,16 +1,14 @@ --- title: concurrencyIndex --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[MongoDbTaskLock](index.md)/[concurrencyIndex](concurrency-index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[MongoDbTaskLock](index.md)/[concurrencyIndex](concurrency-index.md) # concurrencyIndex - - [jvm]\ -open override val [concurrencyIndex](concurrency-index.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) +open override +val [concurrencyIndex](concurrency-index.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-db-task-lock/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-db-task-lock/index.md index e1289462..a379cf20 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-db-task-lock/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-db-task-lock/index.md @@ -1,41 +1,34 @@ --- title: MongoDbTaskLock --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[MongoDbTaskLock](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[MongoDbTaskLock](index.md) # MongoDbTaskLock - - [jvm]\ -data class [MongoDbTaskLock](index.md)(val name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), val concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), var lockedAt: DateTime) : [DatabaseTaskLock](../-database-task-lock/index.md) - - +data class [MongoDbTaskLock](index.md)(val +name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), val +concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), var lockedAt: +DateTime) : [DatabaseTaskLock](../-database-task-lock/index.md) ## Constructors - -| | | -|---|---| +| | | +|-------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [MongoDbTaskLock](-mongo-db-task-lock.md) | [jvm]
constructor(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), lockedAt: DateTime) | - ## Properties - -| Name | Summary | -|---|---| +| Name | Summary | +|------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------| | [concurrencyIndex](concurrency-index.md) | [jvm]
open override val [concurrencyIndex](concurrency-index.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) | -| [lockedAt](locked-at.md) | [jvm]
open override var [lockedAt](locked-at.md): DateTime | -| [name](name.md) | [jvm]
open override val [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | - +| [lockedAt](locked-at.md) | [jvm]
open override var [lockedAt](locked-at.md): DateTime | +| [name](name.md) | [jvm]
open override val [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | ## Functions - -| Name | Summary | -|---|---| +| Name | Summary | +|--------------------------|---------------------------------------------------------------------------------------------------------------------------------------| | [toString](to-string.md) | [jvm]
open override fun [toString](to-string.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-db-task-lock/locked-at.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-db-task-lock/locked-at.md index 34e9d74d..a9a0360b 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-db-task-lock/locked-at.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-db-task-lock/locked-at.md @@ -1,14 +1,11 @@ --- title: lockedAt --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[MongoDbTaskLock](index.md)/[lockedAt](locked-at.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[MongoDbTaskLock](index.md)/[lockedAt](locked-at.md) # lockedAt - - [jvm]\ open override var [lockedAt](locked-at.md): DateTime diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-db-task-lock/name.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-db-task-lock/name.md index 170448fd..eb1e8e92 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-db-task-lock/name.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-db-task-lock/name.md @@ -1,14 +1,11 @@ --- title: name --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[MongoDbTaskLock](index.md)/[name](name.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[MongoDbTaskLock](index.md)/[name](name.md) # name - - [jvm]\ open override val [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-db-task-lock/to-string.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-db-task-lock/to-string.md index 9e1edc73..b538e81f 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-db-task-lock/to-string.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-db-task-lock/to-string.md @@ -1,16 +1,14 @@ --- title: toString --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[MongoDbTaskLock](index.md)/[toString](to-string.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](../index.md)/[MongoDbTaskLock](index.md)/[toString](to-string.md) # toString - - [jvm]\ -open override fun [toString](to-string.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) +open override +fun [toString](to-string.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/index.md index 163f3b67..3a77b9c5 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/index.md @@ -1,36 +1,30 @@ --- title: io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](index.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](index.md) # Package-level declarations - - ## Types - -| Name | Summary | -|---|---| -| [DatabaseTaskLock](-database-task-lock/index.md) | [common]
interface [DatabaseTaskLock](-database-task-lock/index.md) : [TaskLock](../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task-lock/index.md) | -| [DatabaseTaskLockManager](-database-task-lock-manager/index.md) | [common]
abstract class [DatabaseTaskLockManager](-database-task-lock-manager/index.md)<[DB_TASK_LOCK_KEY](-database-task-lock-manager/index.md) : [DatabaseTaskLock](-database-task-lock/index.md)> : [TaskLockManager](../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/index.md)<[DB_TASK_LOCK_KEY](-database-task-lock-manager/index.md)>
An abstract implementation of [TaskLockManager](../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/index.md) using a database as the lock store | -| [DatabaseTaskLockManagerConfiguration](-database-task-lock-manager-configuration/index.md) | [common]
abstract class [DatabaseTaskLockManagerConfiguration](-database-task-lock-manager-configuration/index.md)<[DB_TASK_LOCK_KEY](-database-task-lock-manager-configuration/index.md) : [DatabaseTaskLock](-database-task-lock/index.md)> : [TaskLockManagerConfiguration](../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager-configuration/index.md)<[DB_TASK_LOCK_KEY](-database-task-lock-manager-configuration/index.md)> | -| [ExposedTaskLockTable](-exposed-task-lock-table/index.md) | [jvm]
abstract class [ExposedTaskLockTable](-exposed-task-lock-table/index.md)(tableName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)) : Table | -| [JdbcJobLockManagerConfiguration](-jdbc-job-lock-manager-configuration/index.md) | [jvm]
class [JdbcJobLockManagerConfiguration](-jdbc-job-lock-manager-configuration/index.md) : [DatabaseTaskLockManagerConfiguration](-database-task-lock-manager-configuration/index.md)<[JdbcTaskLock](-jdbc-task-lock/index.md)> | -| [JdbcLockManager](-jdbc-lock-manager/index.md) | [jvm]
class [JdbcLockManager](-jdbc-lock-manager/index.md)(val name: [TaskManagerConfiguration.TaskManagerName](../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md), val application: Application, database: Database, taskLockTable: [ExposedTaskLockTable](-exposed-task-lock-table/index.md) = DefaultTaskLockTable) : [DatabaseTaskLockManager](-database-task-lock-manager/index.md)<[JdbcTaskLock](-jdbc-task-lock/index.md)>
An implementation of [DatabaseTaskLockManager](-database-task-lock-manager/index.md) using JDBC and Exposed as the lock store The manager will take care of generating the lock table using the SchemaUtils and the DefaultTaskLockTable. the schema utils should handle the case where the table already exists. TODO: test this Alternatively, you can use implement the [ExposedTaskLockTable](-exposed-task-lock-table/index.md) yourself and provide it instead | -| [JdbcTaskLock](-jdbc-task-lock/index.md) | [jvm]
class [JdbcTaskLock](-jdbc-task-lock/index.md)(val name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), val concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), val lockedAt: DateTime) : [DatabaseTaskLock](-database-task-lock/index.md) | -| [MongoDBJobLockManagerConfiguration](-mongo-d-b-job-lock-manager-configuration/index.md) | [jvm]
class [MongoDBJobLockManagerConfiguration](-mongo-d-b-job-lock-manager-configuration/index.md) : [DatabaseTaskLockManagerConfiguration](-database-task-lock-manager-configuration/index.md)<[MongoDbTaskLock](-mongo-db-task-lock/index.md)> | -| [MongoDBLockManager](-mongo-d-b-lock-manager/index.md) | [jvm]
class [MongoDBLockManager](-mongo-d-b-lock-manager/index.md)(val name: [TaskManagerConfiguration.TaskManagerName](../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md), val application: Application, client: MongoClient, databaseName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)) : [DatabaseTaskLockManager](-database-task-lock-manager/index.md)<[MongoDbTaskLock](-mongo-db-task-lock/index.md)>
An implementation of [DatabaseTaskLockManager](-database-task-lock-manager/index.md) using MongoDB as the lock store | -| [MongoDbTaskLock](-mongo-db-task-lock/index.md) | [jvm]
data class [MongoDbTaskLock](-mongo-db-task-lock/index.md)(val name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), val concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), var lockedAt: DateTime) : [DatabaseTaskLock](-database-task-lock/index.md) | - +| Name | Summary | +|--------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [DatabaseTaskLock](-database-task-lock/index.md) | [common]
interface [DatabaseTaskLock](-database-task-lock/index.md) : [TaskLock](../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task-lock/index.md) | +| [DatabaseTaskLockManager](-database-task-lock-manager/index.md) | [common]
abstract class [DatabaseTaskLockManager](-database-task-lock-manager/index.md)<[DB_TASK_LOCK_KEY](-database-task-lock-manager/index.md) : [DatabaseTaskLock](-database-task-lock/index.md)> : [TaskLockManager](../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/index.md)<[DB_TASK_LOCK_KEY](-database-task-lock-manager/index.md)>
An abstract implementation of [TaskLockManager](../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/index.md) using a database as the lock store | +| [DatabaseTaskLockManagerConfiguration](-database-task-lock-manager-configuration/index.md) | [common]
abstract class [DatabaseTaskLockManagerConfiguration](-database-task-lock-manager-configuration/index.md)<[DB_TASK_LOCK_KEY](-database-task-lock-manager-configuration/index.md) : [DatabaseTaskLock](-database-task-lock/index.md)> : [TaskLockManagerConfiguration](../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager-configuration/index.md)<[DB_TASK_LOCK_KEY](-database-task-lock-manager-configuration/index.md)> | +| [ExposedTaskLockTable](-exposed-task-lock-table/index.md) | [jvm]
abstract class [ExposedTaskLockTable](-exposed-task-lock-table/index.md)(tableName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)) : Table | +| [JdbcJobLockManagerConfiguration](-jdbc-job-lock-manager-configuration/index.md) | [jvm]
class [JdbcJobLockManagerConfiguration](-jdbc-job-lock-manager-configuration/index.md) : [DatabaseTaskLockManagerConfiguration](-database-task-lock-manager-configuration/index.md)<[JdbcTaskLock](-jdbc-task-lock/index.md)> | +| [JdbcLockManager](-jdbc-lock-manager/index.md) | [jvm]
class [JdbcLockManager](-jdbc-lock-manager/index.md)(val name: [TaskManagerConfiguration.TaskManagerName](../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md), val application: Application, database: Database, taskLockTable: [ExposedTaskLockTable](-exposed-task-lock-table/index.md) = DefaultTaskLockTable) : [DatabaseTaskLockManager](-database-task-lock-manager/index.md)<[JdbcTaskLock](-jdbc-task-lock/index.md)>
An implementation of [DatabaseTaskLockManager](-database-task-lock-manager/index.md) using JDBC and Exposed as the lock store The manager will take care of generating the lock table using the SchemaUtils and the DefaultTaskLockTable. the schema utils should handle the case where the table already exists. TODO: test this Alternatively, you can use implement the [ExposedTaskLockTable](-exposed-task-lock-table/index.md) yourself and provide it instead | +| [JdbcTaskLock](-jdbc-task-lock/index.md) | [jvm]
class [JdbcTaskLock](-jdbc-task-lock/index.md)(val name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), val concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), val lockedAt: DateTime) : [DatabaseTaskLock](-database-task-lock/index.md) | +| [MongoDBJobLockManagerConfiguration](-mongo-d-b-job-lock-manager-configuration/index.md) | [jvm]
class [MongoDBJobLockManagerConfiguration](-mongo-d-b-job-lock-manager-configuration/index.md) : [DatabaseTaskLockManagerConfiguration](-database-task-lock-manager-configuration/index.md)<[MongoDbTaskLock](-mongo-db-task-lock/index.md)> | +| [MongoDBLockManager](-mongo-d-b-lock-manager/index.md) | [jvm]
class [MongoDBLockManager](-mongo-d-b-lock-manager/index.md)(val name: [TaskManagerConfiguration.TaskManagerName](../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md), val application: Application, client: MongoClient, databaseName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)) : [DatabaseTaskLockManager](-database-task-lock-manager/index.md)<[MongoDbTaskLock](-mongo-db-task-lock/index.md)>
An implementation of [DatabaseTaskLockManager](-database-task-lock-manager/index.md) using MongoDB as the lock store | +| [MongoDbTaskLock](-mongo-db-task-lock/index.md) | [jvm]
data class [MongoDbTaskLock](-mongo-db-task-lock/index.md)(val name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), val concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), var lockedAt: DateTime) : [DatabaseTaskLock](-database-task-lock/index.md) | ## Functions - -| Name | Summary | -|---|---| -| [jdbc](jdbc.md) | [jvm]
fun [TaskSchedulingConfiguration](../io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-configuration/index.md).[jdbc](jdbc.md)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = null, config: [JdbcJobLockManagerConfiguration](-jdbc-job-lock-manager-configuration/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md))
Add a [JdbcLockManager](-jdbc-lock-manager/index.md) | +| Name | Summary | +|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [jdbc](jdbc.md) | [jvm]
fun [TaskSchedulingConfiguration](../io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-configuration/index.md).[jdbc](jdbc.md)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = null, config: [JdbcJobLockManagerConfiguration](-jdbc-job-lock-manager-configuration/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md))
Add a [JdbcLockManager](-jdbc-lock-manager/index.md) | | [mongoDb](mongo-db.md) | [jvm]
fun [TaskSchedulingConfiguration](../io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-configuration/index.md).[mongoDb](mongo-db.md)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = null, config: [MongoDBJobLockManagerConfiguration](-mongo-d-b-job-lock-manager-configuration/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md))
Add a [MongoDBLockManager](-mongo-d-b-lock-manager/index.md) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/jdbc.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/jdbc.md index 3db61dd5..079228e6 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/jdbc.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/jdbc.md @@ -1,18 +1,16 @@ --- title: jdbc --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](index.md)/[jdbc](jdbc.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](index.md)/[jdbc](jdbc.md) # jdbc - - [jvm]\ -fun [TaskSchedulingConfiguration](../io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-configuration/index.md).[jdbc](jdbc.md)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = null, config: [JdbcJobLockManagerConfiguration](-jdbc-job-lock-manager-configuration/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) - - +fun [TaskSchedulingConfiguration](../io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-configuration/index.md).[jdbc](jdbc.md)( +name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = null, +config: [JdbcJobLockManagerConfiguration](-jdbc-job-lock-manager-configuration/index.md).() +-> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) Add a [JdbcLockManager](-jdbc-lock-manager/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/mongo-db.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/mongo-db.md index 14c3527e..d3a562c0 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/mongo-db.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/mongo-db.md @@ -1,18 +1,16 @@ --- title: mongoDb --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](index.md)/[mongoDb](mongo-db.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](index.md)/[mongoDb](mongo-db.md) # mongoDb - - [jvm]\ -fun [TaskSchedulingConfiguration](../io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-configuration/index.md).[mongoDb](mongo-db.md)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = null, config: [MongoDBJobLockManagerConfiguration](-mongo-d-b-job-lock-manager-configuration/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) - - +fun [TaskSchedulingConfiguration](../io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-configuration/index.md).[mongoDb](mongo-db.md)( +name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = null, +config: [MongoDBJobLockManagerConfiguration](-mongo-d-b-job-lock-manager-configuration/index.md).() +-> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) Add a [MongoDBLockManager](-mongo-d-b-lock-manager/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-lock-manager/-redis-lock-manager.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-lock-manager/-redis-lock-manager.md index 0c119ba9..2aae6d4c 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-lock-manager/-redis-lock-manager.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-lock-manager/-redis-lock-manager.md @@ -1,16 +1,17 @@ --- title: RedisLockManager --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisLockManager](index.md)/[RedisLockManager](-redis-lock-manager.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisLockManager](index.md)/[RedisLockManager](-redis-lock-manager.md) # RedisLockManager - - [common]\ -constructor(name: [TaskManagerConfiguration.TaskManagerName](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md), application: Application, connectionPool: RedisConnectionPool, lockExpirationMs: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md), connectionAcquisitionTimeoutMs: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)) +constructor( +name: [TaskManagerConfiguration.TaskManagerName](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md), +application: Application, connectionPool: RedisConnectionPool, +lockExpirationMs: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md), +connectionAcquisitionTimeoutMs: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-lock-manager/acquire-lock-key.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-lock-manager/acquire-lock-key.md index dcff4296..d7ca8324 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-lock-manager/acquire-lock-key.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-lock-manager/acquire-lock-key.md @@ -1,16 +1,15 @@ --- title: acquireLockKey --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisLockManager](index.md)/[acquireLockKey](acquire-lock-key.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisLockManager](index.md)/[acquireLockKey](acquire-lock-key.md) # acquireLockKey - - [common]\ -open suspend override fun [acquireLockKey](acquire-lock-key.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), executionTime: DateTime, concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [RedisTaskLock](../-redis-task-lock/index.md)? +open suspend override fun [acquireLockKey](acquire-lock-key.md)( +task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), executionTime: DateTime, +concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [RedisTaskLock](../-redis-task-lock/index.md)? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-lock-manager/application.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-lock-manager/application.md index 1e885476..b9e2948a 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-lock-manager/application.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-lock-manager/application.md @@ -1,14 +1,11 @@ --- title: application --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisLockManager](index.md)/[application](application.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisLockManager](index.md)/[application](application.md) # application - - [common]\ open override val [application](application.md): Application diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-lock-manager/close.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-lock-manager/close.md index bc449437..0a7772eb 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-lock-manager/close.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-lock-manager/close.md @@ -1,14 +1,11 @@ --- title: close --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisLockManager](index.md)/[close](close.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisLockManager](index.md)/[close](close.md) # close - - [common]\ open override fun [close](close.md)() diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-lock-manager/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-lock-manager/index.md index bc92aa26..ed6efd0f 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-lock-manager/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-lock-manager/index.md @@ -1,46 +1,43 @@ --- title: RedisLockManager --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisLockManager](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisLockManager](index.md) # RedisLockManager - - [common]\ -class [RedisLockManager](index.md)(val name: [TaskManagerConfiguration.TaskManagerName](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md), val application: Application, connectionPool: RedisConnectionPool, lockExpirationMs: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md), connectionAcquisitionTimeoutMs: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)) : [TaskLockManager](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/index.md)<[RedisTaskLock](../-redis-task-lock/index.md)> - -An implementation of [TaskLockManager](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/index.md) using Redis as the lock store - +class [RedisLockManager](index.md)(val +name: [TaskManagerConfiguration.TaskManagerName](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md), +val application: Application, connectionPool: RedisConnectionPool, +lockExpirationMs: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md), +connectionAcquisitionTimeoutMs: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)) : [TaskLockManager](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/index.md) +<[RedisTaskLock](../-redis-task-lock/index.md)> +An implementation +of [TaskLockManager](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/index.md) +using Redis as the lock store ## Constructors - -| | | -|---|---| +| | | +|--------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [RedisLockManager](-redis-lock-manager.md) | [common]
constructor(name: [TaskManagerConfiguration.TaskManagerName](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md), application: Application, connectionPool: RedisConnectionPool, lockExpirationMs: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md), connectionAcquisitionTimeoutMs: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)) | - ## Properties - -| Name | Summary | -|---|---| -| [application](application.md) | [common]
open override val [application](application.md): Application | -| [name](name.md) | [common]
open override val [name](name.md): [TaskManagerConfiguration.TaskManagerName](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md) | - +| Name | Summary | +|-------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [application](application.md) | [common]
open override val [application](application.md): Application | +| [name](name.md) | [common]
open override val [name](name.md): [TaskManagerConfiguration.TaskManagerName](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md) | ## Functions - -| Name | Summary | -|---|---| -| [acquireLockKey](acquire-lock-key.md) | [common]
open suspend override fun [acquireLockKey](acquire-lock-key.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), executionTime: DateTime, concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [RedisTaskLock](../-redis-task-lock/index.md)? | +| Name | Summary | +|----------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [acquireLockKey](acquire-lock-key.md) | [common]
open suspend override fun [acquireLockKey](acquire-lock-key.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), executionTime: DateTime, concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [RedisTaskLock](../-redis-task-lock/index.md)? | | [attemptExecute](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/attempt-execute.md) | [common]
open suspend override fun [attemptExecute](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/attempt-execute.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), executionTime: DateTime, concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [RedisTaskLock](../-redis-task-lock/index.md)? | -| [close](close.md) | [common]
open override fun [close](close.md)() | -| [init](init.md) | [common]
open suspend override fun [init](init.md)(tasks: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<[Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md)>) | -| [markExecuted](index.md#-715430314%2FFunctions%2F1182336650) | [common]
open suspend override fun [markExecuted](index.md#-715430314%2FFunctions%2F1182336650)(key: [RedisTaskLock](../-redis-task-lock/index.md)) | +| [close](close.md) | [common]
open override fun [close](close.md)() | +| [init](init.md) | [common]
open suspend override fun [init](init.md)(tasks: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<[Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md)>) | +| [markExecuted](index.md#-715430314%2FFunctions%2F1182336650) | [common]
open suspend override fun [markExecuted](index.md#-715430314%2FFunctions%2F1182336650)(key: [RedisTaskLock](../-redis-task-lock/index.md)) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-lock-manager/init.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-lock-manager/init.md index 823d3299..572f347e 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-lock-manager/init.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-lock-manager/init.md @@ -1,16 +1,15 @@ --- title: init --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisLockManager](index.md)/[init](init.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisLockManager](index.md)/[init](init.md) # init - - [common]\ -open suspend override fun [init](init.md)(tasks: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<[Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md)>) +open suspend override fun [init](init.md)( +tasks: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md) +<[Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md)>) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-lock-manager/name.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-lock-manager/name.md index a349bd8f..55a025e7 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-lock-manager/name.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-lock-manager/name.md @@ -1,16 +1,14 @@ --- title: name --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisLockManager](index.md)/[name](name.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisLockManager](index.md)/[name](name.md) # name - - [common]\ -open override val [name](name.md): [TaskManagerConfiguration.TaskManagerName](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md) +open override +val [name](name.md): [TaskManagerConfiguration.TaskManagerName](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/-redis-task-lock-manager-configuration.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/-redis-task-lock-manager-configuration.md index 05ef4bee..cdb337c5 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/-redis-task-lock-manager-configuration.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/-redis-task-lock-manager-configuration.md @@ -1,16 +1,21 @@ --- title: RedisTaskLockManagerConfiguration --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisTaskLockManagerConfiguration](index.md)/[RedisTaskLockManagerConfiguration](-redis-task-lock-manager-configuration.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisTaskLockManagerConfiguration](index.md)/[RedisTaskLockManagerConfiguration](-redis-task-lock-manager-configuration.md) # RedisTaskLockManagerConfiguration - - [common]\ -constructor(host: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) = "undefined", port: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = 0, username: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = null, password: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = null, lockExpirationMs: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = 100, connectionPoolInitialSize: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = 10, connectionPoolMaxSize: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = connectionPoolInitialSize, connectionAcquisitionTimeoutMs: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = 100) +constructor(host: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) = +"undefined", port: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = 0, +username: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = null, +password: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = null, +lockExpirationMs: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = 100, +connectionPoolInitialSize: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = 10, +connectionPoolMaxSize: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = +connectionPoolInitialSize, +connectionAcquisitionTimeoutMs: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = 100) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/connection-acquisition-timeout-ms.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/connection-acquisition-timeout-ms.md index 46cc44bb..6fa1e639 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/connection-acquisition-timeout-ms.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/connection-acquisition-timeout-ms.md @@ -1,19 +1,14 @@ --- title: connectionAcquisitionTimeoutMs --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisTaskLockManagerConfiguration](index.md)/[connectionAcquisitionTimeoutMs](connection-acquisition-timeout-ms.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisTaskLockManagerConfiguration](index.md)/[connectionAcquisitionTimeoutMs](connection-acquisition-timeout-ms.md) # connectionAcquisitionTimeoutMs - - [common]\ var [connectionAcquisitionTimeoutMs](connection-acquisition-timeout-ms.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) - - The timeout for trying to get a connection to from the pool diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/connection-pool-initial-size.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/connection-pool-initial-size.md index 95431da7..b87034d5 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/connection-pool-initial-size.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/connection-pool-initial-size.md @@ -1,19 +1,14 @@ --- title: connectionPoolInitialSize --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisTaskLockManagerConfiguration](index.md)/[connectionPoolInitialSize](connection-pool-initial-size.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisTaskLockManagerConfiguration](index.md)/[connectionPoolInitialSize](connection-pool-initial-size.md) # connectionPoolInitialSize - - [common]\ var [connectionPoolInitialSize](connection-pool-initial-size.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) - - How many connections should the pool have initially diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/connection-pool-max-size.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/connection-pool-max-size.md index 7d2226cc..2779b56a 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/connection-pool-max-size.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/connection-pool-max-size.md @@ -1,19 +1,14 @@ --- title: connectionPoolMaxSize --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisTaskLockManagerConfiguration](index.md)/[connectionPoolMaxSize](connection-pool-max-size.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisTaskLockManagerConfiguration](index.md)/[connectionPoolMaxSize](connection-pool-max-size.md) # connectionPoolMaxSize - - [common]\ var [connectionPoolMaxSize](connection-pool-max-size.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) - - The maximum number of connections in the pool diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/create-task-manager.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/create-task-manager.md index 14ec6773..c0438f70 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/create-task-manager.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/create-task-manager.md @@ -1,16 +1,14 @@ --- title: createTaskManager --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisTaskLockManagerConfiguration](index.md)/[createTaskManager](create-task-manager.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisTaskLockManagerConfiguration](index.md)/[createTaskManager](create-task-manager.md) # createTaskManager - - [common]\ -open override fun [createTaskManager](create-task-manager.md)(application: Application): [RedisLockManager](../-redis-lock-manager/index.md) +open override fun [createTaskManager](create-task-manager.md)(application: +Application): [RedisLockManager](../-redis-lock-manager/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/host.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/host.md index e94b396a..42d58307 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/host.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/host.md @@ -1,19 +1,14 @@ --- title: host --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisTaskLockManagerConfiguration](index.md)/[host](host.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisTaskLockManagerConfiguration](index.md)/[host](host.md) # host - - [common]\ var [host](host.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) - - The redis host diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/index.md index 48b2cc21..133de83e 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/index.md @@ -1,47 +1,48 @@ --- title: RedisTaskLockManagerConfiguration --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisTaskLockManagerConfiguration](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisTaskLockManagerConfiguration](index.md) # RedisTaskLockManagerConfiguration - - [common]\ -class [RedisTaskLockManagerConfiguration](index.md)(var host: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) = "undefined", var port: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = 0, var username: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = null, var password: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = null, var lockExpirationMs: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = 100, var connectionPoolInitialSize: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = 10, var connectionPoolMaxSize: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = connectionPoolInitialSize, var connectionAcquisitionTimeoutMs: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = 100) : [TaskLockManagerConfiguration](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager-configuration/index.md)<[RedisTaskLock](../-redis-task-lock/index.md)> - - +class [RedisTaskLockManagerConfiguration](index.md)(var +host: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) = "undefined", var +port: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = 0, var +username: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = null, var +password: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = null, var +lockExpirationMs: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = 100, var +connectionPoolInitialSize: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = 10, var +connectionPoolMaxSize: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = +connectionPoolInitialSize, var +connectionAcquisitionTimeoutMs: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = +100) : [TaskLockManagerConfiguration](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager-configuration/index.md) +<[RedisTaskLock](../-redis-task-lock/index.md)> ## Constructors - -| | | -|---|---| +| | | +|--------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [RedisTaskLockManagerConfiguration](-redis-task-lock-manager-configuration.md) | [common]
constructor(host: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) = "undefined", port: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = 0, username: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = null, password: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = null, lockExpirationMs: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = 100, connectionPoolInitialSize: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = 10, connectionPoolMaxSize: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = connectionPoolInitialSize, connectionAcquisitionTimeoutMs: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = 100) | - ## Properties - -| Name | Summary | -|---|---| -| [connectionAcquisitionTimeoutMs](connection-acquisition-timeout-ms.md) | [common]
var [connectionAcquisitionTimeoutMs](connection-acquisition-timeout-ms.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)
The timeout for trying to get a connection to from the pool | -| [connectionPoolInitialSize](connection-pool-initial-size.md) | [common]
var [connectionPoolInitialSize](connection-pool-initial-size.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)
How many connections should the pool have initially | -| [connectionPoolMaxSize](connection-pool-max-size.md) | [common]
var [connectionPoolMaxSize](connection-pool-max-size.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)
The maximum number of connections in the pool | -| [host](host.md) | [common]
var [host](host.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)
The redis host | -| [lockExpirationMs](lock-expiration-ms.md) | [common]
var [lockExpirationMs](lock-expiration-ms.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)
For how long the lock should be valid, effectively, the pxMilliseconds for the setNx command | -| [name](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/name.md) | [common]
var [name](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? | -| [password](password.md) | [common]
var [password](password.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?
The redis password | -| [port](port.md) | [common]
var [port](port.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)
The redis port | -| [username](username.md) | [common]
var [username](username.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?
The redis username | - +| Name | Summary | +|-----------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [connectionAcquisitionTimeoutMs](connection-acquisition-timeout-ms.md) | [common]
var [connectionAcquisitionTimeoutMs](connection-acquisition-timeout-ms.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)
The timeout for trying to get a connection to from the pool | +| [connectionPoolInitialSize](connection-pool-initial-size.md) | [common]
var [connectionPoolInitialSize](connection-pool-initial-size.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)
How many connections should the pool have initially | +| [connectionPoolMaxSize](connection-pool-max-size.md) | [common]
var [connectionPoolMaxSize](connection-pool-max-size.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)
The maximum number of connections in the pool | +| [host](host.md) | [common]
var [host](host.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)
The redis host | +| [lockExpirationMs](lock-expiration-ms.md) | [common]
var [lockExpirationMs](lock-expiration-ms.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)
For how long the lock should be valid, effectively, the pxMilliseconds for the setNx command | +| [name](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/name.md) | [common]
var [name](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? | +| [password](password.md) | [common]
var [password](password.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?
The redis password | +| [port](port.md) | [common]
var [port](port.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)
The redis port | +| [username](username.md) | [common]
var [username](username.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?
The redis username | ## Functions - -| Name | Summary | -|---|---| +| Name | Summary | +|---------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| | [createTaskManager](create-task-manager.md) | [common]
open override fun [createTaskManager](create-task-manager.md)(application: Application): [RedisLockManager](../-redis-lock-manager/index.md) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/lock-expiration-ms.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/lock-expiration-ms.md index ba984619..de0d1db0 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/lock-expiration-ms.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/lock-expiration-ms.md @@ -1,19 +1,14 @@ --- title: lockExpirationMs --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisTaskLockManagerConfiguration](index.md)/[lockExpirationMs](lock-expiration-ms.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisTaskLockManagerConfiguration](index.md)/[lockExpirationMs](lock-expiration-ms.md) # lockExpirationMs - - [common]\ var [lockExpirationMs](lock-expiration-ms.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) - - For how long the lock should be valid, effectively, the pxMilliseconds for the setNx command diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/password.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/password.md index f7f6f0f6..bc329419 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/password.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/password.md @@ -1,19 +1,14 @@ --- title: password --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisTaskLockManagerConfiguration](index.md)/[password](password.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisTaskLockManagerConfiguration](index.md)/[password](password.md) # password - - [common]\ var [password](password.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? - - The redis password diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/port.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/port.md index c33c6fed..579867b1 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/port.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/port.md @@ -1,19 +1,14 @@ --- title: port --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisTaskLockManagerConfiguration](index.md)/[port](port.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisTaskLockManagerConfiguration](index.md)/[port](port.md) # port - - [common]\ var [port](port.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) - - The redis port diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/username.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/username.md index b8e4b740..6772b1ab 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/username.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/username.md @@ -1,19 +1,14 @@ --- title: username --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisTaskLockManagerConfiguration](index.md)/[username](username.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisTaskLockManagerConfiguration](index.md)/[username](username.md) # username - - [common]\ var [username](username.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? - - The redis username diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock/-companion/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock/-companion/index.md index 35ce145d..a597b045 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock/-companion/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock/-companion/index.md @@ -1,23 +1,17 @@ --- title: Companion --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../../index.md)/[RedisTaskLock](../index.md)/[Companion](index.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../../index.md)/[RedisTaskLock](../index.md)/[Companion](index.md) # Companion - - [common]\ object [Companion](index.md) - - ## Functions - -| Name | Summary | -|---|---| +| Name | Summary | +|----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [toRedisLockKey](to-redis-lock-key.md) | [common]
fun [Task](../../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md).[toRedisLockKey](to-redis-lock-key.md)(executionTime: DateTime, concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [RedisTaskLock](../index.md) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock/-companion/to-redis-lock-key.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock/-companion/to-redis-lock-key.md index 51098082..9f7f1dc3 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock/-companion/to-redis-lock-key.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock/-companion/to-redis-lock-key.md @@ -1,16 +1,15 @@ --- title: toRedisLockKey --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../../index.md)/[RedisTaskLock](../index.md)/[Companion](index.md)/[toRedisLockKey](to-redis-lock-key.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../../index.md)/[RedisTaskLock](../index.md)/[Companion](index.md)/[toRedisLockKey](to-redis-lock-key.md) # toRedisLockKey - - [common]\ -fun [Task](../../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md).[toRedisLockKey](to-redis-lock-key.md)(executionTime: DateTime, concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [RedisTaskLock](../index.md) +fun [Task](../../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md).[toRedisLockKey](to-redis-lock-key.md)( +executionTime: DateTime, +concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [RedisTaskLock](../index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock/concurrency-index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock/concurrency-index.md index 97bd0839..6735f64b 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock/concurrency-index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock/concurrency-index.md @@ -1,16 +1,14 @@ --- title: concurrencyIndex --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisTaskLock](index.md)/[concurrencyIndex](concurrency-index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisTaskLock](index.md)/[concurrencyIndex](concurrency-index.md) # concurrencyIndex - - [common]\ -open override val [concurrencyIndex](concurrency-index.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) +open override +val [concurrencyIndex](concurrency-index.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock/index.md index 93200abb..cbab93c5 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock/index.md @@ -1,39 +1,31 @@ --- title: RedisTaskLock --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisTaskLock](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisTaskLock](index.md) # RedisTaskLock - - [common]\ @[JvmInline](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-inline/index.md) +value +class [RedisTaskLock](index.md) : [TaskLock](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task-lock/index.md) - -value class [RedisTaskLock](index.md) : [TaskLock](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task-lock/index.md) - -A [TaskLock](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task-lock/index.md) implementation for redis to use as a key - - +A [TaskLock](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task-lock/index.md) implementation for +redis to use as a key ## Types - -| Name | Summary | -|---|---| +| Name | Summary | +|----------------------------------|-----------------------------------------------------| | [Companion](-companion/index.md) | [common]
object [Companion](-companion/index.md) | - ## Properties - -| Name | Summary | -|---|---| -| [concurrencyIndex](concurrency-index.md) | [common]
open override val [concurrencyIndex](concurrency-index.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) | -| [name](name.md) | [common]
open override val [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | -| [value](value.md) | [common]
val [value](value.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)
must be unique to a task execution, i.e `$name_$concurrencyIndex at $executionTime` | +| Name | Summary | +|------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [concurrencyIndex](concurrency-index.md) | [common]
open override val [concurrencyIndex](concurrency-index.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) | +| [name](name.md) | [common]
open override val [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | +| [value](value.md) | [common]
val [value](value.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)
must be unique to a task execution, i.e `$name_$concurrencyIndex at $executionTime` | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock/name.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock/name.md index 6d72ceac..8c4b2892 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock/name.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock/name.md @@ -1,14 +1,11 @@ --- title: name --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisTaskLock](index.md)/[name](name.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisTaskLock](index.md)/[name](name.md) # name - - [common]\ open override val [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock/value.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock/value.md index 639123fb..bcd0665e 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock/value.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock/value.md @@ -1,19 +1,14 @@ --- title: value --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisTaskLock](index.md)/[value](value.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](../index.md)/[RedisTaskLock](index.md)/[value](value.md) # value - - [common]\ val [value](value.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) - - must be unique to a task execution, i.e `$name_$concurrencyIndex at $executionTime` diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/index.md index 5add32aa..2c271d0d 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/index.md @@ -1,28 +1,22 @@ --- title: io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](index.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](index.md) # Package-level declarations - - ## Types - -| Name | Summary | -|---|---| -| [RedisLockManager](-redis-lock-manager/index.md) | [common]
class [RedisLockManager](-redis-lock-manager/index.md)(val name: [TaskManagerConfiguration.TaskManagerName](../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md), val application: Application, connectionPool: RedisConnectionPool, lockExpirationMs: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md), connectionAcquisitionTimeoutMs: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)) : [TaskLockManager](../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/index.md)<[RedisTaskLock](-redis-task-lock/index.md)>
An implementation of [TaskLockManager](../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/index.md) using Redis as the lock store | -| [RedisTaskLock](-redis-task-lock/index.md) | [common]
@[JvmInline](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-inline/index.md)
value class [RedisTaskLock](-redis-task-lock/index.md) : [TaskLock](../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task-lock/index.md)
A [TaskLock](../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task-lock/index.md) implementation for redis to use as a key | +| Name | Summary | +|--------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [RedisLockManager](-redis-lock-manager/index.md) | [common]
class [RedisLockManager](-redis-lock-manager/index.md)(val name: [TaskManagerConfiguration.TaskManagerName](../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md), val application: Application, connectionPool: RedisConnectionPool, lockExpirationMs: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md), connectionAcquisitionTimeoutMs: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)) : [TaskLockManager](../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/index.md)<[RedisTaskLock](-redis-task-lock/index.md)>
An implementation of [TaskLockManager](../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/index.md) using Redis as the lock store | +| [RedisTaskLock](-redis-task-lock/index.md) | [common]
@[JvmInline](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-inline/index.md)
value class [RedisTaskLock](-redis-task-lock/index.md) : [TaskLock](../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task-lock/index.md)
A [TaskLock](../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task-lock/index.md) implementation for redis to use as a key | | [RedisTaskLockManagerConfiguration](-redis-task-lock-manager-configuration/index.md) | [common]
class [RedisTaskLockManagerConfiguration](-redis-task-lock-manager-configuration/index.md)(var host: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) = "undefined", var port: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = 0, var username: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = null, var password: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = null, var lockExpirationMs: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = 100, var connectionPoolInitialSize: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = 10, var connectionPoolMaxSize: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = connectionPoolInitialSize, var connectionAcquisitionTimeoutMs: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) = 100) : [TaskLockManagerConfiguration](../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager-configuration/index.md)<[RedisTaskLock](-redis-task-lock/index.md)> | - ## Functions - -| Name | Summary | -|---|---| +| Name | Summary | +|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [redis](redis.md) | [common]
fun [TaskSchedulingConfiguration](../io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-configuration/index.md).[redis](redis.md)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = null, config: [RedisTaskLockManagerConfiguration](-redis-task-lock-manager-configuration/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md))
Add a [RedisLockManager](-redis-lock-manager/index.md) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/redis.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/redis.md index 47a3e20e..dc0b01c4 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/redis.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/redis.md @@ -1,18 +1,16 @@ --- title: redis --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](index.md)/[redis](redis.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](index.md)/[redis](redis.md) # redis - - [common]\ -fun [TaskSchedulingConfiguration](../io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-configuration/index.md).[redis](redis.md)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = null, config: [RedisTaskLockManagerConfiguration](-redis-task-lock-manager-configuration/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) - - +fun [TaskSchedulingConfiguration](../io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-configuration/index.md).[redis](redis.md)( +name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = null, +config: [RedisTaskLockManagerConfiguration](-redis-task-lock-manager-configuration/index.md).() +-> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) Add a [RedisLockManager](-redis-lock-manager/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager-configuration/-task-lock-manager-configuration.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager-configuration/-task-lock-manager-configuration.md index 8e978130..66f01e14 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager-configuration/-task-lock-manager-configuration.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager-configuration/-task-lock-manager-configuration.md @@ -1,14 +1,11 @@ --- title: TaskLockManagerConfiguration --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock](../index.md)/[TaskLockManagerConfiguration](index.md)/[TaskLockManagerConfiguration](-task-lock-manager-configuration.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock](../index.md)/[TaskLockManagerConfiguration](index.md)/[TaskLockManagerConfiguration](-task-lock-manager-configuration.md) # TaskLockManagerConfiguration - - [common]\ constructor() diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager-configuration/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager-configuration/index.md index 0f1ae438..e07a7de4 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager-configuration/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager-configuration/index.md @@ -1,43 +1,37 @@ --- title: TaskLockManagerConfiguration --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock](../index.md)/[TaskLockManagerConfiguration](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock](../index.md)/[TaskLockManagerConfiguration](index.md) # TaskLockManagerConfiguration -abstract class [TaskLockManagerConfiguration](index.md)<[TASK_LOCK](index.md)> : [TaskManagerConfiguration](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/index.md)<[TASK_LOCK](index.md)> +abstract class [TaskLockManagerConfiguration](index.md)<[TASK_LOCK](index.md) +> : [TaskManagerConfiguration](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/index.md) +<[TASK_LOCK](index.md)> #### Inheritors - -| | -|---| +| | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [DatabaseTaskLockManagerConfiguration](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager-configuration/index.md) | -| [RedisTaskLockManagerConfiguration](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/index.md) | - +| [RedisTaskLockManagerConfiguration](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/index.md) | ## Constructors - -| | | -|---|---| +| | | +|---------------------------------------------------------------------|---------------------------| | [TaskLockManagerConfiguration](-task-lock-manager-configuration.md) | [common]
constructor() | - ## Properties - -| Name | Summary | -|---|---| +| Name | Summary | +|-----------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [name](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/name.md) | [common]
var [name](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?
The name of the task manager, will be used to identify the task manager when assigning tasks to it if none is provided, it will be considered the default one. only one default task manager is allowed. | - ## Functions - -| Name | Summary | -|---|---| +| Name | Summary | +|---------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [createTaskManager](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/create-task-manager.md) | [common]
abstract fun [createTaskManager](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/create-task-manager.md)(application: Application): [TaskManager](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/index.md)<out [TaskExecutionToken](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-execution-token/index.md)>
Create the [TaskManager](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/index.md) that this configuration is for | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/-task-lock-manager.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/-task-lock-manager.md index 15c8cf80..9e2ab83d 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/-task-lock-manager.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/-task-lock-manager.md @@ -1,14 +1,11 @@ --- title: TaskLockManager --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock](../index.md)/[TaskLockManager](index.md)/[TaskLockManager](-task-lock-manager.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock](../index.md)/[TaskLockManager](index.md)/[TaskLockManager](-task-lock-manager.md) # TaskLockManager - - [common]\ constructor() diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/acquire-lock-key.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/acquire-lock-key.md index d65019bd..df23e902 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/acquire-lock-key.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/acquire-lock-key.md @@ -1,18 +1,15 @@ --- title: acquireLockKey --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock](../index.md)/[TaskLockManager](index.md)/[acquireLockKey](acquire-lock-key.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock](../index.md)/[TaskLockManager](index.md)/[acquireLockKey](acquire-lock-key.md) # acquireLockKey - - [common]\ -abstract suspend fun [acquireLockKey](acquire-lock-key.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), executionTime: DateTime, concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [TASK_LOCK](index.md)? - - +abstract suspend fun [acquireLockKey](acquire-lock-key.md)( +task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), executionTime: DateTime, +concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [TASK_LOCK](index.md)? Get permission to execute the task diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/attempt-execute.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/attempt-execute.md index 44cb8097..b2eabae8 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/attempt-execute.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/attempt-execute.md @@ -1,18 +1,15 @@ --- title: attemptExecute --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock](../index.md)/[TaskLockManager](index.md)/[attemptExecute](attempt-execute.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock](../index.md)/[TaskLockManager](index.md)/[attemptExecute](attempt-execute.md) # attemptExecute - - [common]\ -open suspend override fun [attemptExecute](attempt-execute.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), executionTime: DateTime, concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [TASK_LOCK](index.md)? - - +open suspend override fun [attemptExecute](attempt-execute.md)( +task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), executionTime: DateTime, +concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [TASK_LOCK](index.md)? Try executing the given task at the given execution time with the given concurrency index diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/index.md index 034b6f55..6c82b873 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/index.md @@ -1,48 +1,43 @@ --- title: TaskLockManager --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock](../index.md)/[TaskLockManager](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock](../index.md)/[TaskLockManager](index.md) # TaskLockManager -abstract class [TaskLockManager](index.md)<[TASK_LOCK](index.md) : [TaskLock](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task-lock/index.md)> : [TaskManager](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/index.md)<[TASK_LOCK](index.md)> +abstract class [TaskLockManager](index.md) +<[TASK_LOCK](index.md) : [TaskLock](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task-lock/index.md) +> : [TaskManager](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/index.md) +<[TASK_LOCK](index.md)> #### Inheritors - -| | -|---| +| | +|---------------------------------------------------------------------------------------------------------------------------------------------------| | [DatabaseTaskLockManager](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager/index.md) | -| [RedisLockManager](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-lock-manager/index.md) | - +| [RedisLockManager](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-lock-manager/index.md) | ## Constructors - -| | | -|---|---| +| | | +|------------------------------------------|---------------------------| | [TaskLockManager](-task-lock-manager.md) | [common]
constructor() | - ## Properties - -| Name | Summary | -|---|---| -| [application](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/application.md) | [common]
abstract val [application](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/application.md): Application | -| [name](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/name.md) | [common]
abstract val [name](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/name.md): [TaskManagerConfiguration.TaskManagerName](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md) | - +| Name | Summary | +|-----------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [application](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/application.md) | [common]
abstract val [application](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/application.md): Application | +| [name](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/name.md) | [common]
abstract val [name](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/name.md): [TaskManagerConfiguration.TaskManagerName](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md) | ## Functions - -| Name | Summary | -|---|---| -| [acquireLockKey](acquire-lock-key.md) | [common]
abstract suspend fun [acquireLockKey](acquire-lock-key.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), executionTime: DateTime, concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [TASK_LOCK](index.md)?
Get permission to execute the task | -| [attemptExecute](attempt-execute.md) | [common]
open suspend override fun [attemptExecute](attempt-execute.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), executionTime: DateTime, concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [TASK_LOCK](index.md)?
Try executing the given task at the given execution time with the given concurrency index | -| [close](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager/index.md#539526881%2FFunctions%2F1182336650) | [common]
expect abstract fun [close](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager/index.md#539526881%2FFunctions%2F1182336650)() | -| [init](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/init.md) | [common]
abstract suspend fun [init](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/init.md)(tasks: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<[Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md)>)
Initialize the [TaskManager](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/index.md) with the given tasks it manages | -| [markExecuted](mark-executed.md) | [common]
open suspend override fun [markExecuted](mark-executed.md)(key: [TASK_LOCK](index.md))
Mark this task as, provided a key was acquired | +| Name | Summary | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [acquireLockKey](acquire-lock-key.md) | [common]
abstract suspend fun [acquireLockKey](acquire-lock-key.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), executionTime: DateTime, concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [TASK_LOCK](index.md)?
Get permission to execute the task | +| [attemptExecute](attempt-execute.md) | [common]
open suspend override fun [attemptExecute](attempt-execute.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), executionTime: DateTime, concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [TASK_LOCK](index.md)?
Try executing the given task at the given execution time with the given concurrency index | +| [close](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager/index.md#539526881%2FFunctions%2F1182336650) | [common]
expect abstract fun [close](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager/index.md#539526881%2FFunctions%2F1182336650)() | +| [init](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/init.md) | [common]
abstract suspend fun [init](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/init.md)(tasks: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<[Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md)>)
Initialize the [TaskManager](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/index.md) with the given tasks it manages | +| [markExecuted](mark-executed.md) | [common]
open suspend override fun [markExecuted](mark-executed.md)(key: [TASK_LOCK](index.md))
Mark this task as, provided a key was acquired | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/mark-executed.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/mark-executed.md index 2dedb968..d9aea159 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/mark-executed.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/mark-executed.md @@ -1,19 +1,14 @@ --- title: markExecuted --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock](../index.md)/[TaskLockManager](index.md)/[markExecuted](mark-executed.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock](../index.md)/[TaskLockManager](index.md)/[markExecuted](mark-executed.md) # markExecuted - - [common]\ open suspend override fun [markExecuted](mark-executed.md)(key: [TASK_LOCK](index.md)) - - Mark this task as, provided a key was acquired diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/index.md index 207fecd4..90cf1d4a 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/index.md @@ -1,19 +1,15 @@ --- title: io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock](index.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock](index.md) # Package-level declarations - - ## Types - -| Name | Summary | -|---|---| -| [TaskLockManager](-task-lock-manager/index.md) | [common]
abstract class [TaskLockManager](-task-lock-manager/index.md)<[TASK_LOCK](-task-lock-manager/index.md) : [TaskLock](../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task-lock/index.md)> : [TaskManager](../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/index.md)<[TASK_LOCK](-task-lock-manager/index.md)> | -| [TaskLockManagerConfiguration](-task-lock-manager-configuration/index.md) | [common]
abstract class [TaskLockManagerConfiguration](-task-lock-manager-configuration/index.md)<[TASK_LOCK](-task-lock-manager-configuration/index.md)> : [TaskManagerConfiguration](../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/index.md)<[TASK_LOCK](-task-lock-manager-configuration/index.md)> | +| Name | Summary | +|---------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [TaskLockManager](-task-lock-manager/index.md) | [common]
abstract class [TaskLockManager](-task-lock-manager/index.md)<[TASK_LOCK](-task-lock-manager/index.md) : [TaskLock](../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task-lock/index.md)> : [TaskManager](../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/index.md)<[TASK_LOCK](-task-lock-manager/index.md)> | +| [TaskLockManagerConfiguration](-task-lock-manager-configuration/index.md) | [common]
abstract class [TaskLockManagerConfiguration](-task-lock-manager-configuration/index.md)<[TASK_LOCK](-task-lock-manager-configuration/index.md)> : [TaskManagerConfiguration](../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/index.md)<[TASK_LOCK](-task-lock-manager-configuration/index.md)> | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-execution-token/concurrency-index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-execution-token/concurrency-index.md index 5ce2f110..69227db4 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-execution-token/concurrency-index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-execution-token/concurrency-index.md @@ -1,16 +1,14 @@ --- title: concurrencyIndex --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../index.md)/[TaskExecutionToken](index.md)/[concurrencyIndex](concurrency-index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../index.md)/[TaskExecutionToken](index.md)/[concurrencyIndex](concurrency-index.md) # concurrencyIndex - - [common]\ -abstract val [concurrencyIndex](concurrency-index.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) +abstract +val [concurrencyIndex](concurrency-index.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-execution-token/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-execution-token/index.md index cad075aa..13b7ec74 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-execution-token/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-execution-token/index.md @@ -1,9 +1,8 @@ --- title: TaskExecutionToken --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../index.md)/[TaskExecutionToken](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../index.md)/[TaskExecutionToken](index.md) # TaskExecutionToken @@ -11,21 +10,16 @@ interface [TaskExecutionToken](index.md) Represents a token that can be used to grant permission to execute a task - - #### Inheritors - -| | -|---| +| | +|--------------------------------------------------------------------------------------------------| | [TaskLock](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task-lock/index.md) | - ## Properties - -| Name | Summary | -|---|---| +| Name | Summary | +|------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------| | [concurrencyIndex](concurrency-index.md) | [common]
abstract val [concurrencyIndex](concurrency-index.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) | -| [name](name.md) | [common]
abstract val [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | +| [name](name.md) | [common]
abstract val [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-execution-token/name.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-execution-token/name.md index 41734835..5122acc3 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-execution-token/name.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-execution-token/name.md @@ -1,14 +1,11 @@ --- title: name --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../index.md)/[TaskExecutionToken](index.md)/[name](name.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../index.md)/[TaskExecutionToken](index.md)/[name](name.md) # name - - [common]\ abstract val [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-configuration.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-configuration.md index d4e76b19..f0313a8e 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-configuration.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-configuration.md @@ -1,14 +1,11 @@ --- title: TaskManagerConfiguration --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../index.md)/[TaskManagerConfiguration](index.md)/[TaskManagerConfiguration](-task-manager-configuration.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../index.md)/[TaskManagerConfiguration](index.md)/[TaskManagerConfiguration](-task-manager-configuration.md) # TaskManagerConfiguration - - [common]\ constructor() diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/-companion/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/-companion/index.md index 6c401da6..dcd5a987 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/-companion/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/-companion/index.md @@ -1,23 +1,17 @@ --- title: Companion --- -//[extra-ktor-plugins](../../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../../../index.md)/[TaskManagerConfiguration](../../index.md)/[TaskManagerName](../index.md)/[Companion](index.md) - +//[extra-ktor-plugins](../../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../../../index.md)/[TaskManagerConfiguration](../../index.md)/[TaskManagerName](../index.md)/[Companion](index.md) # Companion - - [common]\ object [Companion](index.md) - - ## Functions - -| Name | Summary | -|---|---| +| Name | Summary | +|----------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [toTaskManagerName](to-task-manager-name.md) | [common]
fun [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?.[toTaskManagerName](to-task-manager-name.md)(): [TaskManagerConfiguration.TaskManagerName](../index.md) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/-companion/to-task-manager-name.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/-companion/to-task-manager-name.md index 55e71931..412ae47e 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/-companion/to-task-manager-name.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/-companion/to-task-manager-name.md @@ -1,14 +1,11 @@ --- title: toTaskManagerName --- -//[extra-ktor-plugins](../../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../../../index.md)/[TaskManagerConfiguration](../../index.md)/[TaskManagerName](../index.md)/[Companion](index.md)/[toTaskManagerName](to-task-manager-name.md) - +//[extra-ktor-plugins](../../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../../../index.md)/[TaskManagerConfiguration](../../index.md)/[TaskManagerName](../index.md)/[Companion](index.md)/[toTaskManagerName](to-task-manager-name.md) # toTaskManagerName - - [common]\ fun [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?.[toTaskManagerName](to-task-manager-name.md)(): [TaskManagerConfiguration.TaskManagerName](../index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/-task-manager-name.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/-task-manager-name.md index faf1687b..b7d3507a 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/-task-manager-name.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/-task-manager-name.md @@ -1,14 +1,11 @@ --- title: TaskManagerName --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../../index.md)/[TaskManagerConfiguration](../index.md)/[TaskManagerName](index.md)/[TaskManagerName](-task-manager-name.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../../index.md)/[TaskManagerConfiguration](../index.md)/[TaskManagerName](index.md)/[TaskManagerName](-task-manager-name.md) # TaskManagerName - - [common]\ constructor(value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md index 2c578c22..d0a9c89f 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/index.md @@ -1,43 +1,32 @@ --- title: TaskManagerName --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../../index.md)/[TaskManagerConfiguration](../index.md)/[TaskManagerName](index.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../../index.md)/[TaskManagerConfiguration](../index.md)/[TaskManagerName](index.md) # TaskManagerName - - [common]\ @[JvmInline](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-inline/index.md) - - -value class [TaskManagerName](index.md)(val value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)) - - +value class [TaskManagerName](index.md)(val +value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)) ## Constructors - -| | | -|---|---| +| | | +|------------------------------------------|----------------------------------------------------------------------------------------------------------------| | [TaskManagerName](-task-manager-name.md) | [common]
constructor(value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)) | - ## Types - -| Name | Summary | -|---|---| +| Name | Summary | +|----------------------------------|-----------------------------------------------------| | [Companion](-companion/index.md) | [common]
object [Companion](-companion/index.md) | - ## Properties - -| Name | Summary | -|---|---| +| Name | Summary | +|-------------------|-------------------------------------------------------------------------------------------------------------------| | [value](value.md) | [common]
val [value](value.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/value.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/value.md index 8b7b2547..82fb4f3b 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/value.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/-task-manager-name/value.md @@ -1,14 +1,11 @@ --- title: value --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../../index.md)/[TaskManagerConfiguration](../index.md)/[TaskManagerName](index.md)/[value](value.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../../index.md)/[TaskManagerConfiguration](../index.md)/[TaskManagerName](index.md)/[value](value.md) # value - - [common]\ val [value](value.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/create-task-manager.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/create-task-manager.md index b483b9a5..e4dc1fdb 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/create-task-manager.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/create-task-manager.md @@ -1,18 +1,15 @@ --- title: createTaskManager --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../index.md)/[TaskManagerConfiguration](index.md)/[createTaskManager](create-task-manager.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../index.md)/[TaskManagerConfiguration](index.md)/[createTaskManager](create-task-manager.md) # createTaskManager - - [common]\ -abstract fun [createTaskManager](create-task-manager.md)(application: Application): [TaskManager](../-task-manager/index.md)<out [TaskExecutionToken](../-task-execution-token/index.md)> - - +abstract fun [createTaskManager](create-task-manager.md)(application: +Application): [TaskManager](../-task-manager/index.md)<out [TaskExecutionToken](../-task-execution-token/index.md) +> Create the [TaskManager](../-task-manager/index.md) that this configuration is for diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/index.md index c1dcfef7..9db5217c 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/index.md @@ -1,9 +1,8 @@ --- title: TaskManagerConfiguration --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../index.md)/[TaskManagerConfiguration](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../index.md)/[TaskManagerConfiguration](index.md) # TaskManagerConfiguration @@ -11,44 +10,33 @@ abstract class [TaskManagerConfiguration](index.md)<[TASK_EXECUTION_TOKEN](in Configuration for [TaskManager](../-task-manager/index.md) - - #### Inheritors - -| | -|---| +| | +|----------------------------------------------------------------------------------------------------------------------------------------------------| | [TaskLockManagerConfiguration](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager-configuration/index.md) | - ## Constructors - -| | | -|---|---| +| | | +|------------------------------------------------------------|---------------------------| | [TaskManagerConfiguration](-task-manager-configuration.md) | [common]
constructor() | - ## Types - -| Name | Summary | -|---|---| +| Name | Summary | +|------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [TaskManagerName](-task-manager-name/index.md) | [common]
@[JvmInline](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-inline/index.md)
value class [TaskManagerName](-task-manager-name/index.md)(val value: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)) | - ## Properties - -| Name | Summary | -|---|---| +| Name | Summary | +|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [name](name.md) | [common]
var [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)?
The name of the task manager, will be used to identify the task manager when assigning tasks to it if none is provided, it will be considered the default one. only one default task manager is allowed. | - ## Functions - -| Name | Summary | -|---|---| +| Name | Summary | +|---------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [createTaskManager](create-task-manager.md) | [common]
abstract fun [createTaskManager](create-task-manager.md)(application: Application): [TaskManager](../-task-manager/index.md)<out [TaskExecutionToken](../-task-execution-token/index.md)>
Create the [TaskManager](../-task-manager/index.md) that this configuration is for | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/name.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/name.md index b517fc0a..642f6cdc 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/name.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/name.md @@ -1,20 +1,16 @@ --- title: name --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../index.md)/[TaskManagerConfiguration](index.md)/[name](name.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../index.md)/[TaskManagerConfiguration](index.md)/[name](name.md) # name - - [common]\ var [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? - - -The name of the task manager, will be used to identify the task manager when assigning tasks to it if none is provided, it will be considered the default one. only one default task manager is allowed. +The name of the task manager, will be used to identify the task manager when assigning tasks to it if none is provided, +it will be considered the default one. only one default task manager is allowed. diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/-companion/format2-to-date-time.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/-companion/format2-to-date-time.md index 404c9520..e586f3d9 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/-companion/format2-to-date-time.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/-companion/format2-to-date-time.md @@ -1,16 +1,14 @@ --- title: format2ToDateTime --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../../index.md)/[TaskManager](../index.md)/[Companion](index.md)/[format2ToDateTime](format2-to-date-time.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../../index.md)/[TaskManager](../index.md)/[Companion](index.md)/[format2ToDateTime](format2-to-date-time.md) # format2ToDateTime - - [common]\ -fun [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md).[format2ToDateTime](format2-to-date-time.md)(): DateTime +fun [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md).[format2ToDateTime](format2-to-date-time.md)(): +DateTime diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/-companion/format2.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/-companion/format2.md index 11190161..02ca9699 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/-companion/format2.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/-companion/format2.md @@ -1,14 +1,11 @@ --- title: format2 --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../../index.md)/[TaskManager](../index.md)/[Companion](index.md)/[format2](format2.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../../index.md)/[TaskManager](../index.md)/[Companion](index.md)/[format2](format2.md) # format2 - - [common]\ fun DateTime.[format2](format2.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/-companion/host.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/-companion/host.md index 97d309b4..de6b6830 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/-companion/host.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/-companion/host.md @@ -1,14 +1,11 @@ --- title: host --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../../index.md)/[TaskManager](../index.md)/[Companion](index.md)/[host](host.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../../index.md)/[TaskManager](../index.md)/[Companion](index.md)/[host](host.md) # host - - [common]\ fun Application.[host](host.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/-companion/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/-companion/index.md index 4b7b63f6..163d1e9c 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/-companion/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/-companion/index.md @@ -1,25 +1,19 @@ --- title: Companion --- -//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../../index.md)/[TaskManager](../index.md)/[Companion](index.md) - +//[extra-ktor-plugins](../../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../../index.md)/[TaskManager](../index.md)/[Companion](index.md) # Companion - - [common]\ object [Companion](index.md) - - ## Functions - -| Name | Summary | -|---|---| -| [format2](format2.md) | [common]
fun DateTime.[format2](format2.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | +| Name | Summary | +|----------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| [format2](format2.md) | [common]
fun DateTime.[format2](format2.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | | [format2ToDateTime](format2-to-date-time.md) | [common]
fun [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md).[format2ToDateTime](format2-to-date-time.md)(): DateTime | -| [host](host.md) | [common]
fun Application.[host](host.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | +| [host](host.md) | [common]
fun Application.[host](host.md)(): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/-task-manager.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/-task-manager.md index 9df90eeb..fd7f974e 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/-task-manager.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/-task-manager.md @@ -1,14 +1,11 @@ --- title: TaskManager --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../index.md)/[TaskManager](index.md)/[TaskManager](-task-manager.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../index.md)/[TaskManager](index.md)/[TaskManager](-task-manager.md) # TaskManager - - [common]\ constructor() diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/application.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/application.md index f309b31d..2c20f7a6 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/application.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/application.md @@ -1,14 +1,11 @@ --- title: application --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../index.md)/[TaskManager](index.md)/[application](application.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../index.md)/[TaskManager](index.md)/[application](application.md) # application - - [common]\ abstract val [application](application.md): Application diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/attempt-execute.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/attempt-execute.md index 15ab8dda..6f1e4fa1 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/attempt-execute.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/attempt-execute.md @@ -1,18 +1,15 @@ --- title: attemptExecute --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../index.md)/[TaskManager](index.md)/[attemptExecute](attempt-execute.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../index.md)/[TaskManager](index.md)/[attemptExecute](attempt-execute.md) # attemptExecute - - [common]\ -abstract suspend fun [attemptExecute](attempt-execute.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), executionTime: DateTime, concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [TASK_EXECUTION_TOKEN](index.md)? - - +abstract suspend fun [attemptExecute](attempt-execute.md)( +task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), executionTime: DateTime, +concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [TASK_EXECUTION_TOKEN](index.md)? Try executing the given task at the given execution time with the given concurrency index diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/index.md index 7bc55038..e801ad01 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/index.md @@ -1,54 +1,45 @@ --- title: TaskManager --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../index.md)/[TaskManager](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../index.md)/[TaskManager](index.md) # TaskManager -abstract class [TaskManager](index.md)<[TASK_EXECUTION_TOKEN](index.md) : [TaskExecutionToken](../-task-execution-token/index.md)> : Closeable +abstract class [TaskManager](index.md) +<[TASK_EXECUTION_TOKEN](index.md) : [TaskExecutionToken](../-task-execution-token/index.md)> : Closeable #### Inheritors - -| | -|---| +| | +|-------------------------------------------------------------------------------------------------------------------------| | [TaskLockManager](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/-task-lock-manager/index.md) | - ## Constructors - -| | | -|---|---| +| | | +|---------------------------------|---------------------------| | [TaskManager](-task-manager.md) | [common]
constructor() | - ## Types - -| Name | Summary | -|---|---| +| Name | Summary | +|----------------------------------|-----------------------------------------------------| | [Companion](-companion/index.md) | [common]
object [Companion](-companion/index.md) | - ## Properties - -| Name | Summary | -|---|---| -| [application](application.md) | [common]
abstract val [application](application.md): Application | -| [name](name.md) | [common]
abstract val [name](name.md): [TaskManagerConfiguration.TaskManagerName](../-task-manager-configuration/-task-manager-name/index.md) | - +| Name | Summary | +|-------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------| +| [application](application.md) | [common]
abstract val [application](application.md): Application | +| [name](name.md) | [common]
abstract val [name](name.md): [TaskManagerConfiguration.TaskManagerName](../-task-manager-configuration/-task-manager-name/index.md) | ## Functions - -| Name | Summary | -|---|---| -| [attemptExecute](attempt-execute.md) | [common]
abstract suspend fun [attemptExecute](attempt-execute.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), executionTime: DateTime, concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [TASK_EXECUTION_TOKEN](index.md)?
Try executing the given task at the given execution time with the given concurrency index | -| [close](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager/index.md#539526881%2FFunctions%2F1182336650) | [common]
expect abstract fun [close](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager/index.md#539526881%2FFunctions%2F1182336650)() | -| [init](init.md) | [common]
abstract suspend fun [init](init.md)(tasks: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<[Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md)>)
Initialize the [TaskManager](index.md) with the given tasks it manages | -| [markExecuted](mark-executed.md) | [common]
abstract suspend fun [markExecuted](mark-executed.md)(key: [TASK_EXECUTION_TOKEN](index.md))
Mark this task as, provided a key was acquired | +| Name | Summary | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [attemptExecute](attempt-execute.md) | [common]
abstract suspend fun [attemptExecute](attempt-execute.md)(task: [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md), executionTime: DateTime, concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [TASK_EXECUTION_TOKEN](index.md)?
Try executing the given task at the given execution time with the given concurrency index | +| [close](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager/index.md#539526881%2FFunctions%2F1182336650) | [common]
expect abstract fun [close](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock-manager/index.md#539526881%2FFunctions%2F1182336650)() | +| [init](init.md) | [common]
abstract suspend fun [init](init.md)(tasks: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<[Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md)>)
Initialize the [TaskManager](index.md) with the given tasks it manages | +| [markExecuted](mark-executed.md) | [common]
abstract suspend fun [markExecuted](mark-executed.md)(key: [TASK_EXECUTION_TOKEN](index.md))
Mark this task as, provided a key was acquired | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/init.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/init.md index 0af35c43..7ab0de03 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/init.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/init.md @@ -1,18 +1,15 @@ --- title: init --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../index.md)/[TaskManager](index.md)/[init](init.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../index.md)/[TaskManager](index.md)/[init](init.md) # init - - [common]\ -abstract suspend fun [init](init.md)(tasks: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<[Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md)>) - - +abstract suspend fun [init](init.md)( +tasks: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md) +<[Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md)>) Initialize the [TaskManager](index.md) with the given tasks it manages diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/mark-executed.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/mark-executed.md index 9632dfc1..726a58f0 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/mark-executed.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/mark-executed.md @@ -1,19 +1,14 @@ --- title: markExecuted --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../index.md)/[TaskManager](index.md)/[markExecuted](mark-executed.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../index.md)/[TaskManager](index.md)/[markExecuted](mark-executed.md) # markExecuted - - [common]\ abstract suspend fun [markExecuted](mark-executed.md)(key: [TASK_EXECUTION_TOKEN](index.md)) - - Mark this task as, provided a key was acquired diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/name.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/name.md index 8ca23065..6268fe48 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/name.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/name.md @@ -1,16 +1,14 @@ --- title: name --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../index.md)/[TaskManager](index.md)/[name](name.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](../index.md)/[TaskManager](index.md)/[name](name.md) # name - - [common]\ -abstract val [name](name.md): [TaskManagerConfiguration.TaskManagerName](../-task-manager-configuration/-task-manager-name/index.md) +abstract +val [name](name.md): [TaskManagerConfiguration.TaskManagerName](../-task-manager-configuration/-task-manager-name/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/index.md index a3a565c0..717d5c06 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/index.md @@ -1,20 +1,16 @@ --- title: io.github.flaxoos.ktor.server.plugins.taskscheduling.managers --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](index.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](index.md) # Package-level declarations - - ## Types - -| Name | Summary | -|---|---| -| [TaskExecutionToken](-task-execution-token/index.md) | [common]
interface [TaskExecutionToken](-task-execution-token/index.md)
Represents a token that can be used to grant permission to execute a task | -| [TaskManager](-task-manager/index.md) | [common]
abstract class [TaskManager](-task-manager/index.md)<[TASK_EXECUTION_TOKEN](-task-manager/index.md) : [TaskExecutionToken](-task-execution-token/index.md)> : Closeable | +| Name | Summary | +|------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [TaskExecutionToken](-task-execution-token/index.md) | [common]
interface [TaskExecutionToken](-task-execution-token/index.md)
Represents a token that can be used to grant permission to execute a task | +| [TaskManager](-task-manager/index.md) | [common]
abstract class [TaskManager](-task-manager/index.md)<[TASK_EXECUTION_TOKEN](-task-manager/index.md) : [TaskExecutionToken](-task-execution-token/index.md)> : Closeable | | [TaskManagerConfiguration](-task-manager-configuration/index.md) | [common]
abstract class [TaskManagerConfiguration](-task-manager-configuration/index.md)<[TASK_EXECUTION_TOKEN](-task-manager-configuration/index.md)>
Configuration for [TaskManager](-task-manager/index.md) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task-lock/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task-lock/index.md index 4d35e9af..856602f1 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task-lock/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task-lock/index.md @@ -1,9 +1,8 @@ --- title: TaskLock --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks](../index.md)/[TaskLock](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks](../index.md)/[TaskLock](index.md) # TaskLock @@ -11,22 +10,17 @@ interface [TaskLock](index.md) : [TaskExecutionToken](../../io.github.flaxoos.kt value must be unique to a task execution, i.e name + executionTime - - #### Inheritors - -| | -|---| +| | +|------------------------------------------------------------------------------------------------------------------------------------| | [DatabaseTaskLock](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-database-task-lock/index.md) | -| [RedisTaskLock](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock/index.md) | - +| [RedisTaskLock](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock/index.md) | ## Properties - -| Name | Summary | -|---|---| +| Name | Summary | +|------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [concurrencyIndex](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-execution-token/concurrency-index.md) | [common]
abstract val [concurrencyIndex](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-execution-token/concurrency-index.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) | -| [name](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-execution-token/name.md) | [common]
abstract val [name](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-execution-token/name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | +| [name](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-execution-token/name.md) | [common]
abstract val [name](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-execution-token/name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/-task.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/-task.md index 0db6d82b..53afc08d 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/-task.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/-task.md @@ -1,16 +1,16 @@ --- title: Task --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks](../index.md)/[Task](index.md)/[Task](-task.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks](../index.md)/[Task](index.md)/[Task](-task.md) # Task - - [common]\ -constructor(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), dispatcher: CoroutineDispatcher?, concurrency: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), kronSchedule: KronScheduler, task: suspend Application.(DateTime) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) +constructor(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), dispatcher: +CoroutineDispatcher?, concurrency: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), +kronSchedule: KronScheduler, task: suspend Application.(DateTime) +-> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/concurrency-range.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/concurrency-range.md index 964d79fe..b5da58f9 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/concurrency-range.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/concurrency-range.md @@ -1,14 +1,11 @@ --- title: concurrencyRange --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks](../index.md)/[Task](index.md)/[concurrencyRange](concurrency-range.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks](../index.md)/[Task](index.md)/[concurrencyRange](concurrency-range.md) # concurrencyRange - - [common]\ fun [concurrencyRange](concurrency-range.md)(): [IntRange](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.ranges/-int-range/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/concurrency.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/concurrency.md index b6a31b56..36a86be2 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/concurrency.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/concurrency.md @@ -1,14 +1,11 @@ --- title: concurrency --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks](../index.md)/[Task](index.md)/[concurrency](concurrency.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks](../index.md)/[Task](index.md)/[concurrency](concurrency.md) # concurrency - - [common]\ val [concurrency](concurrency.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/dispatcher.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/dispatcher.md index 864e81e1..32717b37 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/dispatcher.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/dispatcher.md @@ -1,14 +1,11 @@ --- title: dispatcher --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks](../index.md)/[Task](index.md)/[dispatcher](dispatcher.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks](../index.md)/[Task](index.md)/[dispatcher](dispatcher.md) # dispatcher - - [common]\ val [dispatcher](dispatcher.md): CoroutineDispatcher? diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md index 93b50e8d..25612940 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md @@ -1,44 +1,38 @@ --- title: Task --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks](../index.md)/[Task](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks](../index.md)/[Task](index.md) # Task - - [common]\ -data class [Task](index.md)(val name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), val dispatcher: CoroutineDispatcher?, val concurrency: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), val kronSchedule: KronScheduler, val task: suspend Application.(DateTime) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) - - +data class [Task](index.md)(val name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), +val dispatcher: CoroutineDispatcher?, val +concurrency: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), val kronSchedule: KronScheduler, +val task: suspend Application.(DateTime) +-> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) ## Constructors - -| | | -|---|---| +| | | +|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Task](-task.md) | [common]
constructor(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), dispatcher: CoroutineDispatcher?, concurrency: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), kronSchedule: KronScheduler, task: suspend Application.(DateTime) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) | - ## Properties - -| Name | Summary | -|---|---| -| [concurrency](concurrency.md) | [common]
val [concurrency](concurrency.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) | -| [dispatcher](dispatcher.md) | [common]
val [dispatcher](dispatcher.md): CoroutineDispatcher? | -| [kronSchedule](kron-schedule.md) | [common]
val [kronSchedule](kron-schedule.md): KronScheduler | -| [name](name.md) | [common]
val [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | -| [task](task.md) | [common]
val [task](task.md): suspend Application.(DateTime) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) | - +| Name | Summary | +|----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------| +| [concurrency](concurrency.md) | [common]
val [concurrency](concurrency.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) | +| [dispatcher](dispatcher.md) | [common]
val [dispatcher](dispatcher.md): CoroutineDispatcher? | +| [kronSchedule](kron-schedule.md) | [common]
val [kronSchedule](kron-schedule.md): KronScheduler | +| [name](name.md) | [common]
val [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) | +| [task](task.md) | [common]
val [task](task.md): suspend Application.(DateTime) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) | ## Functions - -| Name | Summary | -|---|---| -| [concurrencyRange](concurrency-range.md) | [common]
fun [concurrencyRange](concurrency-range.md)(): [IntRange](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.ranges/-int-range/index.md) | +| Name | Summary | +|---------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [concurrencyRange](concurrency-range.md) | [common]
fun [concurrencyRange](concurrency-range.md)(): [IntRange](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.ranges/-int-range/index.md) | | [toRedisLockKey](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock/-companion/to-redis-lock-key.md) | [common]
fun [Task](index.md).[toRedisLockKey](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock/-companion/to-redis-lock-key.md)(executionTime: DateTime, concurrencyIndex: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)): [RedisTaskLock](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock/index.md) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/kron-schedule.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/kron-schedule.md index 87f5e66c..0ee8b432 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/kron-schedule.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/kron-schedule.md @@ -1,14 +1,11 @@ --- title: kronSchedule --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks](../index.md)/[Task](index.md)/[kronSchedule](kron-schedule.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks](../index.md)/[Task](index.md)/[kronSchedule](kron-schedule.md) # kronSchedule - - [common]\ val [kronSchedule](kron-schedule.md): KronScheduler diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/name.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/name.md index 9227ab72..d9e7d0d8 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/name.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/name.md @@ -1,14 +1,11 @@ --- title: name --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks](../index.md)/[Task](index.md)/[name](name.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks](../index.md)/[Task](index.md)/[name](name.md) # name - - [common]\ val [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/task.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/task.md index 4b192ea8..9c75a075 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/task.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/task.md @@ -1,16 +1,14 @@ --- title: task --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks](../index.md)/[Task](index.md)/[task](task.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks](../index.md)/[Task](index.md)/[task](task.md) # task - - [common]\ -val [task](task.md): suspend Application.(DateTime) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) +val [task](task.md): suspend Application.(DateTime) +-> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/index.md index d289e8a9..ef460c9d 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/index.md @@ -1,19 +1,15 @@ --- title: io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks](index.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks](index.md) # Package-level declarations - - ## Types - -| Name | Summary | -|---|---| -| [Task](-task/index.md) | [common]
data class [Task](-task/index.md)(val name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), val dispatcher: CoroutineDispatcher?, val concurrency: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), val kronSchedule: KronScheduler, val task: suspend Application.(DateTime) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) | -| [TaskLock](-task-lock/index.md) | [common]
interface [TaskLock](-task-lock/index.md) : [TaskExecutionToken](../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-execution-token/index.md)
value must be unique to a task execution, i.e name + executionTime | +| Name | Summary | +|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [Task](-task/index.md) | [common]
data class [Task](-task/index.md)(val name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), val dispatcher: CoroutineDispatcher?, val concurrency: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md), val kronSchedule: KronScheduler, val task: suspend Application.(DateTime) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) | +| [TaskLock](-task-lock/index.md) | [common]
interface [TaskLock](-task-lock/index.md) : [TaskExecutionToken](../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-execution-token/index.md)
value must be unique to a task execution, i.e name + executionTime | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-configuration/-task-configuration.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-configuration/-task-configuration.md index a10e8d6b..47ec4157 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-configuration/-task-configuration.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-configuration/-task-configuration.md @@ -1,14 +1,11 @@ --- title: TaskConfiguration --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](../index.md)/[TaskConfiguration](index.md)/[TaskConfiguration](-task-configuration.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](../index.md)/[TaskConfiguration](index.md)/[TaskConfiguration](-task-configuration.md) # TaskConfiguration - - [common]\ constructor() diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-configuration/concurrency.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-configuration/concurrency.md index 3b222461..97f3d2ba 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-configuration/concurrency.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-configuration/concurrency.md @@ -1,19 +1,14 @@ --- title: concurrency --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](../index.md)/[TaskConfiguration](index.md)/[concurrency](concurrency.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](../index.md)/[TaskConfiguration](index.md)/[concurrency](concurrency.md) # concurrency - - [common]\ var [concurrency](concurrency.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) - - How many instances of the task should be fired at the same time diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-configuration/dispatcher.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-configuration/dispatcher.md index bbedebde..ede54adb 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-configuration/dispatcher.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-configuration/dispatcher.md @@ -1,19 +1,14 @@ --- title: dispatcher --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](../index.md)/[TaskConfiguration](index.md)/[dispatcher](dispatcher.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](../index.md)/[TaskConfiguration](index.md)/[dispatcher](dispatcher.md) # dispatcher - - [common]\ var [dispatcher](dispatcher.md): CoroutineDispatcher? - - What dispatcher should be used to execute the task, if none is provided, the application's dispatcher will be used diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-configuration/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-configuration/index.md index fd130aad..2f7e0cd0 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-configuration/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-configuration/index.md @@ -1,37 +1,29 @@ --- title: TaskConfiguration --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](../index.md)/[TaskConfiguration](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](../index.md)/[TaskConfiguration](index.md) # TaskConfiguration - - [common]\ class [TaskConfiguration](index.md) Configuration for a [Task](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md) - - ## Constructors - -| | | -|---|---| +| | | +|---------------------------------------------|---------------------------| | [TaskConfiguration](-task-configuration.md) | [common]
constructor() | - ## Properties - -| Name | Summary | -|---|---| -| [concurrency](concurrency.md) | [common]
var [concurrency](concurrency.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)
How many instances of the task should be fired at the same time | -| [dispatcher](dispatcher.md) | [common]
var [dispatcher](dispatcher.md): CoroutineDispatcher?
What dispatcher should be used to execute the task, if none is provided, the application's dispatcher will be used | +| Name | Summary | +|----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [concurrency](concurrency.md) | [common]
var [concurrency](concurrency.md): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)
How many instances of the task should be fired at the same time | +| [dispatcher](dispatcher.md) | [common]
var [dispatcher](dispatcher.md): CoroutineDispatcher?
What dispatcher should be used to execute the task, if none is provided, the application's dispatcher will be used | | [kronSchedule](kron-schedule.md) | [common]
var [kronSchedule](kron-schedule.md): SchedulerBuilder.() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)?
The [kronSchedule](kron-schedule.md) for the task | -| [name](name.md) | [common]
var [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)
The name of the task, should be unique, as it id used to identify the task | -| [task](task.md) | [common]
var [task](task.md): suspend Application.(DateTime) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)
The actual task logic | +| [name](name.md) | [common]
var [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)
The name of the task, should be unique, as it id used to identify the task | +| [task](task.md) | [common]
var [task](task.md): suspend Application.(DateTime) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)
The actual task logic | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-configuration/kron-schedule.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-configuration/kron-schedule.md index cd7c264f..d9e45f30 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-configuration/kron-schedule.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-configuration/kron-schedule.md @@ -1,18 +1,14 @@ --- title: kronSchedule --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](../index.md)/[TaskConfiguration](index.md)/[kronSchedule](kron-schedule.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](../index.md)/[TaskConfiguration](index.md)/[kronSchedule](kron-schedule.md) # kronSchedule - - [common]\ -var [kronSchedule](kron-schedule.md): SchedulerBuilder.() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)? - - +var [kronSchedule](kron-schedule.md): SchedulerBuilder.() +-> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)? The [kronSchedule](kron-schedule.md) for the task diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-configuration/name.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-configuration/name.md index a931ae49..1457d5de 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-configuration/name.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-configuration/name.md @@ -1,19 +1,14 @@ --- title: name --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](../index.md)/[TaskConfiguration](index.md)/[name](name.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](../index.md)/[TaskConfiguration](index.md)/[name](name.md) # name - - [common]\ var [name](name.md): [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md) - - The name of the task, should be unique, as it id used to identify the task diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-configuration/task.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-configuration/task.md index f398bcab..2ce9411b 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-configuration/task.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-configuration/task.md @@ -1,18 +1,14 @@ --- title: task --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](../index.md)/[TaskConfiguration](index.md)/[task](task.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](../index.md)/[TaskConfiguration](index.md)/[task](task.md) # task - - [common]\ -var [task](task.md): suspend Application.(DateTime) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) - - +var [task](task.md): suspend Application.(DateTime) +-> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md) The actual task logic diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-freq-ms/-task-freq-ms.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-freq-ms/-task-freq-ms.md index 45ef4107..014001c3 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-freq-ms/-task-freq-ms.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-freq-ms/-task-freq-ms.md @@ -1,14 +1,11 @@ --- title: TaskFreqMs --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](../index.md)/[TaskFreqMs](index.md)/[TaskFreqMs](-task-freq-ms.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](../index.md)/[TaskFreqMs](index.md)/[TaskFreqMs](-task-freq-ms.md) # TaskFreqMs - - [jvm]\ constructor(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-freq-ms/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-freq-ms/index.md index dbcf6d14..e56cbb4f 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-freq-ms/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-freq-ms/index.md @@ -1,35 +1,26 @@ --- title: TaskFreqMs --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](../index.md)/[TaskFreqMs](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](../index.md)/[TaskFreqMs](index.md) # TaskFreqMs - - [jvm]\ @[JvmInline](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-inline/index.md) - - -value class [TaskFreqMs](index.md)(val value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)) - - +value class [TaskFreqMs](index.md)(val +value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)) ## Constructors - -| | | -|---|---| +| | | +|--------------------------------|---------------------------------------------------------------------------------------------------------| | [TaskFreqMs](-task-freq-ms.md) | [jvm]
constructor(value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)) | - ## Properties - -| Name | Summary | -|---|---| +| Name | Summary | +|-------------------|------------------------------------------------------------------------------------------------------------| | [value](value.md) | [jvm]
val [value](value.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-freq-ms/value.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-freq-ms/value.md index 9d543d55..4ecb55c4 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-freq-ms/value.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-freq-ms/value.md @@ -1,14 +1,11 @@ --- title: value --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](../index.md)/[TaskFreqMs](index.md)/[value](value.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](../index.md)/[TaskFreqMs](index.md)/[value](value.md) # value - - [jvm]\ val [value](value.md): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-configuration/-task-scheduling-configuration.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-configuration/-task-scheduling-configuration.md index af9b5d02..2095b2cb 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-configuration/-task-scheduling-configuration.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-configuration/-task-scheduling-configuration.md @@ -1,14 +1,11 @@ --- title: TaskSchedulingConfiguration --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](../index.md)/[TaskSchedulingConfiguration](index.md)/[TaskSchedulingConfiguration](-task-scheduling-configuration.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](../index.md)/[TaskSchedulingConfiguration](index.md)/[TaskSchedulingConfiguration](-task-scheduling-configuration.md) # TaskSchedulingConfiguration - - [common]\ constructor() diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-configuration/add-task-manager.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-configuration/add-task-manager.md index 0dbbf53c..221562fa 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-configuration/add-task-manager.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-configuration/add-task-manager.md @@ -1,16 +1,15 @@ --- title: addTaskManager --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](../index.md)/[TaskSchedulingConfiguration](index.md)/[addTaskManager](add-task-manager.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](../index.md)/[TaskSchedulingConfiguration](index.md)/[addTaskManager](add-task-manager.md) # addTaskManager - - [common]\ -fun [addTaskManager](add-task-manager.md)(taskManagerConfiguration: [TaskManagerConfiguration](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/index.md)<*>) +fun [addTaskManager](add-task-manager.md)( +taskManagerConfiguration: [TaskManagerConfiguration](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/index.md) +<*>) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-configuration/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-configuration/index.md index 69aa5219..dd93a56a 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-configuration/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-configuration/index.md @@ -1,37 +1,29 @@ --- title: TaskSchedulingConfiguration --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](../index.md)/[TaskSchedulingConfiguration](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](../index.md)/[TaskSchedulingConfiguration](index.md) # TaskSchedulingConfiguration - - [common]\ open class [TaskSchedulingConfiguration](index.md) Configuration for [TaskScheduling](../-task-scheduling.md) - - ## Constructors - -| | | -|---|---| +| | | +|------------------------------------------------------------------|---------------------------| | [TaskSchedulingConfiguration](-task-scheduling-configuration.md) | [common]
constructor() | - ## Functions - -| Name | Summary | -|---|---| -| [addTaskManager](add-task-manager.md) | [common]
fun [addTaskManager](add-task-manager.md)(taskManagerConfiguration: [TaskManagerConfiguration](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/index.md)<*>) | -| [jdbc](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/jdbc.md) | [jvm]
fun [TaskSchedulingConfiguration](index.md).[jdbc](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/jdbc.md)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = null, config: [JdbcJobLockManagerConfiguration](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-job-lock-manager-configuration/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md))
Add a [JdbcLockManager](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-lock-manager/index.md) | +| Name | Summary | +|----------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [addTaskManager](add-task-manager.md) | [common]
fun [addTaskManager](add-task-manager.md)(taskManagerConfiguration: [TaskManagerConfiguration](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager-configuration/index.md)<*>) | +| [jdbc](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/jdbc.md) | [jvm]
fun [TaskSchedulingConfiguration](index.md).[jdbc](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/jdbc.md)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = null, config: [JdbcJobLockManagerConfiguration](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-job-lock-manager-configuration/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md))
Add a [JdbcLockManager](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-jdbc-lock-manager/index.md) | | [mongoDb](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/mongo-db.md) | [jvm]
fun [TaskSchedulingConfiguration](index.md).[mongoDb](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/mongo-db.md)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = null, config: [MongoDBJobLockManagerConfiguration](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-job-lock-manager-configuration/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md))
Add a [MongoDBLockManager](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/-mongo-d-b-lock-manager/index.md) | -| [redis](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/redis.md) | [common]
fun [TaskSchedulingConfiguration](index.md).[redis](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/redis.md)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = null, config: [RedisTaskLockManagerConfiguration](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md))
Add a [RedisLockManager](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-lock-manager/index.md) | -| [task](task.md) | [common]
fun [task](task.md)(taskManagerName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = null, taskConfiguration: [TaskConfiguration](../-task-configuration/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md))
Add a task to be managed by a [TaskManager](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/index.md) with the given name or the default one if no name is provided and a default task manager has been configured | +| [redis](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/redis.md) | [common]
fun [TaskSchedulingConfiguration](index.md).[redis](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/redis.md)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = null, config: [RedisTaskLockManagerConfiguration](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-task-lock-manager-configuration/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md))
Add a [RedisLockManager](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/-redis-lock-manager/index.md) | +| [task](task.md) | [common]
fun [task](task.md)(taskManagerName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = null, taskConfiguration: [TaskConfiguration](../-task-configuration/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md))
Add a task to be managed by a [TaskManager](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/index.md) with the given name or the default one if no name is provided and a default task manager has been configured | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-configuration/task.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-configuration/task.md index 5ba16c51..8a675b60 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-configuration/task.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-configuration/task.md @@ -1,20 +1,19 @@ --- title: task --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](../index.md)/[TaskSchedulingConfiguration](index.md)/[task](task.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](../index.md)/[TaskSchedulingConfiguration](index.md)/[task](task.md) # task - - [common]\ -fun [task](task.md)(taskManagerName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = null, taskConfiguration: [TaskConfiguration](../-task-configuration/index.md).() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) - - +fun [task](task.md)(taskManagerName: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)? = +null, taskConfiguration: [TaskConfiguration](../-task-configuration/index.md).() +-> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) -Add a task to be managed by a [TaskManager](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/index.md) with the given name or the default one if no name is provided and a default task manager has been configured +Add a task to be managed by +a [TaskManager](../../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/index.md) with the +given name or the default one if no name is provided and a default task manager has been configured diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-dsl/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-dsl/index.md index ca7c297a..ae946fe2 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-dsl/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-dsl/index.md @@ -1,19 +1,14 @@ --- title: TaskSchedulingDsl --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](../index.md)/[TaskSchedulingDsl](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](../index.md)/[TaskSchedulingDsl](index.md) # TaskSchedulingDsl - - [common]\ @[DslMarker](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-dsl-marker/index.md) - - annotation class [TaskSchedulingDsl](index.md) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-plugin-test/-task-scheduling-plugin-test.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-plugin-test/-task-scheduling-plugin-test.md index 4504a7a3..7b5521ce 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-plugin-test/-task-scheduling-plugin-test.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-plugin-test/-task-scheduling-plugin-test.md @@ -1,14 +1,11 @@ --- title: TaskSchedulingPluginTest --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](../index.md)/[TaskSchedulingPluginTest](index.md)/[TaskSchedulingPluginTest](-task-scheduling-plugin-test.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](../index.md)/[TaskSchedulingPluginTest](index.md)/[TaskSchedulingPluginTest](-task-scheduling-plugin-test.md) # TaskSchedulingPluginTest - - [jvm]\ constructor() diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-plugin-test/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-plugin-test/index.md index fafcce0c..f38be50a 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-plugin-test/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-plugin-test/index.md @@ -1,99 +1,89 @@ --- title: TaskSchedulingPluginTest --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](../index.md)/[TaskSchedulingPluginTest](index.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](../index.md)/[TaskSchedulingPluginTest](index.md) # TaskSchedulingPluginTest - - [jvm]\ abstract class [TaskSchedulingPluginTest](index.md) : FunSpec - - ## Constructors - -| | | -|---|---| +| | | +|-------------------------------------------------------------|------------------------| | [TaskSchedulingPluginTest](-task-scheduling-plugin-test.md) | [jvm]
constructor() | - ## Properties - -| Name | Summary | -|---|---| -| [assertions](index.md#-903273535%2FProperties%2F1975120172) | [jvm]
var [assertions](index.md#-903273535%2FProperties%2F1975120172): AssertionMode? | -| [assertSoftly](index.md#-469419115%2FProperties%2F1975120172) | [jvm]
var [assertSoftly](index.md#-469419115%2FProperties%2F1975120172): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)? | -| [blockingTest](index.md#1109722295%2FProperties%2F1975120172) | [jvm]
var [blockingTest](index.md#1109722295%2FProperties%2F1975120172): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)? | -| [concurrency](index.md#1608059369%2FFunctions%2F1975120172) | [jvm]
var [concurrency](index.md#1608059369%2FFunctions%2F1975120172): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)? | -| [coroutineDebugProbes](index.md#337488128%2FProperties%2F1975120172) | [jvm]
var [coroutineDebugProbes](index.md#337488128%2FProperties%2F1975120172): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)? | -| [coroutineDispatcherFactory](index.md#-335339149%2FFunctions%2F1975120172) | [jvm]
var [coroutineDispatcherFactory](index.md#-335339149%2FFunctions%2F1975120172): CoroutineDispatcherFactory? | -| [coroutineTestScope](index.md#-575355180%2FProperties%2F1975120172) | [jvm]
var [coroutineTestScope](index.md#-575355180%2FProperties%2F1975120172): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)? | -| [defaultTestConfig](index.md#732610451%2FProperties%2F1975120172) | [jvm]
var [~~defaultTestConfig~~](index.md#732610451%2FProperties%2F1975120172): TestCaseConfig? | -| [dispatcherAffinity](index.md#967441007%2FFunctions%2F1975120172) | [jvm]
var [dispatcherAffinity](index.md#967441007%2FFunctions%2F1975120172): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)? | -| [duplicateTestNameMode](index.md#-254083183%2FProperties%2F1975120172) | [jvm]
var [duplicateTestNameMode](index.md#-254083183%2FProperties%2F1975120172): DuplicateTestNameMode? | -| [failfast](index.md#1052371588%2FProperties%2F1975120172) | [jvm]
var [failfast](index.md#1052371588%2FProperties%2F1975120172): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)? | -| [invocationTimeout](index.md#-1543059125%2FFunctions%2F1975120172) | [jvm]
var [invocationTimeout](index.md#-1543059125%2FFunctions%2F1975120172): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)? | -| [isolationMode](index.md#-209763861%2FFunctions%2F1975120172) | [jvm]
var [isolationMode](index.md#-209763861%2FFunctions%2F1975120172): IsolationMode? | -| [severity](index.md#-2023779999%2FProperties%2F1975120172) | [jvm]
var [severity](index.md#-2023779999%2FProperties%2F1975120172): TestCaseSeverityLevel? | -| [testCoroutineDispatcher](index.md#1742905999%2FProperties%2F1975120172) | [jvm]
var [~~testCoroutineDispatcher~~](index.md#1742905999%2FProperties%2F1975120172): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)? | -| [testOrder](index.md#1930754944%2FProperties%2F1975120172) | [jvm]
var [testOrder](index.md#1930754944%2FProperties%2F1975120172): TestCaseOrder? | -| [threads](index.md#2107429395%2FFunctions%2F1975120172) | [jvm]
var [threads](index.md#2107429395%2FFunctions%2F1975120172): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)? | -| [timeout](index.md#-1966074021%2FFunctions%2F1975120172) | [jvm]
var [timeout](index.md#-1966074021%2FFunctions%2F1975120172): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)? | - +| Name | Summary | +|----------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [assertions](index.md#-903273535%2FProperties%2F1975120172) | [jvm]
var [assertions](index.md#-903273535%2FProperties%2F1975120172): AssertionMode? | +| [assertSoftly](index.md#-469419115%2FProperties%2F1975120172) | [jvm]
var [assertSoftly](index.md#-469419115%2FProperties%2F1975120172): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)? | +| [blockingTest](index.md#1109722295%2FProperties%2F1975120172) | [jvm]
var [blockingTest](index.md#1109722295%2FProperties%2F1975120172): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)? | +| [concurrency](index.md#1608059369%2FFunctions%2F1975120172) | [jvm]
var [concurrency](index.md#1608059369%2FFunctions%2F1975120172): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)? | +| [coroutineDebugProbes](index.md#337488128%2FProperties%2F1975120172) | [jvm]
var [coroutineDebugProbes](index.md#337488128%2FProperties%2F1975120172): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)? | +| [coroutineDispatcherFactory](index.md#-335339149%2FFunctions%2F1975120172) | [jvm]
var [coroutineDispatcherFactory](index.md#-335339149%2FFunctions%2F1975120172): CoroutineDispatcherFactory? | +| [coroutineTestScope](index.md#-575355180%2FProperties%2F1975120172) | [jvm]
var [coroutineTestScope](index.md#-575355180%2FProperties%2F1975120172): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)? | +| [defaultTestConfig](index.md#732610451%2FProperties%2F1975120172) | [jvm]
var [~~defaultTestConfig~~](index.md#732610451%2FProperties%2F1975120172): TestCaseConfig? | +| [dispatcherAffinity](index.md#967441007%2FFunctions%2F1975120172) | [jvm]
var [dispatcherAffinity](index.md#967441007%2FFunctions%2F1975120172): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)? | +| [duplicateTestNameMode](index.md#-254083183%2FProperties%2F1975120172) | [jvm]
var [duplicateTestNameMode](index.md#-254083183%2FProperties%2F1975120172): DuplicateTestNameMode? | +| [failfast](index.md#1052371588%2FProperties%2F1975120172) | [jvm]
var [failfast](index.md#1052371588%2FProperties%2F1975120172): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)? | +| [invocationTimeout](index.md#-1543059125%2FFunctions%2F1975120172) | [jvm]
var [invocationTimeout](index.md#-1543059125%2FFunctions%2F1975120172): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)? | +| [isolationMode](index.md#-209763861%2FFunctions%2F1975120172) | [jvm]
var [isolationMode](index.md#-209763861%2FFunctions%2F1975120172): IsolationMode? | +| [severity](index.md#-2023779999%2FProperties%2F1975120172) | [jvm]
var [severity](index.md#-2023779999%2FProperties%2F1975120172): TestCaseSeverityLevel? | +| [testCoroutineDispatcher](index.md#1742905999%2FProperties%2F1975120172) | [jvm]
var [~~testCoroutineDispatcher~~](index.md#1742905999%2FProperties%2F1975120172): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)? | +| [testOrder](index.md#1930754944%2FProperties%2F1975120172) | [jvm]
var [testOrder](index.md#1930754944%2FProperties%2F1975120172): TestCaseOrder? | +| [threads](index.md#2107429395%2FFunctions%2F1975120172) | [jvm]
var [threads](index.md#2107429395%2FFunctions%2F1975120172): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)? | +| [timeout](index.md#-1966074021%2FFunctions%2F1975120172) | [jvm]
var [timeout](index.md#-1966074021%2FFunctions%2F1975120172): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)? | ## Functions - -| Name | Summary | -|---|---| -| [add](index.md#-1999980164%2FFunctions%2F1975120172) | [jvm]
open override fun [add](index.md#-1999980164%2FFunctions%2F1975120172)(test: RootTest) | -| [afterAny](index.md#1547740728%2FFunctions%2F1975120172) | [jvm]
fun [afterAny](index.md#1547740728%2FFunctions%2F1975120172)(f: suspend (Tuple2<TestCase, TestResult>) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md))
open suspend fun [afterAny](index.md#136674436%2FFunctions%2F1975120172)(testCase: TestCase, result: TestResult) | -| [afterContainer](index.md#-1960575549%2FFunctions%2F1975120172) | [jvm]
fun [afterContainer](index.md#-1960575549%2FFunctions%2F1975120172)(f: suspend (Tuple2<TestCase, TestResult>) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md))
open suspend fun [afterContainer](index.md#758535257%2FFunctions%2F1975120172)(testCase: TestCase, result: TestResult) | -| [afterEach](index.md#1014745089%2FFunctions%2F1975120172) | [jvm]
fun [afterEach](index.md#1014745089%2FFunctions%2F1975120172)(f: suspend (Tuple2<TestCase, TestResult>) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md))
open suspend fun [afterEach](index.md#-742374221%2FFunctions%2F1975120172)(testCase: TestCase, result: TestResult) | -| [afterProject](index.md#32903022%2FFunctions%2F1975120172) | [jvm]
fun [afterProject](index.md#32903022%2FFunctions%2F1975120172)(f: AfterProject) | -| [afterSpec](index.md#-468334506%2FFunctions%2F1975120172) | [jvm]
open suspend fun [afterSpec](index.md#-468334506%2FFunctions%2F1975120172)(spec: Spec)
open override fun [afterSpec](index.md#1229631156%2FFunctions%2F1975120172)(f: suspend (Spec) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) | -| [afterTest](index.md#-1115432156%2FFunctions%2F1975120172) | [jvm]
open override fun [afterTest](index.md#-1115432156%2FFunctions%2F1975120172)(f: suspend (Tuple2<TestCase, TestResult>) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md))
open suspend fun [afterTest](index.md#1247554756%2FFunctions%2F1975120172)(testCase: TestCase, result: TestResult) | -| [appliedTags](index.md#281443410%2FFunctions%2F1975120172) | [jvm]
fun [appliedTags](index.md#281443410%2FFunctions%2F1975120172)(): [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.md)<Tag> | -| [aroundSpec](index.md#785363173%2FFunctions%2F1975120172) | [jvm]
fun [~~aroundSpec~~](index.md#785363173%2FFunctions%2F1975120172)(aroundSpecFn: suspend (Tuple2<[KClass](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.md)<out Spec>, suspend () -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)>) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) | -| [aroundTest](index.md#-1698503286%2FFunctions%2F1975120172) | [jvm]
fun [aroundTest](index.md#-1698503286%2FFunctions%2F1975120172)(aroundTestFn: suspend (Tuple2<TestCase, suspend (TestCase) -> TestResult>) -> TestResult) | -| [assertionMode](index.md#-115997129%2FFunctions%2F1975120172) | [jvm]
open fun [assertionMode](index.md#-115997129%2FFunctions%2F1975120172)(): AssertionMode? | -| [autoClose](index.md#-766347760%2FFunctions%2F1975120172) | [jvm]
fun <[T](index.md#-766347760%2FFunctions%2F1975120172) : AutoCloseable> [autoClose](index.md#-766347760%2FFunctions%2F1975120172)(closeable: [T](index.md#-766347760%2FFunctions%2F1975120172)): [T](index.md#-766347760%2FFunctions%2F1975120172)
fun <[T](index.md#1118384539%2FFunctions%2F1975120172) : AutoCloseable> [autoClose](index.md#1118384539%2FFunctions%2F1975120172)(closeable: [Lazy](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-lazy/index.md)<[T](index.md#1118384539%2FFunctions%2F1975120172)>): [Lazy](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-lazy/index.md)<[T](index.md#1118384539%2FFunctions%2F1975120172)> | -| [beforeAny](index.md#-1851449574%2FFunctions%2F1975120172) | [jvm]
fun [beforeAny](index.md#-1851449574%2FFunctions%2F1975120172)(f: suspend (TestCase) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md))
open suspend fun [beforeAny](index.md#940017072%2FFunctions%2F1975120172)(testCase: TestCase) | -| [beforeContainer](index.md#1596196389%2FFunctions%2F1975120172) | [jvm]
fun [beforeContainer](index.md#1596196389%2FFunctions%2F1975120172)(f: suspend (TestCase) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md))
open suspend fun [beforeContainer](index.md#-1269235781%2FFunctions%2F1975120172)(testCase: TestCase) | -| [beforeEach](index.md#1986061201%2FFunctions%2F1975120172) | [jvm]
fun [beforeEach](index.md#1986061201%2FFunctions%2F1975120172)(f: suspend (TestCase) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md))
open suspend fun [beforeEach](index.md#-174575617%2FFunctions%2F1975120172)(testCase: TestCase) | -| [beforeSpec](index.md#-516232345%2FFunctions%2F1975120172) | [jvm]
fun [beforeSpec](index.md#-516232345%2FFunctions%2F1975120172)(f: suspend (Spec) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md))
open suspend fun [beforeSpec](index.md#-1683292107%2FFunctions%2F1975120172)(spec: Spec) | -| [beforeTest](index.md#-55753202%2FFunctions%2F1975120172) | [jvm]
open suspend fun [beforeTest](index.md#-55753202%2FFunctions%2F1975120172)(testCase: TestCase)
open override fun [beforeTest](index.md#-1647465780%2FFunctions%2F1975120172)(f: suspend (TestCase) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) | -| [concurrency](index.md#1608059369%2FFunctions%2F1975120172) | [jvm]
open fun [concurrency](index.md#1608059369%2FFunctions%2F1975120172)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)? | -| [context](index.md#-931840898%2FFunctions%2F1975120172) | [jvm]
open fun [context](index.md#-931840898%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): RootContainerWithConfigBuilder<FunSpecContainerScope>
open fun [context](index.md#1854742352%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), test: suspend FunSpecContainerScope.() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) | -| [coroutineDispatcherFactory](index.md#-335339149%2FFunctions%2F1975120172) | [jvm]
open fun [coroutineDispatcherFactory](index.md#-335339149%2FFunctions%2F1975120172)(): CoroutineDispatcherFactory? | -| [defaultTestCaseConfig](index.md#-1208186473%2FFunctions%2F1975120172) | [jvm]
open fun [~~defaultTestCaseConfig~~](index.md#-1208186473%2FFunctions%2F1975120172)(): TestCaseConfig? | -| [dispatcherAffinity](index.md#967441007%2FFunctions%2F1975120172) | [jvm]
open fun [dispatcherAffinity](index.md#967441007%2FFunctions%2F1975120172)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)? | -| [extension](index.md#-1270485135%2FFunctions%2F1975120172) | [jvm]
fun <[T](index.md#-1270485135%2FFunctions%2F1975120172) : Extension> [extension](index.md#-1270485135%2FFunctions%2F1975120172)(extension: [T](index.md#-1270485135%2FFunctions%2F1975120172)): [T](index.md#-1270485135%2FFunctions%2F1975120172)
fun [extension](index.md#-625111808%2FFunctions%2F1975120172)(f: suspend (Tuple2<TestCase, suspend (TestCase) -> TestResult>) -> TestResult) | -| [extensions](index.md#-1125030564%2FFunctions%2F1975120172) | [jvm]
fun [extensions](index.md#-1125030564%2FFunctions%2F1975120172)(vararg extensions: Extension)
fun [extensions](index.md#-1743402674%2FFunctions%2F1975120172)(extensions: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<Extension>)
open fun [extensions](index.md#753161194%2FFunctions%2F1975120172)(): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<Extension> | -| [finalizeSpec](index.md#483870928%2FFunctions%2F1975120172) | [jvm]
fun [finalizeSpec](index.md#483870928%2FFunctions%2F1975120172)(f: suspend (Tuple2<[KClass](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.md)<out Spec>, [Map](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.md)<TestCase, TestResult>>) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) | -| [globalExtensions](index.md#1081396766%2FFunctions%2F1975120172) | [jvm]
open override fun [globalExtensions](index.md#1081396766%2FFunctions%2F1975120172)(): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<Extension> | -| [include](index.md#340185448%2FFunctions%2F1975120172) | [jvm]
fun [include](index.md#340185448%2FFunctions%2F1975120172)(factory: TestFactory)
fun [include](index.md#-1076090397%2FFunctions%2F1975120172)(prefix: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), factory: TestFactory) | -| [invocationTimeout](index.md#-1543059125%2FFunctions%2F1975120172) | [jvm]
open fun [invocationTimeout](index.md#-1543059125%2FFunctions%2F1975120172)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)? | -| [isolationMode](index.md#-209763861%2FFunctions%2F1975120172) | [jvm]
open fun [isolationMode](index.md#-209763861%2FFunctions%2F1975120172)(): IsolationMode? | -| [listener](index.md#-718864244%2FFunctions%2F1975120172) | [jvm]
fun <[T](index.md#-718864244%2FFunctions%2F1975120172) : TestListener> [listener](index.md#-718864244%2FFunctions%2F1975120172)(listener: [T](index.md#-718864244%2FFunctions%2F1975120172)): [T](index.md#-718864244%2FFunctions%2F1975120172) | -| [listeners](index.md#420835937%2FFunctions%2F1975120172) | [jvm]
fun [listeners](index.md#420835937%2FFunctions%2F1975120172)(vararg listeners: TestListener)
fun [listeners](index.md#1561031497%2FFunctions%2F1975120172)(listeners: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<TestListener>)
open fun [listeners](index.md#-959107971%2FFunctions%2F1975120172)(): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<TestListener> | -| [register](index.md#1123447995%2FFunctions%2F1975120172) | [jvm]
fun <[T](index.md#1123447995%2FFunctions%2F1975120172) : TestListener> [register](index.md#1123447995%2FFunctions%2F1975120172)(extension: [T](index.md#1123447995%2FFunctions%2F1975120172)): [T](index.md#1123447995%2FFunctions%2F1975120172)
fun [register](index.md#1528631275%2FFunctions%2F1975120172)(vararg extensions: Extension)
fun [register](index.md#1159151455%2FFunctions%2F1975120172)(extensions: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<Extension>) | -| [registeredAutoCloseables](index.md#1761867328%2FFunctions%2F1975120172) | [jvm]
fun [registeredAutoCloseables](index.md#1761867328%2FFunctions%2F1975120172)(): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<[Lazy](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-lazy/index.md)<AutoCloseable>> | -| [registeredExtensions](index.md#1202043548%2FFunctions%2F1975120172) | [jvm]
fun [registeredExtensions](index.md#1202043548%2FFunctions%2F1975120172)(): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<Extension> | -| [rootTests](index.md#580898470%2FFunctions%2F1975120172) | [jvm]
open override fun [rootTests](index.md#580898470%2FFunctions%2F1975120172)(): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<RootTest> | -| [seal](index.md#-2055778568%2FFunctions%2F1975120172) | [jvm]
fun [seal](index.md#-2055778568%2FFunctions%2F1975120172)() | -| [tags](index.md#-1949138170%2FFunctions%2F1975120172) | [jvm]
fun [tags](index.md#-1949138170%2FFunctions%2F1975120172)(vararg tags: Tag)
open fun [tags](index.md#502911045%2FFunctions%2F1975120172)(): [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.md)<Tag> | -| [test](index.md#310933201%2FFunctions%2F1975120172) | [jvm]
open fun [test](index.md#310933201%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): RootTestWithConfigBuilder
open fun [test](index.md#-1089832823%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), test: suspend TestScope.() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) | -| [testCaseOrder](index.md#-223199664%2FFunctions%2F1975120172) | [jvm]
open fun [testCaseOrder](index.md#-223199664%2FFunctions%2F1975120172)(): TestCaseOrder? | -| [testTaskScheduling](test-task-scheduling.md) | [jvm]
suspend fun ContainerScope.[testTaskScheduling](test-task-scheduling.md)(engineCount: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = ENGINE_COUNT, executions: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = EXECUTIONS, executionBufferMs: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = DEFAULT_EXECUTION_BUFFER_MS, frequenciesExponentialSeriesInitialMs: [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.md) = FREQUENCIES_EXPONENTIAL_SERIES_INITIAL_MS, frequenciesExponentialSeriesN: [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.md) = FREQUENCIES_EXPONENTIAL_SERIES_N, taskSchedulingConfiguration: [TaskSchedulingConfiguration](../-task-scheduling-configuration/index.md).([TaskFreqMs](../-task-freq-ms/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) | -| [threads](index.md#2107429395%2FFunctions%2F1975120172) | [jvm]
open fun [threads](index.md#2107429395%2FFunctions%2F1975120172)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)? | -| [timeout](index.md#-1966074021%2FFunctions%2F1975120172) | [jvm]
open fun [timeout](index.md#-1966074021%2FFunctions%2F1975120172)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)? | -| [xcontext](index.md#-34627402%2FFunctions%2F1975120172) | [jvm]
open fun [xcontext](index.md#-34627402%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): RootContainerWithConfigBuilder<FunSpecContainerScope>
open fun [xcontext](index.md#-1381192680%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), test: suspend FunSpecContainerScope.() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) | -| [xtest](index.md#1009466777%2FFunctions%2F1975120172) | [jvm]
open fun [xtest](index.md#1009466777%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): RootTestWithConfigBuilder
open fun [xtest](index.md#-1944354479%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), test: suspend TestScope.() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) | +| Name | Summary | +|----------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [add](index.md#-1999980164%2FFunctions%2F1975120172) | [jvm]
open override fun [add](index.md#-1999980164%2FFunctions%2F1975120172)(test: RootTest) | +| [afterAny](index.md#1547740728%2FFunctions%2F1975120172) | [jvm]
fun [afterAny](index.md#1547740728%2FFunctions%2F1975120172)(f: suspend (Tuple2<TestCase, TestResult>) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md))
open suspend fun [afterAny](index.md#136674436%2FFunctions%2F1975120172)(testCase: TestCase, result: TestResult) | +| [afterContainer](index.md#-1960575549%2FFunctions%2F1975120172) | [jvm]
fun [afterContainer](index.md#-1960575549%2FFunctions%2F1975120172)(f: suspend (Tuple2<TestCase, TestResult>) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md))
open suspend fun [afterContainer](index.md#758535257%2FFunctions%2F1975120172)(testCase: TestCase, result: TestResult) | +| [afterEach](index.md#1014745089%2FFunctions%2F1975120172) | [jvm]
fun [afterEach](index.md#1014745089%2FFunctions%2F1975120172)(f: suspend (Tuple2<TestCase, TestResult>) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md))
open suspend fun [afterEach](index.md#-742374221%2FFunctions%2F1975120172)(testCase: TestCase, result: TestResult) | +| [afterProject](index.md#32903022%2FFunctions%2F1975120172) | [jvm]
fun [afterProject](index.md#32903022%2FFunctions%2F1975120172)(f: AfterProject) | +| [afterSpec](index.md#-468334506%2FFunctions%2F1975120172) | [jvm]
open suspend fun [afterSpec](index.md#-468334506%2FFunctions%2F1975120172)(spec: Spec)
open override fun [afterSpec](index.md#1229631156%2FFunctions%2F1975120172)(f: suspend (Spec) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) | +| [afterTest](index.md#-1115432156%2FFunctions%2F1975120172) | [jvm]
open override fun [afterTest](index.md#-1115432156%2FFunctions%2F1975120172)(f: suspend (Tuple2<TestCase, TestResult>) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md))
open suspend fun [afterTest](index.md#1247554756%2FFunctions%2F1975120172)(testCase: TestCase, result: TestResult) | +| [appliedTags](index.md#281443410%2FFunctions%2F1975120172) | [jvm]
fun [appliedTags](index.md#281443410%2FFunctions%2F1975120172)(): [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.md)<Tag> | +| [aroundSpec](index.md#785363173%2FFunctions%2F1975120172) | [jvm]
fun [~~aroundSpec~~](index.md#785363173%2FFunctions%2F1975120172)(aroundSpecFn: suspend (Tuple2<[KClass](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.md)<out Spec>, suspend () -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)>) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) | +| [aroundTest](index.md#-1698503286%2FFunctions%2F1975120172) | [jvm]
fun [aroundTest](index.md#-1698503286%2FFunctions%2F1975120172)(aroundTestFn: suspend (Tuple2<TestCase, suspend (TestCase) -> TestResult>) -> TestResult) | +| [assertionMode](index.md#-115997129%2FFunctions%2F1975120172) | [jvm]
open fun [assertionMode](index.md#-115997129%2FFunctions%2F1975120172)(): AssertionMode? | +| [autoClose](index.md#-766347760%2FFunctions%2F1975120172) | [jvm]
fun <[T](index.md#-766347760%2FFunctions%2F1975120172) : AutoCloseable> [autoClose](index.md#-766347760%2FFunctions%2F1975120172)(closeable: [T](index.md#-766347760%2FFunctions%2F1975120172)): [T](index.md#-766347760%2FFunctions%2F1975120172)
fun <[T](index.md#1118384539%2FFunctions%2F1975120172) : AutoCloseable> [autoClose](index.md#1118384539%2FFunctions%2F1975120172)(closeable: [Lazy](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-lazy/index.md)<[T](index.md#1118384539%2FFunctions%2F1975120172)>): [Lazy](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-lazy/index.md)<[T](index.md#1118384539%2FFunctions%2F1975120172)> | +| [beforeAny](index.md#-1851449574%2FFunctions%2F1975120172) | [jvm]
fun [beforeAny](index.md#-1851449574%2FFunctions%2F1975120172)(f: suspend (TestCase) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md))
open suspend fun [beforeAny](index.md#940017072%2FFunctions%2F1975120172)(testCase: TestCase) | +| [beforeContainer](index.md#1596196389%2FFunctions%2F1975120172) | [jvm]
fun [beforeContainer](index.md#1596196389%2FFunctions%2F1975120172)(f: suspend (TestCase) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md))
open suspend fun [beforeContainer](index.md#-1269235781%2FFunctions%2F1975120172)(testCase: TestCase) | +| [beforeEach](index.md#1986061201%2FFunctions%2F1975120172) | [jvm]
fun [beforeEach](index.md#1986061201%2FFunctions%2F1975120172)(f: suspend (TestCase) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md))
open suspend fun [beforeEach](index.md#-174575617%2FFunctions%2F1975120172)(testCase: TestCase) | +| [beforeSpec](index.md#-516232345%2FFunctions%2F1975120172) | [jvm]
fun [beforeSpec](index.md#-516232345%2FFunctions%2F1975120172)(f: suspend (Spec) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md))
open suspend fun [beforeSpec](index.md#-1683292107%2FFunctions%2F1975120172)(spec: Spec) | +| [beforeTest](index.md#-55753202%2FFunctions%2F1975120172) | [jvm]
open suspend fun [beforeTest](index.md#-55753202%2FFunctions%2F1975120172)(testCase: TestCase)
open override fun [beforeTest](index.md#-1647465780%2FFunctions%2F1975120172)(f: suspend (TestCase) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) | +| [concurrency](index.md#1608059369%2FFunctions%2F1975120172) | [jvm]
open fun [concurrency](index.md#1608059369%2FFunctions%2F1975120172)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)? | +| [context](index.md#-931840898%2FFunctions%2F1975120172) | [jvm]
open fun [context](index.md#-931840898%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): RootContainerWithConfigBuilder<FunSpecContainerScope>
open fun [context](index.md#1854742352%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), test: suspend FunSpecContainerScope.() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) | +| [coroutineDispatcherFactory](index.md#-335339149%2FFunctions%2F1975120172) | [jvm]
open fun [coroutineDispatcherFactory](index.md#-335339149%2FFunctions%2F1975120172)(): CoroutineDispatcherFactory? | +| [defaultTestCaseConfig](index.md#-1208186473%2FFunctions%2F1975120172) | [jvm]
open fun [~~defaultTestCaseConfig~~](index.md#-1208186473%2FFunctions%2F1975120172)(): TestCaseConfig? | +| [dispatcherAffinity](index.md#967441007%2FFunctions%2F1975120172) | [jvm]
open fun [dispatcherAffinity](index.md#967441007%2FFunctions%2F1975120172)(): [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.md)? | +| [extension](index.md#-1270485135%2FFunctions%2F1975120172) | [jvm]
fun <[T](index.md#-1270485135%2FFunctions%2F1975120172) : Extension> [extension](index.md#-1270485135%2FFunctions%2F1975120172)(extension: [T](index.md#-1270485135%2FFunctions%2F1975120172)): [T](index.md#-1270485135%2FFunctions%2F1975120172)
fun [extension](index.md#-625111808%2FFunctions%2F1975120172)(f: suspend (Tuple2<TestCase, suspend (TestCase) -> TestResult>) -> TestResult) | +| [extensions](index.md#-1125030564%2FFunctions%2F1975120172) | [jvm]
fun [extensions](index.md#-1125030564%2FFunctions%2F1975120172)(vararg extensions: Extension)
fun [extensions](index.md#-1743402674%2FFunctions%2F1975120172)(extensions: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<Extension>)
open fun [extensions](index.md#753161194%2FFunctions%2F1975120172)(): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<Extension> | +| [finalizeSpec](index.md#483870928%2FFunctions%2F1975120172) | [jvm]
fun [finalizeSpec](index.md#483870928%2FFunctions%2F1975120172)(f: suspend (Tuple2<[KClass](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.md)<out Spec>, [Map](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-map/index.md)<TestCase, TestResult>>) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) | +| [globalExtensions](index.md#1081396766%2FFunctions%2F1975120172) | [jvm]
open override fun [globalExtensions](index.md#1081396766%2FFunctions%2F1975120172)(): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<Extension> | +| [include](index.md#340185448%2FFunctions%2F1975120172) | [jvm]
fun [include](index.md#340185448%2FFunctions%2F1975120172)(factory: TestFactory)
fun [include](index.md#-1076090397%2FFunctions%2F1975120172)(prefix: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), factory: TestFactory) | +| [invocationTimeout](index.md#-1543059125%2FFunctions%2F1975120172) | [jvm]
open fun [invocationTimeout](index.md#-1543059125%2FFunctions%2F1975120172)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)? | +| [isolationMode](index.md#-209763861%2FFunctions%2F1975120172) | [jvm]
open fun [isolationMode](index.md#-209763861%2FFunctions%2F1975120172)(): IsolationMode? | +| [listener](index.md#-718864244%2FFunctions%2F1975120172) | [jvm]
fun <[T](index.md#-718864244%2FFunctions%2F1975120172) : TestListener> [listener](index.md#-718864244%2FFunctions%2F1975120172)(listener: [T](index.md#-718864244%2FFunctions%2F1975120172)): [T](index.md#-718864244%2FFunctions%2F1975120172) | +| [listeners](index.md#420835937%2FFunctions%2F1975120172) | [jvm]
fun [listeners](index.md#420835937%2FFunctions%2F1975120172)(vararg listeners: TestListener)
fun [listeners](index.md#1561031497%2FFunctions%2F1975120172)(listeners: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<TestListener>)
open fun [listeners](index.md#-959107971%2FFunctions%2F1975120172)(): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<TestListener> | +| [register](index.md#1123447995%2FFunctions%2F1975120172) | [jvm]
fun <[T](index.md#1123447995%2FFunctions%2F1975120172) : TestListener> [register](index.md#1123447995%2FFunctions%2F1975120172)(extension: [T](index.md#1123447995%2FFunctions%2F1975120172)): [T](index.md#1123447995%2FFunctions%2F1975120172)
fun [register](index.md#1528631275%2FFunctions%2F1975120172)(vararg extensions: Extension)
fun [register](index.md#1159151455%2FFunctions%2F1975120172)(extensions: [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<Extension>) | +| [registeredAutoCloseables](index.md#1761867328%2FFunctions%2F1975120172) | [jvm]
fun [registeredAutoCloseables](index.md#1761867328%2FFunctions%2F1975120172)(): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<[Lazy](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-lazy/index.md)<AutoCloseable>> | +| [registeredExtensions](index.md#1202043548%2FFunctions%2F1975120172) | [jvm]
fun [registeredExtensions](index.md#1202043548%2FFunctions%2F1975120172)(): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<Extension> | +| [rootTests](index.md#580898470%2FFunctions%2F1975120172) | [jvm]
open override fun [rootTests](index.md#580898470%2FFunctions%2F1975120172)(): [List](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.md)<RootTest> | +| [seal](index.md#-2055778568%2FFunctions%2F1975120172) | [jvm]
fun [seal](index.md#-2055778568%2FFunctions%2F1975120172)() | +| [tags](index.md#-1949138170%2FFunctions%2F1975120172) | [jvm]
fun [tags](index.md#-1949138170%2FFunctions%2F1975120172)(vararg tags: Tag)
open fun [tags](index.md#502911045%2FFunctions%2F1975120172)(): [Set](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-set/index.md)<Tag> | +| [test](index.md#310933201%2FFunctions%2F1975120172) | [jvm]
open fun [test](index.md#310933201%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): RootTestWithConfigBuilder
open fun [test](index.md#-1089832823%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), test: suspend TestScope.() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) | +| [testCaseOrder](index.md#-223199664%2FFunctions%2F1975120172) | [jvm]
open fun [testCaseOrder](index.md#-223199664%2FFunctions%2F1975120172)(): TestCaseOrder? | +| [testTaskScheduling](test-task-scheduling.md) | [jvm]
suspend fun ContainerScope.[testTaskScheduling](test-task-scheduling.md)(engineCount: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = ENGINE_COUNT, executions: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = EXECUTIONS, executionBufferMs: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = DEFAULT_EXECUTION_BUFFER_MS, frequenciesExponentialSeriesInitialMs: [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.md) = FREQUENCIES_EXPONENTIAL_SERIES_INITIAL_MS, frequenciesExponentialSeriesN: [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.md) = FREQUENCIES_EXPONENTIAL_SERIES_N, taskSchedulingConfiguration: [TaskSchedulingConfiguration](../-task-scheduling-configuration/index.md).([TaskFreqMs](../-task-freq-ms/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) | +| [threads](index.md#2107429395%2FFunctions%2F1975120172) | [jvm]
open fun [threads](index.md#2107429395%2FFunctions%2F1975120172)(): [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md)? | +| [timeout](index.md#-1966074021%2FFunctions%2F1975120172) | [jvm]
open fun [timeout](index.md#-1966074021%2FFunctions%2F1975120172)(): [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)? | +| [xcontext](index.md#-34627402%2FFunctions%2F1975120172) | [jvm]
open fun [xcontext](index.md#-34627402%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): RootContainerWithConfigBuilder<FunSpecContainerScope>
open fun [xcontext](index.md#-1381192680%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), test: suspend FunSpecContainerScope.() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) | +| [xtest](index.md#1009466777%2FFunctions%2F1975120172) | [jvm]
open fun [xtest](index.md#1009466777%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md)): RootTestWithConfigBuilder
open fun [xtest](index.md#-1944354479%2FFunctions%2F1975120172)(name: [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.md), test: suspend TestScope.() -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-plugin-test/test-task-scheduling.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-plugin-test/test-task-scheduling.md index e1da8720..f14a6bbf 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-plugin-test/test-task-scheduling.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling-plugin-test/test-task-scheduling.md @@ -1,16 +1,23 @@ --- title: testTaskScheduling --- -//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](../index.md)/[TaskSchedulingPluginTest](index.md)/[testTaskScheduling](test-task-scheduling.md) - +//[extra-ktor-plugins](../../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](../index.md)/[TaskSchedulingPluginTest](index.md)/[testTaskScheduling](test-task-scheduling.md) # testTaskScheduling - - [jvm]\ -suspend fun ContainerScope.[testTaskScheduling](test-task-scheduling.md)(engineCount: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = ENGINE_COUNT, executions: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = EXECUTIONS, executionBufferMs: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = DEFAULT_EXECUTION_BUFFER_MS, frequenciesExponentialSeriesInitialMs: [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.md) = FREQUENCIES_EXPONENTIAL_SERIES_INITIAL_MS, frequenciesExponentialSeriesN: [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.md) = FREQUENCIES_EXPONENTIAL_SERIES_N, taskSchedulingConfiguration: [TaskSchedulingConfiguration](../-task-scheduling-configuration/index.md).([TaskFreqMs](../-task-freq-ms/index.md)) -> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) +suspend fun ContainerScope.[testTaskScheduling](test-task-scheduling.md)( +engineCount: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = ENGINE_COUNT, +executions: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = EXECUTIONS, +executionBufferMs: [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.md) = +DEFAULT_EXECUTION_BUFFER_MS, +frequenciesExponentialSeriesInitialMs: [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.md) = +FREQUENCIES_EXPONENTIAL_SERIES_INITIAL_MS, +frequenciesExponentialSeriesN: [Short](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-short/index.md) = +FREQUENCIES_EXPONENTIAL_SERIES_N, +taskSchedulingConfiguration: [TaskSchedulingConfiguration](../-task-scheduling-configuration/index.md).([TaskFreqMs](../-task-freq-ms/index.md)) +-> [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.md)) diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling.md index 22108e06..3db43fdf 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/-task-scheduling.md @@ -1,24 +1,20 @@ --- title: TaskScheduling --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](index.md)/[TaskScheduling](-task-scheduling.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](index.md)/[TaskScheduling](-task-scheduling.md) # TaskScheduling - - [common]\ -val [TaskScheduling](-task-scheduling.md): ApplicationPlugin<[TaskSchedulingConfiguration](-task-scheduling-configuration/index.md)> - - +val [TaskScheduling](-task-scheduling.md): +ApplicationPlugin<[TaskSchedulingConfiguration](-task-scheduling-configuration/index.md)> Task scheduler plugin - - -Provides scheduling capabilities for a given set of scheduled tasks. The tasks are managed by some implementation of [TaskManager](../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/index.md), that is responsible for coordinating the execution of the tasks across the different instances of the application. +Provides scheduling capabilities for a given set of scheduled tasks. The tasks are managed by some implementation +of [TaskManager](../io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/-task-manager/index.md), that is +responsible for coordinating the execution of the tasks across the different instances of the application. diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/index.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/index.md index 2f476047..97f4dc1e 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/index.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/index.md @@ -1,31 +1,25 @@ --- title: io.github.flaxoos.ktor.server.plugins.taskscheduling --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](index.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](index.md) # Package-level declarations - - ## Types - -| Name | Summary | -|---|---| -| [TaskConfiguration](-task-configuration/index.md) | [common]
class [TaskConfiguration](-task-configuration/index.md)
Configuration for a [Task](../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md) | -| [TaskFreqMs](-task-freq-ms/index.md) | [jvm]
@[JvmInline](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-inline/index.md)
value class [TaskFreqMs](-task-freq-ms/index.md)(val value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)) | -| [TaskSchedulingConfiguration](-task-scheduling-configuration/index.md) | [common]
open class [TaskSchedulingConfiguration](-task-scheduling-configuration/index.md)
Configuration for [TaskScheduling](-task-scheduling.md) | -| [TaskSchedulingDsl](-task-scheduling-dsl/index.md) | [common]
@[DslMarker](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-dsl-marker/index.md)
annotation class [TaskSchedulingDsl](-task-scheduling-dsl/index.md) | -| [TaskSchedulingPluginTest](-task-scheduling-plugin-test/index.md) | [jvm]
abstract class [TaskSchedulingPluginTest](-task-scheduling-plugin-test/index.md) : FunSpec | - +| Name | Summary | +|------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [TaskConfiguration](-task-configuration/index.md) | [common]
class [TaskConfiguration](-task-configuration/index.md)
Configuration for a [Task](../io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/-task/index.md) | +| [TaskFreqMs](-task-freq-ms/index.md) | [jvm]
@[JvmInline](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.jvm/-jvm-inline/index.md)
value class [TaskFreqMs](-task-freq-ms/index.md)(val value: [Long](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.md)) | +| [TaskSchedulingConfiguration](-task-scheduling-configuration/index.md) | [common]
open class [TaskSchedulingConfiguration](-task-scheduling-configuration/index.md)
Configuration for [TaskScheduling](-task-scheduling.md) | +| [TaskSchedulingDsl](-task-scheduling-dsl/index.md) | [common]
@[DslMarker](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-dsl-marker/index.md)
annotation class [TaskSchedulingDsl](-task-scheduling-dsl/index.md) | +| [TaskSchedulingPluginTest](-task-scheduling-plugin-test/index.md) | [jvm]
abstract class [TaskSchedulingPluginTest](-task-scheduling-plugin-test/index.md) : FunSpec | ## Properties - -| Name | Summary | -|---|---| -| [logger](logger.md) | [jvm]
val [logger](logger.md): KLogger | +| Name | Summary | +|---------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [logger](logger.md) | [jvm]
val [logger](logger.md): KLogger | | [TaskScheduling](-task-scheduling.md) | [common]
val [TaskScheduling](-task-scheduling.md): ApplicationPlugin<[TaskSchedulingConfiguration](-task-scheduling-configuration/index.md)>
Task scheduler plugin | diff --git a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/logger.md b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/logger.md index 38b141bb..06573b21 100644 --- a/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/logger.md +++ b/documentation/mkdocs/docs/dokka/extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/logger.md @@ -1,14 +1,11 @@ --- title: logger --- -//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](index.md)/[logger](logger.md) - +//[extra-ktor-plugins](../../index.md)/[io.github.flaxoos.ktor.server.plugins.taskscheduling](index.md)/[logger](logger.md) # logger - - [jvm]\ val [logger](logger.md): KLogger diff --git a/documentation/mkdocs/docs/dokka/index.md b/documentation/mkdocs/docs/dokka/index.md index 2cb1eae6..293c12af 100644 --- a/documentation/mkdocs/docs/dokka/index.md +++ b/documentation/mkdocs/docs/dokka/index.md @@ -1,28 +1,24 @@ --- title: extra-ktor-plugins --- -//[extra-ktor-plugins](index.md) - +//[extra-ktor-plugins](index.md) # extra-ktor-plugins - - ## Packages - -| Name | -|---| -| [io.github.flaxoos.ktor.client.plugins.circuitbreaker](extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/index.md) | -| [io.github.flaxoos.ktor.server.plugins.kafka](extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/index.md) | -| [io.github.flaxoos.ktor.server.plugins.kafka.components](extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/index.md) | -| [io.github.flaxoos.ktor.server.plugins.ratelimiter](extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/index.md) | -| [io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/index.md) | -| [io.github.flaxoos.ktor.server.plugins.taskscheduling](extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/index.md) | -| [io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/index.md) | -| [io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock](extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/index.md) | +| Name | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [io.github.flaxoos.ktor.client.plugins.circuitbreaker](extra-ktor-plugins/io.github.flaxoos.ktor.client.plugins.circuitbreaker/index.md) | +| [io.github.flaxoos.ktor.server.plugins.kafka](extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka/index.md) | +| [io.github.flaxoos.ktor.server.plugins.kafka.components](extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.kafka.components/index.md) | +| [io.github.flaxoos.ktor.server.plugins.ratelimiter](extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter/index.md) | +| [io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations](extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.ratelimiter.implementations/index.md) | +| [io.github.flaxoos.ktor.server.plugins.taskscheduling](extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling/index.md) | +| [io.github.flaxoos.ktor.server.plugins.taskscheduling.managers](extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers/index.md) | +| [io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock](extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock/index.md) | | [io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database](extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.database/index.md) | -| [io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/index.md) | -| [io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks](extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/index.md) | +| [io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis](extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.managers.lock.redis/index.md) | +| [io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks](extra-ktor-plugins/io.github.flaxoos.ktor.server.plugins.taskscheduling.tasks/index.md) | diff --git a/documentation/mkdocs/docs/guide/installation.md b/documentation/mkdocs/docs/guide/installation.md index c471cb96..18493896 100644 --- a/documentation/mkdocs/docs/guide/installation.md +++ b/documentation/mkdocs/docs/guide/installation.md @@ -1,7 +1,7 @@ - [![Maven-central](https://img.shields.io/maven-central/v/io.github.flaxoos/ktor-server-kafka?style=for-the-badge&logo=apachemaven)](https://search.maven.org/search?q=io.github.flaxoos%20AND%20ktor) The libraries are published to maven central, see above for the latest version + ```kotlin dependencies { implementation("io.github.flaxoos:ktor-server-kafka:$ktor_plugins_version") @@ -9,4 +9,4 @@ dependencies { implementation("io.github.flaxoos:ktor-server-rate-limiting:$ktor_plugins_version") implementation("io.github.flaxoos:ktor-client-circuit-breaker:$ktor_plugins_version") } -``` \ No newline at end of file +``` diff --git a/documentation/mkdocs/docs/index.md b/documentation/mkdocs/docs/index.md index ed2ac895..ebae2c12 100644 --- a/documentation/mkdocs/docs/index.md +++ b/documentation/mkdocs/docs/index.md @@ -6,6 +6,7 @@ [![Koverage: 94.42%](https://img.shields.io/badge/94.42-green?logo=kotlin&label=koverage&style=for-the-badge)](file:/Users/ido/IdeaProjects/flax-ktor-plugins/build/reports/kover/html/index.html) [![Docs](https://custom-icon-badges.demolab.com/badge/Pages-blue.svg?label=Docs&logo=github&logoColor=white?icon=githubpages&style=for-the-badge)](https://github.com/Flaxoos/extra-ktor-plugins/actions/workflows/pages/pages-build-deployment) [![Awesome Kotlin Badge](https://custom-icon-badges.demolab.com/badge/awesome-kotlin-orange.svg?labelColor=blue&style=for-the-badge)](https://github.com/KotlinBy/awesome-kotlin) --- + ### Feature-rich, efficient, and highly customizable plugins for your Multiplatform Ktor Server or Client --- @@ -18,11 +19,10 @@ | **[Task Scheduling](ktor-server-task-scheduling)** | **JVM / Native^** | Task scheduling for distributed servers with various and extendable task management strategies | | **[Rate Limiting](ktor-server-rate-limiting)** | **JVM / Native** | Highly configurable rate limiter with offering different startegies, request weighting, blacklisting and whitelisting of requests based on authentication, host and user agents | - ### **Client Plugins** -| Plugin | Supported Platforms | Description | -|----------------------------------------------------|----------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Plugin | Supported Platforms | Description | +|----------------------------------------------------|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **[Circuit Breaker](ktor-client-circuit-breaker)** | **JVM / Native / JS** | Enhances system resilience by halting requests to failing services once a defined error threshold is reached. Automatically switches between open and closed states based on the health of the targeted service. | Note that `^` means issues with native binary dependencies, feel free to pull the project and publish locally @@ -30,8 +30,10 @@ Note that `^` means issues with native binary dependencies, feel free to pull th --- ## Examples + See [Examples Projects](https://github.com/Flaxoos/flax-ktor-plugins-examples) ## Contributing -Contributions are always welcome! If you have an idea for a plugin or want to improve an existing one, feel free to fork this repository and submit a pull request. +Contributions are always welcome! If you have an idea for a plugin or want to improve an existing one, feel free to fork +this repository and submit a pull request. diff --git a/documentation/mkdocs/docs/ktor-client-circuit-breaker/index.md b/documentation/mkdocs/docs/ktor-client-circuit-breaker/index.md index 094cecdc..fd63edfc 100644 --- a/documentation/mkdocs/docs/ktor-client-circuit-breaker/index.md +++ b/documentation/mkdocs/docs/ktor-client-circuit-breaker/index.md @@ -1,7 +1,10 @@ # Circuit Breaker Plugin for Ktor Client + ![koverage](https://img.shields.io/badge/93.58-green?logo=kotlin&label=koverage&style=flat) -The Circuit Breaker pattern is a crucial part of modern software architecture, allowing you to gracefully handle potential failures when communicating with external services. The Ktor Circuit Breaker plugin is an implementation of this pattern, providing you with an easy way to incorporate this mechanism into your Ktor clients. +The Circuit Breaker pattern is a crucial part of modern software architecture, allowing you to gracefully handle +potential failures when communicating with external services. The Ktor Circuit Breaker plugin is an implementation of +this pattern, providing you with an easy way to incorporate this mechanism into your Ktor clients. ## Features: @@ -13,9 +16,11 @@ The Circuit Breaker pattern is a crucial part of modern software architecture, a ## How to Use: -You can configure the Circuit Breaker plugin during the installation phase of the HttpClient. Both global and named configurations can be set. +You can configure the Circuit Breaker plugin during the installation phase of the HttpClient. Both global and named +configurations can be set. -Global, if registered, will be the default choice, whereas registering with a specific name allows you to apply it to specific services +Global, if registered, will be the default choice, whereas registering with a specific name allows you to apply it to +specific services ```kotlin HttpClient { @@ -35,7 +40,7 @@ HttpClient { } ``` -You can then make requests using the circuit breaker, either by calling `HttpClient.requestWithCircuitBreaker` +You can then make requests using the circuit breaker, either by calling `HttpClient.requestWithCircuitBreaker` ```kotlin client.requestWithCircuitBreaker { @@ -49,7 +54,8 @@ client.requestWithCircuitBreaker(name = "strict".toCircuitBreakerName()) { } ``` -Or `HttpRequestBuilder.withCircuitBreaker` +Or `HttpRequestBuilder.withCircuitBreaker` + ```kotlin client.get("https://service.com") { withCircuitBreaker() @@ -64,7 +70,8 @@ client.get("https://unreliable-service.com") { The following are the configurable parameters: -- `failureThreshold`: The number of failures allowed before moving the circuit to the `HALF_OPEN` state for the global configuration. +- `failureThreshold`: The number of failures allowed before moving the circuit to the `HALF_OPEN` state for the global + configuration. - `halfOpenFailureThreshold`: The number of failures allowed in the `HALF_OPEN` state for the global configuration. diff --git a/documentation/mkdocs/docs/ktor-server-kafka/index.md b/documentation/mkdocs/docs/ktor-server-kafka/index.md index 512921d9..0827141e 100644 --- a/documentation/mkdocs/docs/ktor-server-kafka/index.md +++ b/documentation/mkdocs/docs/ktor-server-kafka/index.md @@ -4,58 +4,64 @@ --- -Integrate Kafka effortlessly into your Ktor application with this powerful Kafka Plugin. This plugin provides an easy setup for Kafka clients, allowing you to configure and manage Kafka Admin, Producer, and Consumer instances directly in your Ktor server. +Integrate Kafka effortlessly into your Ktor application with this powerful Kafka Plugin. This plugin provides an easy +setup for Kafka clients, allowing you to configure and manage Kafka Admin, Producer, and Consumer instances directly in +your Ktor server. --- ## Features -- **Streamlined Configuration**: Install Kafka client configurations either through application configuration files or directly in code. +- **Streamlined Configuration**: Install Kafka client configurations either through application configuration files or + directly in code. - **Admin Client**: Easy setup and topic creation for your Kafka admin client. - **Producer Client**: Initialize Kafka producer instances effortlessly. - **Consumer Client**: Configure and manage Kafka consumer instances, including polling logic and record handling. -- **Built in Avro4k support**: Avro schemas are supported by default. There's no need to define key/value serializers. Schemas can be registered automatically. Avro records to and from conversion methods +- **Built in Avro4k support**: Avro schemas are supported by default. There's no need to define key/value serializers. + Schemas can be registered automatically. Avro records to and from conversion methods ## How to Use ### From Code -The plugin provides a DSL that enables comprehensive Kafka configuration, adhering to the classes and properties defined in [org.apache.kafka.common.config](https://kafka.apache.org/21/javadoc/index.html?org/apache/kafka/common/config/package-summary.html), the DSL offers a fluent, programmatic way to set up your Kafka settings right within your Ktor application. +The plugin provides a DSL that enables comprehensive Kafka configuration, adhering to the classes and properties defined +in [org.apache.kafka.common.config](https://kafka.apache.org/21/javadoc/index.html?org/apache/kafka/common/config/package-summary.html), +the DSL offers a fluent, programmatic way to set up your Kafka settings right within your Ktor application. ```kotlin install(Kafka) { schemaRegistryUrl = listOf("my.schemaRegistryUrl") - topic(named("my-topic")) { - partitions = 1 - replicas = 1 - configs { - messageTimestampType = CreateTime - } - } - common { // <-- Define common configs - bootstrapServers = listOf("my-kafka") - retries = 1 - clientId = "my-client-id" - } - admin { } // <-- Creates an admin client - producer { // <-- Creates a producer - clientId = "my-client-id" - } - consumer { // <-- Creates a consumer - groupId = "my-group-id" - clientId = "my-client-id-override" //<-- Override common configurations - } - consumerConfig { - consumerRecordHandler(named("my-topic")) { record -> - myService.save(record) - } - } - registerSchemas { - using { // <-- optionally provide a client, by default CIO is used - HttpClient() - } - MyRecord::class at named("my-topic") // <-- Will register schema upon startup - } + topic(named("my-topic")) { + partitions = 1 + replicas = 1 + configs { + messageTimestampType = CreateTime + } + } + common { // <-- Define common configs + bootstrapServers = listOf("my-kafka") + retries = 1 + clientId = "my-client-id" + } + admin { } // <-- Creates an admin client + producer { // <-- Creates a producer + clientId = "my-client-id" + } + consumer { // <-- Creates a consumer + groupId = "my-group-id" + clientId = "my-client-id-override" //<-- Override common configurations + } + consumerConfig { + consumerRecordHandler(named("my-topic")) { record -> + myService.save(record) + } + } + registerSchemas { + using { // <-- optionally provide a client, by default CIO is used + HttpClient() + } + MyRecord::class at named("my-topic") // <-- Will register schema upon startup + } } ``` @@ -75,17 +81,19 @@ install(KafkaFromFileConfig.Kafka) { } } ``` + The above will look for the config in `ktor.kafka` by default. You can also specify a different path if needed: ```kotlin -install(KafkaFromFileConfig.Kafka("ktor.my.kafka")){ +install(KafkaFromFileConfig.Kafka("ktor.my.kafka")) { ... } ``` Example file configuration: + ```hocon ktor { kafka { @@ -132,7 +140,8 @@ val consumer = application.kafkaConsumer ## Important Notes -- Make sure you define a consumer configuration when you initialize a consumer client, or the consumer job will not start automatically. +- Make sure you define a consumer configuration when you initialize a consumer client, or the consumer job will not + start automatically. - Ensure that the `pollFrequency` for consumers is set appropriately, depending on your use-case. @@ -140,10 +149,10 @@ val consumer = application.kafkaConsumer - This plugin works asynchronously, so it's advised to monitor the logs for setup completion and error notifications. - ## Acknowledgements -This project uses code from [gAmUssA/ktor-kafka](https://github.com/gAmUssA/ktor-kafka), which is available under the MIT License. This project expands on concepts that were introduced there in a few ways: +This project uses code from [gAmUssA/ktor-kafka](https://github.com/gAmUssA/ktor-kafka), which is available under the +MIT License. This project expands on concepts that were introduced there in a few ways: - The Topic DSL idea was expanded to allow for configuration of all components in a similar manner - The consumer behaviour can be configured in the plugin setup diff --git a/documentation/mkdocs/docs/ktor-server-rate-limiting/index.md b/documentation/mkdocs/docs/ktor-server-rate-limiting/index.md index 22990753..c97e4e56 100644 --- a/documentation/mkdocs/docs/ktor-server-rate-limiting/index.md +++ b/documentation/mkdocs/docs/ktor-server-rate-limiting/index.md @@ -1,24 +1,30 @@ # Rate Limiting Plugin for Ktor Server + ![koverage](https://img.shields.io/badge/94.24-green?logo=kotlin&label=koverage&style=flat) --- -Manage request rate limiting as you see fit with `RateLimiting` in your Ktor server, ensuring you protect your application from potential abuse or resource overload. +Manage request rate limiting as you see fit with `RateLimiting` in your Ktor server, ensuring you protect your +application from potential abuse or resource overload. --- ## Features + ### Strategies + - **Token Bucket:** Supports variable request rate and is suitable for handling bursts of requests. - **Leaky Bucket:** Guarantees a constant request rate, providing fair distribution between clients -- **Sliding Window:** Allows a specific weight of calls to be made over a designated duration, considering the rate and call weight configured. +- **Sliding Window:** Allows a specific weight of calls to be made over a designated duration, considering the rate and + call weight configured. ### Configurability -- **Configurable capacity unit of measure**: Measure call count or call weight in bytes +- **Configurable capacity unit of measure**: Measure call count or call weight in bytes - **Configurable call weighting**: Calls can be made to take up more capacity based on a given function - **Whitelist & Blacklist**: Whitelist or blacklist based on the client's host, user-agent, or principal. -- **Customizable Response**: Set your custom response when the rate limit is exceeded. The default response status is `429 Too Many Requests`. +- **Customizable Response**: Set your custom response when the rate limit is exceeded. The default response status is + `429 Too Many Requests`. - **Logging**: Log rate limit hits for better monitoring and debugging. ## How to Use diff --git a/documentation/mkdocs/docs/ktor-server-task-scheduling/index.md b/documentation/mkdocs/docs/ktor-server-task-scheduling/index.md index b404cbc0..996afcc5 100644 --- a/documentation/mkdocs/docs/ktor-server-task-scheduling/index.md +++ b/documentation/mkdocs/docs/ktor-server-task-scheduling/index.md @@ -1,27 +1,40 @@ # Task Scheduler Plugin for Ktor Server + ![koverage](https://img.shields.io/badge/93.58-green?logo=kotlin&label=koverage&style=flat) --- -Manage scheduled tasks across instances of your distributed ktor server, using various strategies and a kotlin favoured cron tab +Manage scheduled tasks across instances of your distributed ktor server, using various strategies and a kotlin favoured +cron tab --- ## Features -- **Various Implementations**: Can use [Redis](https://github.com/Flaxoos/extra-ktor-plugins/tree/main/ktor-server-task-scheduling/ktor-server-task-scheduling-redis)(JVM/Native), [JDBC](https://github.com/Flaxoos/extra-ktor-plugins/tree/main/ktor-server-task-scheduling/ktor-server-task-scheduling-jdbc) (JVM) or [MongoDB](https://github.com/Flaxoos/extra-ktor-plugins/tree/main/ktor-server-task-scheduling/ktor-server-task-scheduling-mongodb) (JVM) for lock management, or add your own implementation -by extending [Core](https://github.com/Flaxoos/extra-ktor-plugins/tree/main/ktor-server-task-scheduling/ktor-server-task-scheduling-core) +- **Various Implementations**: Can + use [Redis](https://github.com/Flaxoos/extra-ktor-plugins/tree/main/ktor-server-task-scheduling/ktor-server-task-scheduling-redis)( + JVM/Native), [JDBC](https://github.com/Flaxoos/extra-ktor-plugins/tree/main/ktor-server-task-scheduling/ktor-server-task-scheduling-jdbc) ( + JVM) + or [MongoDB](https://github.com/Flaxoos/extra-ktor-plugins/tree/main/ktor-server-task-scheduling/ktor-server-task-scheduling-mongodb) ( + JVM) for lock management, or add your own implementation + by + extending [Core](https://github.com/Flaxoos/extra-ktor-plugins/tree/main/ktor-server-task-scheduling/ktor-server-task-scheduling-core) - **Multiple managers**: Define multiple tasks and assign each to a manager of your choice -- **Kron Schedule builder**: Utilizes [krontab](https://github.com/InsanusMokrassar/krontab) for building schedules using a convenient kotlin DSL +- **Kron Schedule builder**: Utilizes [krontab](https://github.com/InsanusMokrassar/krontab) for building schedules + using a convenient kotlin DSL ## How to Use + - Add a dependency for your chosen task managers or for core and implement yourself: + ```kotlin implementation("io.github.flaxoos:ktor-server-task-scheduling-${redis/jdbc/mongodb/core}:$ktor_plugins_version") ``` + - Or add - Install the plugin and define one or more task managers: + ```kotlin install(TaskScheduling){ redis{ //<-- this will be the default manager @@ -33,7 +46,7 @@ install(TaskScheduling){ } ``` -- Configure some tasks and assign them to the managers +- Configure some tasks and assign them to the managers ```kotlin install(TaskScheduling) { diff --git a/gradle.properties b/gradle.properties index 94cabc30..325c7e4d 100644 --- a/gradle.properties +++ b/gradle.properties @@ -3,7 +3,7 @@ github.repository.name=extra-ktor-plugins kotlin.native.cacheKind.linuxX64=none kotlin.native.ignoreDisabledTargets=true gradle.publish.enable.module-metadata=true -version=2.0.0 +version=2.0.1 gpr.user=flaxoos org.gradle.jvmargs=-Xmx2g -XX:MaxMetaspaceSize=2g kotlin.mpp.applyDefaultHierarchyTemplate=false \ No newline at end of file diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml index 38cefe7d..80f12347 100644 --- a/gradle/libs.versions.toml +++ b/gradle/libs.versions.toml @@ -28,7 +28,8 @@ atomicfu = "0.25.0" kotlinx-coroutines = "1.9.0" # Testing -kotest = "6.0.0.M1" +#kotest = "6.0.0.M1" +kotest = "5.9.1" kotest-stable = "5.9.1" kotest-test-containers = "2.0.2" mockk = "1.13.4" @@ -38,7 +39,8 @@ testcontainers = "1.19.8" redis-testcontainers = "1.6.4" # Code Quality and Coverage -ktlint = "11.6.1" +ktlint-gradle = "12.1.1" +ktlint = "1.3.1" kover = "0.7.2" koverBadge = "0.0.6" detekt = "1.23.1" @@ -51,13 +53,13 @@ arrow = "1.2.0" # Messaging kafka = "3.5.1" -confluent = "5.3.0" +confluent = "7.7.1" avro4k = "0.41.0" -avro = "1.11.3" +avro = "1.12.0" # Redis -kreds = "0.9.0" -redis-mp-client = "0.0.2" +kreds = "0.9.1" +redis-mp-client = "0.0.3" # Documentation dokka = "1.9.10" @@ -102,6 +104,7 @@ ktor-server-test-host = { module = "io.ktor:ktor-server-test-host", version.ref ktor-client-core = { module = "io.ktor:ktor-client-core", version.ref = "ktor" } ktor-client-cio = { module = "io.ktor:ktor-client-cio", version.ref = "ktor" } +ktor-client-java = { module = "io.ktor:ktor-client-java", version.ref = "ktor" } ktor-client-mock = { module = "io.ktor:ktor-client-mock", version.ref = "ktor" } ktor-client-contentNegotiation = { module = "io.ktor:ktor-client-content-negotiation", version.ref = "ktor" } @@ -147,7 +150,7 @@ avro4k-core = { module = "com.sksamuel.avro4k:avro4k-core", version.ref = "avro4 avro-tools = { module = "org.apache.avro:avro-tools", version.ref = "avro" } # Code Quality and Coverage plugins -ktlint-gradlePlugin = { module = "org.jlleitschuh.gradle:ktlint-gradle", version.ref = "ktlint" } +ktlint-gradlePlugin = { module = "org.jlleitschuh.gradle:ktlint-gradle", version.ref = "ktlint-gradle" } kover-gradlePlugin = { module = "org.jetbrains.kotlinx:kover-gradle-plugin", version.ref = "kover" } kover-badge-gradlePlugin = { module = "io.github.flaxoos:kover-badge", version.ref = "koverBadge" } detekt-gradlePlugin = { module = "io.gitlab.arturbosch.detekt:detekt-gradle-plugin", version.ref = "detekt" } @@ -222,4 +225,4 @@ kmock = { id = "tech.antibytes.kmock.kmock-gradle", version.ref = "kmock" } gradle-release = { id = "net.researchgate.release", version.ref = "gradle-release" } # Nexus -nexusPublish = { id = "io.github.gradle-nexus.publish-plugin", version.ref = "nexusPublish" } \ No newline at end of file +nexusPublish = { id = "io.github.gradle-nexus.publish-plugin", version.ref = "nexusPublish" } diff --git a/images/kotlin-logo.svg b/images/kotlin-logo.svg index 08c9d784..24231a0f 100644 --- a/images/kotlin-logo.svg +++ b/images/kotlin-logo.svg @@ -2,9 +2,24 @@ - - - - - + + + + + + + + + + + + + + + diff --git a/ktor-client-circuit-breaker/README.md b/ktor-client-circuit-breaker/README.md index 14f98af6..fbf66c2a 100644 --- a/ktor-client-circuit-breaker/README.md +++ b/ktor-client-circuit-breaker/README.md @@ -1,9 +1,12 @@ # Circuit Breaker Plugin for Ktor Client + ![koverage](https://img.shields.io/badge/93.58-green?logo=kotlin&label=koverage&style=flat) --- -The Circuit Breaker pattern is a crucial part of modern software architecture, allowing you to gracefully handle potential failures when communicating with external services. The Ktor Circuit Breaker plugin is an implementation of this pattern, providing you with an easy way to incorporate this mechanism into your Ktor clients. +The Circuit Breaker pattern is a crucial part of modern software architecture, allowing you to gracefully handle +potential failures when communicating with external services. The Ktor Circuit Breaker plugin is an implementation of +this pattern, providing you with an easy way to incorporate this mechanism into your Ktor clients. --- @@ -17,9 +20,11 @@ The Circuit Breaker pattern is a crucial part of modern software architecture, a ## How to Use: -You can configure the Circuit Breaker plugin during the installation phase of the HttpClient. Both global and named configurations can be set. +You can configure the Circuit Breaker plugin during the installation phase of the HttpClient. Both global and named +configurations can be set. -Global, if registered, will be the default choice, whereas registering with a specific name allows you to apply it to specific services +Global, if registered, will be the default choice, whereas registering with a specific name allows you to apply it to +specific services ```kotlin HttpClient { @@ -39,7 +44,7 @@ HttpClient { } ``` -You can then make requests using the circuit breaker, either by calling `HttpClient.requestWithCircuitBreaker` +You can then make requests using the circuit breaker, either by calling `HttpClient.requestWithCircuitBreaker` ```kotlin client.requestWithCircuitBreaker { @@ -53,7 +58,8 @@ client.requestWithCircuitBreaker(name = "strict".toCircuitBreakerName()) { } ``` -Or `HttpRequestBuilder.withCircuitBreaker` +Or `HttpRequestBuilder.withCircuitBreaker` + ```kotlin client.get("https://service.com") { withCircuitBreaker() @@ -68,7 +74,8 @@ client.get("https://unreliable-service.com") { The following are the configurable parameters: -- `failureThreshold`: The number of failures allowed before moving the circuit to the `HALF_OPEN` state for the global configuration. +- `failureThreshold`: The number of failures allowed before moving the circuit to the `HALF_OPEN` state for the global + configuration. - `halfOpenFailureThreshold`: The number of failures allowed in the `HALF_OPEN` state for the global configuration. diff --git a/ktor-client-circuit-breaker/build.gradle.kts b/ktor-client-circuit-breaker/build.gradle.kts index 8d69c7cc..4b5ac04f 100644 --- a/ktor-client-circuit-breaker/build.gradle.kts +++ b/ktor-client-circuit-breaker/build.gradle.kts @@ -6,3 +6,7 @@ plugins { kotlin { targetNative() } + +tasks.named("compileTestKotlinNative") { + enabled = false +} diff --git a/ktor-client-circuit-breaker/src/commonMain/kotlin/io/github/flaxoos/ktor/client/plugins/circuitbreaker/CircuitBreaker.kt b/ktor-client-circuit-breaker/src/commonMain/kotlin/io/github/flaxoos/ktor/client/plugins/circuitbreaker/CircuitBreaker.kt index 65605ba8..d2d779ad 100644 --- a/ktor-client-circuit-breaker/src/commonMain/kotlin/io/github/flaxoos/ktor/client/plugins/circuitbreaker/CircuitBreaker.kt +++ b/ktor-client-circuit-breaker/src/commonMain/kotlin/io/github/flaxoos/ktor/client/plugins/circuitbreaker/CircuitBreaker.kt @@ -27,6 +27,8 @@ internal class CircuitBreaker( private val resetInterval: Duration = config.resetInterval private val failureTrigger = config.failureTrigger private val failureCounter = atomic(0) + + @Suppress("ktlint:standard:backing-property-naming") private val _state = atomic(CLOSED) private val responseDecorator: HttpResponse.() -> Unit = {} @@ -75,12 +77,16 @@ internal class CircuitBreaker( logger.trace("Finished handling response status ${response.status.value}") } - private fun handleResponse(state: CircuitBreakerState, response: HttpResponse) { - val selectedFailureThreshold = when (state) { - CLOSED -> failureThreshold - HALF_OPEN -> halfOpenFailureThreshold - OPEN -> error("Circuit breaker is already open") - } + private fun handleResponse( + state: CircuitBreakerState, + response: HttpResponse, + ) { + val selectedFailureThreshold = + when (state) { + CLOSED -> failureThreshold + HALF_OPEN -> halfOpenFailureThreshold + OPEN -> error("Circuit breaker is already open") + } val failureCount = failureCounter.value if (failureCount < selectedFailureThreshold) { if (!response.failureTrigger()) { @@ -122,8 +128,11 @@ internal class CircuitBreaker( } internal enum class CircuitBreakerState { - CLOSED, OPEN, HALF_OPEN + CLOSED, + OPEN, + HALF_OPEN, } -class CircuitBreakerException(failureThreshold: Int) : - Exception("Action failed more than $failureThreshold times, subsequent calls will be prevented until action is successful again") +class CircuitBreakerException( + failureThreshold: Int, +) : Exception("Action failed more than $failureThreshold times, subsequent calls will be prevented until action is successful again") diff --git a/ktor-client-circuit-breaker/src/commonMain/kotlin/io/github/flaxoos/ktor/client/plugins/circuitbreaker/CircuitBreakerConfig.kt b/ktor-client-circuit-breaker/src/commonMain/kotlin/io/github/flaxoos/ktor/client/plugins/circuitbreaker/CircuitBreakerConfig.kt index aa5c49ed..8133c805 100644 --- a/ktor-client-circuit-breaker/src/commonMain/kotlin/io/github/flaxoos/ktor/client/plugins/circuitbreaker/CircuitBreakerConfig.kt +++ b/ktor-client-circuit-breaker/src/commonMain/kotlin/io/github/flaxoos/ktor/client/plugins/circuitbreaker/CircuitBreakerConfig.kt @@ -49,7 +49,9 @@ class CircuitBreakerConfig { * Value class for a [CircuitBreaker] name */ @JvmInline -value class CircuitBreakerName(val value: String) { +value class CircuitBreakerName( + val value: String, +) { companion object { fun String.toCircuitBreakerName() = CircuitBreakerName(this) } diff --git a/ktor-client-circuit-breaker/src/commonMain/kotlin/io/github/flaxoos/ktor/client/plugins/circuitbreaker/CircuitBreakerInitializers.kt b/ktor-client-circuit-breaker/src/commonMain/kotlin/io/github/flaxoos/ktor/client/plugins/circuitbreaker/CircuitBreakerInitializers.kt index 6638ab2b..e98117d6 100644 --- a/ktor-client-circuit-breaker/src/commonMain/kotlin/io/github/flaxoos/ktor/client/plugins/circuitbreaker/CircuitBreakerInitializers.kt +++ b/ktor-client-circuit-breaker/src/commonMain/kotlin/io/github/flaxoos/ktor/client/plugins/circuitbreaker/CircuitBreakerInitializers.kt @@ -22,10 +22,11 @@ fun CircuitBreakerConfig.register( */ @CircuitBreakerDsl fun CircuitBreakerConfig.global(config: CircuitBreakerConfig.CircuitBreakerBuilder.() -> Unit) { - global = CircuitBreaker( - CIRCUIT_BREAKER_NAME_GLOBAL, - CircuitBreakerConfig.CircuitBreakerBuilder().apply(config), - ) + global = + CircuitBreaker( + CIRCUIT_BREAKER_NAME_GLOBAL, + CircuitBreakerConfig.CircuitBreakerBuilder().apply(config), + ) } /** @@ -43,12 +44,11 @@ fun HttpRequestBuilder.withCircuitBreaker(name: CircuitBreakerName = CIRCUIT_BRE suspend fun HttpClient.requestWithCircuitBreaker( name: CircuitBreakerName = CIRCUIT_BREAKER_NAME_GLOBAL, block: HttpRequestBuilder.() -> Unit, -): HttpResponse { - return request { +): HttpResponse = + request { withCircuitBreaker(name) block() } -} /** * Adds a [CircuitBreaker] to a [ConcurrentMap] diff --git a/ktor-server-kafka/README.md b/ktor-server-kafka/README.md index 64b44636..a05d0516 100644 --- a/ktor-server-kafka/README.md +++ b/ktor-server-kafka/README.md @@ -4,23 +4,29 @@ --- -Integrate Kafka effortlessly into your Ktor application with this powerful Kafka Plugin. This plugin provides an easy setup for Kafka clients, allowing you to configure and manage Kafka Admin, Producer, and Consumer instances directly in your Ktor server. +Integrate Kafka effortlessly into your Ktor application with this powerful Kafka Plugin. This plugin provides an easy +setup for Kafka clients, allowing you to configure and manage Kafka Admin, Producer, and Consumer instances directly in +your Ktor server. --- ## Features: -- **Streamlined Configuration**: Install Kafka client configurations either through application configuration files or directly in code. +- **Streamlined Configuration**: Install Kafka client configurations either through application configuration files or + directly in code. - **Admin Client**: Easy setup and topic creation for your Kafka admin client. - **Producer Client**: Initialize Kafka producer instances effortlessly. - **Consumer Client**: Configure and manage Kafka consumer instances, including polling logic and record handling. -- **Built in Avro4k support**: Avro schemas are supported by default. There's no need to define key/value serializers. Schemas can be registered automatically. Avro records to and from conversion methods +- **Built in Avro4k support**: Avro schemas are supported by default. There's no need to define key/value serializers. + Schemas can be registered automatically. Avro records to and from conversion methods ## How to Use: ### From Code: -The plugin provides a DSL that enables comprehensive Kafka configuration, adhering to the classes and properties defined in [org.apache.kafka.common.config](https://kafka.apache.org/21/javadoc/index.html?org/apache/kafka/common/config/package-summary.html), the DSL offers a fluent, programmatic way to set up your Kafka settings right within your Ktor application. +The plugin provides a DSL that enables comprehensive Kafka configuration, adhering to the classes and properties defined +in [org.apache.kafka.common.config](https://kafka.apache.org/21/javadoc/index.html?org/apache/kafka/common/config/package-summary.html), +the DSL offers a fluent, programmatic way to set up your Kafka settings right within your Ktor application. ```kotlin install(Kafka) { @@ -75,6 +81,7 @@ install(KafkaFromFileConfig.Kafka) { } } ``` + The above will look for the config in `ktor.kafka` by default. You can also specify a different path if needed: @@ -86,6 +93,7 @@ install(KafkaFromFileConfig.Kafka("ktor.my.kafka")){ ``` Example file configuration: + ```hocon ktor { kafka { @@ -132,7 +140,8 @@ val consumer = application.kafkaConsumer ## Important Notes: -- Make sure you define a consumer configuration when you initialize a consumer client, or the consumer job will not start automatically. +- Make sure you define a consumer configuration when you initialize a consumer client, or the consumer job will not + start automatically. - Ensure that the `pollFrequency` for consumers is set appropriately, depending on your use-case. @@ -140,10 +149,10 @@ val consumer = application.kafkaConsumer - This plugin works asynchronously, so it's advised to monitor the logs for setup completion and error notifications. - ## Acknowledgements -This project uses code from [gAmUssA/ktor-kafka](https://github.com/gAmUssA/ktor-kafka), which is available under the MIT License. This project expands on concepts that were introduced there in a few ways: +This project uses code from [gAmUssA/ktor-kafka](https://github.com/gAmUssA/ktor-kafka), which is available under the +MIT License. This project expands on concepts that were introduced there in a few ways: - The Topic DSL idea was expanded to allow for configuration of all components in a similar manner - The consumer behaviour can be configured in the plugin setup diff --git a/ktor-server-kafka/build.gradle.kts b/ktor-server-kafka/build.gradle.kts index aae41b4d..4cf9e25d 100644 --- a/ktor-server-kafka/build.gradle.kts +++ b/ktor-server-kafka/build.gradle.kts @@ -30,6 +30,7 @@ kotlin { api(libs.kafka.schema.registry.client) api(libs.ktor.serialization.kotlinx.json) implementation(libs.ktor.client.cio) + implementation(libs.ktor.client.java) implementation(libs.ktor.client.contentNegotiation) } } diff --git a/ktor-server-kafka/src/jvmMain/kotlin/io/github/flaxoos/ktor/server/plugins/kafka/Commons.kt b/ktor-server-kafka/src/jvmMain/kotlin/io/github/flaxoos/ktor/server/plugins/kafka/Commons.kt index dc4a36b3..5c374172 100644 --- a/ktor-server-kafka/src/jvmMain/kotlin/io/github/flaxoos/ktor/server/plugins/kafka/Commons.kt +++ b/ktor-server-kafka/src/jvmMain/kotlin/io/github/flaxoos/ktor/server/plugins/kafka/Commons.kt @@ -12,7 +12,9 @@ import org.apache.kafka.clients.consumer.KafkaConsumer import org.apache.kafka.clients.producer.KafkaProducer @JvmInline -value class TopicName(val value: String) { +value class TopicName( + val value: String, +) { companion object { infix fun named(name: String) = TopicName(name) } @@ -41,16 +43,18 @@ object Attributes { /** * Attribute key for [Producer] */ - val ProducerAttributeKey = AttributeKey>( - KTOR_KAFKA_PRODUCER_ATTRIBUTE_KEY, - ) + val ProducerAttributeKey = + AttributeKey>( + KTOR_KAFKA_PRODUCER_ATTRIBUTE_KEY, + ) /** * Attribute key for [Consumer] */ - val ConsumerAttributeKey = AttributeKey>( - KTOR_KAFKA_CONSUMER_ATTRIBUTE_KEY, - ) + val ConsumerAttributeKey = + AttributeKey>( + KTOR_KAFKA_CONSUMER_ATTRIBUTE_KEY, + ) /** * Attribute key for [HttpClient] used for registering [Schema]s to the configured schema registry diff --git a/ktor-server-kafka/src/jvmMain/kotlin/io/github/flaxoos/ktor/server/plugins/kafka/KafkaPlugin.kt b/ktor-server-kafka/src/jvmMain/kotlin/io/github/flaxoos/ktor/server/plugins/kafka/KafkaPlugin.kt index d07603d3..07866dc4 100644 --- a/ktor-server-kafka/src/jvmMain/kotlin/io/github/flaxoos/ktor/server/plugins/kafka/KafkaPlugin.kt +++ b/ktor-server-kafka/src/jvmMain/kotlin/io/github/flaxoos/ktor/server/plugins/kafka/KafkaPlugin.kt @@ -141,21 +141,21 @@ private fun PluginBuilder.setupKafka(pluginConfig: try { pluginConfig.adminProperties?.createKafkaAdminClient() } catch (e: Exception) { - failCreatingClient("admin client", pluginConfig.adminProperties!!) + failCreatingClient("admin client", pluginConfig.adminProperties!!, e) return }?.also { application.attributes.put(AdminClientAttributeKey, it) application.log.info("Kafka admin setup finished") runBlocking(Dispatchers.IO) { CoroutineScopedAdminClient(it).createKafkaTopics(topicBuilders = pluginConfig.topics) { - application.log.info("Created Topics: $first") + application.log.info("Created Topic: $first") } } } try { pluginConfig.producerProperties?.createProducer() } catch (e: Exception) { - failCreatingClient("producer", pluginConfig.producerProperties!!) + failCreatingClient("producer", pluginConfig.producerProperties!!, e) return }?.also { application.attributes.put(ProducerAttributeKey, it) @@ -166,7 +166,7 @@ private fun PluginBuilder.setupKafka(pluginConfig: try { pluginConfig.consumerProperties?.createConsumer() } catch (e: Exception) { - failCreatingClient("consumer", pluginConfig.consumerProperties!!) + failCreatingClient("consumer", pluginConfig.consumerProperties!!, e) return }?.also { consumer -> application.attributes.put(ConsumerAttributeKey, consumer) @@ -182,13 +182,17 @@ private fun PluginBuilder.setupKafka(pluginConfig: private fun PluginBuilder.failCreatingClient( clientName: String, clientProperties: KafkaProperties, + exception: Exception, ) { - application.coroutineContext.cancel( - CancellationException( - "Failed creating kafka $clientName using properties: " + - clientProperties.entries.joinToString { "${it.key}: ${it.value}\n" }, - ), - ) + val message = "Failed creating kafka $clientName: ${exception.message}.\nProperties used:\n\t${ + clientProperties.entries.joinToString( + "\n\t", + ) { + "${it.key}: ${it.value}" + } + }" + application.log.error(message, exception) + application.coroutineContext.cancel(CancellationException(message)) } private fun PluginBuilder.onStop() { @@ -208,31 +212,38 @@ private fun PluginBuilder.onStop() { runCatching { application.kafkaConsumerJob?.let { if (it.isActive) { - closeConsumer() it.cancel() } + application.log.info("Kafka consumer job is inactive") } }.onFailure { if (it !is CancellationException) { application.log.error("Error closing kafka consumer", it) } } + + runCatching { + application.schemaRegistryClient?.let { + it.client.close() + application.log.info("Closed schema registry client") + } + }.onFailure { + application.log.error("Error closing schema registry client", it) + } } } -private fun PluginBuilder.closeConsumer() { +private suspend fun PluginBuilder.closeConsumer() { val consumer = application.kafkaConsumer - runBlocking(application.coroutineContext) { - application.log.info("Closing kafka consumer") - with( - checkNotNull(pluginConfig.consumerConfig) { - "Consumer config changed to null during application start, this shouldn't happen" - }, - ) { - // Let it finish one round to avoid race condition - delay(consumerPollFrequency) - consumer?.close() - } + application.log.info("Closing kafka consumer") + with( + checkNotNull(pluginConfig.consumerConfig) { + "Consumer config changed to null during application start, this shouldn't happen" + }, + ) { + // Let it finish one round to avoid race condition + delay(consumerPollFrequency) + consumer?.close() } application.log.info("Closed kafka consumer") } @@ -269,6 +280,8 @@ private fun PluginBuilder.onStart() { .also { application.attributes.put(ConsumerJob, it) application.log.info("Started kafka consumer") + }.invokeOnCompletion { + application.log.info("Stopped kafka consumer") } }.onFailure { application.log.error("Error starting kafka consumer", it) diff --git a/ktor-server-kafka/src/jvmMain/kotlin/io/github/flaxoos/ktor/server/plugins/kafka/KafkaPluginConfig.kt b/ktor-server-kafka/src/jvmMain/kotlin/io/github/flaxoos/ktor/server/plugins/kafka/KafkaPluginConfig.kt index 77d518f7..f2ade177 100644 --- a/ktor-server-kafka/src/jvmMain/kotlin/io/github/flaxoos/ktor/server/plugins/kafka/KafkaPluginConfig.kt +++ b/ktor-server-kafka/src/jvmMain/kotlin/io/github/flaxoos/ktor/server/plugins/kafka/KafkaPluginConfig.kt @@ -2,9 +2,11 @@ package io.github.flaxoos.ktor.server.plugins.kafka -import io.confluent.kafka.serializers.AbstractKafkaAvroSerDeConfig +import io.confluent.kafka.serializers.AbstractKafkaSchemaSerDeConfig import io.confluent.kafka.serializers.KafkaAvroDeserializer +import io.confluent.kafka.serializers.KafkaAvroDeserializerConfig import io.confluent.kafka.serializers.KafkaAvroSerializer +import io.confluent.kafka.serializers.KafkaAvroSerializerConfig import io.github.flaxoos.ktor.server.plugins.kafka.Defaults.DEFAULT_CLIENT_ID import io.github.flaxoos.ktor.server.plugins.kafka.Defaults.DEFAULT_CONSUMER_POLL_FREQUENCY_MS import io.github.flaxoos.ktor.server.plugins.kafka.Defaults.DEFAULT_GROUP_ID @@ -14,6 +16,7 @@ import io.github.flaxoos.ktor.server.plugins.kafka.Defaults.DEFAULT_TOPIC_REPLIC import io.github.flaxoos.ktor.server.plugins.kafka.KafkaConfigPropertiesContext.Companion.propertiesContext import io.ktor.client.HttpClient import io.ktor.server.config.ApplicationConfig +import io.ktor.util.logging.KtorSimpleLogger import org.apache.kafka.clients.CommonClientConfigs import org.apache.kafka.clients.admin.NewTopic import org.apache.kafka.clients.consumer.ConsumerConfig @@ -26,6 +29,8 @@ import kotlin.reflect.KClass import kotlin.time.Duration import kotlin.time.Duration.Companion.milliseconds +private val Logger = KtorSimpleLogger("KafkaPluginConfig") + @DslMarker annotation class KafkaDsl @@ -76,30 +81,46 @@ class KafkaConfig : AbstractKafkaConfig() { override var schemaRegistryUrl: String? = null override val commonProperties: KafkaProperties? by lazy { - commonPropertiesBuilder?.build() - } - override val adminProperties: KafkaProperties? by lazy { - adminPropertiesBuilder - ?.build() - ?.propertiesContext(this@KafkaConfig) - ?.withDefaultAdminConfig() - ?.delegatingToCommon() + commonPropertiesBuilder?.build()?.apply { + commonSslPropertiesBuilderPair?.let { (broker, schemaRegistry) -> + broker?.let { putAll(it.build()) } + schemaRegistry?.let { putAll(it.build()) } + } + commonSaslPropertiesBuilderPair?.let { (broker, schemaRegistry) -> + broker?.let { putAll(it.build()) } + schemaRegistry?.let { putAll(it.build()) } + } + } } + override val adminProperties: KafkaProperties? + get() = + adminPropertiesBuilder + ?.build() + ?.propertiesContext(this@KafkaConfig) + ?.withSslProperties(adminSslPropertiesBuilder) + ?.withDefaultAdminConfig() + ?.delegatingToCommon() + ?.kafkaProperties + override val producerProperties: KafkaProperties? by lazy { producerPropertiesBuilder ?.build() ?.propertiesContext(this@KafkaConfig) + ?.withSslProperties(producerSslPropertiesBuilderPair) ?.withSchemaRegistryUrl() ?.withDefaultProducerConfig() ?.delegatingToCommon() + ?.kafkaProperties } override val consumerProperties: KafkaProperties? by lazy { consumerPropertiesBuilder ?.build() ?.propertiesContext(this@KafkaConfig) + ?.withSslProperties(consumerSslPropertiesBuilderPair) ?.withSchemaRegistryUrl() ?.withDefaultConsumerConfig() ?.delegatingToCommon() + ?.kafkaProperties } internal val topicBuilders = mutableListOf() @@ -107,6 +128,20 @@ class KafkaConfig : AbstractKafkaConfig() { internal var adminPropertiesBuilder: AdminPropertiesBuilder? = null internal var producerPropertiesBuilder: ProducerPropertiesBuilder? = null internal var consumerPropertiesBuilder: ConsumerPropertiesBuilder? = null + + // SSL Configurations + internal var commonSslPropertiesBuilderPair: SslPropertiesBuilderPair? = null + internal var adminSslPropertiesBuilder: SslPropertiesBuilder? = null + internal var producerSslPropertiesBuilderPair: SslPropertiesBuilderPair? = null + internal var consumerSslPropertiesBuilderPair: SslPropertiesBuilderPair? = null + internal var schemaRegistryClientSslPropertiesBuilder: SslPropertiesBuilder? = null + + // SASL Configurations + internal var commonSaslPropertiesBuilderPair: SaslPropertiesBuilderPair? = null + internal var adminSaslPropertiesBuilder: SaslPropertiesBuilderPair? = null + internal var producerSaslPropertiesBuilderPair: SaslPropertiesBuilderPair? = null + internal var consumerSaslPropertiesBuilderPair: SaslPropertiesBuilderPair? = null + internal var schemaRegistryClientSaslPropertiesBuilder: SaslPropertiesBuilder? = null } /** @@ -127,6 +162,7 @@ class KafkaFileConfig( ?.propertiesContext(this@KafkaFileConfig) ?.withDefaultAdminConfig() ?.delegatingToCommon() + ?.kafkaProperties override val producerProperties: KafkaProperties? = config .configOrNull("producer") @@ -135,6 +171,7 @@ class KafkaFileConfig( ?.withSchemaRegistryUrl() ?.withDefaultProducerConfig() ?.delegatingToCommon() + ?.kafkaProperties override val consumerProperties: KafkaProperties? = config .configOrNull("consumer") @@ -143,8 +180,10 @@ class KafkaFileConfig( ?.withSchemaRegistryUrl() ?.withDefaultConsumerConfig() ?.delegatingToCommon() + ?.kafkaProperties - override val topics: List = config.configList("topics").map { TopicBuilder.froMap(it.toMap()).build() } + override val topics: List = + config.configList("topics").map { TopicBuilder.froMap(it.toMap()).build() } } private fun ApplicationConfig.configOrNull(name: String) = @@ -167,11 +206,12 @@ class KafkaConfigPropertiesContext( } } -internal fun KafkaConfigPropertiesContext.delegatingToCommon(): KafkaProperties { - val joined = this.kafkaConfig.commonProperties - joined?.putAll(this.kafkaProperties) - return joined ?: this.kafkaProperties -} +internal fun KafkaConfigPropertiesContext.delegatingToCommon(): KafkaConfigPropertiesContext = + apply { + kafkaConfig.commonProperties?.let { + kafkaProperties.putAll(it) + } + } internal fun KafkaConfigPropertiesContext.withDefaultAdminConfig() = apply { @@ -194,7 +234,25 @@ internal fun KafkaConfigPropertiesContext.withDefaultConsumerConfig() = internal fun KafkaConfigPropertiesContext.withSchemaRegistryUrl() = apply { - kafkaProperties[AbstractKafkaAvroSerDeConfig.SCHEMA_REGISTRY_URL_CONFIG] = this.kafkaConfig.schemaRegistryUrl + kafkaProperties[AbstractKafkaSchemaSerDeConfig.SCHEMA_REGISTRY_URL_CONFIG] = this.kafkaConfig.schemaRegistryUrl + } + +internal fun KafkaConfigPropertiesContext.withSslProperties(properties: SslPropertiesBuilderPair?) = + apply { + properties?.let { (broker, schemaRegistry) -> + broker?.let { kafkaProperties.putAll(it.build()) } + schemaRegistry?.let { kafkaProperties.putAll(it.build()) } + } + } + +internal fun KafkaConfigPropertiesContext.withSslProperties(properties: SslPropertiesBuilder?) = + apply { + properties?.let { kafkaProperties.putAll(it.build()) } + } + +internal fun KafkaConfigPropertiesContext.withSaslProperties(properties: SaslPropertiesBuilder?) = + apply { + properties?.let { kafkaProperties.putAll(it.build()) } } @KafkaDsl @@ -218,9 +276,24 @@ fun KafkaConfig.admin(configuration: AdminPropertiesBuilder.() -> Unit = { Admin @KafkaDsl fun AbstractKafkaConfig.registerSchemas(configuration: SchemaRegistrationBuilder.() -> Unit = { SchemaRegistrationBuilder() }) { - SchemaRegistrationBuilder().apply(configuration).let { - this.schemas.putAll(it.schemas) - this.schemaRegistryClientProvider = it.clientProvider + SchemaRegistrationBuilder().apply(configuration).let { schemaRegistrationBuilder -> + schemas.putAll(schemaRegistrationBuilder.schemas) + schemaRegistryClientProvider = { + val sslClientProvider = + if (this is KafkaConfig) { + ( + this.schemaRegistryClientSslPropertiesBuilder + ?: this.commonSslPropertiesBuilderPair?.schemaRegistry + )?.toHttpClient() + } else { + null + } + sslClientProvider?.also { + Logger.info( + "Schema registry client ssl properties provided, so using CIO Http Client as schema registry client, ignoring client provider defined in `SchemaRegistrationBuilder.using`", + ) + } ?: schemaRegistrationBuilder.clientProvider() + } } } @@ -233,7 +306,13 @@ fun KafkaConfig.topic( } @KafkaDsl -fun KafkaConfig.producer(configuration: ProducerPropertiesBuilder.() -> Unit = { ProducerPropertiesBuilder(schemaRegistryUrl) }) { +fun KafkaConfig.producer( + configuration: ProducerPropertiesBuilder.() -> Unit = { + ProducerPropertiesBuilder( + schemaRegistryUrl, + ) + }, +) { producerPropertiesBuilder = ProducerPropertiesBuilder( // assuming only avro is used, support custom serializers later @@ -244,7 +323,13 @@ fun KafkaConfig.producer(configuration: ProducerPropertiesBuilder.() -> Unit = { } @KafkaDsl -fun KafkaConfig.consumer(configuration: ConsumerPropertiesBuilder.() -> Unit = { ConsumerPropertiesBuilder(schemaRegistryUrl) }) { +fun KafkaConfig.consumer( + configuration: ConsumerPropertiesBuilder.() -> Unit = { + ConsumerPropertiesBuilder( + schemaRegistryUrl, + ) + }, +) { consumerPropertiesBuilder = ConsumerPropertiesBuilder( // assuming only avro is used, support custom serializers later @@ -318,19 +403,42 @@ class TopicBuilder( } } +@KafkaDsl +class AdditionalKafkaProperties { + internal val map = mutableMapOf() + + @KafkaDsl + operator fun String.invoke(value: Any?) { + map[this] = value + } +} + /** * [KafkaDsl] Builder for [KafkaProperties] */ @KafkaDsl -sealed interface KafkaPropertiesBuilder { - fun build(): KafkaProperties +sealed class KafkaPropertiesBuilder { + private val additionalKafkaProperties = AdditionalKafkaProperties() + + fun build(): KafkaProperties { + val kafkaProperties = doBuild() + kafkaProperties.putAll(additionalKafkaProperties.map) + return kafkaProperties + } + + abstract fun doBuild(): KafkaProperties + + @KafkaDsl + fun additional(config: AdditionalKafkaProperties.() -> Unit) { + additionalKafkaProperties.config() + } } /** * See [TopicConfig] */ @Suppress("MemberVisibilityCanBePrivate", "CyclomaticComplexMethod") -class TopicPropertiesBuilder : KafkaPropertiesBuilder { +class TopicPropertiesBuilder : KafkaPropertiesBuilder() { var segmentBytes: Int? = null var segmentMs: Long? = null var segmentJitterMs: Long? = null @@ -351,39 +459,81 @@ class TopicPropertiesBuilder : KafkaPropertiesBuilder { var minInSyncReplicas: Int? = null var compressionType: CompressionType? = null var preallocate: Boolean? = null + + @Deprecated("see [TopicConfig.MESSAGE_FORMAT_VERSION_CONFIG]") var messageFormatVersion: String? = null var messageTimestampType: MessageTimestampType? = null + + @Deprecated("see [TopicConfig.MESSAGE_TIMESTAMP_DIFFERENCE_MAX_MS_CONFIG]") var messageTimestampDifferenceMaxMs: Long? = null var messageDownconversionEnable: Boolean? = null - override fun build(): KafkaProperties { + override fun doBuild(): KafkaProperties { val configMap = mutableMapOf() - segmentBytes?.let { configMap["segment.bytes"] = it } - segmentMs?.let { configMap["segment.ms"] = it } - segmentJitterMs?.let { configMap["segment.jitter.ms"] = it } - segmentIndexBytes?.let { configMap["segment.index.bytes"] = it } - flushMessagesInterval?.let { configMap["flush.messages"] = it } - flushMs?.let { configMap["flush.ms"] = it } - retentionBytes?.let { configMap["retention.bytes"] = it } - retentionMs?.let { configMap["retention.ms"] = it } - maxMessageBytes?.let { configMap["max.message.bytes"] = it } - indexIntervalBytes?.let { configMap["index.interval.bytes"] = it } - fileDeleteDelayMs?.let { configMap["file.delete.delay.ms"] = it } - deleteRetentionMs?.let { configMap["delete.retention.ms"] = it } - minCompactionLagMs?.let { configMap["min.compaction.lag.ms"] = it } - maxCompactionLagMs?.let { configMap["max.compaction.lag.ms"] = it } - minCleanableDirtyRatio?.let { configMap["min.cleanable.dirty.ratio"] = it } - cleanupPolicy?.let { configMap["cleanup.policy"] = it } - uncleanLeaderElectionEnable?.let { configMap["unclean.leader.election.enable"] = it } - minInSyncReplicas?.let { configMap["min.insync.replicas"] = it } - compressionType?.let { configMap["compression.type"] = it } - preallocate?.let { configMap["preallocate"] = it } - messageFormatVersion?.let { configMap["message.format.version"] = it } - messageTimestampType?.let { configMap["message.timestamp.type"] = it } - messageTimestampDifferenceMaxMs?.let { configMap["message.timestamp.difference.max.ms"] = it } - messageDownconversionEnable?.let { configMap["message.downconversion.enable"] = it } + segmentBytes?.let { configMap[TopicConfig.SEGMENT_BYTES_CONFIG] = it } + segmentMs?.let { configMap[TopicConfig.SEGMENT_MS_CONFIG] = it } + segmentJitterMs?.let { configMap[TopicConfig.SEGMENT_JITTER_MS_CONFIG] = it } + segmentIndexBytes?.let { configMap[TopicConfig.SEGMENT_INDEX_BYTES_CONFIG] = it } + flushMessagesInterval?.let { configMap[TopicConfig.FLUSH_MESSAGES_INTERVAL_CONFIG] = it } + flushMs?.let { configMap[TopicConfig.FLUSH_MS_CONFIG] = it } + retentionBytes?.let { configMap[TopicConfig.RETENTION_BYTES_CONFIG] = it } + retentionMs?.let { configMap[TopicConfig.RETENTION_MS_CONFIG] = it } + maxMessageBytes?.let { configMap[TopicConfig.MAX_MESSAGE_BYTES_CONFIG] = it } + indexIntervalBytes?.let { configMap[TopicConfig.INDEX_INTERVAL_BYTES_CONFIG] = it } + fileDeleteDelayMs?.let { configMap[TopicConfig.FILE_DELETE_DELAY_MS_CONFIG] = it } + deleteRetentionMs?.let { configMap[TopicConfig.DELETE_RETENTION_MS_CONFIG] = it } + minCompactionLagMs?.let { + configMap[ + TopicConfig.MIN_CLEANABLE_DIRTY_RATIO_CONFIG, + ] = it + } + maxCompactionLagMs?.let { + configMap[ + TopicConfig.MAX_COMPACTION_LAG_MS_CONFIG, + ] = it + } + minCleanableDirtyRatio?.let { + configMap[ + TopicConfig.MIN_CLEANABLE_DIRTY_RATIO_CONFIG, + ] = it + } + cleanupPolicy?.let { configMap[TopicConfig.CLEANUP_POLICY_CONFIG] = it } + uncleanLeaderElectionEnable?.let { + configMap[ + TopicConfig.UNCLEAN_LEADER_ELECTION_ENABLE_CONFIG, + ] = it + } + minInSyncReplicas?.let { + configMap[ + TopicConfig.MIN_IN_SYNC_REPLICAS_CONFIG, + ] = it + } + compressionType?.let { + configMap[ + TopicConfig.COMPRESSION_TYPE_CONFIG, + ] = it + } + preallocate?.let { + configMap[ + TopicConfig.PREALLOCATE_CONFIG, + ] = it + } + @Suppress("DEPRECATION") + messageFormatVersion?.let { configMap[TopicConfig.MESSAGE_FORMAT_VERSION_CONFIG] = it } + messageTimestampType?.let { configMap[TopicConfig.MESSAGE_TIMESTAMP_TYPE_CONFIG] = it } + @Suppress("DEPRECATION") + messageTimestampDifferenceMaxMs?.let { + configMap[ + TopicConfig.MESSAGE_TIMESTAMP_DIFFERENCE_MAX_MS_CONFIG, + ] = it + } + messageDownconversionEnable?.let { + configMap[ + TopicConfig.MESSAGE_DOWNCONVERSION_ENABLE_CONFIG, + ] = it + } return configMap } } @@ -392,7 +542,7 @@ class TopicPropertiesBuilder : KafkaPropertiesBuilder { * see [CommonClientConfigs] */ @Suppress("MemberVisibilityCanBePrivate", "CyclomaticComplexMethod") -sealed class ClientPropertiesBuilder : KafkaPropertiesBuilder { +sealed class ClientPropertiesBuilder : KafkaPropertiesBuilder() { var bootstrapServers: Any? = null var clientDnsLookup: Any? = null var metadataMaxAge: Any? = null @@ -435,7 +585,7 @@ sealed class ClientPropertiesBuilder : KafkaPropertiesBuilder { return configMap } - override fun build() = buildCommon() + override fun doBuild() = buildCommon() } /** @@ -477,7 +627,17 @@ class ProducerPropertiesBuilder( var transactionTimeout: Any? = null var transactionalId: Any? = null - override fun build(): KafkaProperties { + private var serializerPropertiesBuilder: KafkaAvroSerializerPropertiesBuilder? = null + + /** + * This is not yet tested but should work as it just does the same thing all the config function do which is to add these properties to the config map + */ + @KafkaDsl + fun serializer(configuration: KafkaAvroSerializerPropertiesBuilder.() -> Unit = { KafkaAvroSerializerPropertiesBuilder() }) { + serializerPropertiesBuilder = KafkaAvroSerializerPropertiesBuilder().apply(configuration) + } + + override fun doBuild(): KafkaProperties { val configMap = buildCommon() batchSize?.let { configMap[ProducerConfig.BATCH_SIZE_CONFIG] = it } acks?.let { configMap[ProducerConfig.ACKS_CONFIG] = it } @@ -499,6 +659,9 @@ class ProducerPropertiesBuilder( transactionalId?.let { configMap[ProducerConfig.TRANSACTIONAL_ID_CONFIG] = it } return configMap + .apply { + serializerPropertiesBuilder?.let { serializer -> putAll(serializer.build()) } + } } } @@ -533,7 +696,17 @@ class ConsumerPropertiesBuilder( var isolationLevel: Any? = null var allowAutoCreateTopics: Any? = null - override fun build(): KafkaProperties { + var deserializerPropertiesBuilder: KafkaAvroDeserializerPropertiesBuilder? = null + + /** + * This is not yet tested but should work as it just does the same thing all the config function do which is to add these properties to the config map + */ + @KafkaDsl + fun deserializer(configuration: KafkaAvroDeserializerPropertiesBuilder.() -> Unit = { KafkaAvroDeserializerPropertiesBuilder() }) { + deserializerPropertiesBuilder = KafkaAvroDeserializerPropertiesBuilder().apply(configuration) + } + + override fun doBuild(): KafkaProperties { val configMap = buildCommon() groupId?.let { configMap[ConsumerConfig.GROUP_ID_CONFIG] = it } groupInstanceId?.let { configMap[ConsumerConfig.GROUP_INSTANCE_ID_CONFIG] = it } @@ -558,10 +731,187 @@ class ConsumerPropertiesBuilder( isolationLevel?.let { configMap[ConsumerConfig.ISOLATION_LEVEL_CONFIG] = it } allowAutoCreateTopics?.let { configMap[ConsumerConfig.ALLOW_AUTO_CREATE_TOPICS_CONFIG] = it } + return configMap + .apply { + deserializerPropertiesBuilder?.let { deserializer -> putAll(deserializer.build()) } + } + } +} + +/** + * see [AbstractKafkaSchemaSerDeConfig] + */ +@Suppress("MemberVisibilityCanBePrivate") +abstract class KafkaAvroSerDePropertiesBuilder : KafkaPropertiesBuilder() { + var schemaRegistryUrl: List? = null + var maxSchemasPerSubject: Int? = null + var normalizeSchemas: Boolean? = null + var autoRegisterSchemas: Boolean? = null + var propagateSchemaTags: Boolean? = null + var useSchemaId: Int? = null + var idCompatibilityStrict: Boolean? = null + var useLatestVersion: Boolean? = null + var latestCompatibilityStrict: Boolean? = null + var latestCacheSize: Int? = null + var latestCacheTtl: Int? = null + var useLatestWithMetadata: String? = null + var schemaFormat: String? = null + var ruleExecutors: List? = null + var ruleActions: List? = null + var ruleServiceLoaderEnable: Boolean? = null + var basicAuthCredentialsSource: String? = null + var userInfoConfig: String? = null + var bearerAuthToken: String? = null + var contextNameStrategy: String? = null + var keySubjectNameStrategy: String? = null + var valueSubjectNameStrategy: String? = null + var schemaReflection: Boolean? = null + var proxyHost: String? = null + var proxyPort: Int? = null + + internal fun buildCommon(): KafkaProperties { + val configMap = mutableMapOf() + schemaRegistryUrl?.let { + configMap[AbstractKafkaSchemaSerDeConfig.SCHEMA_REGISTRY_URL_CONFIG] = it + } + maxSchemasPerSubject?.let { + configMap[AbstractKafkaSchemaSerDeConfig.MAX_SCHEMAS_PER_SUBJECT_CONFIG] = it + } + normalizeSchemas?.let { + configMap[AbstractKafkaSchemaSerDeConfig.NORMALIZE_SCHEMAS] = it + } + autoRegisterSchemas?.let { + configMap[AbstractKafkaSchemaSerDeConfig.AUTO_REGISTER_SCHEMAS] = it + } + propagateSchemaTags?.let { + configMap[AbstractKafkaSchemaSerDeConfig.PROPAGATE_SCHEMA_TAGS] = it + } + useSchemaId?.let { + configMap[AbstractKafkaSchemaSerDeConfig.USE_SCHEMA_ID] = it + } + idCompatibilityStrict?.let { + configMap[AbstractKafkaSchemaSerDeConfig.ID_COMPATIBILITY_STRICT] = it + } + useLatestVersion?.let { + configMap[AbstractKafkaSchemaSerDeConfig.USE_LATEST_VERSION] = it + } + latestCompatibilityStrict?.let { + configMap[AbstractKafkaSchemaSerDeConfig.LATEST_COMPATIBILITY_STRICT] = it + } + latestCacheSize?.let { + configMap[AbstractKafkaSchemaSerDeConfig.LATEST_CACHE_SIZE] = it + } + latestCacheTtl?.let { + configMap[AbstractKafkaSchemaSerDeConfig.LATEST_CACHE_TTL] = it + } + useLatestWithMetadata?.let { + configMap[AbstractKafkaSchemaSerDeConfig.USE_LATEST_WITH_METADATA] = it + } + schemaFormat?.let { + configMap[AbstractKafkaSchemaSerDeConfig.SCHEMA_FORMAT] = it + } + ruleExecutors?.let { + configMap[AbstractKafkaSchemaSerDeConfig.RULE_EXECUTORS] = it + } + ruleActions?.let { + configMap[AbstractKafkaSchemaSerDeConfig.RULE_ACTIONS] = it + } + ruleServiceLoaderEnable?.let { + configMap[AbstractKafkaSchemaSerDeConfig.RULE_SERVICE_LOADER_ENABLE] = it + } + basicAuthCredentialsSource?.let { + configMap[AbstractKafkaSchemaSerDeConfig.BASIC_AUTH_CREDENTIALS_SOURCE] = it + } + userInfoConfig?.let { + configMap[AbstractKafkaSchemaSerDeConfig.USER_INFO_CONFIG] = it + } + bearerAuthToken?.let { + configMap[AbstractKafkaSchemaSerDeConfig.BEARER_AUTH_TOKEN_CONFIG] = it + } + contextNameStrategy?.let { + configMap[AbstractKafkaSchemaSerDeConfig.CONTEXT_NAME_STRATEGY] = it + } + keySubjectNameStrategy?.let { + configMap[AbstractKafkaSchemaSerDeConfig.KEY_SUBJECT_NAME_STRATEGY] = it + } + valueSubjectNameStrategy?.let { + configMap[AbstractKafkaSchemaSerDeConfig.VALUE_SUBJECT_NAME_STRATEGY] = it + } + schemaReflection?.let { + configMap[AbstractKafkaSchemaSerDeConfig.SCHEMA_REFLECTION_CONFIG] = it + } + proxyHost?.let { + configMap[AbstractKafkaSchemaSerDeConfig.PROXY_HOST] = it + } + proxyPort?.let { + configMap[AbstractKafkaSchemaSerDeConfig.PROXY_PORT] = it + } + return configMap } + + override fun doBuild(): KafkaProperties = buildCommon() } +/** + * see [KafkaAvroDeserializerConfig] + */ +@Suppress("MemberVisibilityCanBePrivate") +class KafkaAvroDeserializerPropertiesBuilder : KafkaAvroSerDePropertiesBuilder() { + var specificAvroReader: Boolean? = null + var specificAvroKeyType: Class<*>? = null + var specificAvroValueType: Class<*>? = null + var avroReflectionAllowNull: Boolean? = null + var avroUseLogicalTypeConverters: Boolean? = null + + override fun doBuild(): KafkaProperties { + val configMap = mutableMapOf() + + specificAvroReader?.let { + configMap[KafkaAvroDeserializerConfig.SPECIFIC_AVRO_READER_CONFIG] = it + } + specificAvroKeyType?.let { + configMap[KafkaAvroDeserializerConfig.SPECIFIC_AVRO_KEY_TYPE_CONFIG] = it + } + specificAvroValueType?.let { + configMap[KafkaAvroDeserializerConfig.SPECIFIC_AVRO_VALUE_TYPE_CONFIG] = it + } + avroReflectionAllowNull?.let { + configMap[KafkaAvroDeserializerConfig.AVRO_REFLECTION_ALLOW_NULL_CONFIG] = it + } + avroUseLogicalTypeConverters?.let { + configMap[KafkaAvroDeserializerConfig.AVRO_USE_LOGICAL_TYPE_CONVERTERS_CONFIG] = it + } + + return configMap + } +} + +/** + * See [KafkaAvroSerializerConfig] + */ +@Suppress("MemberVisibilityCanBePrivate") +class KafkaAvroSerializerPropertiesBuilder : KafkaAvroSerDePropertiesBuilder() { + var avroReflectionAllowNull: Boolean? = null + var avroUseLogicalTypeConverters: Boolean? = null + var avroRemoveJavaProperties: Boolean? = null + + override fun doBuild(): KafkaProperties { + val configMap = mutableMapOf() + + avroReflectionAllowNull?.let { + configMap[KafkaAvroSerializerConfig.AVRO_REFLECTION_ALLOW_NULL_CONFIG] = it + } + avroUseLogicalTypeConverters?.let { + configMap[KafkaAvroSerializerConfig.AVRO_USE_LOGICAL_TYPE_CONVERTERS_CONFIG] = it + } + avroRemoveJavaProperties?.let { + configMap[KafkaAvroSerializerConfig.AVRO_REMOVE_JAVA_PROPS_CONFIG] = it + } + + return configMap + } +} typealias KafkaProperties = MutableMap @Suppress("unused") diff --git a/ktor-server-kafka/src/jvmMain/kotlin/io/github/flaxoos/ktor/server/plugins/kafka/SslConfig.kt b/ktor-server-kafka/src/jvmMain/kotlin/io/github/flaxoos/ktor/server/plugins/kafka/SslConfig.kt new file mode 100644 index 00000000..40807aec --- /dev/null +++ b/ktor-server-kafka/src/jvmMain/kotlin/io/github/flaxoos/ktor/server/plugins/kafka/SslConfig.kt @@ -0,0 +1,332 @@ +package io.github.flaxoos.ktor.server.plugins.kafka + +import io.ktor.client.HttpClient +import io.ktor.client.engine.cio.CIO +import org.apache.kafka.common.config.SaslConfigs +import org.apache.kafka.common.config.SslConfigs +import java.io.FileInputStream +import java.security.KeyStore +import javax.net.ssl.KeyManager +import javax.net.ssl.KeyManagerFactory +import javax.net.ssl.TrustManagerFactory +import javax.net.ssl.X509TrustManager + +class SslSettings( + private val sslConfig: SslPropertiesBuilder, +) { + /** + * Loads the KeyStore from the provided SSL configuration. + */ + fun getKeyStore(): KeyStore? = sslConfig.keyStore?.toKeyStore() + + /** + * Initializes the TrustManagerFactory using the TrustStore properties. + */ + fun getTrustManagerFactory(): TrustManagerFactory { + val trustStore = sslConfig.trustStore?.toKeyStore() ?: error("Truststore must be provided") + + val trustManagerFactory = + TrustManagerFactory.getInstance(TrustManagerFactory.getDefaultAlgorithm()).apply { + init(trustStore) + } + return trustManagerFactory + } + + /** + * Initializes the KeyManagerFactory using the KeyStore properties. + */ + fun getKeyManagerFactory(): KeyManagerFactory? { + val keyStore = getKeyStore() ?: return null + val keyPassword = + sslConfig.keyPassword?.toCharArray() ?: error("Key password must be provided if keystore is used") + + val keyManagerFactory = + KeyManagerFactory.getInstance(KeyManagerFactory.getDefaultAlgorithm()).apply { + init(keyStore, keyPassword) + } + return keyManagerFactory + } + + /** + * Retrieves the X509TrustManager from the TrustManagerFactory. + */ + fun getTrustManager(): X509TrustManager { + val trustManagers = getTrustManagerFactory().trustManagers + return trustManagers.first { it is X509TrustManager } as X509TrustManager + } + + /** + * Retrieves the KeyManagers from the KeyManagerFactory. + */ + fun getKeyManagers(): Array? { + val keyManagerFactory = getKeyManagerFactory() + return keyManagerFactory?.keyManagers + } +} + +/** + * Sets the default SSL configuration for all components. + */ +@KafkaDsl +fun KafkaConfig.commonSsl(configuration: SslPropertiesBuilderPair.() -> Unit) { + commonSslPropertiesBuilderPair = SslPropertiesBuilderPair().apply(configuration) +} + +/** + * Sets a specific SSL configuration for the admin client. + */ +@KafkaDsl +fun KafkaConfig.adminSsl(configuration: SslPropertiesBuilder.() -> Unit) { + adminSslPropertiesBuilder = SslPropertiesBuilder().apply(configuration) +} + +/** + * Sets a specific SSL configuration for the producer. + */ +@KafkaDsl +fun KafkaConfig.producerSsl(configuration: SslPropertiesBuilderPair.() -> Unit) { + producerSslPropertiesBuilderPair = SslPropertiesBuilderPair().apply(configuration) +} + +/** + * Sets a specific SSL configuration for the consumer. + */ +@KafkaDsl +fun KafkaConfig.consumerSsl(configuration: SslPropertiesBuilderPair.() -> Unit) { + consumerSslPropertiesBuilderPair = SslPropertiesBuilderPair().apply(configuration) +} + +/** + * Sets a specific SSL configuration for the Schema Registry client. + */ +@KafkaDsl +fun KafkaConfig.schemaRegistryClientSsl(configuration: SslPropertiesBuilder.() -> Unit) { + schemaRegistryClientSslPropertiesBuilder = SslPropertiesBuilder("schema.registry.").apply(configuration) +} + +/** + * Sets the default SASL configuration for all components. + */ +@KafkaDsl +fun KafkaConfig.commonSasl(configuration: SaslPropertiesBuilderPair.() -> Unit) { + commonSaslPropertiesBuilderPair = SaslPropertiesBuilderPair().apply(configuration) +} + +/** + * Sets a specific SASL configuration for the admin client. + */ +@KafkaDsl +fun KafkaConfig.adminSasl(configuration: SaslPropertiesBuilderPair.() -> Unit) { + adminSaslPropertiesBuilder = SaslPropertiesBuilderPair().apply(configuration) +} + +/** + * Sets a specific SASL configuration for the producer. + */ +@KafkaDsl +fun KafkaConfig.producerSasl(configuration: SaslPropertiesBuilderPair.() -> Unit) { + producerSaslPropertiesBuilderPair = SaslPropertiesBuilderPair().apply(configuration) +} + +/** + * Sets a specific SASL configuration for the consumer. + */ +@KafkaDsl +fun KafkaConfig.consumerSasl(configuration: SaslPropertiesBuilderPair.() -> Unit) { + consumerSaslPropertiesBuilderPair = SaslPropertiesBuilderPair().apply(configuration) +} + +/** + * Sets a specific SASL configuration for the Schema Registry client. + */ +@KafkaDsl +fun KafkaConfig.schemaRegistryClientSasl(configuration: SaslPropertiesBuilder.() -> Unit) { + schemaRegistryClientSaslPropertiesBuilder = SaslPropertiesBuilder("schema.registry.").apply(configuration) +} + +/** + * Converts SslConfig to an HttpClient configured with SSL settings. + */ +fun SslPropertiesBuilder.toHttpClient(): HttpClient { + val sslSettings = SslSettings(this) + + return HttpClient(CIO) { + engine { + https { + trustManager = sslSettings.getTrustManager() + } + } + } +} + +@KafkaDsl +class KeyStorePropertiesBuilder { + var type: String = "JKS" + var location: String = "" + var password: String = "" + var managerAlgorithm: String? = null + + fun toKeyStore(): KeyStore = + KeyStore.getInstance(type).apply { + FileInputStream(location).use { fis -> + load(fis, password.toCharArray()) + } + } +} + +@KafkaDsl +data class SslPropertiesBuilderPair( + var broker: SslPropertiesBuilder? = null, + var schemaRegistry: SslPropertiesBuilder? = null, +) { + @KafkaDsl + fun broker(configuration: SslPropertiesBuilder.() -> Unit) { + broker = SslPropertiesBuilder().apply(configuration) + } + + @KafkaDsl + fun schemaRegistry(configuration: SslPropertiesBuilder.() -> Unit) { + schemaRegistry = SslPropertiesBuilder("schema.registry.").apply(configuration) + } +} + +@KafkaDsl +data class SaslPropertiesBuilderPair( + var broker: SaslPropertiesBuilder? = null, + var schemaRegistry: SaslPropertiesBuilder? = null, +) { + @KafkaDsl + fun broker(configuration: SaslPropertiesBuilder.() -> Unit) { + broker = SaslPropertiesBuilder().apply(configuration) + } + + @KafkaDsl + fun schemaRegistry(configuration: SaslPropertiesBuilder.() -> Unit) { + schemaRegistry = SaslPropertiesBuilder("schema.registry.").apply(configuration) + } +} + +@Suppress("MemberVisibilityCanBePrivate") +@KafkaDsl +class SslPropertiesBuilder( + val namespace: String = "", +) : KafkaPropertiesBuilder() { + var protocol: String? = null + var provider: String? = null + var cipherSuites: List? = null + var enabledProtocols: List? = null + + var trustStore: KeyStorePropertiesBuilder? = null + var keyStore: KeyStorePropertiesBuilder? = null + + var keyPassword: String? = null + var endpointIdentificationAlgorithm: String? = null + var secureRandomImplementation: String? = null + + override fun doBuild(): KafkaProperties { + val configMap = mutableMapOf() + protocol?.let { configMap[namespace + SslConfigs.SSL_PROTOCOL_CONFIG] = it } + provider?.let { configMap[namespace + SslConfigs.SSL_PROVIDER_CONFIG] = it } + cipherSuites?.let { configMap[namespace + SslConfigs.SSL_CIPHER_SUITES_CONFIG] = it } + enabledProtocols?.let { configMap[namespace + SslConfigs.SSL_ENABLED_PROTOCOLS_CONFIG] = it } + keyStore?.let { + it.type.let { configMap[namespace + SslConfigs.SSL_KEYSTORE_TYPE_CONFIG] = it } + it.location.let { configMap[namespace + SslConfigs.SSL_KEYSTORE_LOCATION_CONFIG] = it } + it.password.let { configMap[namespace + SslConfigs.SSL_KEYSTORE_PASSWORD_CONFIG] = it } + it.managerAlgorithm?.let { configMap[namespace + SslConfigs.SSL_KEYMANAGER_ALGORITHM_CONFIG] = it } + } + trustStore?.let { + it.type.let { configMap[namespace + SslConfigs.SSL_TRUSTSTORE_TYPE_CONFIG] = it } + it.location.let { configMap[namespace + SslConfigs.SSL_TRUSTSTORE_LOCATION_CONFIG] = it } + it.password.let { configMap[namespace + SslConfigs.SSL_TRUSTSTORE_PASSWORD_CONFIG] = it } + it.managerAlgorithm?.let { configMap[namespace + SslConfigs.SSL_TRUSTMANAGER_ALGORITHM_CONFIG] = it } + } + keyPassword?.let { configMap[namespace + SslConfigs.SSL_KEY_PASSWORD_CONFIG] = it } + endpointIdentificationAlgorithm?.let { + configMap[namespace + SslConfigs.SSL_ENDPOINT_IDENTIFICATION_ALGORITHM_CONFIG] = it + } + secureRandomImplementation?.let { + configMap[namespace + SslConfigs.SSL_SECURE_RANDOM_IMPLEMENTATION_CONFIG] = it + } + return configMap + } + + @KafkaDsl + fun trustStore(configuration: KeyStorePropertiesBuilder.() -> Unit) { + trustStore = KeyStorePropertiesBuilder().apply(configuration) + } + + @KafkaDsl + fun keyStore(configuration: KeyStorePropertiesBuilder.() -> Unit) { + keyStore = KeyStorePropertiesBuilder().apply(configuration) + } +} + +@Suppress("MemberVisibilityCanBePrivate") +class SaslPropertiesBuilder( + val namespace: String = "", +) : KafkaPropertiesBuilder() { + var kerberosServiceName: String? = null + var kerberosKinitCmd: String? = null + var kerberosTicketRenewWindowFactor: Double? = null + var kerberosTicketRenewJitter: Double? = null + var kerberosMinTimeBeforeRelogin: Long? = null + var loginRefreshWindowFactor: Double? = null + var loginRefreshWindowJitter: Double? = null + var loginRefreshMinPeriodSeconds: Short? = null + var loginRefreshBufferSeconds: Short? = null + var mechanism: String? = null + var jaasConfig: String? = null + var clientCallbackHandlerClass: String? = null + var loginCallbackHandlerClass: String? = null + var loginClass: String? = null + + override fun doBuild(): KafkaProperties { + val configMap = mutableMapOf() + kerberosServiceName?.let { configMap[namespace + SaslConfigs.SASL_KERBEROS_SERVICE_NAME] = it } + kerberosKinitCmd?.let { configMap[namespace + SaslConfigs.SASL_KERBEROS_KINIT_CMD] = it } + kerberosTicketRenewWindowFactor?.let { + configMap[SaslConfigs.SASL_KERBEROS_TICKET_RENEW_WINDOW_FACTOR] = it + } + kerberosTicketRenewJitter?.let { configMap[namespace + SaslConfigs.SASL_KERBEROS_TICKET_RENEW_JITTER] = it } + kerberosMinTimeBeforeRelogin?.let { + configMap[namespace + SaslConfigs.SASL_KERBEROS_MIN_TIME_BEFORE_RELOGIN] = it + } + loginRefreshWindowFactor?.let { configMap[namespace + SaslConfigs.SASL_LOGIN_REFRESH_WINDOW_FACTOR] = it } + loginRefreshWindowJitter?.let { configMap[namespace + SaslConfigs.SASL_LOGIN_REFRESH_WINDOW_JITTER] = it } + loginRefreshMinPeriodSeconds?.let { + configMap[namespace + SaslConfigs.SASL_LOGIN_REFRESH_MIN_PERIOD_SECONDS] = it + } + loginRefreshBufferSeconds?.let { configMap[namespace + SaslConfigs.SASL_LOGIN_REFRESH_BUFFER_SECONDS] = it } + mechanism?.let { configMap[namespace + SaslConfigs.SASL_MECHANISM] = it } + jaasConfig?.let { configMap[namespace + SaslConfigs.SASL_JAAS_CONFIG] = it } + clientCallbackHandlerClass?.let { configMap[namespace + SaslConfigs.SASL_CLIENT_CALLBACK_HANDLER_CLASS] = it } + loginCallbackHandlerClass?.let { configMap[namespace + SaslConfigs.SASL_LOGIN_CALLBACK_HANDLER_CLASS] = it } + loginClass?.let { configMap[namespace + SaslConfigs.SASL_LOGIN_CLASS] = it } + return configMap + } +} + +interface SecurityPropertiesBuilder { + val namespace: String + + var sslPropertiesBuilder: SslPropertiesBuilder? + var schemaRegistrySslPropertiesBuilder: SslPropertiesBuilder? + + @KafkaDsl + fun ssl(configuration: SslPropertiesBuilder.() -> Unit = { SslPropertiesBuilder(namespace) }) { + sslPropertiesBuilder = SslPropertiesBuilder(namespace).apply(configuration) + } + + @KafkaDsl + fun schemaRegistrySsl(configuration: SslPropertiesBuilder.() -> Unit = { SslPropertiesBuilder("schema.registry.") }) { + schemaRegistrySslPropertiesBuilder = SslPropertiesBuilder("schema.registry.").apply(configuration) + } + + var saslPropertiesBuilder: SaslPropertiesBuilder? + + @KafkaDsl + fun sasl(configuration: SaslPropertiesBuilder.() -> Unit = { SaslPropertiesBuilder(namespace) }) { + saslPropertiesBuilder = SaslPropertiesBuilder(namespace).apply(configuration) + } +} diff --git a/ktor-server-kafka/src/jvmMain/kotlin/io/github/flaxoos/ktor/server/plugins/kafka/components/Avro.kt b/ktor-server-kafka/src/jvmMain/kotlin/io/github/flaxoos/ktor/server/plugins/kafka/components/Avro.kt index f5bf3ef1..879b49d5 100644 --- a/ktor-server-kafka/src/jvmMain/kotlin/io/github/flaxoos/ktor/server/plugins/kafka/components/Avro.kt +++ b/ktor-server-kafka/src/jvmMain/kotlin/io/github/flaxoos/ktor/server/plugins/kafka/components/Avro.kt @@ -74,21 +74,29 @@ class SchemaRegistryClient( val schema = Avro.default.schema(klass.serializer()) val payload = mapOf("schema" to schema.toString()) // Creating a map to form the payload application.launch(Dispatchers.IO) { - client - .post("subjects/${topicName.value}.${schema.name}/versions") { - contentType(ContentType.Application.Json) - setBody(payload) - }.let { - if (it.status == HttpStatusCode.Conflict) { - onConflict() + runCatching { + application.log.info("Registering schema to schema registry: $payload") + client + .post("subjects/${topicName.value}.${schema.name}/versions") { + contentType(ContentType.Application.Json) + setBody(payload) + }.let { + if (it.status == HttpStatusCode.Conflict) { + onConflict() + } + if (!it.status.isSuccess()) { + application.log.error( + "Failed registering schema to schema registry at ${it.call.request.url}:\n${it.status} " + + "${it.bodyAsText()}:\nschema: $payload", + ) + } } - if (!it.status.isSuccess()) { - application.log.error( - "Failed registering schema to schema registry at ${it.call.request.url}:\n${it.status} " + - "${it.bodyAsText()}:\nschema: $payload", - ) - } - } + }.onFailure { + application.log.error( + "Failed registering schema to schema registry:\nschema: $payload", + it, + ) + } } } } diff --git a/ktor-server-kafka/src/jvmMain/kotlin/io/github/flaxoos/ktor/server/plugins/kafka/components/Consumer.kt b/ktor-server-kafka/src/jvmMain/kotlin/io/github/flaxoos/ktor/server/plugins/kafka/components/Consumer.kt index 01c4e443..525946b0 100644 --- a/ktor-server-kafka/src/jvmMain/kotlin/io/github/flaxoos/ktor/server/plugins/kafka/components/Consumer.kt +++ b/ktor-server-kafka/src/jvmMain/kotlin/io/github/flaxoos/ktor/server/plugins/kafka/components/Consumer.kt @@ -20,14 +20,13 @@ import org.apache.kafka.clients.consumer.KafkaConsumer import kotlin.time.Duration import kotlin.time.toJavaDuration -internal fun Map.createConsumer(): Consumer = - KafkaConsumer(this) +internal fun Map.createConsumer(): Consumer = KafkaConsumer(this) internal fun Application.startConsumer( consumer: Consumer, pollFrequency: Duration, consumerRecordHandlers: Map, - cleanUp: () -> Unit, + cleanUp: suspend () -> Unit, ): Job { val consumerFlow = subscribe(consumer, pollFrequency, consumerRecordHandlers.keys.toList()) return launch(Dispatchers.IO) { @@ -37,6 +36,7 @@ internal fun Application.startConsumer( ?: log.warn("No handler defined for topic ${record.topic()}") } } finally { + log.info("Running clean up for consumer job") withContext(NonCancellable) { cleanUp() } diff --git a/ktor-server-kafka/src/jvmTest/kotlin/io/github/flaxoos/ktor/server/plugins/kafka/BaseKafkaIntegrationTest.kt b/ktor-server-kafka/src/jvmTest/kotlin/io/github/flaxoos/ktor/server/plugins/kafka/BaseKafkaIntegrationTest.kt index 47fa5d83..c2ffcbb3 100644 --- a/ktor-server-kafka/src/jvmTest/kotlin/io/github/flaxoos/ktor/server/plugins/kafka/BaseKafkaIntegrationTest.kt +++ b/ktor-server-kafka/src/jvmTest/kotlin/io/github/flaxoos/ktor/server/plugins/kafka/BaseKafkaIntegrationTest.kt @@ -1,150 +1,315 @@ package io.github.flaxoos.ktor.server.plugins.kafka import io.github.flaxoos.ktor.server.plugins.kafka.Defaults.DEFAULT_CONFIG_PATH +import io.github.flaxoos.ktor.server.plugins.kafka.MessageTimestampType.CreateTime +import io.github.flaxoos.ktor.server.plugins.kafka.TopicName.Companion.named +import io.github.flaxoos.ktor.server.plugins.kafka.components.fromRecord +import io.github.flaxoos.ktor.server.plugins.kafka.components.toRecord +import io.kotest.assertions.retry +import io.kotest.assertions.throwables.shouldNotThrowAny import io.kotest.core.spec.style.FunSpec import io.kotest.core.test.TestScope +import io.kotest.matchers.collections.shouldContainExactly +import io.kotest.matchers.nulls.shouldNotBeNull +import io.kotest.matchers.shouldBe +import io.ktor.client.HttpClient +import io.ktor.client.call.body +import io.ktor.client.request.delete +import io.ktor.client.request.get +import io.ktor.client.request.parameter +import io.ktor.http.HttpStatusCode.Companion.OK +import io.ktor.serialization.kotlinx.json.json +import io.ktor.server.application.Application +import io.ktor.server.application.install +import io.ktor.server.config.ApplicationConfig +import io.ktor.server.plugins.contentnegotiation.ContentNegotiation +import io.ktor.server.response.respond +import io.ktor.server.routing.delete +import io.ktor.server.routing.get +import io.ktor.server.routing.route +import io.ktor.server.routing.routing +import io.ktor.server.testing.ApplicationTestBuilder +import io.ktor.server.testing.testApplication import io.ktor.util.logging.KtorSimpleLogger +import io.ktor.util.logging.Logger import kotlinx.coroutines.Dispatchers +import kotlinx.coroutines.channels.Channel import kotlinx.coroutines.delay import kotlinx.coroutines.withContext import org.apache.kafka.clients.producer.KafkaProducer import org.apache.kafka.clients.producer.ProducerConfig import org.apache.kafka.clients.producer.ProducerRecord import org.apache.kafka.common.serialization.StringSerializer -import org.testcontainers.containers.GenericContainer -import org.testcontainers.containers.KafkaContainer -import org.testcontainers.containers.Network -import org.testcontainers.containers.wait.strategy.Wait -import org.testcontainers.utility.DockerImageName import java.io.File import java.util.Properties import kotlin.time.Duration +import kotlin.time.Duration.Companion.milliseconds import kotlin.time.Duration.Companion.seconds -private const val CONFLUENT_PLATFORM_VERSION = "7.5.0" -private const val BOOTSTRAP_SERVERS_PLACEHOLDER = "BOOTSTRAP_SERVERS" +internal const val BOOTSTRAP_SERVERS_PLACEHOLDER = "BOOTSTRAP_SERVERS" +internal const val CONFIG_PATH_PLACEHOLDER = "CONFIG_PATH" +internal const val GROUP_ID_PLACEHOLDER = "GROUP_ID" +internal const val CLIENT_ID_PLACEHOLDER = "CLIENT_ID" private const val SCHEMA_REGISTRY_URL_PLACEHOLDER = "SCHEMA_REGISTRY_URL" -private const val CONFIG_PATH_PLACEHOLDER = "CONFIG_PATH" -private const val GROUP_ID_PLACEHOLDER = "GROUP_ID" -private const val CLIENT_ID_PLACEHOLDER = "CLIENT_ID" abstract class BaseKafkaIntegrationTest : FunSpec() { + open val additionalProducerProperties: Map = emptyMap() - private lateinit var applicationConfigFile: File - private lateinit var applicationConfigFileContent: String - - lateinit var schemaRegistryUrl: String + protected lateinit var bootstrapServers: String + protected lateinit var resolvedSchemaRegistryUrl: String + private var applicationConfigFile: File? = null + private lateinit var originalApplicationConfigFileContent: String + private val logger: Logger = KtorSimpleLogger(javaClass.simpleName) + private val testTopics = listOf(named("topic1"), named("topic2")) + private val invocations = 2 + protected open val httpClient = HttpClient() + private lateinit var recordChannel: Channel init { - beforeSpec { - kafka.start() - schemaRegistry.withKafka(kafka).start() - schemaRegistryUrl = "http://${schemaRegistry.host}:${schemaRegistry.firstMappedPort}" + beforeEach { + recordChannel = Channel() + } + afterEach { + recordChannel.close() + revertConfigurationFileEdit() + } + } + + @Suppress("SwallowedException") + open suspend fun waitTillProducersAccepted( + attempts: Int = 10, + delay: Duration = 5.seconds, + ) { + val props = Properties() + props[ProducerConfig.BOOTSTRAP_SERVERS_CONFIG] = bootstrapServers + props[ProducerConfig.KEY_SERIALIZER_CLASS_CONFIG] = StringSerializer::class.java.name + props[ProducerConfig.VALUE_SERIALIZER_CLASS_CONFIG] = StringSerializer::class.java.name + + additionalProducerProperties.forEach { (key, value) -> + props[key] = value + } + + val producer = KafkaProducer(props) + var isConnected = false + + logger.info("Waiting to connect to Kafka broker at bootstrap.servers: $bootstrapServers") + for (i in 0 until attempts) { + try { + val record = ProducerRecord("test-topic", "key", "value") + val futureResult = producer.send(record) + withContext(Dispatchers.IO) { + futureResult.get() + } + isConnected = true + break + } catch (e: Exception) { + logger.info( + "Attempt $i to connect to Kafka broker at bootstrap.servers: " + + "$bootstrapServers failed, retrying", + ) + delay(delay) + } + } + + producer.close() - waitTillProducersAccepted(10, 5.seconds) + if (!isConnected) { + throw AssertionError( + "Unable to connect to Kafka broker at bootstrap.servers: $bootstrapServers", + ) } + logger.info("Connected to Kafka broker at bootstrap.servers: $bootstrapServers") } - protected fun revertConfigurationFileEdit() { - applicationConfigFile.writeText(applicationConfigFileContent) + private fun revertConfigurationFileEdit() { + applicationConfigFile?.writeText(originalApplicationConfigFileContent) } protected fun TestScope.editConfigurationFile(configPath: String = DEFAULT_CONFIG_PATH) { - applicationConfigFile = javaClass.getResource("/test-application.conf")?.toURI()?.let { File(it) } - ?: error("Application config file not found") - applicationConfigFileContent = applicationConfigFile.readText() - applicationConfigFile.writeText( - applicationConfigFileContent - .replace(CONFIG_PATH_PLACEHOLDER, configPath) - .replace(BOOTSTRAP_SERVERS_PLACEHOLDER, kafka.bootstrapServers) - .replace(SCHEMA_REGISTRY_URL_PLACEHOLDER, schemaRegistryUrl) - .replace(GROUP_ID_PLACEHOLDER, this.testCase.name.testName.plus("-group")) - .replace(CLIENT_ID_PLACEHOLDER, this.testCase.name.testName.plus("-client")), - ) + applicationConfigFile = + ( + javaClass.getResource("/test-application.conf")?.toURI()?.let { File(it) } + ?: error("Application config file not found") + ).also { + originalApplicationConfigFileContent = it.readText() + it.writeText( + originalApplicationConfigFileContent + .replace(CONFIG_PATH_PLACEHOLDER, configPath) + .replace(BOOTSTRAP_SERVERS_PLACEHOLDER, bootstrapServers) + .replace(SCHEMA_REGISTRY_URL_PLACEHOLDER, resolvedSchemaRegistryUrl) + .replace( + GROUP_ID_PLACEHOLDER, + testCase.name.testName.plus("-group"), + ).replace( + CLIENT_ID_PLACEHOLDER, + testCase.name.testName.plus("-client"), + ), + ) + } } - protected companion object { - private val logger = KtorSimpleLogger(this::class.java.simpleName) - - private val kafkaImage: DockerImageName = - DockerImageName.parse("confluentinc/cp-kafka:$CONFLUENT_PLATFORM_VERSION") - private val schemaRegistry = SchemaRegistryContainer() - private val kafkaNetwork = Network.newNetwork() + protected fun AbstractKafkaConfig.withConsumerConfig() { + consumerConfig { + testTopics.forEach { topicName -> + consumerRecordHandler(topicName) { record -> + logger.debug("Consumed record: {} on topic: {}", record, topicName) + recordChannel.send( + fromRecord(record.value()), + ) + } + } + } + } - val kafka: KafkaContainer = KafkaContainer(kafkaImage).apply { - if (System.getProperty("os.name").lowercase().contains("mac")) { - withCreateContainerCmdModifier { it.withPlatform("linux/amd64") } + protected fun AbstractKafkaConfig.withRegisterSchemas() { + topics.forEach { + registerSchemas { + using { + httpClient + } + TestRecord::class at named(it.name()) } - withNetwork(kafkaNetwork) - withEnv("KAFKA_AUTO_CREATE_TOPIC_ENABLE", "false") - withEnv("KAFKA_TRANSACTION_STATE_LOG_MIN_ISR", "1") - withEnv("KAFKA_TRANSACTION_STATE_LOG_REPLICATION_FACTOR", "1") } + } - @Suppress("SwallowedException") - suspend fun waitTillProducersAccepted(attempts: Int, delay: Duration) { - val props = Properties() - props[ProducerConfig.BOOTSTRAP_SERVERS_CONFIG] = kafka.bootstrapServers - props[ProducerConfig.KEY_SERIALIZER_CLASS_CONFIG] = StringSerializer::class.java.name - props[ProducerConfig.VALUE_SERIALIZER_CLASS_CONFIG] = StringSerializer::class.java.name - - val producer = KafkaProducer(props) - var isConnected = false - - logger.info("Waiting to connect to Kafka broker at bootstrap.servers: $kafka.bootstrapServers") - for (i in 0 until attempts) { - try { - val record = ProducerRecord("test-topic", "key", "value") - val futureResult = producer.send(record) - withContext(Dispatchers.IO) { - futureResult.get() - } - isConnected = true - break - } catch (e: Exception) { - logger.info( - "Attempt $i to connect to Kafka broker at bootstrap.servers: " + - "$kafka.bootstrapServers failed, retrying", - ) - delay(delay) + protected val setupTopics: KafkaConfig.() -> Unit = { + testTopics.forEach { + topic(it) { + partitions = 1 + replicas = 1 + configs { + messageTimestampType = CreateTime } } + } + } - producer.close() + protected fun testKafkaApplication( + extraAssertions: Application.() -> Unit = {}, + waitSecondsAfterApplicationStart: Int = 1, + pluginInstallation: Application.() -> Unit, + ) { + testApplication { + val client = setupClient() + environment { applicationConfigFile?.let { config = ApplicationConfig(it.name) } } + setupApplication(extraAssertions) { pluginInstallation() } + waitTillProducersAccepted() + startApplication() + delay(waitSecondsAfterApplicationStart.seconds) // let the consumer start polling - if (!isConnected) { - throw AssertionError( - "Unable to connect to Kafka broker at bootstrap.servers: " + - "$kafka.bootstrapServers", - ) + val producedRecords = client.produceRecords() + val expectedRecords = collectProducedRecords() + + producedRecords shouldContainExactly expectedRecords + + // Check communication with schema registry using the application schema registry client + testTopics.forEach { topicName -> + val expectedSubject = "${topicName.value}-value" + logger.info("Making call to check subject version: $expectedSubject") + + client + .get("/check-subject-versions") { + parameter("subject", expectedSubject) + }.status shouldBe OK } - logger.info("Connected to Kafka broker at bootstrap.servers: $kafka.bootstrapServers") + + client.clearTopics() } } -} - -internal class SchemaRegistryContainer : - GenericContainer("$schemaRegistryImage:$CONFLUENT_PLATFORM_VERSION") { - init { - waitingFor(Wait.forHttp("/subjects").forStatusCode(200)) - withExposedPorts(SCHEMA_REGISTRY_PORT) + private suspend fun HttpClient.clearTopics() { + testTopics.forEach { + delete(it.value) + } } - fun withKafka(kafka: KafkaContainer): SchemaRegistryContainer { - return withKafka(kafka.network, "${kafka.networkAliases[0]}:9092") + private suspend fun HttpClient.produceRecords() = + testTopics.flatMap { topic -> + (0.rangeUntil(invocations)).map { + logger.info("Triggering record production for topic: $topic") + get("/$topic").body() + } + } + + private suspend fun collectProducedRecords(): MutableList { + val expectedRecords = mutableListOf() + repeat(invocations * testTopics.size) { + expectedRecords.add( + recordChannel.receive().also { + logger.info("Received record: {}", it) + }, + ) + } + return expectedRecords } - private fun withKafka(network: Network?, bootstrapServers: String): SchemaRegistryContainer { - withNetwork(network) - withEnv("SCHEMA_REGISTRY_HOST_NAME", "schema-registry") - withEnv("SCHEMA_REGISTRY_LISTENERS", "http://0.0.0.0:$SCHEMA_REGISTRY_PORT") - withEnv("SCHEMA_REGISTRY_KAFKASTORE_BOOTSTRAP_SERVERS", "PLAINTEXT://$bootstrapServers") - return self() + private fun ApplicationTestBuilder.setupApplication( + extraAssertions: Application.() -> Unit = {}, + pluginInstallation: Application.() -> Unit, + ) { + application { + install(ContentNegotiation) { + json() + } + + pluginInstallation() + + this@application.kafkaAdminClient.shouldNotBeNull() + this@application.kafkaConsumer.shouldNotBeNull() + this@application.kafkaProducer.shouldNotBeNull() + + val topicIdCounters = testTopics.associateWith { 0 } + routing { + testTopics.forEach { topic -> + route("/$topic") { + get { + val testRecord = + TestRecord(topicIdCounters[topic]?.inc() ?: error("topic not counted"), topic.value) + val genericRecord = testRecord.toRecord() + val record = ProducerRecord(topic.value, "testKey", genericRecord) + with(call.application.kafkaProducer.shouldNotBeNull()) { send(record) } + logger.debug("Produced record: {}", record) + call.respond(testRecord) + } + delete { + with(call.application.kafkaAdminClient.shouldNotBeNull()) { + deleteTopics(listOf(topic.value)).all().get() + } + } + } + } + + get("/check-subject-versions") { + retry(maxRetry = 10, timeout = 5.seconds, delay = 500.milliseconds) { + logger.info("Checking subject version: ${call.queryParameters["subject"]}") + val schemaRegistryResponse = + schemaRegistryClient + .shouldNotBeNull() + .client + .get("$resolvedSchemaRegistryUrl/subjects/${call.queryParameters["subject"]}/versions") + + logger.info( + "${schemaRegistryResponse.status} response from checking subject version: ${call.queryParameters["subject"]}", + ) + schemaRegistryResponse.status shouldBe OK + shouldNotThrowAny { + schemaRegistryResponse.body>().shouldBe(listOf(1)) + } + call.respond(OK) + } + } + } + extraAssertions(this) + } } - internal companion object { - const val SCHEMA_REGISTRY_PORT = 8081 - val schemaRegistryImage: DockerImageName = DockerImageName.parse("confluentinc/cp-schema-registry") + private fun ApplicationTestBuilder.setupClient(): HttpClient { + val client = + createClient { + install(io.ktor.client.plugins.contentnegotiation.ContentNegotiation) { + json() + } + } + return client } } diff --git a/ktor-server-kafka/src/jvmTest/kotlin/io/github/flaxoos/ktor/server/plugins/kafka/KafkaContainers.kt b/ktor-server-kafka/src/jvmTest/kotlin/io/github/flaxoos/ktor/server/plugins/kafka/KafkaContainers.kt new file mode 100644 index 00000000..d723f9b6 --- /dev/null +++ b/ktor-server-kafka/src/jvmTest/kotlin/io/github/flaxoos/ktor/server/plugins/kafka/KafkaContainers.kt @@ -0,0 +1,176 @@ +package io.github.flaxoos.ktor.server.plugins.kafka + +import io.github.flaxoos.ktor.server.plugins.kafka.KafkaGenericContainer.Companion.kafkaImage +import io.ktor.util.logging.KtorSimpleLogger +import io.ktor.util.logging.Logger +import org.testcontainers.containers.DockerComposeContainer +import org.testcontainers.containers.GenericContainer +import org.testcontainers.containers.KafkaContainer +import org.testcontainers.containers.Network +import org.testcontainers.containers.output.Slf4jLogConsumer +import org.testcontainers.containers.wait.strategy.Wait +import org.testcontainers.utility.DockerImageName +import org.testcontainers.utility.MountableFile +import java.io.File +import kotlin.time.Duration.Companion.seconds +import kotlin.time.toJavaDuration + +private const val CONFLUENT_PLATFORM_VERSION = "7.7.1" +private val logger: Logger = KtorSimpleLogger(BaseKafkaIntegrationTest::class.java.simpleName) +private val kafkaNetwork = Network.builder().driver("bridge").build() +private const val YML_FILE_PATH = "/Kafka Cluster SSL.yml" +private val yml = object {}::class.java.getResource(YML_FILE_PATH)?.toURI() ?: error("$YML_FILE_PATH not found") + +internal const val LOCALHOST = "localhost" +internal const val KAFKA_BROKER_PORT = 19092 +internal const val BOOTSTRAP_SERVERS: String = "$LOCALHOST:$KAFKA_BROKER_PORT" +internal const val SCHEMA_REGISTRY_PORT = 8081 +internal const val SCHEMA_REGISTRY_URL: String = "https://$LOCALHOST:$SCHEMA_REGISTRY_PORT" +internal const val PASSWORD = "test_password" + +internal fun newKafkaContainer() = KafkaContainer(kafkaImage) + +internal fun KafkaContainer.config() { + if (System.getProperty("os.name").lowercase().contains("mac")) { + withCreateContainerCmdModifier { it.withPlatform("linux/amd64") } + } + withNetworkAliases("kafka") + withNetwork(kafkaNetwork) + withEnv("KAFKA_AUTO_CREATE_TOPIC_ENABLE", "false") + withEnv("KAFKA_TRANSACTION_STATE_LOG_MIN_ISR", "1") + withEnv("KAFKA_TRANSACTION_STATE_LOG_REPLICATION_FACTOR", "1") +} + +internal fun SchemaRegistryContainer.config(kafka: KafkaContainer) { + waitingFor(Wait.forHttp("/subjects").forStatusCode(200).withStartupTimeout(120.seconds.toJavaDuration())) + withExposedPorts(SCHEMA_REGISTRY_PORT) + withNetwork(kafka.network) + withEnv("SCHEMA_REGISTRY_HOST_NAME", "schema-registry") + withEnv("SCHEMA_REGISTRY_LISTENERS", "http://0.0.0.0:$SCHEMA_REGISTRY_PORT") + withEnv("SCHEMA_REGISTRY_KAFKASTORE_BOOTSTRAP_SERVERS", "PLAINTEXT://${kafka.networkAliases[0]}:9092") +} + +internal val zookeeperContainer = + GenericContainer("confluentinc/cp-zookeeper:$CONFLUENT_PLATFORM_VERSION").apply { + withNetwork(kafkaNetwork) + withNetworkAliases("zookeeper") + withEnv("ZOOKEEPER_SERVER_ID", "1") + withEnv("ZOOKEEPER_CLIENT_PORT", "22181") + withEnv("ZOOKEEPER_TICK_TIME", "2000") + withEnv("ZOOKEEPER_INIT_LIMIT", "5") + withEnv("ZOOKEEPER_SYNC_LIMIT", "2") + withEnv("ZOOKEEPER_SERVERS", "zookeeper:22888:23888") + } + +internal fun KafkaGenericContainer.sslConfig() { + withNetwork(kafkaNetwork) + withExposedPorts(KAFKA_BROKER_PORT) + withFixedExposedPorts(KAFKA_BROKER_PORT to KAFKA_BROKER_PORT) + withNetworkAliases("kafka") + withEnv("KAFKA_ZOOKEEPER_CONNECT", "zookeeper:22181") + withEnv("KAFKA_BROKER_ID", "1") + withEnv("KAFKA_LISTENERS", "EXTERNAL://0.0.0.0:19092,INTERNAL://0.0.0.0:29092") + withEnv("KAFKA_ADVERTISED_LISTENERS", "EXTERNAL://localhost:19092,INTERNAL://kafka:29092") + withEnv("KAFKA_LISTENER_SECURITY_PROTOCOL_MAP", "EXTERNAL:SSL,INTERNAL:SSL") + withEnv("KAFKA_INTER_BROKER_LISTENER_NAME", "INTERNAL") + + withEnv("KAFKA_SSL_KEYSTORE_LOCATION", "/etc/kafka/secrets/kafka.server.keystore.jks") + withEnv("KAFKA_SSL_KEYSTORE_PASSWORD", PASSWORD) + withEnv("KAFKA_SSL_KEY_PASSWORD", PASSWORD) + withEnv("KAFKA_SSL_TRUSTSTORE_LOCATION", "/etc/kafka/secrets/kafka.server.truststore.jks") + withEnv("KAFKA_SSL_TRUSTSTORE_PASSWORD", PASSWORD) + withEnv("KAFKA_SSL_ENDPOINT_IDENTIFICATION_ALGORITHM", "") + + withEnv("KAFKA_SSL_CLIENT_AUTH", "required") + withEnv("KAFKA_OFFSETS_TOPIC_REPLICATION_FACTOR", "1") + withEnv("KAFKA_TRANSACTION_STATE_LOG_REPLICATION_FACTOR", "1") + withEnv("KAFKA_TRANSACTION_STATE_LOG_MIN_ISR", "1") + + withCopyToContainer(MountableFile.forClasspathResource("/secrets"), "/etc/kafka/secrets") +} + +internal fun SchemaRegistryContainer.sslConfig() { + withNetwork(kafkaNetwork) + withExposedPorts(SCHEMA_REGISTRY_PORT) + withFixedExposedPorts(SCHEMA_REGISTRY_PORT to SCHEMA_REGISTRY_PORT) + withEnv("SCHEMA_REGISTRY_HOST_NAME", "localhost") + withEnv("SCHEMA_REGISTRY_LISTENERS", "https://0.0.0.0:8081") + + // Connect to Kafka using the internal listener address without the listener name + withEnv("SCHEMA_REGISTRY_KAFKASTORE_BOOTSTRAP_SERVERS", "kafka:29092") + withEnv("SCHEMA_REGISTRY_KAFKASTORE_SECURITY_PROTOCOL", "SSL") + + // SSL configuration for connecting to Kafka (Corrected) + withEnv( + "SCHEMA_REGISTRY_KAFKASTORE_SSL_TRUSTSTORE_LOCATION", + "/etc/kafka/secrets/schemaregistry.server.truststore.jks", + ) + withEnv("SCHEMA_REGISTRY_KAFKASTORE_SSL_TRUSTSTORE_PASSWORD", PASSWORD) + withEnv("SCHEMA_REGISTRY_KAFKASTORE_SSL_KEYSTORE_LOCATION", "/etc/kafka/secrets/schemaregistry.server.keystore.jks") + withEnv("SCHEMA_REGISTRY_KAFKASTORE_SSL_KEYSTORE_PASSWORD", PASSWORD) + withEnv("SCHEMA_REGISTRY_KAFKASTORE_SSL_KEY_PASSWORD", PASSWORD) + withEnv("SCHEMA_REGISTRY_KAFKASTORE_SSL_ENDPOINT_IDENTIFICATION_ALGORITHM", "") + + // SSL configuration for Schema Registry's own listener + withEnv("SCHEMA_REGISTRY_SSL_TRUSTSTORE_LOCATION", "/etc/kafka/secrets/schemaregistry.server.truststore.jks") + withEnv("SCHEMA_REGISTRY_SSL_TRUSTSTORE_PASSWORD", PASSWORD) + withEnv("SCHEMA_REGISTRY_SSL_KEYSTORE_LOCATION", "/etc/kafka/secrets/schemaregistry.server.keystore.jks") + withEnv("SCHEMA_REGISTRY_SSL_KEYSTORE_PASSWORD", PASSWORD) + withEnv("SCHEMA_REGISTRY_SSL_KEY_PASSWORD", PASSWORD) + withEnv("SCHEMA_REGISTRY_SSL_CLIENT_AUTHENTICATION", "NONE") + + withEnv("SCHEMA_REGISTRY_INTER_INSTANCE_PROTOCOL", "https") + withEnv("SCHEMA_REGISTRY_DEBUG", "true") + + withCopyToContainer(MountableFile.forClasspathResource("/secrets"), "/etc/kafka/secrets") +} + +internal val dockerComposeContainer: DockerComposeContainer<*> = + logErrors { DockerComposeContainer("kafka-ssl", File(yml)) } + +private fun logErrors(block: () -> T) = + runCatching { + block() + }.onFailure { + logger.error(it.message) + }.getOrThrow() + +internal abstract class FixedPortsContainer>( + imageName: String, +) : GenericContainer(imageName) { + fun withFixedExposedPorts(vararg ports: Pair) = + apply { + ports.forEach { (internalPort, externalPort) -> + addFixedExposedPort(internalPort, externalPort) + } + } +} + +internal class SchemaRegistryContainer private constructor() : + FixedPortsContainer("$schemaRegistryImage:$CONFLUENT_PLATFORM_VERSION") { + companion object { + val schemaRegistryImage: DockerImageName = DockerImageName.parse("confluentinc/cp-schema-registry") + + fun new() = SchemaRegistryContainer() + } + } + +internal class KafkaGenericContainer private constructor() : + FixedPortsContainer("$kafkaImage:$CONFLUENT_PLATFORM_VERSION") { + companion object { + val kafkaImage: DockerImageName = DockerImageName.parse("confluentinc/cp-kafka") + + fun new() = KafkaGenericContainer() + } + } + +internal fun KafkaContainer.withConsumeLogs() = withLogConsumer(kafkaLogConsumer) + +internal fun KafkaGenericContainer.withConsumeLogs() = withLogConsumer(kafkaLogConsumer) + +internal fun SchemaRegistryContainer.withConsumeLogs() = withLogConsumer(schemaRegistryLogConsumer) + +private val kafkaLogger = KtorSimpleLogger("kafka") +private val schemaRegistryLogger = KtorSimpleLogger("schemaregistry") +private val kafkaLogConsumer = Slf4jLogConsumer(kafkaLogger).withSeparateOutputStreams() +private val schemaRegistryLogConsumer = Slf4jLogConsumer(schemaRegistryLogger).withSeparateOutputStreams() diff --git a/ktor-server-kafka/src/jvmTest/kotlin/io/github/flaxoos/ktor/server/plugins/kafka/KafkaIntegrationTest.kt b/ktor-server-kafka/src/jvmTest/kotlin/io/github/flaxoos/ktor/server/plugins/kafka/KafkaIntegrationTest.kt new file mode 100644 index 00000000..f08ff989 --- /dev/null +++ b/ktor-server-kafka/src/jvmTest/kotlin/io/github/flaxoos/ktor/server/plugins/kafka/KafkaIntegrationTest.kt @@ -0,0 +1,120 @@ +package io.github.flaxoos.ktor.server.plugins.kafka + +import com.sksamuel.avro4k.AvroName +import com.sksamuel.avro4k.AvroNamespace +import io.kotest.common.ExperimentalKotest +import io.kotest.core.extensions.install +import io.kotest.extensions.testcontainers.ContainerExtension +import io.kotest.extensions.testcontainers.ContainerLifecycleMode +import io.ktor.server.application.install +import kotlinx.serialization.Serializable +import org.apache.kafka.clients.CommonClientConfigs.CLIENT_ID_CONFIG +import org.apache.kafka.clients.consumer.ConsumerConfig.GROUP_ID_CONFIG +import org.testcontainers.containers.KafkaContainer +import kotlin.time.Duration.Companion.seconds + +const val CODE_CONFIGURED_CLIENT_ID = "code-configured-client-id" +const val CODE_CONFIGURED_GROUP_ID = "code-configured-group-id" + +@OptIn(ExperimentalKotest::class) +class KafkaIntegrationTest : BaseKafkaIntegrationTest() { + init { + val kafkaContainer: KafkaContainer = newKafkaContainer() + val schemaRegistryContainer = SchemaRegistryContainer.new() + val kafka = + install( + ContainerExtension( + kafkaContainer.apply { config() }, + mode = ContainerLifecycleMode.Project, + beforeTest = { + bootstrapServers = kafkaContainer.bootstrapServers + }, + ), + ) + install( + ContainerExtension( + schemaRegistryContainer.apply { config(kafka) }, + mode = ContainerLifecycleMode.Spec, + beforeTest = { + resolvedSchemaRegistryUrl = + "http://${schemaRegistryContainer.host}:${schemaRegistryContainer.firstMappedPort}" + }, + ), + ) + context("should pr oduce and consume records").config(timeout = 120.seconds) { + test("With default config path") { + editConfigurationFile() + testKafkaApplication { + install(FileConfig.Kafka) { + withConsumerConfig() + withRegisterSchemas() + } + } + } + test("With custom config path") { + val customConfigPath = "ktor.kafka.config" + editConfigurationFile(customConfigPath) + testKafkaApplication { + install(FileConfig.Kafka(customConfigPath)) { + withConsumerConfig() + withRegisterSchemas() + } + } + } + test("With code configuration") { + testKafkaApplication { + install(Kafka) { + schemaRegistryUrl = resolvedSchemaRegistryUrl + setupTopics() + common { bootstrapServers = listOf(kafka.bootstrapServers) } + admin { clientId = CODE_CONFIGURED_CLIENT_ID } + producer { clientId = CODE_CONFIGURED_CLIENT_ID } + consumer { + groupId = CODE_CONFIGURED_GROUP_ID + } + withConsumerConfig() + withRegisterSchemas() + } + } + } + test("With code configuration additional configuration") { + testKafkaApplication { + install(Kafka) { + schemaRegistryUrl = resolvedSchemaRegistryUrl + setupTopics() + common { + additional { + (listOf(kafka.bootstrapServers)) + } + } + admin { + additional { + CLIENT_ID_CONFIG(CODE_CONFIGURED_CLIENT_ID) + } + } + producer { + additional { + CLIENT_ID_CONFIG(CODE_CONFIGURED_CLIENT_ID) + } + } + consumer { + additional { + GROUP_ID_CONFIG(CODE_CONFIGURED_GROUP_ID) + } + } + withConsumerConfig() + withRegisterSchemas() + } + } + } + } + } +} + +@Serializable +@AvroName("TestRecord") +@AvroNamespace("io.github.flaxoos") +data class TestRecord( + val id: Int, + val topic: String, +) diff --git a/ktor-server-kafka/src/jvmTest/kotlin/io/github/flaxoos/ktor/server/plugins/kafka/KafkaSSLIntegrationTest.kt b/ktor-server-kafka/src/jvmTest/kotlin/io/github/flaxoos/ktor/server/plugins/kafka/KafkaSSLIntegrationTest.kt new file mode 100644 index 00000000..35d11c7a --- /dev/null +++ b/ktor-server-kafka/src/jvmTest/kotlin/io/github/flaxoos/ktor/server/plugins/kafka/KafkaSSLIntegrationTest.kt @@ -0,0 +1,146 @@ +package io.github.flaxoos.ktor.server.plugins.kafka + +import io.kotest.core.extensions.install +import io.kotest.extensions.testcontainers.ContainerExtension +import io.kotest.extensions.testcontainers.ContainerLifecycleMode +import io.ktor.server.application.install +import org.apache.kafka.clients.CommonClientConfigs +import org.apache.kafka.common.config.SslConfigs +import java.io.File +import java.nio.file.Paths + +class KafkaSSLIntegrationTest : BaseKafkaIntegrationTest() { + override val additionalProducerProperties: Map by lazy { + mapOf( + // SSL Configuration + CommonClientConfigs.SECURITY_PROTOCOL_CONFIG to "SSL", + SslConfigs.SSL_KEYSTORE_LOCATION_CONFIG to getKeyStoreFile("kafka.client"), + SslConfigs.SSL_KEYSTORE_PASSWORD_CONFIG to PASSWORD, + SslConfigs.SSL_KEY_PASSWORD_CONFIG to PASSWORD, + SslConfigs.SSL_TRUSTSTORE_LOCATION_CONFIG to getTrustStoreFile("kafka.client"), + SslConfigs.SSL_TRUSTSTORE_PASSWORD_CONFIG to PASSWORD, + SslConfigs.SSL_ENDPOINT_IDENTIFICATION_ALGORITHM_CONFIG to "", + ) + } + + init { + val kafkaContainer = KafkaGenericContainer.new() + val schemaRegistryContainer = SchemaRegistryContainer.new() + val zooKeeper = + install( + ContainerExtension( + zookeeperContainer, + ContainerLifecycleMode.Project, + beforeStart = { generateCertificates() }, + ), + ) + val kafka = + install( + ContainerExtension( + kafkaContainer.apply { + sslConfig() + dependsOn(zooKeeper) + }, + ContainerLifecycleMode.Project, + beforeStart = { zooKeeper.start() }, + beforeTest = { + bootstrapServers = BOOTSTRAP_SERVERS + }, + ), + ) + install( + ContainerExtension( + schemaRegistryContainer.apply { + sslConfig() + dependsOn(kafka) + }, + ContainerLifecycleMode.Project, + beforeStart = { + kafkaContainer.start() + }, + beforeTest = { + resolvedSchemaRegistryUrl = SCHEMA_REGISTRY_URL + }, + ), + ) + + test("With code configuration") { + testKafkaApplication(waitSecondsAfterApplicationStart = 10) { + install(Kafka) { + schemaRegistryUrl = resolvedSchemaRegistryUrl + setupTopics() + common { + bootstrapServers = listOf(BOOTSTRAP_SERVERS) + securityProtocol = "SSL" + } + admin { + clientId = CODE_CONFIGURED_CLIENT_ID + } + producer { + clientId = CODE_CONFIGURED_CLIENT_ID + } + consumer { + groupId = CODE_CONFIGURED_GROUP_ID + } + commonSsl { + broker { + protocol = "TLSv1.2" + endpointIdentificationAlgorithm = "" + trustStore { + location = getTrustStoreFile("kafka.client") + password = PASSWORD + } + keyStore { + location = getKeyStoreFile("kafka.client") + password = PASSWORD + } + keyPassword = PASSWORD + } + schemaRegistry { + protocol = "TLSv1.2" + endpointIdentificationAlgorithm = "" + trustStore { + location = getTrustStoreFile("schemaregistry.client") + password = PASSWORD + } + keyStore { + location = getKeyStoreFile("schemaregistry.client") + password = PASSWORD + } + keyPassword = PASSWORD + } + } + withConsumerConfig() + withRegisterSchemas() + } + } + } + } + + private fun generateCertificates() { + val script = + File( + javaClass + .getResource( + "/secrets/generate_certificates.sh", + )?.toURI() ?: error("File secrets/generate_certificates.sh not found in test resources"), + ) + + ProcessBuilder("sh", script.absolutePath) + .directory(script.parentFile) + .inheritIO() + .start() + .waitFor() + } + + private fun getTrustStoreFile(component: String) = getSecretFile("$component.truststore.jks") + + private fun getKeyStoreFile(component: String) = getSecretFile("$component.keystore.jks") + + private fun getSecretFile(fileName: String) = + javaClass + .getResource("/secrets/$fileName") + ?.toURI() + ?.let { Paths.get(it).toAbsolutePath().toString() } + ?: throw IllegalArgumentException("Resource $fileName not found") +} diff --git a/ktor-server-kafka/src/jvmTest/kotlin/io/github/flaxoos/ktor/server/plugins/kafka/KtorKafkaIntegrationTest.kt b/ktor-server-kafka/src/jvmTest/kotlin/io/github/flaxoos/ktor/server/plugins/kafka/KtorKafkaIntegrationTest.kt deleted file mode 100644 index 03128bd8..00000000 --- a/ktor-server-kafka/src/jvmTest/kotlin/io/github/flaxoos/ktor/server/plugins/kafka/KtorKafkaIntegrationTest.kt +++ /dev/null @@ -1,234 +0,0 @@ -package io.github.flaxoos.ktor.server.plugins.kafka - -import com.sksamuel.avro4k.AvroName -import com.sksamuel.avro4k.AvroNamespace -import io.github.flaxoos.ktor.server.plugins.kafka.MessageTimestampType.CreateTime -import io.github.flaxoos.ktor.server.plugins.kafka.TopicName.Companion.named -import io.github.flaxoos.ktor.server.plugins.kafka.components.fromRecord -import io.github.flaxoos.ktor.server.plugins.kafka.components.toRecord -import io.kotest.common.ExperimentalKotest -import io.kotest.matchers.collections.shouldContainExactly -import io.kotest.matchers.nulls.shouldNotBeNull -import io.kotest.matchers.shouldBe -import io.ktor.client.HttpClient -import io.ktor.client.call.body -import io.ktor.client.request.delete -import io.ktor.client.request.get -import io.ktor.client.statement.HttpResponse -import io.ktor.serialization.kotlinx.json.json -import io.ktor.server.application.Application -import io.ktor.server.application.call -import io.ktor.server.application.install -import io.ktor.server.config.ApplicationConfig -import io.ktor.server.plugins.contentnegotiation.ContentNegotiation -import io.ktor.server.response.respond -import io.ktor.server.routing.delete -import io.ktor.server.routing.get -import io.ktor.server.routing.route -import io.ktor.server.routing.routing -import io.ktor.server.testing.ApplicationTestBuilder -import io.ktor.server.testing.testApplication -import io.ktor.util.logging.KtorSimpleLogger -import io.ktor.util.logging.Logger -import kotlinx.coroutines.channels.Channel -import kotlinx.coroutines.delay -import kotlinx.serialization.Serializable -import org.apache.kafka.clients.producer.ProducerRecord -import kotlin.time.Duration.Companion.seconds - -@OptIn(ExperimentalKotest::class) -class KtorKafkaIntegrationTest : BaseKafkaIntegrationTest() { - private val logger: Logger = KtorSimpleLogger(javaClass.simpleName) - private val testTopics = listOf(named("topic1"), named("topic2")) - private val invocations = 2 - private val httpClient = HttpClient() - - private lateinit var recordChannel: Channel - - init { - beforeEach { - recordChannel = Channel() - } - afterEach { - recordChannel.close() - revertConfigurationFileEdit() - } - context("should produce and consume records").config(timeout = 120.seconds) { - test("With default config path") { - editConfigurationFile() - testKafkaApplication { - install(FileConfig.Kafka) { - withConsumerConfig() - withRegisterSchemas() - } - } - } - test("With custom config path") { - val customConfigPath = "ktor.kafka.config" - editConfigurationFile(customConfigPath) - testKafkaApplication { - install(FileConfig.Kafka(customConfigPath)) { - withConsumerConfig() - withRegisterSchemas() - } - } - } - test("With code configuration") { - editConfigurationFile() - testKafkaApplication { - install(Kafka) { - schemaRegistryUrl = super.schemaRegistryUrl - setupTopics() - common { bootstrapServers = listOf(kafka.bootstrapServers) } - admin { clientId = "code-configured-client-id" } - producer { clientId = "code-configured-client-id" } - consumer { groupId = "code-configured-group-id" } - withConsumerConfig() - withRegisterSchemas() - } - } - } - } - } - - private fun AbstractKafkaConfig.withConsumerConfig() { - consumerConfig { - testTopics.forEach { topicName -> - consumerRecordHandler(topicName) { record -> - logger.debug("Consumed record: {} on topic: {}", record, topicName) - recordChannel.send( - fromRecord(record.value()), - ) - } - } - } - } - - private fun AbstractKafkaConfig.withRegisterSchemas() { - topics.forEach { - registerSchemas { - using { - httpClient - } - TestRecord::class at named(it.name()) - } - } - } - - private val setupTopics: KafkaConfig.() -> Unit = { - testTopics.forEach { - topic(it) { - partitions = 1 - replicas = 1 - configs { - messageTimestampType = CreateTime - } - } - } - } - - private fun testKafkaApplication( - extraAssertions: Application.() -> Unit = {}, - pluginInstallation: Application.() -> Unit, - ) { - testApplication { - val client = setupClient() - environment { config = ApplicationConfig("test-application.conf") } - setupApplication(extraAssertions) { pluginInstallation() } - startApplication() - delay(1.seconds) // let the consumer start polling - - val producedRecords = client.produceRecords() - val expectedRecords = collectProducedRecords() - val expectedSubject = "${testTopics.last().value}.${TestRecord::class.java.simpleName}" - val response = collectSchemaVersionsBySubject(expectedSubject) - - producedRecords shouldContainExactly expectedRecords - response.status.value shouldBe 200 - - client.clearTopics() - } - } - - private suspend fun HttpClient.clearTopics() { - testTopics.forEach { - delete(it.value) - } - } - - private suspend fun HttpClient.produceRecords() = testTopics.flatMap { topic -> - (0.rangeUntil(invocations)).map { - logger.debug("Triggering record production for topic: $topic") - get("/$topic").body() - } - } - - private suspend fun collectProducedRecords(): MutableList { - val expectedRecords = mutableListOf() - repeat(invocations * testTopics.size) { - expectedRecords.add(recordChannel.receive()) - } - return expectedRecords - } - - private suspend fun collectSchemaVersionsBySubject(subject: String): HttpResponse { - return httpClient.get("${super.schemaRegistryUrl}/subjects/$subject/versions") - } - - private fun ApplicationTestBuilder.setupApplication( - extraAssertions: Application.() -> Unit = {}, - pluginInstallation: Application.() -> Unit, - ) { - application { - install(ContentNegotiation) { - json() - } - - pluginInstallation() - - this@application.kafkaAdminClient.shouldNotBeNull() - this@application.kafkaConsumer.shouldNotBeNull() - this@application.kafkaProducer.shouldNotBeNull() - - val topicIdCounters = testTopics.associateWith { 0 } - routing { - testTopics.forEach { topic -> - route("/$topic") { - get { - val testRecord = - TestRecord(topicIdCounters[topic]?.inc() ?: error("topic not counted"), topic.value) - val genericRecord = testRecord.toRecord() - val record = ProducerRecord(topic.value, "testKey", genericRecord) - with(call.application.kafkaProducer.shouldNotBeNull()) { send(record) } - logger.debug("Produced record: {}", record) - call.respond(testRecord) - } - delete { - with(call.application.kafkaAdminClient.shouldNotBeNull()) { - deleteTopics(listOf(topic.value)) - } - } - } - } - } - extraAssertions(this) - } - } - - private fun ApplicationTestBuilder.setupClient(): HttpClient { - val client = createClient { - install(io.ktor.client.plugins.contentnegotiation.ContentNegotiation) { - json() - } - } - return client - } -} - -@Serializable -@AvroName("TestRecord") -@AvroNamespace("io.github.flaxoos") -data class TestRecord( - val id: Int, - val topic: String, -) diff --git a/ktor-server-kafka/src/jvmTest/resources/Kafka Cluster SSL.yml b/ktor-server-kafka/src/jvmTest/resources/Kafka Cluster SSL.yml new file mode 100644 index 00000000..fb837b72 --- /dev/null +++ b/ktor-server-kafka/src/jvmTest/resources/Kafka Cluster SSL.yml @@ -0,0 +1,117 @@ +version: '2' +services: + zookeeper: + image: confluentinc/cp-zookeeper:latest + networks: + - kafka-network + hostname: zookeeper + + environment: + ZOOKEEPER_SERVER_ID: 1 + ZOOKEEPER_CLIENT_PORT: 22181 + ZOOKEEPER_TICK_TIME: 2000 + ZOOKEEPER_INIT_LIMIT: 5 + ZOOKEEPER_SYNC_LIMIT: 2 + ZOOKEEPER_SERVERS: zookeeper:22888:23888 + + extra_hosts: + - "moby:127.0.0.1" + + kafka: + image: confluentinc/cp-kafka:latest + networks: + - kafka-network + hostname: kafka + depends_on: + - zookeeper + ports: + - "19092:19092" # External access + volumes: + - ./secrets:/etc/kafka/secrets + environment: + KAFKA_ZOOKEEPER_CONNECT: zookeeper:22181 + KAFKA_BROKER_ID: 1 + + # Define listeners with unique names + KAFKA_LISTENERS: EXTERNAL://0.0.0.0:19092,INTERNAL://0.0.0.0:29092 + KAFKA_ADVERTISED_LISTENERS: EXTERNAL://localhost:19092,INTERNAL://kafka:29092 + + # Map listener names to security protocols + KAFKA_LISTENER_SECURITY_PROTOCOL_MAP: EXTERNAL:SSL,INTERNAL:SSL + + # Specify the inter-broker listener + KAFKA_INTER_BROKER_LISTENER_NAME: INTERNAL + + # SSL Configuration (Corrected) + KAFKA_SSL_KEYSTORE_LOCATION: /etc/kafka/secrets/kafka.server.keystore.jks + KAFKA_SSL_KEYSTORE_PASSWORD: test_password + KAFKA_SSL_KEY_PASSWORD: test_password + KAFKA_SSL_TRUSTSTORE_LOCATION: /etc/kafka/secrets/kafka.server.truststore.jks + KAFKA_SSL_TRUSTSTORE_PASSWORD: test_password + KAFKA_SSL_ENDPOINT_IDENTIFICATION_ALGORITHM: "" + + # Additional configurations + KAFKA_SSL_CLIENT_AUTH: required + KAFKA_OFFSETS_TOPIC_REPLICATION_FACTOR: 1 + KAFKA_TRANSACTION_STATE_LOG_REPLICATION_FACTOR: 1 + KAFKA_TRANSACTION_STATE_LOG_MIN_ISR: 1 + + # Enable SSL Debugging + # KAFKA_OPTS: "-Djavax.net.debug=ssl:handshake" + + logging: + driver: "json-file" + options: + max-size: "10m" + max-file: "3" + + schemaregistry: + image: confluentinc/cp-schema-registry:latest + networks: + - kafka-network + hostname: schemaregistry + ports: + - "8081:8081" + depends_on: + - kafka + volumes: + - ./secrets:/etc/kafka/secrets + environment: + SCHEMA_REGISTRY_HOST_NAME: localhost + SCHEMA_REGISTRY_LISTENERS: https://0.0.0.0:8081 + + # Connect to Kafka using the internal listener address without the listener name + SCHEMA_REGISTRY_KAFKASTORE_BOOTSTRAP_SERVERS: kafka:29092 + SCHEMA_REGISTRY_KAFKASTORE_SECURITY_PROTOCOL: SSL + + # SSL configuration for connecting to Kafka (Corrected) + SCHEMA_REGISTRY_KAFKASTORE_SSL_TRUSTSTORE_LOCATION: /etc/kafka/secrets/schemaregistry.server.truststore.jks + SCHEMA_REGISTRY_KAFKASTORE_SSL_TRUSTSTORE_PASSWORD: test_password + SCHEMA_REGISTRY_KAFKASTORE_SSL_KEYSTORE_LOCATION: /etc/kafka/secrets/schemaregistry.server.keystore.jks + SCHEMA_REGISTRY_KAFKASTORE_SSL_KEYSTORE_PASSWORD: test_password + SCHEMA_REGISTRY_KAFKASTORE_SSL_KEY_PASSWORD: test_password + SCHEMA_REGISTRY_KAFKASTORE_SSL_ENDPOINT_IDENTIFICATION_ALGORITHM: "" + + # SSL configuration for Schema Registry's own listener + SCHEMA_REGISTRY_SSL_TRUSTSTORE_LOCATION: /etc/kafka/secrets/schemaregistry.server.truststore.jks + SCHEMA_REGISTRY_SSL_TRUSTSTORE_PASSWORD: test_password + SCHEMA_REGISTRY_SSL_KEYSTORE_LOCATION: /etc/kafka/secrets/schemaregistry.server.keystore.jks + SCHEMA_REGISTRY_SSL_KEYSTORE_PASSWORD: test_password + SCHEMA_REGISTRY_SSL_KEY_PASSWORD: test_password + SCHEMA_REGISTRY_SSL_CLIENT_AUTHENTICATION: 'NONE' + + SCHEMA_REGISTRY_INTER_INSTANCE_PROTOCOL: https + SCHEMA_REGISTRY_DEBUG: 'true' + + # Enable SSL Debugging + # KAFKA_OPTS: "-Djavax.net.debug=ssl:handshake" + + logging: + driver: "json-file" + options: + max-size: "10m" + max-file: "3" + +networks: + kafka-network: + driver: bridge diff --git a/ktor-server-kafka/src/jvmTest/resources/KafkaSasl.yml b/ktor-server-kafka/src/jvmTest/resources/KafkaSasl.yml new file mode 100644 index 00000000..7deb0ced --- /dev/null +++ b/ktor-server-kafka/src/jvmTest/resources/KafkaSasl.yml @@ -0,0 +1,49 @@ +version: '3.8' +services: + kafka: + image: confluentinc/cp-kafka:latest + environment: + KAFKA_KRAFT_MODE: "true" # Enable Kraft mode + KAFKA_PROCESS_ROLES: broker,controller + KAFKA_LISTENER_SECURITY_PROTOCOL_MAP: PLAINTEXT:PLAINTEXT,SASL_PLAINTEXT:SASL_PLAINTEXT + KAFKA_SASL_MECHANISM_INTER_BROKER_PROTOCOL: "PLAIN" + KAFKA_LISTENERS: "PLAINTEXT://localhost:9092,SASL_PLAINTEXT://localhost:9093" + KAFKA_ADVERTISED_LISTENERS: "PLAINTEXT://localhost:9092,SASL_PLAINTEXT://localhost:9093" + KAFKA_SASL_ENABLED_MECHANISMS: "PLAIN" + KAFKA_INTER_BROKER_LISTENER_NAME: "SASL_PLAINTEXT" + KAFKA_BROKER_ID: 1 + KAFKA_OFFSETS_TOPIC_REPLICATION_FACTOR: 1 + KAFKA_TRANSACTION_STATE_LOG_MIN_ISR: 1 + KAFKA_TRANSACTION_STATE_LOG_REPLICATION_FACTOR: 1 + KAFKA_CONFLUENT_SUPPORT_METRICS_ENABLE: "false" + KAFKA_AUTHORIZER_CLASS_NAME: "kafka.security.auth.SimpleAclAuthorizer" + KAFKA_SUPER_USERS: "User:admin" + KAFKA_SASL_JAAS_CONFIG: | + org.apache.kafka.common.security.plain.PlainLoginModule required + username="admin" + password="admin-secret" + user_admin="admin-secret" + user_user="user-secret"; + CLUSTER_ID: "my-static-cluster-id" # Using a static cluster ID + KAFKA_OPTS: "" # Providing an empty default for KAFKA_OPTS + + ports: + - "9092:9092" + - "9093:9093" + + schema-registry: + image: confluentinc/cp-schema-registry:latest + environment: + SCHEMA_REGISTRY_HOST_NAME: "schema-registry" + SCHEMA_REGISTRY_LISTENERS: "http://0.0.0.0:8081" + SCHEMA_REGISTRY_KAFKASTORE_BOOTSTRAP_SERVERS: "SASL_PLAINTEXT://kafka:9093" + SCHEMA_REGISTRY_KAFKASTORE_SECURITY_PROTOCOL: "SASL_PLAINTEXT" + SCHEMA_REGISTRY_KAFKASTORE_SASL_MECHANISM: "PLAIN" + SCHEMA_REGISTRY_KAFKASTORE_SASL_JAAS_CONFIG: | + org.apache.kafka.common.security.plain.PlainLoginModule required + username="admin" + password="admin-secret"; + ports: + - "8081:8081" + depends_on: + - kafka diff --git a/ktor-server-kafka/src/jvmTest/resources/logback-test.xml b/ktor-server-kafka/src/jvmTest/resources/logback-test.xml index 9b74d4d2..a1a5efa7 100644 --- a/ktor-server-kafka/src/jvmTest/resources/logback-test.xml +++ b/ktor-server-kafka/src/jvmTest/resources/logback-test.xml @@ -8,17 +8,15 @@ - - - - - - - - - + + + + + + + diff --git a/ktor-server-kafka/src/jvmTest/resources/secrets/generate_certificates.sh b/ktor-server-kafka/src/jvmTest/resources/secrets/generate_certificates.sh new file mode 100644 index 00000000..977720f1 --- /dev/null +++ b/ktor-server-kafka/src/jvmTest/resources/secrets/generate_certificates.sh @@ -0,0 +1,334 @@ +#!/bin/bash +# Generate certificates + +## ROOT and CA + +# === 1. Cleanup Previously Generated Files === +echo "=== Cleaning Up Previously Generated Files ===" + +# Define the name of this script to exclude it from deletion +SCRIPT_NAME="generate_certificates.sh" + +# Find and delete all files in the current directory except the script itself +find . -maxdepth 1 -type f ! -name "$SCRIPT_NAME" -exec rm -f {} + + +echo "=== Cleanup Completed ===" +keytool \ + -genkeypair \ + -alias root \ + -dname "cn=localhost" \ + -validity 18250 \ + -keyalg RSA \ + -keysize 4096 \ + -ext bc:c \ + -keystore root.jks \ + -keypass test_password \ + -storepass test_password + +keytool \ + -genkeypair \ + -alias ca \ + -dname "cn=localhost" \ + -validity 18250 \ + -keyalg RSA \ + -keysize 4096 \ + -ext bc:c \ + -keystore ca.jks \ + -keypass test_password \ + -storepass test_password + + +### Generate root certificate + + +keytool \ + -exportcert \ + -rfc \ + -keystore root.jks \ + -alias root \ + -storepass test_password \ + -file root.pem + + +### Generate a certificate for ca signed by root (root -> ca) + + +keytool \ + -keystore ca.jks \ + -storepass test_password \ + -certreq \ + -alias ca \ + -file ca.csr + +keytool \ + -keystore root.jks \ + -storepass test_password \ + -gencert \ + -alias root \ + -ext bc=0 \ + -ext san=dns:ca \ + -rfc \ + -infile ca.csr \ + -outfile ca.pem + + +### Import ca cert chain into ca.jks + + +keytool -keystore ca.jks -storepass test_password -importcert -trustcacerts -noprompt -alias root -file root.pem +keytool -keystore ca.jks -storepass test_password -importcert -alias ca -file ca.pem + + +## Zookeeper Server + +### Generate private keys (for zookeeper) +keytool \ + -genkeypair \ + -alias zookeeper-server \ + -dname cn=zookeeper-server \ + -validity 18250 \ + -keyalg RSA \ + -keysize 4096 \ + -keystore zookeeper.server.keystore.jks \ + -keypass test_password \ + -storepass test_password + +### Generate a certificate for server signed by ca (root -> ca -> zookeeper-server) +keytool \ + -keystore zookeeper.server.keystore.jks \ + -storepass test_password \ + -certreq \ + -alias zookeeper-server \ + -file zookeeper-server.csr + +keytool \ + -keystore ca.jks \ + -storepass test_password \ + -gencert \ + -alias ca \ + -ext ku:c=dig,keyEnc \ + -ext "san=dns:zookeeper,dns:localhost" \ + -ext eku=sa,ca \ + -rfc \ + -infile zookeeper-server.csr \ + -outfile zookeeper-server.pem + +### Import server cert chain into zookeeper.server.keystore.jks +keytool -keystore zookeeper.server.keystore.jks -storepass test_password -importcert -alias zookeeper-server -noprompt -file zookeeper-server.pem + +### Import server cert chain into zookeeper.server.truststore.jks +keytool -keystore zookeeper.server.truststore.jks -storepass test_password -importcert -trustcacerts -noprompt -alias root -file root.pem +keytool -keystore zookeeper.server.truststore.jks -storepass test_password -importcert -alias ca -file ca.pem + + + +## Kafka Server + +### Generate private keys (for server) + + +keytool \ + -genkeypair \ + -alias kafka-server \ + -dname cn=kafka-server \ + -validity 18250 \ + -keyalg RSA \ + -keysize 4096 \ + -keystore kafka.server.keystore.jks \ + -keypass test_password \ + -storepass test_password + + +### Generate a certificate for server signed by ca (root -> ca -> kafka-server) + + +keytool \ + -keystore kafka.server.keystore.jks \ + -storepass test_password \ + -certreq \ + -alias kafka-server \ + -file kafka-server.csr + +keytool \ + -keystore ca.jks \ + -storepass test_password \ + -gencert \ + -alias ca \ + -ext ku:c=dig,keyEnc \ + -ext "san=dns:kafka,dns:localhost" \ + -ext eku=sa,ca \ + -rfc \ + -infile kafka-server.csr \ + -outfile kafka-server.pem + + +### Import server cert chain into kafka.server.keystore.jks + + +keytool -keystore kafka.server.keystore.jks -storepass test_password -importcert -alias kafka-server -noprompt -file kafka-server.pem + + +### Import server cert chain into kafka.server.truststore.jks + + +keytool -keystore kafka.server.truststore.jks -storepass test_password -importcert -trustcacerts -noprompt -alias root -file root.pem +keytool -keystore kafka.server.truststore.jks -storepass test_password -importcert -alias ca -file ca.pem + + +## Schema Registry Server + +### Generate private keys (for schemaregistry-server) + + +keytool \ + -genkeypair \ + -alias schemaregistry-server \ + -dname cn=schemaregistry-server \ + -validity 18250 \ + -keyalg RSA \ + -keysize 4096 \ + -keystore schemaregistry.server.keystore.jks \ + -keypass test_password \ + -storepass test_password + + +### Generate a certificate for server signed by ca (root -> ca -> schemaregistry-server) + + +keytool \ + -keystore schemaregistry.server.keystore.jks \ + -storepass test_password \ + -certreq \ + -alias schemaregistry-server \ + -file schemaregistry-server.csr + +keytool \ + -keystore ca.jks \ + -storepass test_password \ + -gencert \ + -alias ca \ + -ext ku:c=dig,keyEnc \ + -ext "san=dns:schemaregistry,dns:localhost" \ + -ext eku=sa,ca \ + -rfc \ + -infile schemaregistry-server.csr \ + -outfile schemaregistry-server.pem + + +### Import server cert chain into schemaregistry.server.keystore.jks + + +keytool -keystore schemaregistry.server.keystore.jks -storepass test_password -importcert -alias schemaregistry-server -noprompt -file schemaregistry-server.pem + + +### Import server cert chain into schemaregistry.server.truststore.jks + + +keytool -keystore schemaregistry.server.truststore.jks -storepass test_password -importcert -trustcacerts -noprompt -alias root -file root.pem +keytool -keystore schemaregistry.server.truststore.jks -storepass test_password -importcert -alias ca -file ca.pem + + +## Schema Registry Client + +### Generate private keys (for schemaregistry-client) + + +keytool \ + -genkeypair \ + -alias schemaregistry-client \ + -dname cn=schemaregistry-client \ + -validity 18250 \ + -keyalg RSA \ + -keysize 4096 \ + -keystore schemaregistry.client.keystore.jks \ + -keypass test_password \ + -storepass test_password + + +### Generate a certificate for client signed by ca (root -> ca -> schemaregistry-client) + + + +keytool \ + -keystore schemaregistry.client.keystore.jks \ + -storepass test_password \ + -certreq \ + -alias schemaregistry-client \ + -file schemaregistry-client.csr + +keytool \ + -keystore ca.jks \ + -storepass test_password \ + -gencert \ + -alias ca \ + -ext ku:c=dig,keyEnc \ + -ext eku=sa,ca \ + -rfc \ + -infile schemaregistry-client.csr \ + -outfile schemaregistry-client.pem + + +### Import server cert chain into schemaregistry.client.keystore.jks + + +keytool -keystore schemaregistry.client.keystore.jks -storepass test_password -importcert -alias schemaregistry-client -noprompt -file schemaregistry-client.pem + + +### Import server cert chain into schemaregistry.client.truststore.jks + + +keytool -keystore schemaregistry.client.truststore.jks -storepass test_password -importcert -trustcacerts -noprompt -alias root -file root.pem +keytool -keystore schemaregistry.client.truststore.jks -storepass test_password -importcert -alias ca -file ca.pem + + +## Kafka Client + +### Generate private keys (for kafka-client) + + +keytool \ + -genkeypair \ + -alias kafka-client \ + -dname cn=kafka-client \ + -validity 18250 \ + -keyalg RSA \ + -keysize 4096 \ + -keystore kafka.client.keystore.jks \ + -keypass test_password \ + -storepass test_password + + +### Generate a certificate for client signed by ca (root -> ca -> kafka-client) + + +keytool \ + -keystore kafka.client.keystore.jks \ + -storepass test_password \ + -certreq \ + -alias kafka-client \ + -file kafka-client.csr + +keytool \ + -keystore ca.jks \ + -storepass test_password \ + -gencert \ + -alias ca \ + -ext ku:c=dig,keyEnc \ + -ext eku=sa,ca \ + -rfc \ + -infile kafka-client.csr \ + -outfile kafka-client.pem + + +### Import server cert chain into kafka.client.keystore.jks + + +keytool -keystore kafka.client.keystore.jks -storepass test_password -importcert -alias kafka-client -noprompt -file kafka-client.pem + + +### Import server cert chain into kafka.client.truststore.jks + + +keytool -keystore kafka.client.truststore.jks -storepass test_password -importcert -trustcacerts -noprompt -alias root -file root.pem +keytool -keystore kafka.client.truststore.jks -storepass test_password -importcert -alias ca -file ca.pem + diff --git a/ktor-server-rate-limiting/README.md b/ktor-server-rate-limiting/README.md index 5245d0ce..ae87f889 100644 --- a/ktor-server-rate-limiting/README.md +++ b/ktor-server-rate-limiting/README.md @@ -1,30 +1,35 @@ # Rate Limiting Plugin for Ktor Server + ![koverage](https://img.shields.io/badge/94.24-green?logo=kotlin&label=koverage&style=flat) --- -Manage request rate limiting as you see fit with `RateLimiting` in your Ktor server, ensuring you protect your application from potential abuse or resource overload. +Manage request rate limiting as you see fit with `RateLimiting` in your Ktor server, ensuring you protect your +application from potential abuse or resource overload. --- ## Features: + ### Three Strategies Available: 1) **Token Bucket:** Supports variable request rate and is suitable for handling bursts of requests. 2) **Leaky Bucket:** Guarantees a constant request rate, providing fair distribution between clients -3) **Sliding Window:** Allows a specific weight of calls to be made over a designated duration, considering the rate and call weight configured. +3) **Sliding Window:** Allows a specific weight of calls to be made over a designated duration, considering the rate and + call weight configured. ### Robust Configurability -- **Configurable capacity unit of measure**: Measure call count or call weight in bytes +- **Configurable capacity unit of measure**: Measure call count or call weight in bytes - **Configurable call weighting**: Calls can be made to take up more capacity based on a given function - **Whitelist & Blacklist**: - Whitelist or blacklist based on the client's host, user-agent, or principal. -- **Customizable Response**: Set your custom response when the rate limit is exceeded. The default response status is `429 Too Many Requests`. +- **Customizable Response**: Set your custom response when the rate limit is exceeded. The default response status is + `429 Too Many Requests`. - **Logging**: Log rate limit hits for better monitoring and debugging. diff --git a/ktor-server-rate-limiting/src/commonMain/kotlin/io/github/flaxoos/ktor/server/plugins/ratelimiter/RateLimiter.kt b/ktor-server-rate-limiting/src/commonMain/kotlin/io/github/flaxoos/ktor/server/plugins/ratelimiter/RateLimiter.kt index 00bbe5b6..0e463fa8 100644 --- a/ktor-server-rate-limiting/src/commonMain/kotlin/io/github/flaxoos/ktor/server/plugins/ratelimiter/RateLimiter.kt +++ b/ktor-server-rate-limiting/src/commonMain/kotlin/io/github/flaxoos/ktor/server/plugins/ratelimiter/RateLimiter.kt @@ -8,7 +8,6 @@ import kotlin.jvm.JvmInline import kotlin.time.Duration abstract class RateLimiter { - /** * Desired change over time */ @@ -74,9 +73,12 @@ interface CallVolumeUnit { * Volume is measured in number of calls, with an optional call weighting function to give more weight to a call * based on any of it's properties */ - open class Calls(val callWeighting: ApplicationCall.() -> Double = { 1.0 }) : CallVolumeUnit { + open class Calls( + val callWeighting: ApplicationCall.() -> Double = { 1.0 }, + ) : CallVolumeUnit { override val name = "calls" override val size: Int = 1 + override suspend fun callSize(call: ApplicationCall) = this.callWeighting(call) } @@ -84,7 +86,9 @@ interface CallVolumeUnit { * Volume is measured in number of bytes of request */ @JvmInline - value class Bytes(override val size: Int) : CallVolumeUnit { + value class Bytes( + override val size: Int, + ) : CallVolumeUnit { override val name: String get() = "bytes" diff --git a/ktor-server-rate-limiting/src/commonMain/kotlin/io/github/flaxoos/ktor/server/plugins/ratelimiter/RateLimitingConfiguration.kt b/ktor-server-rate-limiting/src/commonMain/kotlin/io/github/flaxoos/ktor/server/plugins/ratelimiter/RateLimitingConfiguration.kt index 45447e16..0265f7c4 100644 --- a/ktor-server-rate-limiting/src/commonMain/kotlin/io/github/flaxoos/ktor/server/plugins/ratelimiter/RateLimitingConfiguration.kt +++ b/ktor-server-rate-limiting/src/commonMain/kotlin/io/github/flaxoos/ktor/server/plugins/ratelimiter/RateLimitingConfiguration.kt @@ -73,7 +73,7 @@ class RateLimitingConfiguration { /** * The call handler for accepted calls, use to define the response for accepted calls, by default, adds appropriate X-RateLimit headers */ - val callAcceptedHandler: suspend ApplicationCall.(RateLimiterResponse.NotLimited) -> Unit = { + var callAcceptedHandler: suspend ApplicationCall.(RateLimiterResponse.NotLimited) -> Unit = { response.headers.append("$X_RATE_LIMIT-Remaining", "${it.remaining}") response.headers.append("$X_RATE_LIMIT-Measured-by", it.rateLimiter.callVolumeUnit.name) } @@ -81,7 +81,7 @@ class RateLimitingConfiguration { /** * The call handler for rate limited IPs, use to define the response for rate limited IPs. The default is to respond with 429 and appropriate X-RateLimit headers */ - val rateLimitExceededHandler: suspend ApplicationCall.(RateLimiterResponse.LimitedBy) -> Unit = + var rateLimitExceededHandler: suspend ApplicationCall.(RateLimiterResponse.LimitedBy) -> Unit = { rateLimiterResponse -> respond(HttpStatusCode.TooManyRequests, "$RATE_LIMIT_EXCEEDED_MESSAGE: ${rateLimiterResponse.message}") this.response.headers.append("$X_RATE_LIMIT-Limit", "${rateLimiterResponse.rateLimiter.capacity}") @@ -169,7 +169,7 @@ class RateLimitingConfiguration { clock = clock, ) } - ) + ) TokenBucket::class -> ( { @@ -180,7 +180,7 @@ class RateLimitingConfiguration { clock = clock, ) } - ) + ) else -> { error("Unsupported provider type: $type") diff --git a/ktor-server-rate-limiting/src/commonMain/kotlin/io/github/flaxoos/ktor/server/plugins/ratelimiter/RateLimitingPlugin.kt b/ktor-server-rate-limiting/src/commonMain/kotlin/io/github/flaxoos/ktor/server/plugins/ratelimiter/RateLimitingPlugin.kt index f04a2020..cdd0b75e 100644 --- a/ktor-server-rate-limiting/src/commonMain/kotlin/io/github/flaxoos/ktor/server/plugins/ratelimiter/RateLimitingPlugin.kt +++ b/ktor-server-rate-limiting/src/commonMain/kotlin/io/github/flaxoos/ktor/server/plugins/ratelimiter/RateLimitingPlugin.kt @@ -38,11 +38,11 @@ private fun PluginBuilder.applyNewRateLimiter() { on(AuthenticationChecked) { call -> with(pluginConfig) { if (excludePaths.any { - call.request - .path() - .trimStart { c -> c == '/' } - .matches(it) - } + call.request + .path() + .trimStart { c -> c == '/' } + .matches(it) + } ) { return@with } @@ -56,11 +56,11 @@ private fun PluginBuilder.applyNewRateLimiter() { ) { application.log.debug( "User ${caller.toIdentifier()} is blacklisted by ${ - listOfNotNull( - if (caller.remoteHost in blackListedHosts) "host" else null, - if (caller.principal in blackListedPrincipals) "principal" else null, - if (caller.userAgent in blackListedAgents) "user agent" else null, - ).joinToString(",") + listOfNotNull( + if (caller.remoteHost in blackListedHosts) "host" else null, + if (caller.principal in blackListedPrincipals) "principal" else null, + if (caller.userAgent in blackListedAgents) "user agent" else null, + ).joinToString(",") }", ) blackListedCallerCallHandler(call) @@ -72,11 +72,11 @@ private fun PluginBuilder.applyNewRateLimiter() { ) { application.log.debug( "User ${caller.toIdentifier()} is whitelisted by ${ - listOfNotNull( - if (caller.remoteHost in whiteListedHosts) "host" else null, - if (caller.principal in whiteListedPrincipals) "principal" else null, - if (caller.userAgent in whiteListedAgents) "user agent" else null, - ).joinToString(",") + listOfNotNull( + if (caller.remoteHost in whiteListedHosts) "host" else null, + if (caller.principal in whiteListedPrincipals) "principal" else null, + if (caller.userAgent in whiteListedAgents) "user agent" else null, + ).joinToString(",") }", ) return@with @@ -110,11 +110,11 @@ private fun PluginBuilder.applyNewRateLimiter() { private fun RateLimiterResponse.debugDetails(caller: Caller) = "call from $caller ${if (this is RateLimiterResponse.LimitedBy) "" else "not"} limited ${ - if (this is RateLimiterResponse.LimitedBy) { - this.message - } else { - "" - } + if (this is RateLimiterResponse.LimitedBy) { + this.message + } else { + "" + } }" private fun ApplicationCall.extractCaller(): Caller { diff --git a/ktor-server-rate-limiting/src/commonMain/kotlin/io/github/flaxoos/ktor/server/plugins/ratelimiter/implementations/Bucket.kt b/ktor-server-rate-limiting/src/commonMain/kotlin/io/github/flaxoos/ktor/server/plugins/ratelimiter/implementations/Bucket.kt index 9ceb9f2b..53da9416 100644 --- a/ktor-server-rate-limiting/src/commonMain/kotlin/io/github/flaxoos/ktor/server/plugins/ratelimiter/implementations/Bucket.kt +++ b/ktor-server-rate-limiting/src/commonMain/kotlin/io/github/flaxoos/ktor/server/plugins/ratelimiter/implementations/Bucket.kt @@ -9,20 +9,26 @@ import kotlinx.coroutines.sync.Mutex import kotlinx.coroutines.sync.withLock import kotlinx.datetime.Instant.Companion.fromEpochMilliseconds -sealed class Bucket(initialVolume: Int, final override val clock: () -> Long, final override val capacity: Int) : - RateLimiter() { +sealed class Bucket( + initialVolume: Int, + final override val clock: () -> Long, + final override val capacity: Int, +) : RateLimiter() { internal abstract val log: KLogger - internal var currentVolume = initialVolume.toDouble() - .also { - require(0 <= it && it <= capacity) { - "Volume $initialVolume must be between 0 and $capacity" + internal var currentVolume = + initialVolume + .toDouble() + .also { + require(0 <= it && it <= capacity) { + "Volume $initialVolume must be between 0 and $capacity" + } } - } private set private val currentVolumeMutex = Mutex() + @Suppress("ktlint:standard:backing-property-naming") private val _lastUpdateTime = atomic(clock()) /** @@ -105,8 +111,8 @@ sealed class Bucket(initialVolume: Int, final override val clock: () -> Long, fi call: ApplicationCall, shouldUpdateTime: Boolean = false, update: suspend (Double, Long) -> Double, - ): Double? { - return currentVolumeMutex.withLock { + ): Double? = + currentVolumeMutex.withLock { val now = clock() val lastUpdateTime = _lastUpdateTime.value val timeSinceLastUpdate = now - lastUpdateTime @@ -130,11 +136,12 @@ sealed class Bucket(initialVolume: Int, final override val clock: () -> Long, fi } currentVolume } else { - log.trace { "${call.id()}: Volume not updated due to exceeding volume: currentVolume: $currentVolume, updatedVolume: $updatedVolume, diff: $diff, max: ${capacity * callVolumeUnit.size}" } + log.trace { + "${call.id()}: Volume not updated due to exceeding volume: currentVolume: $currentVolume, updatedVolume: $updatedVolume, diff: $diff, max: ${capacity * callVolumeUnit.size}" + } null } } - } private fun Double.checkNotNegative(): Double { check(this >= 0) { "Volume change figure must not be negative. was: $this" } diff --git a/ktor-server-rate-limiting/src/commonMain/kotlin/io/github/flaxoos/ktor/server/plugins/ratelimiter/implementations/SlidingWindow.kt b/ktor-server-rate-limiting/src/commonMain/kotlin/io/github/flaxoos/ktor/server/plugins/ratelimiter/implementations/SlidingWindow.kt index c052a531..81911046 100644 --- a/ktor-server-rate-limiting/src/commonMain/kotlin/io/github/flaxoos/ktor/server/plugins/ratelimiter/implementations/SlidingWindow.kt +++ b/ktor-server-rate-limiting/src/commonMain/kotlin/io/github/flaxoos/ktor/server/plugins/ratelimiter/implementations/SlidingWindow.kt @@ -61,7 +61,13 @@ data class SlidingWindow( val cutoff = nowMs - timeWindowMs logger.debug { "Trimming timestamps before: $cutoff" } timestamps.trimWhere { timestamp -> - if (timestamp < cutoff) -1 else if (timestamp > cutoff) 1 else 0 + if (timestamp < cutoff) { + -1 + } else if (timestamp > cutoff) { + 1 + } else { + 0 + } } } } @@ -81,9 +87,7 @@ class ConcurrentFixedSizeWeightedQueue( private var weight = 0.0 private val lock = reentrantLock() - override fun toString(): String { - return "ConcurrentFixedSizeWeightedQueue(size=$size, weight=$weight, maxWeight=$maxWeight)" - } + override fun toString(): String = "ConcurrentFixedSizeWeightedQueue(size=$size, weight=$weight, maxWeight=$maxWeight)" init { require(maxWeight > 0) { @@ -91,7 +95,10 @@ class ConcurrentFixedSizeWeightedQueue( } } - fun tryAdd(t: T, weight: Double = 1.0) = lock.withLock { + fun tryAdd( + t: T, + weight: Double = 1.0, + ) = lock.withLock { if (this.weight + weight <= maxWeight) { this.weight += weight list.add(t to weight).also { @@ -104,21 +111,23 @@ class ConcurrentFixedSizeWeightedQueue( fun peekNext() = list.firstOrNull() - fun trimWhere(comparison: (T) -> Int) = lock.withLock { - subListWhere(comparison)?.apply { - val toTrim = sumOf { it.second } - logger.debug { "Trimmed ${this.size} items, weighing: $toTrim from queue with weight $weight" } - weight -= toTrim - clear() + fun trimWhere(comparison: (T) -> Int) = + lock.withLock { + subListWhere(comparison)?.apply { + val toTrim = sumOf { it.second } + logger.debug { "Trimmed ${this.size} items, weighing: $toTrim from queue with weight $weight" } + weight -= toTrim + clear() + } } - } private fun subListWhere(comparison: (T) -> Int): MutableList>? { - val index = lock.withLock { - list.binarySearch { - comparison(it.first) + val index = + lock.withLock { + list.binarySearch { + comparison(it.first) + } } - } val insertionPoint = if (index < 0) -index - 1 else index return if (insertionPoint > 0) { list.subList(0, insertionPoint) diff --git a/ktor-server-rate-limiting/src/commonMain/kotlin/io/github/flaxoos/ktor/server/plugins/ratelimiter/implementations/TokenBucket.kt b/ktor-server-rate-limiting/src/commonMain/kotlin/io/github/flaxoos/ktor/server/plugins/ratelimiter/implementations/TokenBucket.kt index e5fda28e..9036b8c3 100644 --- a/ktor-server-rate-limiting/src/commonMain/kotlin/io/github/flaxoos/ktor/server/plugins/ratelimiter/implementations/TokenBucket.kt +++ b/ktor-server-rate-limiting/src/commonMain/kotlin/io/github/flaxoos/ktor/server/plugins/ratelimiter/implementations/TokenBucket.kt @@ -26,13 +26,11 @@ class TokenBucket( * At what rate should token be added to the bucket */ override val rate: Duration, - /** * The token to be added at every refill, can be [CallVolumeUnit.Calls] with optional call weight factor, * or [CallVolumeUnit.Bytes], specifying how many bytes to add at every refill */ override val callVolumeUnit: CallVolumeUnit = CallVolumeUnit.Calls(), - /** * The maximum capacity, as measured in the specified [CallVolumeUnit] */ @@ -42,7 +40,6 @@ class TokenBucket( */ clock: () -> Long = { Clock.System.now().toEpochMilliseconds() }, ) : Bucket(capacity * callVolumeUnit.size, clock, capacity * callVolumeUnit.size) { - init { log.debug { "Initialized TokenBucket with volume: $currentVolume" } } @@ -61,9 +58,10 @@ class TokenBucket( this@TokenBucket, resetIn = rate, exceededBy = callSize, - message = "Insufficient tokens to accept call. tokens: $currentVolume, " + - "measured in ${callVolumeUnit::class.simpleName?.lowercase()} of size ${callVolumeUnit.size}. " + - "call size: $callSize", + message = + "Insufficient tokens to accept call. tokens: $currentVolume, " + + "measured in ${callVolumeUnit::class.simpleName?.lowercase()} of size ${callVolumeUnit.size}. " + + "call size: $callSize", ) } } @@ -71,7 +69,13 @@ class TokenBucket( private suspend fun addTokensForDuration(call: ApplicationCall) { logger.debug { "${call.id()}: Maybe adding tokens" } increaseVolume(call, shouldUpdateTime = true, by = callVolumeUnit.size.toDouble()) { timeSinceLastUpdate -> - logger.debug { "${call.id()}: Checking if should add tokens: ${Instant.fromEpochMilliseconds(clock())}, time since last update: $timeSinceLastUpdate" } + logger.debug { + "${call.id()}: Checking if should add tokens: ${ + Instant.fromEpochMilliseconds( + clock(), + ) + }, time since last update: $timeSinceLastUpdate" + } if (this > 0) { ((timeSinceLastUpdate / rate.inWholeMilliseconds) * this) * callVolumeUnit.size() } else { diff --git a/ktor-server-rate-limiting/src/jvmTest/kotlin/io/github/flaxoos/ktor/server/plugins/ratelimiter/RateLimitingPluginTest.kt b/ktor-server-rate-limiting/src/jvmTest/kotlin/io/github/flaxoos/ktor/server/plugins/ratelimiter/RateLimitingPluginTest.kt index 1734d48f..d96d6b85 100644 --- a/ktor-server-rate-limiting/src/jvmTest/kotlin/io/github/flaxoos/ktor/server/plugins/ratelimiter/RateLimitingPluginTest.kt +++ b/ktor-server-rate-limiting/src/jvmTest/kotlin/io/github/flaxoos/ktor/server/plugins/ratelimiter/RateLimitingPluginTest.kt @@ -23,7 +23,6 @@ import io.ktor.http.HttpStatusCode.Companion.InternalServerError import io.ktor.http.HttpStatusCode.Companion.OK import io.ktor.http.HttpStatusCode.Companion.TooManyRequests import io.ktor.server.application.Application -import io.ktor.server.application.call import io.ktor.server.application.install import io.ktor.server.auth.Authentication import io.ktor.server.auth.AuthenticationStrategy @@ -189,7 +188,7 @@ class RateLimitingPluginTest : FunSpec() { testRateLimiting("Should let whitelisted hosts pass", { whiteListedHosts = setOf(LOCALHOST) - },) { + }) { it.testCalls( times = LIMIT + EXCEED, ) { shouldBeOk() } @@ -197,7 +196,7 @@ class RateLimitingPluginTest : FunSpec() { testRateLimiting("Should let whitelisted user agents pass", { whiteListedAgents = setOf(USER_AGENT) - },) { + }) { it.testCalls( times = LIMIT + EXCEED, userAgent = USER_AGENT, @@ -208,7 +207,7 @@ class RateLimitingPluginTest : FunSpec() { context("Blacklisting") { testRateLimiting("Should not let blacklisted users pass", { blackListedPrincipals = setOf(UserIdPrincipal(CALLER1)) - },) { + }) { it.testCalls( times = 1, ) { shouldBeForbidden() } @@ -216,7 +215,7 @@ class RateLimitingPluginTest : FunSpec() { testRateLimiting("Should not let blacklisted hosts pass", { blackListedHosts = setOf(LOCALHOST) - },) { + }) { it.testCalls( times = 1, ) { shouldBeForbidden() } @@ -224,7 +223,7 @@ class RateLimitingPluginTest : FunSpec() { testRateLimiting("Should not let blacklisted user agents pass", { blackListedAgents = setOf(USER_AGENT) - },) { + }) { it.testCalls( times = 1, userAgent = USER_AGENT, diff --git a/ktor-server-task-scheduling/README.md b/ktor-server-task-scheduling/README.md index f949f3fe..4a151b82 100644 --- a/ktor-server-task-scheduling/README.md +++ b/ktor-server-task-scheduling/README.md @@ -1,26 +1,35 @@ # Task Scheduler Plugin for Ktor Server + ![koverage](https://img.shields.io/badge/93.58-green?logo=kotlin&label=koverage&style=flat) --- -Manage scheduled tasks across instances of your distributed ktor server, using various strategies and a kotlin flavoured cron tab +Manage scheduled tasks across instances of your distributed ktor server, using various strategies and a kotlin flavoured +cron tab --- ## Features: -- **Various Implementations**: Can use [Redis](ktor-server-task-scheduling-redis)(JVM/Native), [JDBC](ktor-server-task-scheduling-jdbc) (JVM) or [MongoDB](ktor-server-task-scheduling-mongodb) (JVM) for lock management, or add your own implementation -by extending [Core](ktor-server-task-scheduling-core) +- **Various Implementations**: Can use [Redis](ktor-server-task-scheduling-redis)( + JVM/Native), [JDBC](ktor-server-task-scheduling-jdbc) (JVM) or [MongoDB](ktor-server-task-scheduling-mongodb) (JVM) + for lock management, or add your own implementation + by extending [Core](ktor-server-task-scheduling-core) - **Multiple managers**: Define multiple tasks and assign each to a manager of your choice -- **Kron Schedule builder**: Utilizes [krontab](https://github.com/InsanusMokrassar/krontab) for building schedules using a convenient kotlin DSL +- **Kron Schedule builder**: Utilizes [krontab](https://github.com/InsanusMokrassar/krontab) for building schedules + using a convenient kotlin DSL ## How to Use: + - Add a dependency for your chosen task managers or just add core and implement yourself: + ```kotlin implementation("io.github.flaxoos:ktor-server-task-scheduling-${redis/jdbc/mongodb/core}:$ktor_plugins_version") ``` + - Install the plugin and define one or more task managers: + ```kotlin install(TaskScheduling){ redis{ //<-- this will be the default manager @@ -32,7 +41,7 @@ install(TaskScheduling){ } ``` -- Configure some tasks and assign them to the managers +- Configure some tasks and assign them to the managers ```kotlin install(TaskScheduling) { diff --git a/ktor-server-task-scheduling/ktor-server-task-scheduling-core/build.gradle.kts b/ktor-server-task-scheduling/ktor-server-task-scheduling-core/build.gradle.kts index 801f1a80..f8e041ff 100644 --- a/ktor-server-task-scheduling/ktor-server-task-scheduling-core/build.gradle.kts +++ b/ktor-server-task-scheduling/ktor-server-task-scheduling-core/build.gradle.kts @@ -3,7 +3,10 @@ import io.github.flaxoos.ktor.extensions.targetNative plugins { id("ktor-server-plugin-conventions") - kotlin("plugin.serialization") version libs.versions.kotlin.asProvider().get() + kotlin("plugin.serialization") version + libs.versions.kotlin + .asProvider() + .get() } kotlin { diff --git a/ktor-server-task-scheduling/ktor-server-task-scheduling-core/src/commonMain/kotlin/io/github/flaxoos/ktor/server/plugins/taskscheduling/TaskSchedulerPlugin.kt b/ktor-server-task-scheduling/ktor-server-task-scheduling-core/src/commonMain/kotlin/io/github/flaxoos/ktor/server/plugins/taskscheduling/TaskSchedulerPlugin.kt index 33f66e50..9d6402f3 100644 --- a/ktor-server-task-scheduling/ktor-server-task-scheduling-core/src/commonMain/kotlin/io/github/flaxoos/ktor/server/plugins/taskscheduling/TaskSchedulerPlugin.kt +++ b/ktor-server-task-scheduling/ktor-server-task-scheduling-core/src/commonMain/kotlin/io/github/flaxoos/ktor/server/plugins/taskscheduling/TaskSchedulerPlugin.kt @@ -57,7 +57,8 @@ private fun PluginBuilder.initializeTaskManagers(ta manager.init(tasks) tasks.toList() } - } ?: error("Configuration verification did not check for missing task managers assigned to tasks, this is a bug") + } + ?: error("Configuration verification did not check for missing task managers assigned to tasks, this is a bug") }.toMap() private fun PluginBuilder.checkTaskMangerAssignments(taskManagers: List>) { diff --git a/ktor-server-task-scheduling/ktor-server-task-scheduling-core/src/commonMain/kotlin/io/github/flaxoos/ktor/server/plugins/taskscheduling/managers/TaskManager.kt b/ktor-server-task-scheduling/ktor-server-task-scheduling-core/src/commonMain/kotlin/io/github/flaxoos/ktor/server/plugins/taskscheduling/managers/TaskManager.kt index ed14c3d4..455005c8 100644 --- a/ktor-server-task-scheduling/ktor-server-task-scheduling-core/src/commonMain/kotlin/io/github/flaxoos/ktor/server/plugins/taskscheduling/managers/TaskManager.kt +++ b/ktor-server-task-scheduling/ktor-server-task-scheduling-core/src/commonMain/kotlin/io/github/flaxoos/ktor/server/plugins/taskscheduling/managers/TaskManager.kt @@ -18,23 +18,31 @@ public abstract class TaskManager : C public abstract val name: TaskManagerConfiguration.TaskManagerName public abstract val application: Application - internal suspend fun execute(task: Task, executionTime: DateTime) { - val runs = task.concurrencyRange().map { concurrencyIndex -> - application.async { - logger.trace { "${application.host()}: Attempting task execution at ${executionTime.format2()} for ${task.name} - $concurrencyIndex" } - attemptExecute(task, executionTime, concurrencyIndex)?.let { key -> + internal suspend fun execute( + task: Task, + executionTime: DateTime, + ) { + val runs = + task.concurrencyRange().map { concurrencyIndex -> + application.async { logger.trace { - "${application.host()}: Starting task execution at ${executionTime.format2()} using key $key" + "${application.host()}: Attempting task execution at ${executionTime.format2()} for ${task.name} - $concurrencyIndex" + } + attemptExecute(task, executionTime, concurrencyIndex)?.let { key -> + logger.trace { + "${application.host()}: Starting task execution at ${executionTime.format2()} using key $key" + } + task.task.invoke(application, executionTime) + logger.trace { "${application.host()}: Finished task execution using key $key" } + key + } ?: run { + logger.debug { + "${application.host()}: Denied task execution for${task.name} - $concurrencyIndex at ${executionTime.format2()}" + } + null } - task.task.invoke(application, executionTime) - logger.trace { "${application.host()}: Finished task execution using key $key" } - key - } ?: run { - logger.debug { "${application.host()}: Denied task execution for${task.name} - $concurrencyIndex at ${executionTime.format2()}" } - null } } - } runs.awaitAll().filterNotNull().forEach { markExecuted(it) } @@ -60,10 +68,10 @@ public abstract class TaskManager : C public abstract suspend fun markExecuted(key: TASK_EXECUTION_TOKEN) public companion object { - public fun Application.host(): String = - "Host ${environment.config.property("ktor.deployment.host").getString()}" + public fun Application.host(): String = "Host ${environment.config.property("ktor.deployment.host").getString()}" public fun DateTime.format2(): String = format(DateFormat.FORMAT2) + public fun String.format2ToDateTime(): DateTime = DateFormat.FORMAT2.parseLocal(this) } } @@ -85,9 +93,12 @@ public abstract class TaskManagerConfiguration { public abstract fun createTaskManager(application: Application): TaskManager @JvmInline - public value class TaskManagerName(public val value: String) { + public value class TaskManagerName( + public val value: String, + ) { public companion object { private const val DEFAULT_TASK_MANAGER_NAME: String = "KTOR_DEFAULT_TASK_MANAGER" + public fun String?.toTaskManagerName(): TaskManagerName { require(this != DEFAULT_TASK_MANAGER_NAME) { "$DEFAULT_TASK_MANAGER_NAME is a reserved name, please use another name" diff --git a/ktor-server-task-scheduling/ktor-server-task-scheduling-core/test/src/jvmMain/kotlin/io/github/flaxoos/ktor/server/plugins/taskscheduling/TaskSchedulingPluginTest.kt b/ktor-server-task-scheduling/ktor-server-task-scheduling-core/test/src/jvmMain/kotlin/io/github/flaxoos/ktor/server/plugins/taskscheduling/TaskSchedulingPluginTest.kt index f0cc0090..3ab87019 100644 --- a/ktor-server-task-scheduling/ktor-server-task-scheduling-core/test/src/jvmMain/kotlin/io/github/flaxoos/ktor/server/plugins/taskscheduling/TaskSchedulingPluginTest.kt +++ b/ktor-server-task-scheduling/ktor-server-task-scheduling-core/test/src/jvmMain/kotlin/io/github/flaxoos/ktor/server/plugins/taskscheduling/TaskSchedulingPluginTest.kt @@ -30,7 +30,7 @@ private const val DEFAULT_EXECUTION_BUFFER_MS = 100 private const val FREQUENCIES_EXPONENTIAL_SERIES_INITIAL_MS = 200.toShort() private const val FREQUENCIES_EXPONENTIAL_SERIES_N = 3.toShort() private val concurrencyValues = listOf(1, 3, 6) -private val taskCounts = listOf(2, 4) +private val taskCounts = listOf(2) abstract class TaskSchedulingPluginTest : FunSpec() { protected abstract suspend fun clean() diff --git a/ktor-server-task-scheduling/ktor-server-task-scheduling-jdbc/src/jvmMain/kotlin/io/github/flaxoos/ktor/server/plugins/taskscheduling/managers/lock/database/JdbcLockManager.kt b/ktor-server-task-scheduling/ktor-server-task-scheduling-jdbc/src/jvmMain/kotlin/io/github/flaxoos/ktor/server/plugins/taskscheduling/managers/lock/database/JdbcLockManager.kt index 0e9d029b..8082a44a 100644 --- a/ktor-server-task-scheduling/ktor-server-task-scheduling-jdbc/src/jvmMain/kotlin/io/github/flaxoos/ktor/server/plugins/taskscheduling/managers/lock/database/JdbcLockManager.kt +++ b/ktor-server-task-scheduling/ktor-server-task-scheduling-jdbc/src/jvmMain/kotlin/io/github/flaxoos/ktor/server/plugins/taskscheduling/managers/lock/database/JdbcLockManager.kt @@ -46,7 +46,6 @@ public class JdbcLockManager( */ private val taskLockTable: ExposedTaskLockTable = DefaultTaskLockTable, ) : DatabaseTaskLockManager() { - override suspend fun initTaskLockTable() { transaction { SchemaUtils.create(taskLockTable) } } @@ -73,35 +72,36 @@ public class JdbcLockManager( task: Task, concurrencyIndex: Int, executionTime: DateTime, - ): JdbcTaskLock? = newSuspendedTransaction( - application.coroutineContext, - db = database, - transactionIsolation = Connection.TRANSACTION_READ_COMMITTED, - ) { - val taskExecutionInstant = Instant.fromEpochMilliseconds(executionTime.unixMillisLong) - taskLockTable.update( - where = { - selectClause( - task, - concurrencyIndex, - taskExecutionInstant, - ) - }, + ): JdbcTaskLock? = + newSuspendedTransaction( + application.coroutineContext, + db = database, + transactionIsolation = Connection.TRANSACTION_READ_COMMITTED, ) { - it[lockedAt] = taskExecutionInstant - it[taskLockTable.concurrencyIndex] = concurrencyIndex - } - }.let { - if (it == 1) { - JdbcTaskLock( - name = task.name, - concurrencyIndex = concurrencyIndex, - lockedAt = executionTime, - ) - } else { - null + val taskExecutionInstant = Instant.fromEpochMilliseconds(executionTime.unixMillisLong) + taskLockTable.update( + where = { + selectClause( + task, + concurrencyIndex, + taskExecutionInstant, + ) + }, + ) { + it[lockedAt] = taskExecutionInstant + it[taskLockTable.concurrencyIndex] = concurrencyIndex + } + }.let { + if (it == 1) { + JdbcTaskLock( + name = task.name, + concurrencyIndex = concurrencyIndex, + lockedAt = executionTime, + ) + } else { + null + } } - } override suspend fun releaseLockKey(key: JdbcTaskLock) {} @@ -111,9 +111,8 @@ public class JdbcLockManager( task: Task, concurrencyIndex: Int, taskExecutionInstant: Instant, - ) = - (taskLockTable.name eq task.name and taskLockTable.concurrencyIndex.eq(concurrencyIndex)) and - lockedAt.neq(LiteralOp(KotlinInstantColumnType(), taskExecutionInstant)) + ) = (taskLockTable.name eq task.name and taskLockTable.concurrencyIndex.eq(concurrencyIndex)) and + lockedAt.neq(LiteralOp(KotlinInstantColumnType(), taskExecutionInstant)) } public class JdbcTaskLock( @@ -121,11 +120,12 @@ public class JdbcTaskLock( override val concurrencyIndex: Int, override val lockedAt: DateTime, ) : DatabaseTaskLock { - override fun toString(): String = - "name=$name, concurrencyIndex=$concurrencyIndex, lockedAt=${lockedAt.format2()}}" + override fun toString(): String = "name=$name, concurrencyIndex=$concurrencyIndex, lockedAt=${lockedAt.format2()}}" } -public abstract class ExposedTaskLockTable(tableName: String) : Table(tableName) { +public abstract class ExposedTaskLockTable( + tableName: String, +) : Table(tableName) { public abstract val name: Column public abstract val concurrencyIndex: Column public abstract val lockedAt: Column @@ -142,6 +142,7 @@ public object DefaultTaskLockTable : ExposedTaskLockTable("task_locks") { @TaskSchedulingDsl public class JdbcJobLockManagerConfiguration : DatabaseTaskLockManagerConfiguration() { public var database: Database by Delegates.notNull() + override fun createTaskManager(application: Application): JdbcLockManager = JdbcLockManager( name = name.toTaskManagerName(), @@ -155,7 +156,6 @@ public class JdbcJobLockManagerConfiguration : DatabaseTaskLockManagerConfigurat */ @TaskSchedulingDsl public fun TaskSchedulingConfiguration.jdbc( - /** * The name of the task manager, will be used to identify the task manager when assigning tasks to it * if none is provided, it will be considered the default one. only one default task manager is allowed. diff --git a/ktor-server-task-scheduling/ktor-server-task-scheduling-jdbc/src/jvmTest/kotlin/taskscheduling/JdbcLockManagerTest.kt b/ktor-server-task-scheduling/ktor-server-task-scheduling-jdbc/src/jvmTest/kotlin/taskscheduling/JdbcLockManagerTest.kt index f49af507..b521a709 100644 --- a/ktor-server-task-scheduling/ktor-server-task-scheduling-jdbc/src/jvmTest/kotlin/taskscheduling/JdbcLockManagerTest.kt +++ b/ktor-server-task-scheduling/ktor-server-task-scheduling-jdbc/src/jvmTest/kotlin/taskscheduling/JdbcLockManagerTest.kt @@ -13,9 +13,10 @@ import org.testcontainers.utility.DockerImageName class JdbcLockManagerTest : TaskSchedulingPluginTest() { private val postgres = PostgreSQLContainer(DockerImageName.parse("postgres:13.3")) - private val postgresContainer = install(ContainerExtension(postgres)) { - waitingFor(Wait.forListeningPort()) - } + private val postgresContainer = + install(ContainerExtension(postgres)) { + waitingFor(Wait.forListeningPort()) + } override suspend fun clean() { transaction { DefaultTaskLockTable.deleteAll() } @@ -25,14 +26,16 @@ class JdbcLockManagerTest : TaskSchedulingPluginTest() { context("jdbc lock manager") { testTaskScheduling { jdbc { - database = org.jetbrains.exposed.sql.Database.connect( - url = postgresContainer.getJdbcUrl(), - driver = "org.postgresql.Driver", - user = postgresContainer.username, - password = postgresContainer.password, - ).also { - transaction { SchemaUtils.create(DefaultTaskLockTable) } - } + database = + org.jetbrains.exposed.sql.Database + .connect( + url = postgresContainer.getJdbcUrl(), + driver = "org.postgresql.Driver", + user = postgresContainer.username, + password = postgresContainer.password, + ).also { + transaction { SchemaUtils.create(DefaultTaskLockTable) } + } } } } diff --git a/ktor-server-task-scheduling/ktor-server-task-scheduling-mongodb/src/jvmTest/kotlin/taskscheduling/MongodbLockManagerTest.kt b/ktor-server-task-scheduling/ktor-server-task-scheduling-mongodb/src/jvmTest/kotlin/taskscheduling/MongodbLockManagerTest.kt index fc76ead3..cf8cde99 100644 --- a/ktor-server-task-scheduling/ktor-server-task-scheduling-mongodb/src/jvmTest/kotlin/taskscheduling/MongodbLockManagerTest.kt +++ b/ktor-server-task-scheduling/ktor-server-task-scheduling-mongodb/src/jvmTest/kotlin/taskscheduling/MongodbLockManagerTest.kt @@ -12,9 +12,10 @@ import org.testcontainers.utility.DockerImageName class MongodbLockManagerTest : TaskSchedulingPluginTest() { private val mongodb = MongoDBContainer(DockerImageName.parse("mongo:6.0.4")) - private val mongodbContainer = install(ContainerExtension(mongodb)) { - waitingFor(Wait.forListeningPort()) - } + private val mongodbContainer = + install(ContainerExtension(mongodb)) { + waitingFor(Wait.forListeningPort()) + } private val mongoClient = MongoClient.create(mongodbContainer.connectionString) override suspend fun clean() { diff --git a/ktor-server-task-scheduling/ktor-server-task-scheduling-redis/src/jvmTest/kotlin/io/github/flaxoos/ktor/server/plugins/taskscheduling/managers/lock/redis/RedisLockManagerPluginTest.kt b/ktor-server-task-scheduling/ktor-server-task-scheduling-redis/src/jvmTest/kotlin/io/github/flaxoos/ktor/server/plugins/taskscheduling/managers/lock/redis/RedisLockManagerPluginTest.kt index 6aa3d4b6..9618468d 100644 --- a/ktor-server-task-scheduling/ktor-server-task-scheduling-redis/src/jvmTest/kotlin/io/github/flaxoos/ktor/server/plugins/taskscheduling/managers/lock/redis/RedisLockManagerPluginTest.kt +++ b/ktor-server-task-scheduling/ktor-server-task-scheduling-redis/src/jvmTest/kotlin/io/github/flaxoos/ktor/server/plugins/taskscheduling/managers/lock/redis/RedisLockManagerPluginTest.kt @@ -10,12 +10,14 @@ import kotlin.time.Duration.Companion.minutes import kotlin.time.toJavaDuration class RedisLockManagerPluginTest : TaskSchedulingPluginTest() { - private val redis = RedisContainer(DockerImageName.parse("redis:latest")) - .withEnv("REDIS_USERNAME", "flaxoos") - .withEnv("REDIS_PASSWORD", "password") - private val redisContainer = install(ContainerExtension(redis)) { - waitingFor(Wait.forListeningPort()).withStartupTimeout(1.minutes.toJavaDuration()) - } + private val redis = + RedisContainer(DockerImageName.parse("redis:latest")) + .withEnv("REDIS_USERNAME", "flaxoos") + .withEnv("REDIS_PASSWORD", "password") + private val redisContainer = + install(ContainerExtension(redis)) { + waitingFor(Wait.forListeningPort()).withStartupTimeout(1.minutes.toJavaDuration()) + } override suspend fun clean() {} diff --git a/settings.gradle.kts b/settings.gradle.kts index 86f99ecb..b4d33d36 100644 --- a/settings.gradle.kts +++ b/settings.gradle.kts @@ -9,7 +9,7 @@ pluginManagement { } plugins { - id("com.gradle.enterprise") version("3.15.1") + id("com.gradle.enterprise") version ("3.15.1") } dependencyResolutionManagement {