From 7647178541d68c9e21112f9011b5bf91843b7989 Mon Sep 17 00:00:00 2001 From: d1snin Date: Sat, 21 Sep 2024 23:27:35 +0000 Subject: [PATCH] deploy: 65246fefa47787f9824f69afde0efb6afab96153 --- images/anchor-copy-button.svg | 6 +- images/arrow_down.svg | 6 +- images/burger.svg | 6 +- images/copy-icon.svg | 6 +- images/copy-successful-icon.svg | 6 +- images/footer-go-to-link.svg | 6 +- images/go-to-top-icon.svg | 6 +- images/homepage.svg | 3 + images/logo-icon.svg | 6 +- images/nav-icons/abstract-class-kotlin.svg | 4 + images/nav-icons/annotation-kotlin.svg | 4 + images/nav-icons/class-kotlin.svg | 4 + images/nav-icons/enum-kotlin.svg | 4 + images/nav-icons/field-value.svg | 4 + images/nav-icons/field-variable.svg | 4 + images/nav-icons/interface-kotlin.svg | 4 + images/nav-icons/object.svg | 4 + images/nav-icons/typealias-kotlin.svg | 4 + images/theme-toggle.svg | 6 +- index.html | 16 +- .../-client-web-socket-event.html | 6 +- .../-client-web-socket-event/data.html | 4 +- .../-client-web-socket-event/id.html | 76 ++++++++ .../-client-web-socket-event/index.html | 44 ++++- .../-client-web-socket-event/initiated.html | 76 ++++++++ .../-client-web-socket-event/reference.html | 4 +- .../-event-receiver-log.html | 14 +- .../-event-receiving-scope.html | 76 ++++++++ .../-web-socket-events-configuration.html | 2 +- .../client-id.html | 76 ++++++++ .../index.html | 21 +- .../-web-socket-events-configuration/url.html | 4 +- .../-web-socket-events.html | 4 +- .../dev.d1s.ktor.events.client/index.html | 74 ++++++- .../receive-web-socket-event.html | 4 +- .../receive-web-socket-events.html | 14 +- .../web-socket-events.html | 4 +- .../with-retries.html | 76 ++++++++ ktor-ws-events-client/index.html | 2 +- ktor-ws-events-client/navigation.html | 109 ++++++++--- .../-c-l-i-e-n-t_-i-d_-h-e-a-d-e-r.html | 76 ++++++++ ...d-e-f-a-u-l-t_-e-v-e-n-t-s_-r-o-u-t-e.html | 2 +- ...g-r-o-u-p_-p-a-t-h_-p-a-r-a-m-e-t-e-r.html | 2 +- ...-s-e-g-m-e-n-t_-p-l-a-c-e-h-o-l-d-e-r.html | 2 +- ...i-p-a-l_-q-u-e-r-y_-p-a-r-a-m-e-t-e-r.html | 2 +- .../-routes/index.html | 19 +- .../index.html | 2 +- .../-abstract-event/id.html | 76 ++++++++ .../-abstract-event/index.html | 130 +++++++++++++ .../-abstract-event/initiated.html | 76 ++++++++ .../-abstract-event/reference.html | 76 ++++++++ .../-client-parameters/index.html | 4 +- .../-event-group/index.html | 2 +- .../-event-principal/index.html | 2 +- .../-event-reference/-event-reference.html | 2 +- .../-event-reference/equals.html | 2 +- .../-event-reference/group.html | 4 +- .../-event-reference/hash-code.html | 2 +- .../-event-reference/index.html | 8 +- .../-event-reference/parameters.html | 4 +- .../-event-reference/principal.html | 4 +- .../-identifier}/index.html | 14 +- .../-unix-time/index.html | 80 ++++++++ .../dev.d1s.ktor.events.commons/index.html | 74 ++++++- .../random-id.html | 76 ++++++++ .../dev.d1s.ktor.events.commons/ref.html | 4 +- ktor-ws-events-commons/index.html | 2 +- ktor-ws-events-commons/navigation.html | 109 ++++++++--- .../-event-data-supplier/index.html | 8 +- .../-event-sending-connection.html} | 12 +- .../-event-sending-connection/call.html} | 12 +- .../-event-sending-connection}/index.html | 49 +++-- .../-event-sending-connection}/reference.html | 8 +- .../-event-sending-connection/session.html} | 12 +- .../-server-web-socket-event.html | 76 ++++++++ .../-server-web-socket-event/id.html | 76 ++++++++ .../-server-web-socket-event/index.html | 149 ++++++++++++++ .../-server-web-socket-event/initiated.html | 76 ++++++++ .../-server-web-socket-event/reference.html | 76 ++++++++ .../event.html | 8 +- .../index.html | 148 ++++++++++++++ .../-event-pool/confirm.html | 76 ++++++++ .../-event-pool/get.html | 76 ++++++++ .../-event-pool/index.html | 164 ++++++++++++++++ .../-event-pool/lifetime-millis.html | 76 ++++++++ .../-event-pool/on-event.html | 76 ++++++++ .../-event-pool/push.html | 76 ++++++++ .../-in-memory-event-pool.html | 76 ++++++++ .../-in-memory-event-pool/confirm.html | 76 ++++++++ .../-in-memory-event-pool/get.html | 76 ++++++++ .../-in-memory-event-pool/index.html | 183 ++++++++++++++++++ .../lifetime-millis.html | 76 ++++++++ .../-in-memory-event-pool/on-event.html | 76 ++++++++ .../-in-memory-event-pool/push.html | 76 ++++++++ .../index.html | 114 +++++++++++ .../index.html | 99 ++++++++++ .../web-socket-events.html | 76 ++++++++ .../-web-socket-event-channel/index.html | 80 -------- .../-web-socket-events-configuration.html | 2 +- .../{channel.html => event-pool.html} | 12 +- .../index.html | 25 +-- .../-web-socket-events.html | 4 +- .../dev.d1s.ktor.events.server/index.html | 117 +---------- ktor-ws-events-server/index.html | 56 +++++- ktor-ws-events-server/navigation.html | 109 ++++++++--- navigation.html | 109 ++++++++--- package-list | 3 + scripts/clipboard.js | 4 + scripts/navigation-loader.js | 4 + scripts/pages.json | 2 +- scripts/platform-content-handler.js | 49 +++-- scripts/symbol-parameters-wrapper_deferred.js | 119 +++++------- styles/font-jb-sans-auto.css | 4 + styles/logo-styles.css | 4 + styles/main.css | 10 +- styles/prism.css | 4 + styles/style.css | 72 +++++-- 117 files changed, 4030 insertions(+), 596 deletions(-) create mode 100644 images/homepage.svg create mode 100644 ktor-ws-events-client/dev.d1s.ktor.events.client/-client-web-socket-event/id.html create mode 100644 ktor-ws-events-client/dev.d1s.ktor.events.client/-client-web-socket-event/initiated.html rename ktor-ws-events-server/dev.d1s.ktor.events.server/-web-socket-event-channel.html => ktor-ws-events-client/dev.d1s.ktor.events.client/-event-receiver-log.html (75%) create mode 100644 ktor-ws-events-client/dev.d1s.ktor.events.client/-event-receiving-scope.html create mode 100644 ktor-ws-events-client/dev.d1s.ktor.events.client/-web-socket-events-configuration/client-id.html rename ktor-ws-events-server/dev.d1s.ktor.events.server/web-socket-events.html => ktor-ws-events-client/dev.d1s.ktor.events.client/receive-web-socket-events.html (52%) create mode 100644 ktor-ws-events-client/dev.d1s.ktor.events.client/with-retries.html create mode 100644 ktor-ws-events-commons/dev.d1s.ktor.events.commons.util/-routes/-c-l-i-e-n-t_-i-d_-h-e-a-d-e-r.html create mode 100644 ktor-ws-events-commons/dev.d1s.ktor.events.commons/-abstract-event/id.html create mode 100644 ktor-ws-events-commons/dev.d1s.ktor.events.commons/-abstract-event/index.html create mode 100644 ktor-ws-events-commons/dev.d1s.ktor.events.commons/-abstract-event/initiated.html create mode 100644 ktor-ws-events-commons/dev.d1s.ktor.events.commons/-abstract-event/reference.html rename {ktor-ws-events-server/dev.d1s.ktor.events.server/-web-socket-event-sender => ktor-ws-events-commons/dev.d1s.ktor.events.commons/-identifier}/index.html (75%) create mode 100644 ktor-ws-events-commons/dev.d1s.ktor.events.commons/-unix-time/index.html create mode 100644 ktor-ws-events-commons/dev.d1s.ktor.events.commons/random-id.html rename ktor-ws-events-server/{dev.d1s.ktor.events.server => dev.d1s.ktor.events.server.entity}/-event-data-supplier/index.html (86%) rename ktor-ws-events-server/{dev.d1s.ktor.events.server/-server-web-socket-event/-server-web-socket-event.html => dev.d1s.ktor.events.server.entity/-event-sending-connection/-event-sending-connection.html} (78%) rename ktor-ws-events-server/{dev.d1s.ktor.events.server/-server-web-socket-event/data-supplier.html => dev.d1s.ktor.events.server.entity/-event-sending-connection/call.html} (85%) rename ktor-ws-events-server/{dev.d1s.ktor.events.server/-server-web-socket-event => dev.d1s.ktor.events.server.entity/-event-sending-connection}/index.html (61%) rename ktor-ws-events-server/{dev.d1s.ktor.events.server/-server-web-socket-event => dev.d1s.ktor.events.server.entity/-event-sending-connection}/reference.html (86%) rename ktor-ws-events-server/{dev.d1s.ktor.events.server/-web-socket-events-configuration/event-receiving-scope.html => dev.d1s.ktor.events.server.entity/-event-sending-connection/session.html} (83%) create mode 100644 ktor-ws-events-server/dev.d1s.ktor.events.server.entity/-server-web-socket-event/-server-web-socket-event.html create mode 100644 ktor-ws-events-server/dev.d1s.ktor.events.server.entity/-server-web-socket-event/id.html create mode 100644 ktor-ws-events-server/dev.d1s.ktor.events.server.entity/-server-web-socket-event/index.html create mode 100644 ktor-ws-events-server/dev.d1s.ktor.events.server.entity/-server-web-socket-event/initiated.html create mode 100644 ktor-ws-events-server/dev.d1s.ktor.events.server.entity/-server-web-socket-event/reference.html rename ktor-ws-events-server/{dev.d1s.ktor.events.server => dev.d1s.ktor.events.server.entity}/event.html (70%) create mode 100644 ktor-ws-events-server/dev.d1s.ktor.events.server.entity/index.html create mode 100644 ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-event-pool/confirm.html create mode 100644 ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-event-pool/get.html create mode 100644 ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-event-pool/index.html create mode 100644 ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-event-pool/lifetime-millis.html create mode 100644 ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-event-pool/on-event.html create mode 100644 ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-event-pool/push.html create mode 100644 ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-in-memory-event-pool/-in-memory-event-pool.html create mode 100644 ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-in-memory-event-pool/confirm.html create mode 100644 ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-in-memory-event-pool/get.html create mode 100644 ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-in-memory-event-pool/index.html create mode 100644 ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-in-memory-event-pool/lifetime-millis.html create mode 100644 ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-in-memory-event-pool/on-event.html create mode 100644 ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-in-memory-event-pool/push.html create mode 100644 ktor-ws-events-server/dev.d1s.ktor.events.server.pool/index.html create mode 100644 ktor-ws-events-server/dev.d1s.ktor.events.server.route/index.html create mode 100644 ktor-ws-events-server/dev.d1s.ktor.events.server.route/web-socket-events.html delete mode 100644 ktor-ws-events-server/dev.d1s.ktor.events.server/-web-socket-event-channel/index.html rename ktor-ws-events-server/dev.d1s.ktor.events.server/-web-socket-events-configuration/{channel.html => event-pool.html} (88%) diff --git a/images/anchor-copy-button.svg b/images/anchor-copy-button.svg index bab9d74..19c1fa3 100644 --- a/images/anchor-copy-button.svg +++ b/images/anchor-copy-button.svg @@ -1,4 +1,8 @@ + + - \ No newline at end of file + diff --git a/images/arrow_down.svg b/images/arrow_down.svg index c0388de..639aaf1 100644 --- a/images/arrow_down.svg +++ b/images/arrow_down.svg @@ -1,3 +1,7 @@ + + - \ No newline at end of file + diff --git a/images/burger.svg b/images/burger.svg index d6dcefc..fcca732 100644 --- a/images/burger.svg +++ b/images/burger.svg @@ -1,5 +1,9 @@ + + - \ No newline at end of file + diff --git a/images/copy-icon.svg b/images/copy-icon.svg index 61440f0..2cb02ec 100644 --- a/images/copy-icon.svg +++ b/images/copy-icon.svg @@ -1,3 +1,7 @@ + + - \ No newline at end of file + diff --git a/images/copy-successful-icon.svg b/images/copy-successful-icon.svg index 1865f73..c4b9538 100644 --- a/images/copy-successful-icon.svg +++ b/images/copy-successful-icon.svg @@ -1,3 +1,7 @@ + + - \ No newline at end of file + diff --git a/images/footer-go-to-link.svg b/images/footer-go-to-link.svg index 0137e22..a87add7 100644 --- a/images/footer-go-to-link.svg +++ b/images/footer-go-to-link.svg @@ -1,3 +1,7 @@ + + - \ No newline at end of file + diff --git a/images/go-to-top-icon.svg b/images/go-to-top-icon.svg index d987f3e..abc3d1c 100644 --- a/images/go-to-top-icon.svg +++ b/images/go-to-top-icon.svg @@ -1,4 +1,8 @@ + + - \ No newline at end of file + diff --git a/images/homepage.svg b/images/homepage.svg new file mode 100644 index 0000000..e3c83b1 --- /dev/null +++ b/images/homepage.svg @@ -0,0 +1,3 @@ + + + diff --git a/images/logo-icon.svg b/images/logo-icon.svg index 1fea087..e42f957 100644 --- a/images/logo-icon.svg +++ b/images/logo-icon.svg @@ -1,3 +1,7 @@ + + @@ -7,4 +11,4 @@ - \ No newline at end of file + diff --git a/images/nav-icons/abstract-class-kotlin.svg b/images/nav-icons/abstract-class-kotlin.svg index a2069b8..19d6148 100644 --- a/images/nav-icons/abstract-class-kotlin.svg +++ b/images/nav-icons/abstract-class-kotlin.svg @@ -1,3 +1,7 @@ + + diff --git a/images/nav-icons/annotation-kotlin.svg b/images/nav-icons/annotation-kotlin.svg index 932f1d3..b90f508 100644 --- a/images/nav-icons/annotation-kotlin.svg +++ b/images/nav-icons/annotation-kotlin.svg @@ -1,3 +1,7 @@ + + diff --git a/images/nav-icons/class-kotlin.svg b/images/nav-icons/class-kotlin.svg index 46a21f6..797a242 100644 --- a/images/nav-icons/class-kotlin.svg +++ b/images/nav-icons/class-kotlin.svg @@ -1,3 +1,7 @@ + + diff --git a/images/nav-icons/enum-kotlin.svg b/images/nav-icons/enum-kotlin.svg index 4a85459..775a7cc 100644 --- a/images/nav-icons/enum-kotlin.svg +++ b/images/nav-icons/enum-kotlin.svg @@ -1,3 +1,7 @@ + + diff --git a/images/nav-icons/field-value.svg b/images/nav-icons/field-value.svg index 20449c9..2771ee5 100644 --- a/images/nav-icons/field-value.svg +++ b/images/nav-icons/field-value.svg @@ -1,3 +1,7 @@ + + diff --git a/images/nav-icons/field-variable.svg b/images/nav-icons/field-variable.svg index 3b07450..e2d2bbd 100644 --- a/images/nav-icons/field-variable.svg +++ b/images/nav-icons/field-variable.svg @@ -1,3 +1,7 @@ + + diff --git a/images/nav-icons/interface-kotlin.svg b/images/nav-icons/interface-kotlin.svg index bf07a14..5e16326 100644 --- a/images/nav-icons/interface-kotlin.svg +++ b/images/nav-icons/interface-kotlin.svg @@ -1,3 +1,7 @@ + + diff --git a/images/nav-icons/object.svg b/images/nav-icons/object.svg index 9f427de..31f0ee3 100644 --- a/images/nav-icons/object.svg +++ b/images/nav-icons/object.svg @@ -1,3 +1,7 @@ + + diff --git a/images/nav-icons/typealias-kotlin.svg b/images/nav-icons/typealias-kotlin.svg index 4795069..f4bb238 100644 --- a/images/nav-icons/typealias-kotlin.svg +++ b/images/nav-icons/typealias-kotlin.svg @@ -1,3 +1,7 @@ + + diff --git a/images/theme-toggle.svg b/images/theme-toggle.svg index dad3ff2..df86202 100644 --- a/images/theme-toggle.svg +++ b/images/theme-toggle.svg @@ -1,3 +1,7 @@ + + - \ No newline at end of file + diff --git a/index.html b/index.html index 0283967..53f7611 100644 --- a/index.html +++ b/index.html @@ -44,7 +44,7 @@
-1.1.1
+2.0.0
@@ -63,31 +63,31 @@

