Skip to content

Commit 781db44

Browse files
nomisRevgithub-actions[bot]
nomisRev
authored and
github-actions[bot]
committed
Auto update docs
1 parent cea6a77 commit 781db44

File tree

105 files changed

+9922
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

105 files changed

+9922
-0
lines changed

‎docs/images/anchor-copy-button.svg‎

Lines changed: 4 additions & 0 deletions
Loading

‎docs/images/arrow_down.svg‎

Lines changed: 3 additions & 0 deletions
Loading

‎docs/images/copy-icon.svg‎

Lines changed: 3 additions & 0 deletions
Loading

‎docs/images/copy-successful-icon.svg‎

Lines changed: 3 additions & 0 deletions
Loading

‎docs/images/footer-go-to-link.svg‎

Lines changed: 3 additions & 0 deletions
Loading

‎docs/images/go-to-top-icon.svg‎

Lines changed: 4 additions & 0 deletions
Loading

‎docs/images/logo-icon.svg‎

Lines changed: 10 additions & 0 deletions
Loading

‎docs/images/theme-toggle.svg‎

Lines changed: 4 additions & 0 deletions
Loading

‎docs/index.html‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
5+
<title>kotlin-kafka</title>
6+
<link href="images/logo-icon.svg" rel="icon" type="image/svg">
7+
<script>var pathToRoot = "";</script>
8+
<script>const storage = localStorage.getItem("dokka-dark-mode")
9+
const savedDarkMode = storage ? JSON.parse(storage) : false
10+
if(savedDarkMode === true){
11+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
12+
}</script>
13+
<script type="text/javascript" src="scripts/sourceset_dependencies.js" async="async"></script>
14+
<link href="styles/style.css" rel="Stylesheet">
15+
<link href="styles/jetbrains-mono.css" rel="Stylesheet">
16+
<link href="styles/main.css" rel="Stylesheet">
17+
<link href="styles/prism.css" rel="Stylesheet">
18+
<link href="styles/logo-styles.css" rel="Stylesheet">
19+
<script type="text/javascript" src="scripts/clipboard.js" async="async"></script>
20+
<script type="text/javascript" src="scripts/navigation-loader.js" async="async"></script>
21+
<script type="text/javascript" src="scripts/platform-content-handler.js" async="async"></script>
22+
<script type="text/javascript" src="scripts/main.js" defer="defer"></script>
23+
<script type="text/javascript" src="scripts/prism.js" async="async"></script>
24+
</head>
25+
<body>
26+
<div class="navigation-wrapper" id="navigation-wrapper">
27+
<div id="leftToggler"><span class="icon-toggler"></span></div>
28+
<div class="library-name">
29+
<a href="index.html">
30+
<span>kotlin-kafka</span>
31+
</a>
32+
</div>
33+
<div>
34+
0.1.1-SNAPSHOT </div>
35+
<div class="pull-right d-flex">
36+
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
37+
<div id="searchBar"></div>
38+
</div>
39+
</div>
40+
<div id="container">
41+
<div id="leftColumn">
42+
<div id="sideMenu"></div>
43+
</div>
44+
<div id="main">
45+
<div class="main-content" id="content" pageIds="kotlin-kafka::////PointingToDeclaration//769193423">
46+
<div class="breadcrumbs"></div>
47+
<div class="cover ">
48+
<h1 class="cover"><span><span>kotlin-kafka</span></span></h1>
49+
<div class="platform-hinted UnderCoverText" data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><p class="paragraph"><a href="https://maven-badges.herokuapp.com/maven-central/io.github.nomisrev/kotlin-kafka"></a></p><!--- TEST_NAME ReadmeTest --><!--- TOC --><ul><li><p class="paragraph">#rationale</p></li><li><p class="paragraph">#goals</p></li><li><p class="paragraph">#adding-dependency</p></li><li><p class="paragraph">#example</p></li></ul><!--- END --><p class="paragraph">This project is still under development, andd started as a playground where I was playing around with Kafka in Kotlin and the Kafka SDK whilst reading the Kafka book Definite Guide from Confluent. https://www.confluent.io/resources/kafka-the-definitive-guide-v2/</p><h2 class=""> Rationale</h2><p class="paragraph">At the time of starting this repository I didn't find any bindings between Kafka SDK and Kotlin suspension. These operators should be implemented low-level, so they can guarantee correct cancellation support, and high optimised runtimes.</p><h2 class=""> Goals</h2><ul><li><p class="paragraph">Lean Core library built on top of Kotlin Std & KotlinX Coroutines (possible extensions with Arrow in additional module)</p></li><li><p class="paragraph">Extensions to easily operate over the Kafka SDK with KotlinX Coroutines and <code class="lang-kotlin">suspend</code>.</p></li><li><p class="paragraph">Flow based operators, so you can easily compose KotlinX Flow based Kafka programs</p></li><li><p class="paragraph">example for testing Kafka with Test Containers in Kotlin.</p></li></ul><h2 class=""> Adding Dependency</h2><p class="paragraph">Simply add the following dependency as <code class="lang-kotlin">implementation</code> in the <code class="lang-kotlin">build.gradle</code> dependencies` block.</p><div class="sample-container"><pre><code class="block lang-groovy" theme="idea">dependencies {<br> implementation(&quot;io.github.nomisrev:kotlin-kafka:0.1&quot;)<br>}</code></pre><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><h2 class=""> Example</h2><!--- INCLUDE
50+
import java.util.UUID
51+
import kotlinx.coroutines.Dispatchers.Default
52+
import kotlinx.coroutines.coroutineScope
53+
import kotlinx.coroutines.flow.asFlow
54+
import kotlinx.coroutines.flow.collect
55+
import kotlinx.coroutines.flow.map
56+
import kotlinx.coroutines.flow.take
57+
import kotlinx.coroutines.launch
58+
import org.apache.kafka.clients.admin.NewTopic
59+
import org.apache.kafka.clients.producer.ProducerRecord
60+
import org.apache.kafka.common.serialization.IntegerDeserializer
61+
import org.apache.kafka.common.serialization.IntegerSerializer
62+
import org.apache.kafka.common.serialization.StringDeserializer
63+
import org.apache.kafka.common.serialization.StringSerializer
64+
--><div class="sample-container"><pre><code class="block lang-kotlin" theme="idea"></code></pre><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div><div class="block"></div></div></div>
65+
</div>
66+
<h2 class="">Packages</h2>
67+
<div class="table"><a data-name="-1022263899%2FPackages%2F769193423" anchor-label="com.github.nomisRev.kafka" id="-1022263899%2FPackages%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
68+
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
69+
<div>
70+
<div class="main-subrow ">
71+
<div class=""><span class="inline-flex">
72+
<div><a href="kotlin-kafka/com.github.nomisRev.kafka/index.html">com.github.nomisRev.kafka</a></div>
73+
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1022263899%2FPackages%2F769193423"></span>
74+
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
75+
</span></span></div>
76+
<div class="pull-right"></div>
77+
</div>
78+
<div></div>
79+
</div>
80+
</div>
81+
</div>
82+
</div>
83+
<div class="footer">
84+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2022 Copyright</span><span
85+
class="pull-right"><span>Generated by </span><a
86+
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
87+
</div>
88+
</div>
89+
</div>
90+
</body>
91+
</html>