Event streaming extensions for Ktor over WebSocket protocol. Support is provided for both client and server.

-

Installation

+

Installation

repositories {
    maven(url = "https://maven.d1s.dev/releases")
}

dependencies {
    val ktorWsEventsVersion: String by project

    // server side
    implementation("dev.d1s.ktor-ws-events:ktor-ws-events-server:$ktorWsEventsVersion")

    // client side
    implementation("dev.d1s.ktor-ws-events:ktor-ws-events-client:$ktorWsEventsVersion")
}
Content copied to clipboard
-

Example usage on the server side

+

Example usage on the server side

val eventChannel = WebSocketEventChannel()

fun Application.configureWebSocketEvents() {
    install(WebSocketEvents) {
        channel = eventChannel
    }

    routing {
        webSocketEvents()
    }
}

fun handleServerFailure(failure: ServerFailure) {
    val reference = ref("server_failure")
    val event = event(reference) {
        failure
    }

    eventChannel.send(event)
}
Content copied to clipboard
-

Example usage on the client side

+

Example usage on the client side

fun HttClient.configureWebSocketEvents() {
    install(WebSockets) {
        contentConverter = KotlinxWebsocketSerializationConverter(Json)
    }
    
    install(WebSocketEvents) {
        host = "example.com"
        port = 9090
    }
}

fun HttpClient.listenToServerFailures() {
    val reference = ref("server_failure")

    webSocketEvents(reference) {
        val event = receiveWebSocketEvent<ServerFailure>()
        val failure = event.data

        notifyTeam(failure)
    }
}
Content copied to clipboard
-

How to contribute

+

How to contribute

See CONTRIBUTING.md

-

Code of Conduct

+

Code of Conduct

See CODE_OF_CONDUCT.md

-

License

+

License

- 
   Copyright 2022-2023 Mikhail Titov

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       https://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
+ 
   Copyright 2022-2024 Mikhail Titov

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       https://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
Content copied to clipboard
diff --git a/ktor-ws-events-client/dev.d1s.ktor.events.client/-client-web-socket-event/-client-web-socket-event.html b/ktor-ws-events-client/dev.d1s.ktor.events.client/-client-web-socket-event/-client-web-socket-event.html index 5c228cb..9f30f56 100644 --- a/ktor-ws-events-client/dev.d1s.ktor.events.client/-client-web-socket-event/-client-web-socket-event.html +++ b/ktor-ws-events-client/dev.d1s.ktor.events.client/-client-web-socket-event/-client-web-socket-event.html @@ -41,7 +41,7 @@ ktor-ws-events
-
1.1.1 +
2.0.0
@@ -58,12 +58,12 @@
-
+
ktor-ws-events-client/dev.d1s.ktor.events.client/ClientWebSocketEvent/ClientWebSocketEvent

ClientWebSocketEvent

-
constructor(reference: EventReference, data: T)
+
constructor(id: Identifier, reference: EventReference, initiated: UnixTime, data: T)
Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka diff --git a/ktor-ws-events-client/dev.d1s.ktor.events.client/-client-web-socket-event/data.html b/ktor-ws-events-client/dev.d1s.ktor.events.client/-client-web-socket-event/data.html index 06b6445..fd45c3d 100644 --- a/ktor-ws-events-client/dev.d1s.ktor.events.client/-client-web-socket-event/data.html +++ b/ktor-ws-events-client/dev.d1s.ktor.events.client/-client-web-socket-event/data.html @@ -41,7 +41,7 @@ ktor-ws-events
-
1.1.1 +
2.0.0
@@ -63,7 +63,7 @@

data

-
val data: T
+
val data: T
Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka diff --git a/ktor-ws-events-client/dev.d1s.ktor.events.client/-client-web-socket-event/id.html b/ktor-ws-events-client/dev.d1s.ktor.events.client/-client-web-socket-event/id.html new file mode 100644 index 0000000..dc4cdb9 --- /dev/null +++ b/ktor-ws-events-client/dev.d1s.ktor.events.client/-client-web-socket-event/id.html @@ -0,0 +1,76 @@ + + + + + id + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
ktor-ws-events-client/dev.d1s.ktor.events.client/ClientWebSocketEvent/id
+
+

id

+
+
open override val id: Identifier
+
+
+ Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka +
+
+
+
+ + + diff --git a/ktor-ws-events-client/dev.d1s.ktor.events.client/-client-web-socket-event/index.html b/ktor-ws-events-client/dev.d1s.ktor.events.client/-client-web-socket-event/index.html index 058d946..00d3129 100644 --- a/ktor-ws-events-client/dev.d1s.ktor.events.client/-client-web-socket-event/index.html +++ b/ktor-ws-events-client/dev.d1s.ktor.events.client/-client-web-socket-event/index.html @@ -41,7 +41,7 @@ ktor-ws-events
-
1.1.1 +
2.0.0
@@ -62,24 +62,24 @@
ktor-ws-events-client/dev.d1s.ktor.events.client/ClientWebSocketEvent

ClientWebSocketEvent

-
@Serializable
data class ClientWebSocketEvent<T>(val reference: EventReference, val data: T)
+
@Serializable
data class ClientWebSocketEvent<T>(val id: Identifier, val reference: EventReference, val initiated: UnixTime, val data: T) : AbstractEvent

Constructors

-
+
- +
Link copied to clipboard
-
constructor(reference: EventReference, data: T)
+
constructor(id: Identifier, reference: EventReference, initiated: UnixTime, data: T)
@@ -98,7 +98,37 @@

Properties

-
val data: T
+
val data: T
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override val id: Identifier
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override val initiated: UnixTime
@@ -113,7 +143,7 @@

Properties

-
val reference: EventReference
+
open override val reference: EventReference
diff --git a/ktor-ws-events-client/dev.d1s.ktor.events.client/-client-web-socket-event/initiated.html b/ktor-ws-events-client/dev.d1s.ktor.events.client/-client-web-socket-event/initiated.html new file mode 100644 index 0000000..037dc72 --- /dev/null +++ b/ktor-ws-events-client/dev.d1s.ktor.events.client/-client-web-socket-event/initiated.html @@ -0,0 +1,76 @@ + + + + + initiated + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
ktor-ws-events-client/dev.d1s.ktor.events.client/ClientWebSocketEvent/initiated
+
+

initiated

+
+
open override val initiated: UnixTime
+
+
+ Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka +
+
+
+
+ + + diff --git a/ktor-ws-events-client/dev.d1s.ktor.events.client/-client-web-socket-event/reference.html b/ktor-ws-events-client/dev.d1s.ktor.events.client/-client-web-socket-event/reference.html index 0b0abf5..cafea7e 100644 --- a/ktor-ws-events-client/dev.d1s.ktor.events.client/-client-web-socket-event/reference.html +++ b/ktor-ws-events-client/dev.d1s.ktor.events.client/-client-web-socket-event/reference.html @@ -41,7 +41,7 @@ ktor-ws-events
-
1.1.1 +
2.0.0
@@ -63,7 +63,7 @@

reference

-
val reference: EventReference
+
open override val reference: EventReference
Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka diff --git a/ktor-ws-events-server/dev.d1s.ktor.events.server/-web-socket-event-channel.html b/ktor-ws-events-client/dev.d1s.ktor.events.client/-event-receiver-log.html similarity index 75% rename from ktor-ws-events-server/dev.d1s.ktor.events.server/-web-socket-event-channel.html rename to ktor-ws-events-client/dev.d1s.ktor.events.client/-event-receiver-log.html index bc23666..66285b7 100644 --- a/ktor-ws-events-server/dev.d1s.ktor.events.server/-web-socket-event-channel.html +++ b/ktor-ws-events-client/dev.d1s.ktor.events.client/-event-receiver-log.html @@ -2,7 +2,7 @@ - WebSocketEventChannel + EventReceiverLog + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
ktor-ws-events-client/dev.d1s.ktor.events.client/EventReceivingScope
+
+

EventReceivingScope

+
+
val EventReceivingScope: CoroutineScope
+
+
+ Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka +
+
+
+
+ + + diff --git a/ktor-ws-events-client/dev.d1s.ktor.events.client/-web-socket-events-configuration/-web-socket-events-configuration.html b/ktor-ws-events-client/dev.d1s.ktor.events.client/-web-socket-events-configuration/-web-socket-events-configuration.html index 2ac385d..fdec2e6 100644 --- a/ktor-ws-events-client/dev.d1s.ktor.events.client/-web-socket-events-configuration/-web-socket-events-configuration.html +++ b/ktor-ws-events-client/dev.d1s.ktor.events.client/-web-socket-events-configuration/-web-socket-events-configuration.html @@ -41,7 +41,7 @@ ktor-ws-events
-
1.1.1 +
2.0.0
diff --git a/ktor-ws-events-client/dev.d1s.ktor.events.client/-web-socket-events-configuration/client-id.html b/ktor-ws-events-client/dev.d1s.ktor.events.client/-web-socket-events-configuration/client-id.html new file mode 100644 index 0000000..578c160 --- /dev/null +++ b/ktor-ws-events-client/dev.d1s.ktor.events.client/-web-socket-events-configuration/client-id.html @@ -0,0 +1,76 @@ + + + + + clientId + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
ktor-ws-events-client/dev.d1s.ktor.events.client/WebSocketEventsConfiguration/clientId
+
+

clientId

+
+
var clientId: String
+
+
+ Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka +
+
+
+
+ + + diff --git a/ktor-ws-events-client/dev.d1s.ktor.events.client/-web-socket-events-configuration/index.html b/ktor-ws-events-client/dev.d1s.ktor.events.client/-web-socket-events-configuration/index.html index 0674385..799ae26 100644 --- a/ktor-ws-events-client/dev.d1s.ktor.events.client/-web-socket-events-configuration/index.html +++ b/ktor-ws-events-client/dev.d1s.ktor.events.client/-web-socket-events-configuration/index.html @@ -41,7 +41,7 @@ ktor-ws-events
-
1.1.1 +
2.0.0
@@ -88,7 +88,22 @@

Constructors

Properties

-
+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
var clientId: String
+
+
+
+
+
@@ -98,7 +113,7 @@

Properties