‎docs/kotlin-kafka/com.github.nomisRev.kafka/-acks/-all/index.html‎

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
5+
<title>All</title>
6+
<link href="../../../../images/logo-icon.svg" rel="icon" type="image/svg">
7+
<script>var pathToRoot = "../../../../";</script>
8+
<script>const storage = localStorage.getItem("dokka-dark-mode")
9+
const savedDarkMode = storage ? JSON.parse(storage) : false
10+
if(savedDarkMode === true){
11+
document.getElementsByTagName("html")[0].classList.add("theme-dark")
12+
}</script>
13+
<script type="text/javascript" src="../../../../scripts/sourceset_dependencies.js" async="async"></script>
14+
<link href="../../../../styles/style.css" rel="Stylesheet">
15+
<link href="../../../../styles/jetbrains-mono.css" rel="Stylesheet">
16+
<link href="../../../../styles/main.css" rel="Stylesheet">
17+
<link href="../../../../styles/prism.css" rel="Stylesheet">
18+
<link href="../../../../styles/logo-styles.css" rel="Stylesheet">
19+
<script type="text/javascript" src="../../../../scripts/clipboard.js" async="async"></script>
20+
<script type="text/javascript" src="../../../../scripts/navigation-loader.js" async="async"></script>
21+
<script type="text/javascript" src="../../../../scripts/platform-content-handler.js" async="async"></script>
22+
<script type="text/javascript" src="../../../../scripts/main.js" defer="defer"></script>
23+
<script type="text/javascript" src="../../../../scripts/prism.js" async="async"></script>
24+
</head>
25+
<body>
26+
<div class="navigation-wrapper" id="navigation-wrapper">
27+
<div id="leftToggler"><span class="icon-toggler"></span></div>
28+
<div class="library-name">
29+
<a href="../../../../index.html">
30+
<span>kotlin-kafka</span>
31+
</a>
32+
</div>
33+
<div>
34+
0.1.1-SNAPSHOT </div>
35+
<div class="pull-right d-flex">
36+
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
37+
<div id="searchBar"></div>
38+
</div>
39+
</div>
40+
<div id="container">
41+
<div id="leftColumn">
42+
<div id="sideMenu"></div>
43+
</div>
44+
<div id="main">
45+
<div class="main-content" id="content" pageIds="kotlin-kafka::com.github.nomisRev.kafka/Acks.All///PointingToDeclaration/{&quot;org.jetbrains.dokka.links.EnumEntryDRIExtra&quot;:{&quot;key&quot;:&quot;org.jetbrains.dokka.links.EnumEntryDRIExtra&quot;}}/769193423">
46+
<div class="breadcrumbs"><a href="../../../../index.html">kotlin-kafka</a><span class="delimiter">/</span><a href="../../index.html">com.github.nomisRev.kafka</a><span class="delimiter">/</span><a href="../index.html">Acks</a><span class="delimiter">/</span><a href="index.html">All</a></div>
47+
<div class="cover ">
48+
<h1 class="cover"><span><span>All</span></span></h1>
49+
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><div class="symbol monospace"><div class="block"><a href="index.html">All</a></div><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
50+
</div>
51+
<div class="tabbedcontent">
52+
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Properties">Properties</button></div>
53+
<div class="tabs-section-body">
54+
<h2 class="">Properties</h2>
55+
<div class="table" data-togglable="Properties"><a data-name="-372974862%2FProperties%2F769193423" anchor-label="name" id="-372974862%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
56+
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
57+
<div class="main-subrow keyValue ">
58+
<div class=""><span class="inline-flex">
59+
<div><a href="../-one/index.html#-372974862%2FProperties%2F769193423"><span><span>name</span></span></a></div>
60+
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-372974862%2FProperties%2F769193423"></span>
61+
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
62+
</span></span></div>
63+
<div>
64+
<div class="title">
65+
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="-372974862%2FProperties%2F769193423" anchor-label="name" id="-372974862%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="../-one/index.html#-372974862%2FProperties%2F769193423">name</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
66+
</div>
67+
</div>
68+
</div>
69+
</div>
70+
<a data-name="-739389684%2FProperties%2F769193423" anchor-label="ordinal" id="-739389684%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
71+
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
72+
<div class="main-subrow keyValue ">
73+
<div class=""><span class="inline-flex">
74+
<div><a href="../-one/index.html#-739389684%2FProperties%2F769193423"><span><span>ordinal</span></span></a></div>
75+
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-739389684%2FProperties%2F769193423"></span>
76+
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
77+
</span></span></div>
78+
<div>
79+
<div class="title">
80+
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="-739389684%2FProperties%2F769193423" anchor-label="ordinal" id="-739389684%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="../-one/index.html#-739389684%2FProperties%2F769193423">ordinal</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
81+
</div>
82+
</div>
83+
</div>
84+
</div>
85+
<a data-name="383245157%2FProperties%2F769193423" anchor-label="value" id="383245157%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a>
86+
<div class="table-row" data-filterable-current=":dokkaHtml/main" data-filterable-set=":dokkaHtml/main">
87+
<div class="main-subrow keyValue ">
88+
<div class=""><span class="inline-flex">
89+
<div><a href="../value.html"><span><span>value</span></span></a></div>
90+
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="383245157%2FProperties%2F769193423"></span>
91+
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
92+
</span></span></div>
93+
<div>
94+
<div class="title">
95+
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-depenent-content" data-active="" data-togglable=":dokkaHtml/main"><a data-name="383245157%2FProperties%2F769193423" anchor-label="value" id="383245157%2FProperties%2F769193423" data-filterable-set=":dokkaHtml/main"></a><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="../value.html">value</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="top-right-position"><span class="copy-icon"></span><div class="copy-popup-wrapper popup-to-left"><span class="copy-popup-icon"></span><span>Content copied to clipboard</span></div></span></div></div></div>
96+
</div>
97+
</div>
98+
</div>
99+
</div>
100+
</div>
101+
</div>
102+
</div>
103+
</div>
104+
<div class="footer">
105+
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2022 Copyright</span><span
106+
class="pull-right"><span>Generated by </span><a
107+
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
108+
</div>
109+
</div>
110+
</div>
111+
</body>
112+
</html>

0 commit comments

Comments
 (0)