-
var url: String?
+
var url: String?
diff --git a/ktor-ws-events-client/dev.d1s.ktor.events.client/-web-socket-events-configuration/url.html b/ktor-ws-events-client/dev.d1s.ktor.events.client/-web-socket-events-configuration/url.html index d28e773..a4888d5 100644 --- a/ktor-ws-events-client/dev.d1s.ktor.events.client/-web-socket-events-configuration/url.html +++ b/ktor-ws-events-client/dev.d1s.ktor.events.client/-web-socket-events-configuration/url.html @@ -41,7 +41,7 @@ ktor-ws-events
-
1.1.1 +
2.0.0
@@ -63,7 +63,7 @@

url

-
var url: String?
+
var url: String?
Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka diff --git a/ktor-ws-events-client/dev.d1s.ktor.events.client/-web-socket-events.html b/ktor-ws-events-client/dev.d1s.ktor.events.client/-web-socket-events.html index 2deca6c..f27ce53 100644 --- a/ktor-ws-events-client/dev.d1s.ktor.events.client/-web-socket-events.html +++ b/ktor-ws-events-client/dev.d1s.ktor.events.client/-web-socket-events.html @@ -41,7 +41,7 @@ ktor-ws-events
-
1.1.1 +
2.0.0
@@ -63,7 +63,7 @@

WebSocketEvents

-
val WebSocketEvents: ClientPlugin<WebSocketEventsConfiguration>
+
val WebSocketEvents: ClientPlugin<WebSocketEventsConfiguration>
Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka diff --git a/ktor-ws-events-client/dev.d1s.ktor.events.client/index.html b/ktor-ws-events-client/dev.d1s.ktor.events.client/index.html index 315fec9..8e0ee57 100644 --- a/ktor-ws-events-client/dev.d1s.ktor.events.client/index.html +++ b/ktor-ws-events-client/dev.d1s.ktor.events.client/index.html @@ -41,7 +41,7 @@ ktor-ws-events
-
1.1.1 +
2.0.0
@@ -79,7 +79,7 @@

Types

-
@Serializable
data class ClientWebSocketEvent<T>(val reference: EventReference, val data: T)
+
@Serializable
data class ClientWebSocketEvent<T>(val id: Identifier, val reference: EventReference, val initiated: UnixTime, val data: T) : AbstractEvent
@@ -103,7 +103,37 @@

Types

Properties

-
+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val EventReceiverLog: KmLog
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
val EventReceivingScope: CoroutineScope
+
+
+
+
+
@@ -113,14 +143,14 @@

Properties

-
+

Functions

@@ -132,7 +162,22 @@

Functions

-
inline suspend fun <T> DefaultClientWebSocketSession.receiveWebSocketEvent(): ClientWebSocketEvent<T>

Dequeues a frame containing ClientWebSocketEvent and tries to deserialize it.

+
inline suspend fun <T> DefaultClientWebSocketSession.receiveWebSocketEvent(): ClientWebSocketEvent<T>

Dequeues a frame containing ClientWebSocketEvent and tries to deserialize it.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
inline suspend fun <T> DefaultClientWebSocketSession.receiveWebSocketEvents(crossinline receiver: suspend (ClientWebSocketEvent<T>) -> Unit): Job

Dequeues frames containing ClientWebSocketEvent and tries to deserialize it. Will retry if something went wrong while receiving a frame.

@@ -147,7 +192,22 @@

Functions

-
suspend fun HttpClient.webSocketEvents(reference: EventReference, path: String = makeDefaultEventsRoute(reference.group), block: suspend DefaultClientWebSocketSession.() -> Unit)

Opens a block with DefaultClientWebSocketSession associated with the given event reference and optional path.

+
suspend fun HttpClient.webSocketEvents(reference: EventReference, path: String = Routes.DEFAULT_EVENTS_ROUTE, block: suspend DefaultClientWebSocketSession.() -> Unit)

Opens a block with DefaultClientWebSocketSession associated with the given event reference and optional path.

+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
suspend fun <R> withRetries(continuous: Boolean = false, onError: suspend (Throwable) -> Unit = {}, block: suspend () -> R)
diff --git a/ktor-ws-events-client/dev.d1s.ktor.events.client/receive-web-socket-event.html b/ktor-ws-events-client/dev.d1s.ktor.events.client/receive-web-socket-event.html index 8ab084f..bf042b3 100644 --- a/ktor-ws-events-client/dev.d1s.ktor.events.client/receive-web-socket-event.html +++ b/ktor-ws-events-client/dev.d1s.ktor.events.client/receive-web-socket-event.html @@ -41,7 +41,7 @@ ktor-ws-events
-
1.1.1 +
2.0.0
@@ -63,7 +63,7 @@

receiveWebSocketEvent

-
inline suspend fun <T> DefaultClientWebSocketSession.receiveWebSocketEvent(): ClientWebSocketEvent<T>

Dequeues a frame containing ClientWebSocketEvent and tries to deserialize it.

See also

+
inline suspend fun <T> DefaultClientWebSocketSession.receiveWebSocketEvent(): ClientWebSocketEvent<T>

Dequeues a frame containing ClientWebSocketEvent and tries to deserialize it.

See also

Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka diff --git a/ktor-ws-events-server/dev.d1s.ktor.events.server/web-socket-events.html b/ktor-ws-events-client/dev.d1s.ktor.events.client/receive-web-socket-events.html similarity index 52% rename from ktor-ws-events-server/dev.d1s.ktor.events.server/web-socket-events.html rename to ktor-ws-events-client/dev.d1s.ktor.events.client/receive-web-socket-events.html index 9bc12b5..d7b83f3 100644 --- a/ktor-ws-events-server/dev.d1s.ktor.events.server/web-socket-events.html +++ b/ktor-ws-events-client/dev.d1s.ktor.events.client/receive-web-socket-events.html @@ -2,7 +2,7 @@ - webSocketEvents + receiveWebSocketEvents + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
ktor-ws-events-client/dev.d1s.ktor.events.client/withRetries
+
+

withRetries

+
+
suspend fun <R> withRetries(continuous: Boolean = false, onError: suspend (Throwable) -> Unit = {}, block: suspend () -> R)
+
+
+ Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka +
+
+
+
+ + + diff --git a/ktor-ws-events-client/index.html b/ktor-ws-events-client/index.html index 02ce029..3295c8d 100644 --- a/ktor-ws-events-client/index.html +++ b/ktor-ws-events-client/index.html @@ -41,7 +41,7 @@ ktor-ws-events
-
1.1.1 +
2.0.0
diff --git a/ktor-ws-events-client/navigation.html b/ktor-ws-events-client/navigation.html index d676748..f8cf8f8 100644 --- a/ktor-ws-events-client/navigation.html +++ b/ktor-ws-events-client/navigation.html @@ -12,26 +12,46 @@ ClientWebSocketEvent
-
+ + + -
+ + -
@@ -42,31 +62,51 @@
dev.d1s.ktor.events.commons
-
+
+
+ AbstractEvent +
+
+ -
+ -
+ -
+ -
+
+
+ Identifier +
+
+
+
+ randomId +
+
+ +
+
+ UnixTime +
+
@@ -87,49 +127,64 @@
dev.d1s.ktor.events.server
-
+ -
+ -
+
+
+
+ dev.d1s.ktor.events.server.entity +
+ -
+ -
+ -
+ -
+
+
+
+ dev.d1s.ktor.events.server.pool +
+ -
+ -
+
+ diff --git a/ktor-ws-events-commons/dev.d1s.ktor.events.commons.util/-routes/-c-l-i-e-n-t_-i-d_-h-e-a-d-e-r.html b/ktor-ws-events-commons/dev.d1s.ktor.events.commons.util/-routes/-c-l-i-e-n-t_-i-d_-h-e-a-d-e-r.html new file mode 100644 index 0000000..a9714cf --- /dev/null +++ b/ktor-ws-events-commons/dev.d1s.ktor.events.commons.util/-routes/-c-l-i-e-n-t_-i-d_-h-e-a-d-e-r.html @@ -0,0 +1,76 @@ + + + + + CLIENT_ID_HEADER + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
ktor-ws-events-commons/dev.d1s.ktor.events.commons.util/Routes/CLIENT_ID_HEADER
+
+

CLIENT_ID_HEADER

+
+
const val CLIENT_ID_HEADER: String
+
+
+ Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka +
+
+
+
+ + + diff --git a/ktor-ws-events-commons/dev.d1s.ktor.events.commons.util/-routes/-d-e-f-a-u-l-t_-e-v-e-n-t-s_-r-o-u-t-e.html b/ktor-ws-events-commons/dev.d1s.ktor.events.commons.util/-routes/-d-e-f-a-u-l-t_-e-v-e-n-t-s_-r-o-u-t-e.html index 81e32f6..6ab1417 100644 --- a/ktor-ws-events-commons/dev.d1s.ktor.events.commons.util/-routes/-d-e-f-a-u-l-t_-e-v-e-n-t-s_-r-o-u-t-e.html +++ b/ktor-ws-events-commons/dev.d1s.ktor.events.commons.util/-routes/-d-e-f-a-u-l-t_-e-v-e-n-t-s_-r-o-u-t-e.html @@ -41,7 +41,7 @@ ktor-ws-events
-
1.1.1 +
2.0.0
diff --git a/ktor-ws-events-commons/dev.d1s.ktor.events.commons.util/-routes/-g-r-o-u-p_-p-a-t-h_-p-a-r-a-m-e-t-e-r.html b/ktor-ws-events-commons/dev.d1s.ktor.events.commons.util/-routes/-g-r-o-u-p_-p-a-t-h_-p-a-r-a-m-e-t-e-r.html index cc7c199..ee20bbc 100644 --- a/ktor-ws-events-commons/dev.d1s.ktor.events.commons.util/-routes/-g-r-o-u-p_-p-a-t-h_-p-a-r-a-m-e-t-e-r.html +++ b/ktor-ws-events-commons/dev.d1s.ktor.events.commons.util/-routes/-g-r-o-u-p_-p-a-t-h_-p-a-r-a-m-e-t-e-r.html @@ -41,7 +41,7 @@ ktor-ws-events
-
1.1.1 +
2.0.0
diff --git a/ktor-ws-events-commons/dev.d1s.ktor.events.commons.util/-routes/-g-r-o-u-p_-s-e-g-m-e-n-t_-p-l-a-c-e-h-o-l-d-e-r.html b/ktor-ws-events-commons/dev.d1s.ktor.events.commons.util/-routes/-g-r-o-u-p_-s-e-g-m-e-n-t_-p-l-a-c-e-h-o-l-d-e-r.html index 26e74e2..311cfdc 100644 --- a/ktor-ws-events-commons/dev.d1s.ktor.events.commons.util/-routes/-g-r-o-u-p_-s-e-g-m-e-n-t_-p-l-a-c-e-h-o-l-d-e-r.html +++ b/ktor-ws-events-commons/dev.d1s.ktor.events.commons.util/-routes/-g-r-o-u-p_-s-e-g-m-e-n-t_-p-l-a-c-e-h-o-l-d-e-r.html @@ -41,7 +41,7 @@ ktor-ws-events
-
1.1.1 +
2.0.0
diff --git a/ktor-ws-events-commons/dev.d1s.ktor.events.commons.util/-routes/-p-r-i-n-c-i-p-a-l_-q-u-e-r-y_-p-a-r-a-m-e-t-e-r.html b/ktor-ws-events-commons/dev.d1s.ktor.events.commons.util/-routes/-p-r-i-n-c-i-p-a-l_-q-u-e-r-y_-p-a-r-a-m-e-t-e-r.html index 0a0aa71..d8b0ce7 100644 --- a/ktor-ws-events-commons/dev.d1s.ktor.events.commons.util/-routes/-p-r-i-n-c-i-p-a-l_-q-u-e-r-y_-p-a-r-a-m-e-t-e-r.html +++ b/ktor-ws-events-commons/dev.d1s.ktor.events.commons.util/-routes/-p-r-i-n-c-i-p-a-l_-q-u-e-r-y_-p-a-r-a-m-e-t-e-r.html @@ -41,7 +41,7 @@ ktor-ws-events
-
1.1.1 +
2.0.0
diff --git a/ktor-ws-events-commons/dev.d1s.ktor.events.commons.util/-routes/index.html b/ktor-ws-events-commons/dev.d1s.ktor.events.commons.util/-routes/index.html index c521684..787d739 100644 --- a/ktor-ws-events-commons/dev.d1s.ktor.events.commons.util/-routes/index.html +++ b/ktor-ws-events-commons/dev.d1s.ktor.events.commons.util/-routes/index.html @@ -41,7 +41,7 @@ ktor-ws-events
-
1.1.1 +
2.0.0
@@ -69,7 +69,22 @@

Routes

Properties

-
+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
const val CLIENT_ID_HEADER: String
+
+
+
+
+
diff --git a/ktor-ws-events-commons/dev.d1s.ktor.events.commons.util/index.html b/ktor-ws-events-commons/dev.d1s.ktor.events.commons.util/index.html index eeaffb2..7b80897 100644 --- a/ktor-ws-events-commons/dev.d1s.ktor.events.commons.util/index.html +++ b/ktor-ws-events-commons/dev.d1s.ktor.events.commons.util/index.html @@ -41,7 +41,7 @@ ktor-ws-events
-
1.1.1 +
2.0.0
diff --git a/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-abstract-event/id.html b/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-abstract-event/id.html new file mode 100644 index 0000000..8ebf738 --- /dev/null +++ b/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-abstract-event/id.html @@ -0,0 +1,76 @@ + + + + + id + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
ktor-ws-events-commons/dev.d1s.ktor.events.commons/AbstractEvent/id
+
+

id

+
+
abstract val id: Identifier
+
+
+ Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka +
+
+
+
+ + + diff --git a/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-abstract-event/index.html b/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-abstract-event/index.html new file mode 100644 index 0000000..8df7a9a --- /dev/null +++ b/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-abstract-event/index.html @@ -0,0 +1,130 @@ + + + + + AbstractEvent + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
ktor-ws-events-commons/dev.d1s.ktor.events.commons/AbstractEvent
+
+

AbstractEvent

+
interface AbstractEvent
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
abstract val id: Identifier
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
abstract val initiated: UnixTime
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
abstract val reference: EventReference
+
+
+
+
+
+
+
+
+
+
+ Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka +
+
+
+
+ + + diff --git a/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-abstract-event/initiated.html b/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-abstract-event/initiated.html new file mode 100644 index 0000000..b692920 --- /dev/null +++ b/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-abstract-event/initiated.html @@ -0,0 +1,76 @@ + + + + + initiated + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
ktor-ws-events-commons/dev.d1s.ktor.events.commons/AbstractEvent/initiated
+
+

initiated

+
+
abstract val initiated: UnixTime
+
+
+ Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka +
+
+
+
+ + + diff --git a/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-abstract-event/reference.html b/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-abstract-event/reference.html new file mode 100644 index 0000000..06b263e --- /dev/null +++ b/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-abstract-event/reference.html @@ -0,0 +1,76 @@ + + + + + reference + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
ktor-ws-events-commons/dev.d1s.ktor.events.commons/AbstractEvent/reference
+
+

reference

+
+
abstract val reference: EventReference
+
+
+ Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka +
+
+
+
+ + + diff --git a/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-client-parameters/index.html b/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-client-parameters/index.html index e3ca28f..fd20e64 100644 --- a/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-client-parameters/index.html +++ b/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-client-parameters/index.html @@ -41,7 +41,7 @@ ktor-ws-events
-
1.1.1 +
2.0.0
@@ -62,7 +62,7 @@
ktor-ws-events-commons/dev.d1s.ktor.events.commons/ClientParameters

ClientParameters

-
typealias ClientParameters = Map<String, String>

Client parameters passed to the server. The parameters are only scoped to the connection. When firing an event, server can handle them.

+
typealias ClientParameters = Map<String, String>

Client parameters passed to the server. The parameters are only scoped to the connection. When firing an event, server can handle them.

diff --git a/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-event-group/index.html b/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-event-group/index.html index e82c8eb..e355e8b 100644 --- a/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-event-group/index.html +++ b/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-event-group/index.html @@ -41,7 +41,7 @@ ktor-ws-events
-
1.1.1 +
2.0.0
diff --git a/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-event-principal/index.html b/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-event-principal/index.html index dea4c50..7e4b046 100644 --- a/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-event-principal/index.html +++ b/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-event-principal/index.html @@ -41,7 +41,7 @@ ktor-ws-events
-
1.1.1 +
2.0.0
diff --git a/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-event-reference/-event-reference.html b/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-event-reference/-event-reference.html index 0cec46e..417d5b3 100644 --- a/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-event-reference/-event-reference.html +++ b/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-event-reference/-event-reference.html @@ -41,7 +41,7 @@ ktor-ws-events
-
1.1.1 +
2.0.0
diff --git a/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-event-reference/equals.html b/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-event-reference/equals.html index ec577eb..1e9fe63 100644 --- a/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-event-reference/equals.html +++ b/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-event-reference/equals.html @@ -41,7 +41,7 @@ ktor-ws-events
-
1.1.1 +
2.0.0
diff --git a/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-event-reference/group.html b/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-event-reference/group.html index 2e13006..d1788be 100644 --- a/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-event-reference/group.html +++ b/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-event-reference/group.html @@ -41,7 +41,7 @@ ktor-ws-events
-
1.1.1 +
2.0.0
@@ -63,7 +63,7 @@

group

-
val group: EventGroup
+
val group: EventGroup
Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka diff --git a/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-event-reference/hash-code.html b/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-event-reference/hash-code.html index 8338c19..a2989cb 100644 --- a/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-event-reference/hash-code.html +++ b/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-event-reference/hash-code.html @@ -41,7 +41,7 @@ ktor-ws-events
-
1.1.1 +
2.0.0
diff --git a/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-event-reference/index.html b/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-event-reference/index.html index bba5c6f..f3db5a0 100644 --- a/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-event-reference/index.html +++ b/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-event-reference/index.html @@ -41,7 +41,7 @@ ktor-ws-events
-
1.1.1 +
2.0.0
@@ -98,7 +98,7 @@

Properties

@@ -113,7 +113,7 @@

Properties

@@ -128,7 +128,7 @@

Properties

-
val principal: EventPrincipal = null
+
val principal: EventPrincipal = null
diff --git a/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-event-reference/parameters.html b/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-event-reference/parameters.html index f98b74c..0fdc41b 100644 --- a/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-event-reference/parameters.html +++ b/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-event-reference/parameters.html @@ -41,7 +41,7 @@ ktor-ws-events
-
1.1.1 +
2.0.0
@@ -63,7 +63,7 @@

parameters

-
val parameters: ClientParameters
+
val parameters: ClientParameters
Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka diff --git a/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-event-reference/principal.html b/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-event-reference/principal.html index 7c911b1..87fe85a 100644 --- a/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-event-reference/principal.html +++ b/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-event-reference/principal.html @@ -41,7 +41,7 @@ ktor-ws-events
-
1.1.1 +
2.0.0
@@ -63,7 +63,7 @@

principal

-
val principal: EventPrincipal = null
+
val principal: EventPrincipal = null
Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka diff --git a/ktor-ws-events-server/dev.d1s.ktor.events.server/-web-socket-event-sender/index.html b/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-identifier/index.html similarity index 75% rename from ktor-ws-events-server/dev.d1s.ktor.events.server/-web-socket-event-sender/index.html rename to ktor-ws-events-commons/dev.d1s.ktor.events.commons/-identifier/index.html index bd47803..c6b8daf 100644 --- a/ktor-ws-events-server/dev.d1s.ktor.events.server/-web-socket-event-sender/index.html +++ b/ktor-ws-events-commons/dev.d1s.ktor.events.commons/-identifier/index.html @@ -2,7 +2,7 @@ - WebSocketEventSender + Identifier + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
ktor-ws-events-commons/dev.d1s.ktor.events.commons/UnixTime
+
+

UnixTime

+
typealias UnixTime = Long
+
+
+
+
+
+
+
+ Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka +
+
+
+
+ + + diff --git a/ktor-ws-events-commons/dev.d1s.ktor.events.commons/index.html b/ktor-ws-events-commons/dev.d1s.ktor.events.commons/index.html index dff492d..7344eca 100644 --- a/ktor-ws-events-commons/dev.d1s.ktor.events.commons/index.html +++ b/ktor-ws-events-commons/dev.d1s.ktor.events.commons/index.html @@ -41,7 +41,7 @@ ktor-ws-events
-
1.1.1 +
2.0.0
@@ -65,11 +65,26 @@

Package-level declaratio

A module with common code of Ktor WS Events project - Event delivery extensions for Ktor (Server/Client) over WebSocket protocol.

-
+

Types

-
+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
interface AbstractEvent
+
+
+
+
+
@@ -79,7 +94,7 @@

Types

-
typealias ClientParameters = Map<String, String>

Client parameters passed to the server. The parameters are only scoped to the connection. When firing an event, server can handle them.

+
typealias ClientParameters = Map<String, String>

Client parameters passed to the server. The parameters are only scoped to the connection. When firing an event, server can handle them.

@@ -129,6 +144,55 @@

Types

+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
typealias Identifier = String
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
typealias UnixTime = Long
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
val randomId: Identifier
+
+
+
+
@@ -143,7 +207,7 @@

Functions

-
fun ref(group: EventGroup, principal: EventPrincipal = null, clientParameters: ClientParameters = mapOf()): EventReference

A shortcut. Returns EventReference(group, principal, parameters)

+
fun ref(group: EventGroup, principal: EventPrincipal = null, clientParameters: ClientParameters = mapOf()): EventReference

A shortcut.

diff --git a/ktor-ws-events-commons/dev.d1s.ktor.events.commons/random-id.html b/ktor-ws-events-commons/dev.d1s.ktor.events.commons/random-id.html new file mode 100644 index 0000000..3c23ed2 --- /dev/null +++ b/ktor-ws-events-commons/dev.d1s.ktor.events.commons/random-id.html @@ -0,0 +1,76 @@ + + + + + randomId + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
ktor-ws-events-commons/dev.d1s.ktor.events.commons/randomId
+
+

randomId

+
+
val randomId: Identifier
+
+
+ Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka +
+
+
+
+ + + diff --git a/ktor-ws-events-commons/dev.d1s.ktor.events.commons/ref.html b/ktor-ws-events-commons/dev.d1s.ktor.events.commons/ref.html index 91b3df6..ecd61b7 100644 --- a/ktor-ws-events-commons/dev.d1s.ktor.events.commons/ref.html +++ b/ktor-ws-events-commons/dev.d1s.ktor.events.commons/ref.html @@ -41,7 +41,7 @@ ktor-ws-events
-
1.1.1 +
2.0.0
@@ -63,7 +63,7 @@

ref

-
fun ref(group: EventGroup, principal: EventPrincipal = null, clientParameters: ClientParameters = mapOf()): EventReference

A shortcut. Returns EventReference(group, principal, parameters)

See also

+
fun ref(group: EventGroup, principal: EventPrincipal = null, clientParameters: ClientParameters = mapOf()): EventReference

A shortcut.

See also

Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka diff --git a/ktor-ws-events-commons/index.html b/ktor-ws-events-commons/index.html index 9125a88..a0df549 100644 --- a/ktor-ws-events-commons/index.html +++ b/ktor-ws-events-commons/index.html @@ -41,7 +41,7 @@ ktor-ws-events
-
1.1.1 +
2.0.0
diff --git a/ktor-ws-events-commons/navigation.html b/ktor-ws-events-commons/navigation.html index d676748..f8cf8f8 100644 --- a/ktor-ws-events-commons/navigation.html +++ b/ktor-ws-events-commons/navigation.html @@ -12,26 +12,46 @@ ClientWebSocketEvent
-
+ + + -
+ + -
@@ -42,31 +62,51 @@
dev.d1s.ktor.events.commons
-
+
+
+ AbstractEvent +
+
+ -
+ -
+ -
+ -
+
+
+ Identifier +
+
+
+
+ randomId +
+
+ +
+
+ UnixTime +
+
@@ -87,49 +127,64 @@
dev.d1s.ktor.events.server
-
+ -
+ -
+
+
+
+ dev.d1s.ktor.events.server.entity +
+ -
+ -
+ -
+ -
+
+
+
+ dev.d1s.ktor.events.server.pool +
+ -
+ -
+
+ diff --git a/ktor-ws-events-server/dev.d1s.ktor.events.server/-event-data-supplier/index.html b/ktor-ws-events-server/dev.d1s.ktor.events.server.entity/-event-data-supplier/index.html similarity index 86% rename from ktor-ws-events-server/dev.d1s.ktor.events.server/-event-data-supplier/index.html rename to ktor-ws-events-server/dev.d1s.ktor.events.server.entity/-event-data-supplier/index.html index 98ba546..ba3275e 100644 --- a/ktor-ws-events-server/dev.d1s.ktor.events.server/-event-data-supplier/index.html +++ b/ktor-ws-events-server/dev.d1s.ktor.events.server.entity/-event-data-supplier/index.html @@ -41,7 +41,7 @@ ktor-ws-events
-
1.1.1 +
2.0.0
@@ -58,11 +58,11 @@
-
-
ktor-ws-events-server/dev.d1s.ktor.events.server/EventDataSupplier
+
+
ktor-ws-events-server/dev.d1s.ktor.events.server.entity/EventDataSupplier

EventDataSupplier

-
typealias EventDataSupplier = suspend (ClientParameters) -> Any
+
typealias EventDataSupplier = suspend (ClientParameters) -> Any
diff --git a/ktor-ws-events-server/dev.d1s.ktor.events.server/-server-web-socket-event/-server-web-socket-event.html b/ktor-ws-events-server/dev.d1s.ktor.events.server.entity/-event-sending-connection/-event-sending-connection.html similarity index 78% rename from ktor-ws-events-server/dev.d1s.ktor.events.server/-server-web-socket-event/-server-web-socket-event.html rename to ktor-ws-events-server/dev.d1s.ktor.events.server.entity/-event-sending-connection/-event-sending-connection.html index 9f4176f..7fded15 100644 --- a/ktor-ws-events-server/dev.d1s.ktor.events.server/-server-web-socket-event/-server-web-socket-event.html +++ b/ktor-ws-events-server/dev.d1s.ktor.events.server.entity/-event-sending-connection/-event-sending-connection.html @@ -2,7 +2,7 @@ - ServerWebSocketEvent + EventSendingConnection + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
ktor-ws-events-server/dev.d1s.ktor.events.server.entity/ServerWebSocketEvent/ServerWebSocketEvent
+
+

ServerWebSocketEvent

+
+
constructor(id: Identifier = randomId, reference: EventReference, initiated: UnixTime = Instant.now().toEpochMilli(), acceptedByClients: List<Identifier> = listOf(), dataSupplier: EventDataSupplier)
+
+
+ Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka +
+
+
+
+ + + diff --git a/ktor-ws-events-server/dev.d1s.ktor.events.server.entity/-server-web-socket-event/id.html b/ktor-ws-events-server/dev.d1s.ktor.events.server.entity/-server-web-socket-event/id.html new file mode 100644 index 0000000..442204f --- /dev/null +++ b/ktor-ws-events-server/dev.d1s.ktor.events.server.entity/-server-web-socket-event/id.html @@ -0,0 +1,76 @@ + + + + + id + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
ktor-ws-events-server/dev.d1s.ktor.events.server.entity/ServerWebSocketEvent/id
+
+

id

+
+
open override val id: Identifier
+
+
+ Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka +
+
+
+
+ + + diff --git a/ktor-ws-events-server/dev.d1s.ktor.events.server.entity/-server-web-socket-event/index.html b/ktor-ws-events-server/dev.d1s.ktor.events.server.entity/-server-web-socket-event/index.html new file mode 100644 index 0000000..6038c70 --- /dev/null +++ b/ktor-ws-events-server/dev.d1s.ktor.events.server.entity/-server-web-socket-event/index.html @@ -0,0 +1,149 @@ + + + + + ServerWebSocketEvent + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
ktor-ws-events-server/dev.d1s.ktor.events.server.entity/ServerWebSocketEvent
+
+

ServerWebSocketEvent

+
data class ServerWebSocketEvent(val id: Identifier = randomId, val reference: EventReference, val initiated: UnixTime = Instant.now().toEpochMilli(), acceptedByClients: List<Identifier> = listOf(), dataSupplier: EventDataSupplier) : AbstractEvent

Example usage:

val reference = ref("book_created")
val createdBook: Book = createBook()

val event = event(reference) { _ ->
    createdBook
}
Content copied to clipboard

See also

+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(id: Identifier = randomId, reference: EventReference, initiated: UnixTime = Instant.now().toEpochMilli(), acceptedByClients: List<Identifier> = listOf(), dataSupplier: EventDataSupplier)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override val id: Identifier
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override val initiated: UnixTime
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override val reference: EventReference
+
+
+
+
+
+
+
+
+
+
+ Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka +
+
+
+
+ + + diff --git a/ktor-ws-events-server/dev.d1s.ktor.events.server.entity/-server-web-socket-event/initiated.html b/ktor-ws-events-server/dev.d1s.ktor.events.server.entity/-server-web-socket-event/initiated.html new file mode 100644 index 0000000..e9caf46 --- /dev/null +++ b/ktor-ws-events-server/dev.d1s.ktor.events.server.entity/-server-web-socket-event/initiated.html @@ -0,0 +1,76 @@ + + + + + initiated + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
ktor-ws-events-server/dev.d1s.ktor.events.server.entity/ServerWebSocketEvent/initiated
+
+

initiated

+
+
open override val initiated: UnixTime
+
+
+ Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka +
+
+
+
+ + + diff --git a/ktor-ws-events-server/dev.d1s.ktor.events.server.entity/-server-web-socket-event/reference.html b/ktor-ws-events-server/dev.d1s.ktor.events.server.entity/-server-web-socket-event/reference.html new file mode 100644 index 0000000..5a6f036 --- /dev/null +++ b/ktor-ws-events-server/dev.d1s.ktor.events.server.entity/-server-web-socket-event/reference.html @@ -0,0 +1,76 @@ + + + + + reference + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
ktor-ws-events-server/dev.d1s.ktor.events.server.entity/ServerWebSocketEvent/reference
+
+

reference

+
+
open override val reference: EventReference
+
+
+ Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka +
+
+
+
+ + + diff --git a/ktor-ws-events-server/dev.d1s.ktor.events.server/event.html b/ktor-ws-events-server/dev.d1s.ktor.events.server.entity/event.html similarity index 70% rename from ktor-ws-events-server/dev.d1s.ktor.events.server/event.html rename to ktor-ws-events-server/dev.d1s.ktor.events.server.entity/event.html index 3e3aa6d..6313eb1 100644 --- a/ktor-ws-events-server/dev.d1s.ktor.events.server/event.html +++ b/ktor-ws-events-server/dev.d1s.ktor.events.server.entity/event.html @@ -41,7 +41,7 @@ ktor-ws-events
-
1.1.1 +
2.0.0
@@ -58,12 +58,12 @@
-
-
ktor-ws-events-server/dev.d1s.ktor.events.server/event
+
+
ktor-ws-events-server/dev.d1s.ktor.events.server.entity/event

event

-
fun event(reference: EventReference, dataSupplier: EventDataSupplier): ServerWebSocketEvent

A shortcut. Returns ServerWebSocketEvent(reference, data)

See also

+
fun event(reference: EventReference, dataSupplier: EventDataSupplier): ServerWebSocketEvent

A shortcut. Returns ServerWebSocketEvent(reference, data) currently initiated.

See also

Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka diff --git a/ktor-ws-events-server/dev.d1s.ktor.events.server.entity/index.html b/ktor-ws-events-server/dev.d1s.ktor.events.server.entity/index.html new file mode 100644 index 0000000..1fe8f51 --- /dev/null +++ b/ktor-ws-events-server/dev.d1s.ktor.events.server.entity/index.html @@ -0,0 +1,148 @@ + + + + + dev.d1s.ktor.events.server.entity + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
ktor-ws-events-server/dev.d1s.ktor.events.server.entity
+
+

Package-level declarations

+
+
+
+
+
+

Types

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
typealias EventDataSupplier = suspend (ClientParameters) -> Any
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
data class EventSendingConnection(val reference: EventReference, val session: DefaultWebSocketSession, val call: ApplicationCall)
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
data class ServerWebSocketEvent(val id: Identifier = randomId, val reference: EventReference, val initiated: UnixTime = Instant.now().toEpochMilli(), acceptedByClients: List<Identifier> = listOf(), dataSupplier: EventDataSupplier) : AbstractEvent

Example usage:

+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun event(reference: EventReference, dataSupplier: EventDataSupplier): ServerWebSocketEvent

A shortcut. Returns ServerWebSocketEvent(reference, data) currently initiated.

+
+
+
+
+
+
+
+
+
+
+ Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka +
+
+
+
+ + + diff --git a/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-event-pool/confirm.html b/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-event-pool/confirm.html new file mode 100644 index 0000000..416022d --- /dev/null +++ b/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-event-pool/confirm.html @@ -0,0 +1,76 @@ + + + + + confirm + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
ktor-ws-events-server/dev.d1s.ktor.events.server.pool/EventPool/confirm
+
+

confirm

+
+
abstract fun confirm(event: Identifier, client: Identifier)
+
+
+ Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka +
+
+
+
+ + + diff --git a/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-event-pool/get.html b/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-event-pool/get.html new file mode 100644 index 0000000..a6dba3b --- /dev/null +++ b/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-event-pool/get.html @@ -0,0 +1,76 @@ + + + + + get + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
ktor-ws-events-server/dev.d1s.ktor.events.server.pool/EventPool/get
+
+

get

+
+
abstract fun get(reference: EventReference, client: Identifier): List<ServerWebSocketEvent>
+
+
+ Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka +
+
+
+
+ + + diff --git a/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-event-pool/index.html b/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-event-pool/index.html new file mode 100644 index 0000000..1d23d81 --- /dev/null +++ b/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-event-pool/index.html @@ -0,0 +1,164 @@ + + + + + EventPool + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
ktor-ws-events-server/dev.d1s.ktor.events.server.pool/EventPool
+
+

EventPool

+
interface EventPool

Inheritors

+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
abstract val lifetimeMillis: Long
+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
abstract fun confirm(event: Identifier, client: Identifier)
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
abstract fun get(reference: EventReference, client: Identifier): List<ServerWebSocketEvent>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
abstract fun onEvent(reference: EventReference, client: Identifier, handler: suspend (ServerWebSocketEvent) -> Unit)
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
abstract suspend fun push(event: ServerWebSocketEvent)
+
+
+
+
+
+
+
+
+
+
+ Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka +
+
+
+
+ + + diff --git a/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-event-pool/lifetime-millis.html b/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-event-pool/lifetime-millis.html new file mode 100644 index 0000000..aa5238b --- /dev/null +++ b/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-event-pool/lifetime-millis.html @@ -0,0 +1,76 @@ + + + + + lifetimeMillis + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
ktor-ws-events-server/dev.d1s.ktor.events.server.pool/EventPool/lifetimeMillis
+
+

lifetimeMillis

+
+
abstract val lifetimeMillis: Long
+
+
+ Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka +
+
+
+
+ + + diff --git a/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-event-pool/on-event.html b/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-event-pool/on-event.html new file mode 100644 index 0000000..4d56c56 --- /dev/null +++ b/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-event-pool/on-event.html @@ -0,0 +1,76 @@ + + + + + onEvent + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
ktor-ws-events-server/dev.d1s.ktor.events.server.pool/EventPool/onEvent
+
+

onEvent

+
+
abstract fun onEvent(reference: EventReference, client: Identifier, handler: suspend (ServerWebSocketEvent) -> Unit)
+
+
+ Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka +
+
+
+
+ + + diff --git a/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-event-pool/push.html b/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-event-pool/push.html new file mode 100644 index 0000000..a041550 --- /dev/null +++ b/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-event-pool/push.html @@ -0,0 +1,76 @@ + + + + + push + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
ktor-ws-events-server/dev.d1s.ktor.events.server.pool/EventPool/push
+
+

push

+
+
abstract suspend fun push(event: ServerWebSocketEvent)
+
+
+ Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka +
+
+
+
+ + + diff --git a/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-in-memory-event-pool/-in-memory-event-pool.html b/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-in-memory-event-pool/-in-memory-event-pool.html new file mode 100644 index 0000000..f313ae9 --- /dev/null +++ b/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-in-memory-event-pool/-in-memory-event-pool.html @@ -0,0 +1,76 @@ + + + + + InMemoryEventPool + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
ktor-ws-events-server/dev.d1s.ktor.events.server.pool/InMemoryEventPool/InMemoryEventPool
+
+

InMemoryEventPool

+
+
constructor(lifetimeMillis: Long = DEFAULT_LIFETIME)
+
+
+ Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka +
+
+
+
+ + + diff --git a/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-in-memory-event-pool/confirm.html b/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-in-memory-event-pool/confirm.html new file mode 100644 index 0000000..ffbb497 --- /dev/null +++ b/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-in-memory-event-pool/confirm.html @@ -0,0 +1,76 @@ + + + + + confirm + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
ktor-ws-events-server/dev.d1s.ktor.events.server.pool/InMemoryEventPool/confirm
+
+

confirm

+
+
open override fun confirm(event: Identifier, client: Identifier)
+
+
+ Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka +
+
+
+
+ + + diff --git a/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-in-memory-event-pool/get.html b/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-in-memory-event-pool/get.html new file mode 100644 index 0000000..fee0a54 --- /dev/null +++ b/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-in-memory-event-pool/get.html @@ -0,0 +1,76 @@ + + + + + get + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
ktor-ws-events-server/dev.d1s.ktor.events.server.pool/InMemoryEventPool/get
+
+

get

+
+
open override fun get(reference: EventReference, client: Identifier): List<ServerWebSocketEvent>
+
+
+ Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka +
+
+
+
+ + + diff --git a/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-in-memory-event-pool/index.html b/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-in-memory-event-pool/index.html new file mode 100644 index 0000000..4fd0a16 --- /dev/null +++ b/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-in-memory-event-pool/index.html @@ -0,0 +1,183 @@ + + + + + InMemoryEventPool + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
ktor-ws-events-server/dev.d1s.ktor.events.server.pool/InMemoryEventPool
+
+

InMemoryEventPool

+
class InMemoryEventPool(val lifetimeMillis: Long = DEFAULT_LIFETIME) : EventPool
+
+
+
+
+
+

Constructors

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
constructor(lifetimeMillis: Long = DEFAULT_LIFETIME)
+
+
+
+
+
+
+
+

Properties

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override val lifetimeMillis: Long
+
+
+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override fun confirm(event: Identifier, client: Identifier)
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override fun get(reference: EventReference, client: Identifier): List<ServerWebSocketEvent>
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open override fun onEvent(reference: EventReference, client: Identifier, handler: suspend (ServerWebSocketEvent) -> Unit)
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
open suspend override fun push(event: ServerWebSocketEvent)
+
+
+
+
+
+
+
+
+
+
+ Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka +
+
+
+
+ + + diff --git a/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-in-memory-event-pool/lifetime-millis.html b/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-in-memory-event-pool/lifetime-millis.html new file mode 100644 index 0000000..821fd0d --- /dev/null +++ b/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-in-memory-event-pool/lifetime-millis.html @@ -0,0 +1,76 @@ + + + + + lifetimeMillis + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
ktor-ws-events-server/dev.d1s.ktor.events.server.pool/InMemoryEventPool/lifetimeMillis
+
+

lifetimeMillis

+
+
open override val lifetimeMillis: Long
+
+
+ Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka +
+
+
+
+ + + diff --git a/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-in-memory-event-pool/on-event.html b/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-in-memory-event-pool/on-event.html new file mode 100644 index 0000000..1018495 --- /dev/null +++ b/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-in-memory-event-pool/on-event.html @@ -0,0 +1,76 @@ + + + + + onEvent + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
ktor-ws-events-server/dev.d1s.ktor.events.server.pool/InMemoryEventPool/onEvent
+
+

onEvent

+
+
open override fun onEvent(reference: EventReference, client: Identifier, handler: suspend (ServerWebSocketEvent) -> Unit)
+
+
+ Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka +
+
+
+
+ + + diff --git a/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-in-memory-event-pool/push.html b/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-in-memory-event-pool/push.html new file mode 100644 index 0000000..66416a3 --- /dev/null +++ b/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/-in-memory-event-pool/push.html @@ -0,0 +1,76 @@ + + + + + push + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
ktor-ws-events-server/dev.d1s.ktor.events.server.pool/InMemoryEventPool/push
+
+

push

+
+
open suspend override fun push(event: ServerWebSocketEvent)
+
+
+ Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka +
+
+
+
+ + + diff --git a/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/index.html b/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/index.html new file mode 100644 index 0000000..198022f --- /dev/null +++ b/ktor-ws-events-server/dev.d1s.ktor.events.server.pool/index.html @@ -0,0 +1,114 @@ + + + + + dev.d1s.ktor.events.server.pool + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
ktor-ws-events-server/dev.d1s.ktor.events.server.pool
+
+

Package-level declarations

+
+
+
+
+
+

Types

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
interface EventPool
+
+
+
+
+ +
+
+
+ + +
Link copied to clipboard
+
+
+
+
class InMemoryEventPool(val lifetimeMillis: Long = DEFAULT_LIFETIME) : EventPool
+
+
+
+
+
+
+
+
+
+
+ Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka +
+
+
+
+ + + diff --git a/ktor-ws-events-server/dev.d1s.ktor.events.server.route/index.html b/ktor-ws-events-server/dev.d1s.ktor.events.server.route/index.html new file mode 100644 index 0000000..52bd609 --- /dev/null +++ b/ktor-ws-events-server/dev.d1s.ktor.events.server.route/index.html @@ -0,0 +1,99 @@ + + + + + dev.d1s.ktor.events.server.route + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
ktor-ws-events-server/dev.d1s.ktor.events.server.route
+
+

Package-level declarations

+
+
+
+
+
+

Functions

+
+
+
+
+ + +
Link copied to clipboard
+
+
+
+
fun Route.webSocketEvents(route: String = Routes.DEFAULT_EVENTS_ROUTE, preprocess: suspend DefaultWebSocketServerSession.(EventReference) -> Unit = {})

Installs a WebSocket route to your application which is supposed to propagate events to clients. This function is supposed to be called once.

+
+
+
+
+
+
+
+
+
+
+ Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka +
+
+
+
+ + + diff --git a/ktor-ws-events-server/dev.d1s.ktor.events.server.route/web-socket-events.html b/ktor-ws-events-server/dev.d1s.ktor.events.server.route/web-socket-events.html new file mode 100644 index 0000000..04c9578 --- /dev/null +++ b/ktor-ws-events-server/dev.d1s.ktor.events.server.route/web-socket-events.html @@ -0,0 +1,76 @@ + + + + + webSocketEvents + + + + + + + + + + + + + + + + + +
+ +
+ +
+
+
ktor-ws-events-server/dev.d1s.ktor.events.server.route/webSocketEvents
+
+

webSocketEvents

+
+
fun Route.webSocketEvents(route: String = Routes.DEFAULT_EVENTS_ROUTE, preprocess: suspend DefaultWebSocketServerSession.(EventReference) -> Unit = {})

Installs a WebSocket route to your application which is supposed to propagate events to clients. This function is supposed to be called once.

See also

Throws

if the provided route does not container group segment placeholder.

if the application does not have WebSocketEvents plugin installed.

+
+
+ Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka +
+
+
+
+ + + diff --git a/ktor-ws-events-server/dev.d1s.ktor.events.server/-web-socket-event-channel/index.html b/ktor-ws-events-server/dev.d1s.ktor.events.server/-web-socket-event-channel/index.html deleted file mode 100644 index 406406c..0000000 --- a/ktor-ws-events-server/dev.d1s.ktor.events.server/-web-socket-event-channel/index.html +++ /dev/null @@ -1,80 +0,0 @@ - - - - - WebSocketEventChannel - - - - - - - - - - - - - - - - - -
- -
- -
-
-
ktor-ws-events-server/dev.d1s.ktor.events.server/WebSocketEventChannel
-
-

WebSocketEventChannel

-
typealias WebSocketEventChannel = Channel<ServerWebSocketEvent>

See also

-
-
-
-
-
-
-
- Copyright (c) 2022-2023 Mikhail TitovGenerated by dokka -
-
-
-
- - - diff --git a/ktor-ws-events-server/dev.d1s.ktor.events.server/-web-socket-events-configuration/-web-socket-events-configuration.html b/ktor-ws-events-server/dev.d1s.ktor.events.server/-web-socket-events-configuration/-web-socket-events-configuration.html index 811bb91..3185827 100644 --- a/ktor-ws-events-server/dev.d1s.ktor.events.server/-web-socket-events-configuration/-web-socket-events-configuration.html +++ b/ktor-ws-events-server/dev.d1s.ktor.events.server/-web-socket-events-configuration/-web-socket-events-configuration.html @@ -41,7 +41,7 @@ ktor-ws-events
-
1.1.1 +
2.0.0
diff --git a/ktor-ws-events-server/dev.d1s.ktor.events.server/-web-socket-events-configuration/channel.html b/ktor-ws-events-server/dev.d1s.ktor.events.server/-web-socket-events-configuration/event-pool.html similarity index 88% rename from ktor-ws-events-server/dev.d1s.ktor.events.server/-web-socket-events-configuration/channel.html rename to ktor-ws-events-server/dev.d1s.ktor.events.server/-web-socket-events-configuration/event-pool.html index 608980e..d13a181 100644 --- a/ktor-ws-events-server/dev.d1s.ktor.events.server/-web-socket-events-configuration/channel.html +++ b/ktor-ws-events-server/dev.d1s.ktor.events.server/-web-socket-events-configuration/event-pool.html @@ -2,7 +2,7 @@ - channel + eventPool