Compare commits

..

No commits in common. "master" and "0.3.3" have entirely different histories.

47 changed files with 242 additions and 873 deletions

2
.gitignore vendored
View File

@ -5,7 +5,6 @@ build/
!**/src/test/**/build/ !**/src/test/**/build/
### IntelliJ IDEA ### ### IntelliJ IDEA ###
.idea
.idea/modules.xml .idea/modules.xml
.idea/jarRepositories.xml .idea/jarRepositories.xml
.idea/compiler.xml .idea/compiler.xml
@ -44,4 +43,3 @@ out/
# More # More
.kotlin .kotlin
/.idea/workspace.xml /.idea/workspace.xml
/.gigaide/gigaide.properties

2
.idea/misc.xml generated
View File

@ -3,7 +3,7 @@
<component name="FrameworkDetectionExcludesConfiguration"> <component name="FrameworkDetectionExcludesConfiguration">
<file type="web" url="file://$PROJECT_DIR$" /> <file type="web" url="file://$PROJECT_DIR$" />
</component> </component>
<component name="ProjectRootManager" version="2" languageLevel="JDK_17" default="true" project-jdk-name="corretto-17" project-jdk-type="JavaSDK"> <component name="ProjectRootManager" version="2" languageLevel="JDK_17" default="true" project-jdk-name="17 (5)" project-jdk-type="JavaSDK">
<output url="file://$PROJECT_DIR$/out" /> <output url="file://$PROJECT_DIR$/out" />
</component> </component>
</project> </project>

View File

@ -1,7 +1,7 @@
# Kiloparsec # Kiloparsec
__Recommended version is `0.4.1`: to keep the code compatible with current and further versions we __Recommended version is `0.3.3`: to keep the code compatible with current and further versions we
ask to upgrade to `0.4.2` at least.__ Starting from this version some package names are changed for ask to upgrade to `0.3.2` at least.__ Starting from this version some pacakage names are changed for
better clarity and fast UDP endpoints are added. better clarity and fast UDP endpoints are added.
The new generation of __PARanoid SECurity__ protocol, advanced, faster, more secure. It also allows connecting any " The new generation of __PARanoid SECurity__ protocol, advanced, faster, more secure. It also allows connecting any "
@ -9,25 +9,19 @@ block device" transport to the same local interface. Out if the box it
provides the following transports: provides the following transports:
| name | JVM | JS | native | | name | JVM | JS | native |
|-------------------|--------|----|--------| |----------------|--------|----|--------|
| TCP/IP server | ✓ | | 0.2.6+ | | TCP/IP server | ✓ | | 0.2.6+ |
| TCP/IP client | ✓ | | 0.2.6+ | | TCP/IP client | ✓ | | 0.2.6+ |
| UDP server | 0.3.2+ | | 0.3.2+ | | UDP server | 0.3.2+ | | 0.3.2+ |
| UDP client | 0.3.2+ | | 0.3.2+ | | UDP client | 0.3.2+ | | 0.3.2+ |
| Websockets server | ✓ | | | | Websock server | ✓ | | |
| Websockets client | ✓ | ✓ | ✓ | | Websock client | ✓ | ✓ | ✓ |
### Note on version compatibility ### Note on version compatibility
Version 0.5.1 could be backward incompatible due to upgrade of the crypto2.
Protocols >= 0.3.0 are not binary compatible with previous version due to more compact binary Protocols >= 0.3.0 are not binary compatible with previous version due to more compact binary
format. The format from 0.3.0 onwards is supposed to keep compatible. format. The format from 0.3.0 onwards is supposed to keep compatible.
#### ID calculation algorithm is changed since 0.4.1
We recommend to upgrade to 0.4+ ASAP as public/shared key id derivation method was changed for even higher security.
### Supported native targets ### Supported native targets
- iosArm64, iosX64 - iosArm64, iosX64
@ -36,29 +30,23 @@ We recommend to upgrade to 0.4+ ASAP as public/shared key id derivation method w
### Non-native targets ### Non-native targets
- JS (browser and Node.js) - JS (browser and nodeJS)
- JVM (android, macOS, windows, linux, everywhere where JRE is installed) - JVM (android, macos, windows, linx, everywhere where JRE is installed)
## TCP/IP and UDP transports ## TCP/IP transport
These are the fastest based on async socket implementation of ktor client. They works everywhere but JS target as It is the fastest based on async socket implementation of ktor client. It works everywhere but JS target as
there is currently no widely adopted sockets for browser javascript. there is currently no widely adopted sockets for browser javascript.
While UDP is faster than TCP/IP, it is less reliable, especially with commands and return values that serializes to more than 240 bytes approx, and has no retransmission facilities (use TCP!). UDP though shines when all you need is to [push](https://code.sergeych.net/docs/kiloparsec/kiloparsec/net.sergeych.kiloparsec/-remote-interface/push.html) with little or no data in it. ## Websock server
## Websockets server While it is much slower than pure TCP, it is still faster than any http-based transport. It uses binary frames based on
While it is much slower than TCP or UDP, it is still faster than any http-based API; it uses binary frames based on
the Ktor server framework to easily integrate with web services. We recommend using it instead of a classic HTTP API as the Ktor server framework to easily integrate with web services. We recommend using it instead of a classic HTTP API as
it beats it in terms of speed and server load even with HTTP/2. it beats it in terms of speed and server load even with HTTP/2.
We recommend to create the `KiloInterface<S>` instance and connect it to the websockets and tcp servers in real We recommend to create the `KiloInterface<S>` instance and connect it to the websock and tcp servers in real
applications to get easy access from anywhere. applications to get easy access from anywhere.
## Websocket client
It is slower than TCP or UDP, but it works on literally all platforms. See the sample below.
# Usage # Usage
The library should be used as maven dependency, not as source. The library should be used as maven dependency, not as source.
@ -82,7 +70,7 @@ It could be, depending on your project structure, something like:
```kotlin ```kotlin
val commonMain by getting { val commonMain by getting {
dependencies { dependencies {
api("net.sergeych:kiloparsec:0.4.1") api("net.sergeych:kiloparsec:0.3.2")
} }
} }
``` ```
@ -111,7 +99,7 @@ val cmdPushClient by command<String, Unit>()
## Call it from the client: ## Call it from the client:
Remember, we need to implement client interface `cmdPushClient` in our example, so we need to provide Remember, we need to implement client interface `cmdPushClient` in our example, so we need to provide
local interface too: local interace too:
```kotlin ```kotlin
// Unit: no session on the client: // Unit: no session on the client:
@ -141,7 +129,7 @@ assertEquals(FooArgs("bar", 117), client.call(cmdGetFoo))
## Create ktor-based server ## Create ktor-based server
Normally server side needs some session. It is convenient and avoid sending repeating data on each request speeding up Normally server side needs some session. It is convenient and avoid sending repeating data on each request speeding up
the protocol. With KILOPARSEC, it is rather basic operation: the protocol. With KILOPARSEC it is rather basic operation:
~~~kotlin ~~~kotlin
// Our session just keeps Foo for cmd{Get|Set}Foo: // Our session just keeps Foo for cmd{Get|Set}Foo:
@ -198,9 +186,9 @@ Is very much straightforward, same as with TCP/IP:
#### Command size #### Command size
Each command invocation and result are packed in a separate UDP diagram using effective binary packing. Each command invocation and result are packed in a separate UDP diagram using effective binary packing.
Thus, for the best results commands and results should be relatively short, best to fit into 240 bytes. While bigger datagrams are often transmitted successfully, the probability of the effective transmission drops with the size. Thus for the best results commands and results should be relatively short, best to fit into 240 bytes. While bigger datagrams are often transmitted successfully, the probability of the effective transmission drops with the size.
Kiloparsec UDP transport does not retransmit not delivered packets. Use TCP/IP or websocket if it is a concern. Kiloparsec UDP transport does not retransmits not delivered packets. Use TCP/IP or websocket if it is a concern.
For the best results we recommend using [push](https://code.sergeych.net/docs/kiloparsec/kiloparsec/net.sergeych.kiloparsec/-remote-interface/index.html#1558240250%2FFunctions%2F788909594) for remote interfaces with UDP. For the best results we recommend using [push](https://code.sergeych.net/docs/kiloparsec/kiloparsec/net.sergeych.kiloparsec/-remote-interface/index.html#1558240250%2FFunctions%2F788909594) for remote interfaces with UDP.
@ -210,7 +198,7 @@ As Datagrams do not form protocol itself, kiloparsec issues pings when no data i
When no pings are received long enough, kiloparsec connection is closed. There are `maxInactivityTimeout` in all When no pings are received long enough, kiloparsec connection is closed. There are `maxInactivityTimeout` in all
relevant functions and constructors. relevant functions and constructors.
Client should not issue pings manually. Client shoudl not issue pings manually.
## Reusing code between servers ## Reusing code between servers
@ -222,11 +210,12 @@ This is a common proactive to create a business logic in a `KiloInterface`, then
We do not recommend to rely on TLS (HTTPS://, WSS://) host identification solely, in the modern world there is We do not recommend to rely on TLS (HTTPS://, WSS://) host identification solely, in the modern world there is
a high probability of attacks on unfriendly (in respect to at least some of your users) states to the SSL certificates a high probability of attacks on unfriendly (in respect to at least some of your users) states to the SSL certificates
chain, in which case the [MITM attack] and spoofing will be undetected. Check the [remoteId](https://code.sergeych.net/docs/kiloparsec/kiloparsec/net.sergeych.kiloparsec/-kilo-client/remote-id.html?query=suspend%20fun%20remoteId():%20VerifyingPublicKey?) in your client on each connection and provide the safe [serverSecretKey](https://code.sergeych.net/docs/kiloparsec/kiloparsec/net.sergeych.kiloparsec/-kilo-server/index.html) when creating a server. chain, in which case the MITM and spoofing will be undetected. Check the [remoteId](https://code.sergeych.net/docs/kiloparsec/kiloparsec/net.sergeych.kiloparsec/-kilo-client/remote-id.html?query=suspend%20fun%20remoteId():%20VerifyingPublicKey?) in your client on each connection and provide the safe [serverSecretKey](https://code.sergeych.net/docs/kiloparsec/kiloparsec/net.sergeych.kiloparsec/-kilo-server/index.html) when creating a server.
This will effectively protect against certificate chain spoofing in the case of the application installed from the trusted source. This will effectively protetcs against certificate chain spoofing in the case of the application installed from the trusted source.
__Important note__. The web application could not be completely secured this way unless is loaded from the IP-address, as the DNS could be spoofed the same, especially when used with `Cloudflare` or other CDN that can transparently substitute the whole site. For applications, we strongly recommend not to use CDN except your own, controlled ones. You generally can't neither detect nor repel [MITM attack] performed from _any single cloudflare 'ray'_. __Important note__. The web application could not be completely secured this way unless is loaded from the IP-address, as the DNS could be spoofed the same, especially when used with `Cloudflare` or other CDN that can
transparently substitute the whole site. In the case of we applications we strongly recommend not to use CDN except your own where you can control actual traffic rules.
## See also: ## See also:
@ -253,13 +242,13 @@ All RPC is performed over the encrypted connection.
# Technical description # Technical description
Kiloparsec is a full-duplex fully async (coroutine based) Remote Procedure Call protocol with typed parameters Kiloparsec is a dull-duplex fully async (coroutine based) Remote Procedure Call protocol with typed parameters
and support for serializing exceptions (e.g. exception thrown while executing remote command will be caught and and support for serializing exceptions (e.g. exception thrown while executing remote command will be caught and
rethrown at the caller context). rethrown at the caller context).
Kiloparsec is not REST, it _has advanced session mechanisms_ and built-in authentication based on the same curve keys. Kiloparsec is not REST, it _has advanced session mechanisms_ and built-in authentication based on the same curve keys.
Integrated tools to prevent MITM attacks include also non-transferred independently generated token that is calculated Integrated tools to prevent MITM attacks include also non-transferred independently generated token that is calculated
independently on the ends and is never transferred with the network. Comparing it somehow (visually, with QR code, etc.) independently on the ends and is never transferred with the network. Comparing it somehow (visually, with QR code, etc)
could add a very robust guarantee of the connection safety and ingenuity. could add a very robust guarantee of the connection safety and ingenuity.
Kiloparsec has built-in completely asynchronous (coroutine based top-down) transport layer based on TCP (JVM only as for Kiloparsec has built-in completely asynchronous (coroutine based top-down) transport layer based on TCP (JVM only as for
@ -268,10 +257,4 @@ JVM only insofar.
# Licensing # Licensing
This is work in progress, not yet moved to public domain; Currently, you need to obtain a license from https://8-rays.dev or Sergey Chernov.
you need to obtain a license from https://8-rays.dev or [Sergey Chernov]. For open source projects it will most be free on some special terms.
It will be moved to open source; we also guarantee that it will be moved to open source immediately if the software export restrictions will be lifted. We do not support such practices here at 8-rays.dev.
[MITM]: https://en.wikipedia.org/wiki/Man-in-the-middle_attack
[Sergey Chernov]: https://t.me/real_sergeych

View File

@ -1,14 +1,4 @@
#!/bin/bash #!/bin/bash
#
# Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
#
# You may use, distribute and modify this code under the
# terms of the private license, which you must obtain from the author
#
# To obtain the license, contact the author: https://t.me/real_sergeych or email to
# real dot sergeych at gmail.
#
set -e set -e
./gradlew dokkaHtml ./gradlew dokkaHtml
rsync -avz ./build/dokka/* code.sergeych.net:/bigstore/sergeych_pub/code/docs/kiloparsec rsync -avz ./build/dokka/* code.sergeych.net:/bigstore/sergeych_pub/code/docs/kiloparsec

View File

@ -1,52 +1,36 @@
/*
* Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
*
* You may use, distribute and modify this code under the
* terms of the private license, which you must obtain from the author
*
* To obtain the license, contact the author: https://t.me/real_sergeych or email to
* real dot sergeych at gmail.
*/
plugins { plugins {
kotlin("multiplatform") version "2.1.0" kotlin("multiplatform") version "2.0.10"
id("org.jetbrains.kotlin.plugin.serialization") version "2.1.0" id("org.jetbrains.kotlin.plugin.serialization") version "2.0.0"
`maven-publish` `maven-publish`
id("org.jetbrains.dokka") version "1.9.20" id("org.jetbrains.dokka") version "1.9.20"
} }
group = "net.sergeych" group = "net.sergeych"
version = "0.6.1-SNAPSHOT" version = "0.3.3"
repositories { repositories {
mavenCentral() mavenCentral()
mavenLocal() mavenLocal()
maven("https://maven.universablockchain.com/") maven("https://maven.universablockchain.com/")
maven("https://gitea.sergeych.net/api/packages/SergeychWorks/maven") maven("https://gitea.sergeych.net/api/packages/SergeychWorks/maven")
maven("https://gitea.sergeych.net/api/packages/YoungBlood/maven")
} }
kotlin { kotlin {
jvmToolchain(17)
jvm() jvm()
js { js {
browser { browser {
} }
nodejs() nodejs()
} }
// macosArm64() macosArm64()
// iosX64() iosX64()
// iosArm64() iosArm64()
// iosSimulatorArm64() iosSimulatorArm64()
linuxX64() linuxX64()
linuxArm64() linuxArm64()
// macosX64() macosX64()
// macosX64()
mingwX64()
// @OptIn(ExperimentalWasmDsl::class)
// wasmJs()
val ktor_version = "3.1.0" val ktor_version = "2.3.12"
sourceSets { sourceSets {
all { all {
@ -57,10 +41,10 @@ kotlin {
val commonMain by getting { val commonMain by getting {
dependencies { dependencies {
implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.10.1") implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.7.3")
implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.7.2") implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.7.1")
api("io.ktor:ktor-client-core:$ktor_version") api("io.ktor:ktor-client-core:$ktor_version")
api("net.sergeych:crypto2:0.7.2-SNAPSHOT") api("net.sergeych:crypto2:0.4.2")
} }
} }
val ktorSocketMain by creating { val ktorSocketMain by creating {
@ -99,27 +83,27 @@ kotlin {
} }
} }
val jsTest by getting val jsTest by getting
// val macosArm64Main by getting { val macosArm64Main by getting {
// dependsOn(ktorSocketMain) dependsOn(ktorSocketMain)
// } }
// val macosArm64Test by getting { val macosArm64Test by getting {
// dependsOn(ktorSocketTest) dependsOn(ktorSocketTest)
// } }
// val macosX64Main by getting { val macosX64Main by getting {
// dependsOn(ktorSocketMain) dependsOn(ktorSocketMain)
// } }
// val iosX64Main by getting { val iosX64Main by getting {
// dependsOn(ktorSocketMain) dependsOn(ktorSocketMain)
// } }
// val iosX64Test by getting { val iosX64Test by getting {
// dependsOn(ktorSocketTest) dependsOn(ktorSocketTest)
// } }
// val iosArm64Main by getting { val iosArm64Main by getting {
// dependsOn(ktorSocketMain) dependsOn(ktorSocketMain)
// } }
// val iosArm64Test by getting { val iosArm64Test by getting {
// dependsOn(ktorSocketTest) dependsOn(ktorSocketTest)
// } }
val linuxArm64Main by getting { val linuxArm64Main by getting {
dependsOn(ktorSocketMain) dependsOn(ktorSocketMain)
} }

View File

@ -1,12 +1,2 @@
#
# Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
#
# You may use, distribute and modify this code under the
# terms of the private license, which you must obtain from the author
#
# To obtain the license, contact the author: https://t.me/real_sergeych or email to
# real dot sergeych at gmail.
#
kotlin.code.style=official kotlin.code.style=official
kotlin.mpp.applyDefaultHierarchyTemplate=false kotlin.mpp.applyDefaultHierarchyTemplate=false

View File

@ -1,13 +1,3 @@
#
# Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
#
# You may use, distribute and modify this code under the
# terms of the private license, which you must obtain from the author
#
# To obtain the license, contact the author: https://t.me/real_sergeych or email to
# real dot sergeych at gmail.
#
distributionBase=GRADLE_USER_HOME distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-8.2-bin.zip distributionUrl=https\://services.gradle.org/distributions/gradle-8.2-bin.zip

16
gradlew vendored
View File

@ -1,13 +1,19 @@
#!/bin/sh #!/bin/sh
# #
# Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved # Copyright © 2015-2021 the original authors.
# #
# You may use, distribute and modify this code under the # Licensed under the Apache License, Version 2.0 (the "License");
# terms of the private license, which you must obtain from the author # you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# #
# To obtain the license, contact the author: https://t.me/real_sergeych or email to # https://www.apache.org/licenses/LICENSE-2.0
# real dot sergeych at gmail. #
# 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.
# #
############################################################################## ##############################################################################

View File

@ -1,13 +1,3 @@
/*
* Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
*
* You may use, distribute and modify this code under the
* terms of the private license, which you must obtain from the author
*
* To obtain the license, contact the author: https://t.me/real_sergeych or email to
* real dot sergeych at gmail.
*/
pluginManagement { pluginManagement {
repositories { repositories {
mavenCentral() mavenCentral()

View File

@ -1,13 +1,3 @@
/*
* Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
*
* You may use, distribute and modify this code under the
* terms of the private license, which you must obtain from the author
*
* To obtain the license, contact the author: https://t.me/real_sergeych or email to
* real dot sergeych at gmail.
*/
package net.sergeych.kiloparsec package net.sergeych.kiloparsec
import io.ktor.utils.io.* import io.ktor.utils.io.*

View File

@ -1,52 +0,0 @@
/*
* Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
*
* You may use, distribute and modify this code under the
* terms of the private license, which you must obtain from the author
*
* To obtain the license, contact the author: https://t.me/real_sergeych or email to
* real dot sergeych at gmail.
*/
package net.sergeych.kiloparsec
import kotlinx.coroutines.sync.Mutex
import kotlinx.coroutines.sync.withLock
/**
* Multiplatform atomically mutable value to be used in [kotlinx.coroutines],
* with suspending mutating operations, see [mutate].
*
* Actual value can be either changed in a block of [mutate] when
* new value _depends on the current value_ or with [reset].
*
* [value] getter is suspended because it waits until the mutation finishes
*/
open class AtomicAsyncValue<T>(initialValue: T) {
private var actualValue = initialValue
private val access = Mutex()
/**
* Change the value: get the current and set to the returned, all in the
* atomic suspend operation. All other mutating requests including assigning to [value]
* will be blocked and queued.
* @return result of the mutation. Note that immediate call to property [value]
* could already return modified bu some other thread value!
*/
suspend fun mutate(mutator: suspend (T) -> T): T = access.withLock {
actualValue = mutator(actualValue)
actualValue
}
/**
* Atomic get or set the value. Atomic get means if there is a [mutate] in progress
* it will wait until the mutation finishes and then return the correct result.
*/
suspend fun value() = access.withLock { actualValue }
/**
* Set the new value without checking it. Shortcut to
* ```mutate { value = newValue }```
*/
suspend fun reset(value: T) = mutate { value }
}

View File

@ -1,13 +1,3 @@
/*
* Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
*
* You may use, distribute and modify this code under the
* terms of the private license, which you must obtain from the author
*
* To obtain the license, contact the author: https://t.me/real_sergeych or email to
* real dot sergeych at gmail.
*/
package net.sergeych.kiloparsec package net.sergeych.kiloparsec
import kotlinx.serialization.KSerializer import kotlinx.serialization.KSerializer
@ -15,8 +5,6 @@ import kotlinx.serialization.Serializable
import net.sergeych.bintools.toDataSource import net.sergeych.bintools.toDataSource
import net.sergeych.bipack.BipackDecoder import net.sergeych.bipack.BipackDecoder
import net.sergeych.bipack.BipackEncoder import net.sergeych.bipack.BipackEncoder
import net.sergeych.kiloparsec.Command.Call
import net.sergeych.kiloparsec.Command.Companion.unpackCall
import net.sergeych.utools.unpack import net.sergeych.utools.unpack
/** /**
@ -24,20 +12,8 @@ import net.sergeych.utools.unpack
* in node-2-node protocols and client API, and most importantly in calling smart contract * in node-2-node protocols and client API, and most importantly in calling smart contract
* methods. This is essentially a Kotlin binding to typesafe serialize command calls and * methods. This is essentially a Kotlin binding to typesafe serialize command calls and
* deserialize results. * deserialize results.
*
* To create command instances, it is recommended to use [command] that returns [CommandDelegate].
*
* Use [packCall] to serialize the command call with some arguments.
*
* Note that `Command` instances themselves are not serialized, instead, the call is serialized,
* in the form of [Call], containing name and properly serialized arguments.
*
* [unpackCall] deserialized result of the [packCall] so the proper handler for the command could
* be used. Then the result of the execution could be packed with [exec] and then unpacked with
* [unpackResult].
*
*/ */
open class Command<A, R>( class Command<A, R>(
val name: String, val name: String,
val argsSerializer: KSerializer<A>, val argsSerializer: KSerializer<A>,
val resultSerializer: KSerializer<R> val resultSerializer: KSerializer<R>
@ -45,29 +21,13 @@ open class Command<A, R>(
@Serializable @Serializable
data class Call(val name: String,val serializedArgs: UByteArray) data class Call(val name: String,val serializedArgs: UByteArray)
/** fun packCall(args: A): UByteArray = BipackEncoder.encode(
* Pack command invocation with specified arguments. Call(name, BipackEncoder.encode(argsSerializer, args).toUByteArray())
*/ ).toUByteArray()
fun packCall(args: A): UByteArray = BipackEncoder.encode(createCall(args)).toUByteArray()
/**
* Create [Call] instance for specified args vy serializing it properly
*/
fun createCall(args: A): Call = Call(name, BipackEncoder.encode(argsSerializer, args).toUByteArray())
/**
* Unpack result, obtained by [exec].
*/
fun unpackResult(packedResult: UByteArray): R = fun unpackResult(packedResult: UByteArray): R =
unpack(resultSerializer, packedResult) unpack(resultSerializer, packedResult)
/**
* Execute a command unpacking args.
*
* @param packedArgs arguments, as provided by [packCall] in the [Call] instance
* @param handler actual code to execute the command
* @return properly serialized result to be unpacked with [unpackResult].
*/
suspend fun exec(packedArgs: UByteArray, handler: suspend (A) -> R): UByteArray = suspend fun exec(packedArgs: UByteArray, handler: suspend (A) -> R): UByteArray =
BipackEncoder.encode( BipackEncoder.encode(
resultSerializer, resultSerializer,
@ -76,10 +36,6 @@ open class Command<A, R>(
).toUByteArray() ).toUByteArray()
companion object { companion object {
/**
* Unpack command invocation instance from [packCall]. Use [exec] to deserialize arguments and
* perform command.
*/
fun unpackCall(packedCall: UByteArray): Call = BipackDecoder.decode(packedCall.toDataSource()) fun unpackCall(packedCall: UByteArray): Call = BipackDecoder.decode(packedCall.toDataSource())
} }
} }

View File

@ -1,13 +1,3 @@
/*
* Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
*
* You may use, distribute and modify this code under the
* terms of the private license, which you must obtain from the author
*
* To obtain the license, contact the author: https://t.me/real_sergeych or email to
* real dot sergeych at gmail.
*/
package net.sergeych.kiloparsec package net.sergeych.kiloparsec
import kotlinx.serialization.KSerializer import kotlinx.serialization.KSerializer

View File

@ -1,13 +1,3 @@
/*
* Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
*
* You may use, distribute and modify this code under the
* terms of the private license, which you must obtain from the author
*
* To obtain the license, contact the author: https://t.me/real_sergeych or email to
* real dot sergeych at gmail.
*/
package net.sergeych.kiloparsec package net.sergeych.kiloparsec
/** /**

View File

@ -1,16 +0,0 @@
/*
* Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
*
* You may use, distribute and modify this code under the
* terms of the private license, which you must obtain from the author
*
* To obtain the license, contact the author: https://t.me/real_sergeych or email to
* real dot sergeych at gmail.
*/
package net.sergeych.kiloparsec
interface ExceptionWithCode {
val code: String
val message: String?
}

View File

@ -1,13 +1,3 @@
/*
* Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
*
* You may use, distribute and modify this code under the
* terms of the private license, which you must obtain from the author
*
* To obtain the license, contact the author: https://t.me/real_sergeych or email to
* real dot sergeych at gmail.
*/
package net.sergeych.kiloparsec package net.sergeych.kiloparsec
import kotlinx.coroutines.CancellationException import kotlinx.coroutines.CancellationException
@ -19,7 +9,6 @@ import kotlinx.coroutines.isActive
import kotlinx.coroutines.sync.Mutex import kotlinx.coroutines.sync.Mutex
import kotlinx.coroutines.sync.withLock import kotlinx.coroutines.sync.withLock
import net.sergeych.crypto2.SigningKey import net.sergeych.crypto2.SigningKey
import net.sergeych.crypto2.VerifyingKey
import net.sergeych.crypto2.VerifyingPublicKey import net.sergeych.crypto2.VerifyingPublicKey
import net.sergeych.mp_logger.LogTag import net.sergeych.mp_logger.LogTag
import net.sergeych.mp_logger.Loggable import net.sergeych.mp_logger.Loggable
@ -71,14 +60,6 @@ class KiloClient<S>(
@Suppress("unused") @Suppress("unused")
val connectedStateFlow = _state.asStateFlow() val connectedStateFlow = _state.asStateFlow()
/**
* The verifying, or public, key identifying client sessions. It could be used to
* restore environment on reconnection. This is what remote side, e.g. server, sees as
* [KiloScope.remoteIdentity].
*/
@Suppress("unused")
val localIdentity: VerifyingKey? = secretKey?.verifyingKey
private var deferredClient = CompletableDeferred<KiloClientConnection<S>>() private var deferredClient = CompletableDeferred<KiloClientConnection<S>>()
private val job = private val job =
@ -160,7 +141,7 @@ class KiloClient<S>(
* a key. Connection is established either with a properly authenticated key or no key at all. * a key. Connection is established either with a properly authenticated key or no key at all.
*/ */
@Suppress("unused") @Suppress("unused")
suspend fun remoteIdentity(): VerifyingPublicKey? = deferredClient.await().remoteId() suspend fun remoteId(): VerifyingPublicKey? = deferredClient.await().remoteId()
companion object { companion object {
class Builder<S>() { class Builder<S>() {
@ -175,19 +156,8 @@ class KiloClient<S>(
var secretIdKey: SigningKey? = null var secretIdKey: SigningKey? = null
/** /**
* Build local command implementations, those callable from the server, exception * Build local command implementations (remotely callable ones), exception
* class handlers, and anything else [KiloInterface] allows. Usage sample: * class handlers, etc.
*
* ```kotlin
* val client = KiloClient {
* connect { connectTcpDevice("localhost:$port") }
* local {
* on(cmdPing) {
* "pong! $it"
* }
* }
* }
* ```
*/ */
fun local(f: KiloInterface<S>.() -> Unit) { fun local(f: KiloInterface<S>.() -> Unit) {
interfaceBuilder = f interfaceBuilder = f

View File

@ -1,13 +1,3 @@
/*
* Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
*
* You may use, distribute and modify this code under the
* terms of the private license, which you must obtain from the author
*
* To obtain the license, contact the author: https://t.me/real_sergeych or email to
* real dot sergeych at gmail.
*/
package net.sergeych.kiloparsec package net.sergeych.kiloparsec
import kotlinx.coroutines.* import kotlinx.coroutines.*
@ -90,7 +80,7 @@ class KiloClientConnection<S>(
kiloRemoteInterface.complete( kiloRemoteInterface.complete(
KiloRemoteInterface(deferredParams, clientInterface) KiloRemoteInterface(deferredParams, clientInterface)
) )
clientInterface.onConnectHandlers.invokeAll(params.scope) clientInterface.onConnectHandler?.invoke(params.scope)
onConnectedStateChanged?.invoke(true) onConnectedStateChanged?.invoke(true)
job.join() job.join()
@ -115,6 +105,3 @@ class KiloClientConnection<S>(
kiloRemoteInterface.await().push(cmd, args) kiloRemoteInterface.await().push(cmd, args)
} }
} }
internal fun <S>Collection<KiloHandler<S>>.invokeAll(scope: KiloScope<S>) =
forEach { runCatching { scope.it() } }

View File

@ -1,16 +1,5 @@
/*
* Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
*
* You may use, distribute and modify this code under the
* terms of the private license, which you must obtain from the author
*
* To obtain the license, contact the author: https://t.me/real_sergeych or email to
* real dot sergeych at gmail.
*/
package net.sergeych.kiloparsec package net.sergeych.kiloparsec
typealias KiloHandler<S> = KiloScope<S>.()->Unit
/** /**
* The local interface to provide functions, register errors for Kiloparsec users. Use it * The local interface to provide functions, register errors for Kiloparsec users. Use it
* with [KiloClient], [KiloClientConnection], [KiloServerConnection], etc. * with [KiloClient], [KiloClientConnection], [KiloServerConnection], etc.
@ -25,19 +14,12 @@ typealias KiloHandler<S> = KiloScope<S>.()->Unit
*/ */
open class KiloInterface<S> : LocalInterface<KiloScope<S>>() { open class KiloInterface<S> : LocalInterface<KiloScope<S>>() {
internal val onConnectHandlers = mutableListOf<KiloHandler<S>>() internal var onConnectHandler: (KiloScope<S>.()->Unit) ? = null
/** fun onConnected(f: KiloScope<S>.()->Unit) { onConnectHandler = f }
* Registers handler [f] for [onConnected] event, to the head or the end of handler list.
*
* @param addFirst if true, [f] will be added to the beginning of the list of handlers
*/
fun onConnected(addFirst: Boolean = false, f: KiloScope<S>.()->Unit) {
if( addFirst ) onConnectHandlers.add(0, f) else onConnectHandlers += f
}
init { init {
registerError { RemoteInterface.UnknownCommand(it) } registerError { RemoteInterface.UnknownCommand() }
registerError { RemoteInterface.InternalError(it) } registerError { RemoteInterface.InternalError(it) }
registerError { RemoteInterface.ClosedException(it) } registerError { RemoteInterface.ClosedException(it) }
// registerError { RemoteInterface.SecurityException(it) } // registerError { RemoteInterface.SecurityException(it) }

View File

@ -1,13 +1,3 @@
/*
* Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
*
* You may use, distribute and modify this code under the
* terms of the private license, which you must obtain from the author
*
* To obtain the license, contact the author: https://t.me/real_sergeych or email to
* real dot sergeych at gmail.
*/
package net.sergeych.kiloparsec package net.sergeych.kiloparsec
import kotlinx.coroutines.CompletableDeferred import kotlinx.coroutines.CompletableDeferred

View File

@ -1,13 +1,3 @@
/*
* Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
*
* You may use, distribute and modify this code under the
* terms of the private license, which you must obtain from the author
*
* To obtain the license, contact the author: https://t.me/real_sergeych or email to
* real dot sergeych at gmail.
*/
package net.sergeych.kiloparsec package net.sergeych.kiloparsec
import kotlinx.serialization.Serializable import kotlinx.serialization.Serializable

View File

@ -1,13 +1,3 @@
/*
* Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
*
* You may use, distribute and modify this code under the
* terms of the private license, which you must obtain from the author
*
* To obtain the license, contact the author: https://t.me/real_sergeych or email to
* real dot sergeych at gmail.
*/
package net.sergeych.kiloparsec package net.sergeych.kiloparsec
import kotlinx.coroutines.CompletableDeferred import kotlinx.coroutines.CompletableDeferred

View File

@ -1,13 +1,3 @@
/*
* Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
*
* You may use, distribute and modify this code under the
* terms of the private license, which you must obtain from the author
*
* To obtain the license, contact the author: https://t.me/real_sergeych or email to
* real dot sergeych at gmail.
*/
package net.sergeych.kiloparsec package net.sergeych.kiloparsec
import net.sergeych.crypto2.SigningKey import net.sergeych.crypto2.SigningKey

View File

@ -1,13 +1,3 @@
/*
* Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
*
* You may use, distribute and modify this code under the
* terms of the private license, which you must obtain from the author
*
* To obtain the license, contact the author: https://t.me/real_sergeych or email to
* real dot sergeych at gmail.
*/
package net.sergeych.kiloparsec package net.sergeych.kiloparsec
import kotlinx.coroutines.CancellationException import kotlinx.coroutines.CancellationException

View File

@ -1,13 +1,3 @@
/*
* Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
*
* You may use, distribute and modify this code under the
* terms of the private license, which you must obtain from the author
*
* To obtain the license, contact the author: https://t.me/real_sergeych or email to
* real dot sergeych at gmail.
*/
package net.sergeych.kiloparsec package net.sergeych.kiloparsec
import kotlinx.coroutines.CompletableDeferred import kotlinx.coroutines.CompletableDeferred
@ -85,7 +75,7 @@ class KiloServerConnection<S>(
kiloRemoteInterface.complete( kiloRemoteInterface.complete(
KiloRemoteInterface(deferredParams, clientInterface) KiloRemoteInterface(deferredParams, clientInterface)
) )
clientInterface.onConnectHandlers.invokeAll(p.scope) clientInterface.onConnectHandler?.invoke(p.scope)
} }
} }

View File

@ -1,13 +1,3 @@
/*
* Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
*
* You may use, distribute and modify this code under the
* terms of the private license, which you must obtain from the author
*
* To obtain the license, contact the author: https://t.me/real_sergeych or email to
* real dot sergeych at gmail.
*/
package net.sergeych.kiloparsec package net.sergeych.kiloparsec
import net.sergeych.mp_logger.LogTag import net.sergeych.mp_logger.LogTag
@ -77,18 +67,14 @@ open class LocalInterface<S> : Loggable by LogTag("LocalInterface${idCounter.inc
name: String, name: String,
packedArgs: UByteArray, packedArgs: UByteArray,
): UByteArray = ): UByteArray =
(commands[name] ?: throw RemoteInterface.UnknownCommand(name)) (commands[name] ?: throw RemoteInterface.UnknownCommand())
.invoke(scope, packedArgs) .invoke(scope, packedArgs)
private val errorByClass = mutableMapOf<KClass<*>, String>() private val errorByClass = mutableMapOf<KClass<*>, String>()
private val errorBuilder = mutableMapOf<String, (String, UByteArray?) -> Throwable>() private val errorBuilder = mutableMapOf<String, (String, UByteArray?) -> Throwable>()
/** fun <T : Throwable> registerError(
* Register exception for automatic transmission over the kiloparsec connection using its [klass]
* and possibly override code. In most cases it is simpler to use [registerError].
*/
fun <T : Throwable> registerErrorClass(
klass: KClass<T>, code: String = klass.simpleName!!, klass: KClass<T>, code: String = klass.simpleName!!,
exceptionBuilder: (String, UByteArray?) -> T, exceptionBuilder: (String, UByteArray?) -> T,
) { ) {
@ -96,17 +82,10 @@ open class LocalInterface<S> : Loggable by LogTag("LocalInterface${idCounter.inc
errorBuilder[code] = exceptionBuilder errorBuilder[code] = exceptionBuilder
} }
/**
* Register an exception to be transmitted automatically over the kiloparsec connection.
* Example:
* ```kotlin
* localInterface.registerError { IllegalArgumentException(it) }
* ```
*/
inline fun <reified T : Throwable> registerError( inline fun <reified T : Throwable> registerError(
noinline exceptionBuilder: (String) -> T, noinline exceptionBuilder: (String) -> T,
) { ) {
registerErrorClass(T::class) { msg, _ -> exceptionBuilder(msg) } registerError(T::class) { msg, _ -> exceptionBuilder(msg) }
} }
val errorProviders = mutableListOf<LocalInterface<*>>() val errorProviders = mutableListOf<LocalInterface<*>>()
@ -116,8 +95,7 @@ open class LocalInterface<S> : Loggable by LogTag("LocalInterface${idCounter.inc
} }
fun getErrorCode(t: Throwable): String? = fun getErrorCode(t: Throwable): String? =
(t as? ExceptionWithCode)?.code errorByClass[t::class] ?: errorProviders.firstNonNull { it.getErrorCode(t) }
?: errorByClass[t::class] ?: errorProviders.firstNonNull { it.getErrorCode(t) }
fun encodeError(forId: UInt, t: Throwable): Transport.Block.Error = fun encodeError(forId: UInt, t: Throwable): Transport.Block.Error =
if (t is RemoteInterface.ClosedException) { if (t is RemoteInterface.ClosedException) {

View File

@ -1,13 +1,3 @@
/*
* Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
*
* You may use, distribute and modify this code under the
* terms of the private license, which you must obtain from the author
*
* To obtain the license, contact the author: https://t.me/real_sergeych or email to
* real dot sergeych at gmail.
*/
package net.sergeych.kiloparsec package net.sergeych.kiloparsec
/** /**
@ -50,21 +40,14 @@ interface RemoteInterface {
/** /**
* Command is not supported by the remote party * Command is not supported by the remote party
*/ */
class UnknownCommand(commandName: String) : RemoteException("UnknownCommand: $commandName") class UnknownCommand : RemoteException("UnknownCommand")
open class InternalError(code: String="0"): RemoteException("Internal error: $code") open class InternalError(code: String="0"): RemoteException("Internal error: $code")
suspend fun <R> call(cmd: Command<Unit, R>): R = call(cmd, Unit) suspend fun <R> call(cmd: Command<Unit, R>): R = call(cmd, Unit)
/** /**
* Call the remote procedure with specified [args] and return its result of type [R]. The calling coroutine * Call the remote procedure with specified args and return its result
* suspends until the request is performed on the remote side and the result value (also `Unit`) will be received.
*
* When it is not necessary to wait for the return value and/or command execution, it is recommended to
* use [push] instead.
*
* @throws RemoteException if the execution caused exception on the remote size
* @throws Exception for registered exceptions, see [LocalInterface.registerError], etc.
*/ */
suspend fun <A, R> call(cmd: Command<A, R>, args: A): R suspend fun <A, R> call(cmd: Command<A, R>, args: A): R
@ -72,8 +55,6 @@ interface RemoteInterface {
* Push the notification without waiting for reception or processing. * Push the notification without waiting for reception or processing.
* It returns immediately after sending data to the transport (e.g., to the network). * It returns immediately after sending data to the transport (e.g., to the network).
* Use [call] if it is necessary to wait until the command will be received and processed by the remote. * Use [call] if it is necessary to wait until the command will be received and processed by the remote.
*
* Push is onlu available for commands without returned value.
*/ */
suspend fun <A> push(cmd: Command<A, Unit>, args: A) suspend fun <A> push(cmd: Command<A, Unit>, args: A)

View File

@ -1,13 +1,3 @@
/*
* Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
*
* You may use, distribute and modify this code under the
* terms of the private license, which you must obtain from the author
*
* To obtain the license, contact the author: https://t.me/real_sergeych or email to
* real dot sergeych at gmail.
*/
package net.sergeych.kiloparsec package net.sergeych.kiloparsec
import kotlinx.coroutines.* import kotlinx.coroutines.*
@ -134,7 +124,7 @@ class Transport<S>(
} }
// now we have mutex freed so we can call: // now we have mutex freed so we can call:
val r = runCatching { device.output.send(pack(b)) } val r = runCatching { device.output.send(pack(b).also { debug { ">>>\n${it.toDump()}" } }) }
if (!r.isSuccess) { if (!r.isSuccess) {
r.exceptionOrNull()?.let { r.exceptionOrNull()?.let {
exception { "failed to send output block" to it } exception { "failed to send output block" to it }
@ -194,7 +184,10 @@ class Transport<S>(
while (isActive && !isClosed) { while (isActive && !isClosed) {
try { try {
device.input.receive().let { packed -> device.input.receive().let { packed ->
debug { "<<<\n${packed.toDump()}" }
val b = unpack<Block>(packed) val b = unpack<Block>(packed)
debug { "<<$ $b" }
debug { "access state: ${access.isLocked}" }
when (b) { when (b) {
is Block.Error -> access.withLock { is Block.Error -> access.withLock {
val error = localInterface.decodeError(b) val error = localInterface.decodeError(b)
@ -205,7 +198,10 @@ class Transport<S>(
} }
is Block.Response -> access.withLock { is Block.Response -> access.withLock {
calls.remove(b.forId)?.complete(b.packedResult) calls.remove(b.forId)?.let {
debug { "activating wait handle for ${b.forId}" }
it.complete(b.packedResult)
}
?: warning { "wait handle not found for ${b.forId}" } ?: warning { "wait handle not found for ${b.forId}" }
} }
@ -232,10 +228,12 @@ class Transport<S>(
} catch (t: Throwable) { } catch (t: Throwable) {
send(Block.Error(b.id, "UnknownError", t.message)) send(Block.Error(b.id, "UnknownError", t.message))
} }
.also { debug { "command executed: ${b.name}" } }
} }
} }
debug { "=---------------------------------------------" }
} }
// debug { "input step performed closed=$isClosed active=$isActive" } debug { "input step performed closed=$isClosed active=$isActive" }
} catch (_: ClosedSendChannelException) { } catch (_: ClosedSendChannelException) {
info { "closed send channel" } info { "closed send channel" }
isClosed = true isClosed = true

View File

@ -1,13 +1,3 @@
/*
* Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
*
* You may use, distribute and modify this code under the
* terms of the private license, which you must obtain from the author
*
* To obtain the license, contact the author: https://t.me/real_sergeych or email to
* real dot sergeych at gmail.
*/
package net.sergeych.kiloparsec.adapter package net.sergeych.kiloparsec.adapter
import kotlinx.coroutines.channels.Channel import kotlinx.coroutines.channels.Channel

View File

@ -1,13 +1,3 @@
/*
* Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
*
* You may use, distribute and modify this code under the
* terms of the private license, which you must obtain from the author
*
* To obtain the license, contact the author: https://t.me/real_sergeych or email to
* real dot sergeych at gmail.
*/
package net.sergeych.kiloparsec.adapter package net.sergeych.kiloparsec.adapter
/** /**

View File

@ -1,13 +1,3 @@
/*
* Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
*
* You may use, distribute and modify this code under the
* terms of the private license, which you must obtain from the author
*
* To obtain the license, contact the author: https://t.me/real_sergeych or email to
* real dot sergeych at gmail.
*/
package net.sergeych.kiloparsec.adapter package net.sergeych.kiloparsec.adapter
import kotlinx.coroutines.channels.Channel import kotlinx.coroutines.channels.Channel

View File

@ -1,13 +1,3 @@
/*
* Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
*
* You may use, distribute and modify this code under the
* terms of the private license, which you must obtain from the author
*
* To obtain the license, contact the author: https://t.me/real_sergeych or email to
* real dot sergeych at gmail.
*/
package net.sergeych.kiloparsec.adapter package net.sergeych.kiloparsec.adapter
import io.ktor.client.* import io.ktor.client.*
@ -21,7 +11,10 @@ import kotlinx.coroutines.channels.ClosedReceiveChannelException
import kotlinx.coroutines.channels.ClosedSendChannelException import kotlinx.coroutines.channels.ClosedSendChannelException
import kotlinx.coroutines.launch import kotlinx.coroutines.launch
import net.sergeych.crypto2.SigningKey import net.sergeych.crypto2.SigningKey
import net.sergeych.kiloparsec.* import net.sergeych.kiloparsec.KiloClient
import net.sergeych.kiloparsec.KiloConnectionData
import net.sergeych.kiloparsec.KiloInterface
import net.sergeych.kiloparsec.RemoteInterface
import net.sergeych.mp_logger.LogTag import net.sergeych.mp_logger.LogTag
import net.sergeych.mp_logger.exception import net.sergeych.mp_logger.exception
import net.sergeych.mp_logger.info import net.sergeych.mp_logger.info
@ -31,39 +24,23 @@ import net.sergeych.tools.AtomicCounter
private val counter = AtomicCounter() private val counter = AtomicCounter()
/**
* Shortcut to create websocket client. Use [websocketTransportDevice] with [KiloClient]
* for fine-grained control.
*/
fun <S> websocketClient( fun <S> websocketClient(
path: String, path: String,
clientInterface: KiloInterface<S> = KiloInterface(), clientInterface: KiloInterface<S> = KiloInterface(),
client: HttpClient = HttpClient { install(WebSockets) },
secretKey: SigningKey? = null, secretKey: SigningKey? = null,
sessionMaker: () -> S = { sessionMaker: () -> S = {
@Suppress("UNCHECKED_CAST") @Suppress("UNCHECKED_CAST")
Unit as S Unit as S
}, },
): KiloClient<S> { ): KiloClient<S> {
return KiloClient(clientInterface, secretKey) {
KiloConnectionData(websocketTransportDevice(path), sessionMaker())
}
}
/**
* Create kilopaarsec transport over websocket (ws or wss).
* @param path websocket path (must start with ws:// or wss:// and contain a path part)
* @client use default [HttpClient], it installs [WebSockets] plugin
*/
fun websocketTransportDevice(
path: String,
client: HttpClient = HttpClient { install(WebSockets) },
): Transport.Device {
var u = Url(path) var u = Url(path)
if (u.encodedPath.length <= 1) if (u.encodedPath.length <= 1)
u = URLBuilder(u).apply { u = URLBuilder(u).apply {
encodedPath = "/kp" encodedPath = "/kp"
}.build() }.build()
return KiloClient(clientInterface, secretKey) {
val input = Channel<UByteArray>() val input = Channel<UByteArray>()
val output = Channel<UByteArray>() val output = Channel<UByteArray>()
val closeHandle = CompletableDeferred<Boolean>() val closeHandle = CompletableDeferred<Boolean>()
@ -89,8 +66,9 @@ fun websocketTransportDevice(
if (closeHandle.isActive) closeHandle.complete(true) if (closeHandle.isActive) closeHandle.complete(true)
} catch (_: ClosedSendChannelException) { } catch (_: ClosedSendChannelException) {
log.info { "send channel closed" } log.info { "send channel closed" }
} catch (_: CancellationException) { }
} catch (t: Throwable) { catch(_: CancellationException) {}
catch(t: Throwable) {
log.info { "unexpected exception in websock sender: ${t.stackTraceToString()}" } log.info { "unexpected exception in websock sender: ${t.stackTraceToString()}" }
closeHandle.completeExceptionally(t) closeHandle.completeExceptionally(t)
} }
@ -131,6 +109,6 @@ fun websocketTransportDevice(
closeHandle.complete(true) closeHandle.complete(true)
// job.cancel() // job.cancel()
} }
return device KiloConnectionData(device, sessionMaker())
}
} }

View File

@ -1,13 +1,3 @@
/*
* Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
*
* You may use, distribute and modify this code under the
* terms of the private license, which you must obtain from the author
*
* To obtain the license, contact the author: https://t.me/real_sergeych or email to
* real dot sergeych at gmail.
*/
package net.sergeych.kiloparsec package net.sergeych.kiloparsec
import kotlinx.serialization.Serializable import kotlinx.serialization.Serializable

View File

@ -1,13 +1,3 @@
/*
* Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
*
* You may use, distribute and modify this code under the
* terms of the private license, which you must obtain from the author
*
* To obtain the license, contact the author: https://t.me/real_sergeych or email to
* real dot sergeych at gmail.
*/
package net.sergeych.kiloparsec package net.sergeych.kiloparsec
import kotlinx.coroutines.sync.Mutex import kotlinx.coroutines.sync.Mutex

View File

@ -1,13 +1,3 @@
/*
* Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
*
* You may use, distribute and modify this code under the
* terms of the private license, which you must obtain from the author
*
* To obtain the license, contact the author: https://t.me/real_sergeych or email to
* real dot sergeych at gmail.
*/
import kotlinx.coroutines.test.runTest import kotlinx.coroutines.test.runTest
import net.sergeych.crypto2.IllegalSignatureException import net.sergeych.crypto2.IllegalSignatureException
import net.sergeych.crypto2.SealedBox import net.sergeych.crypto2.SealedBox

View File

@ -1,13 +1,3 @@
/*
* Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
*
* You may use, distribute and modify this code under the
* terms of the private license, which you must obtain from the author
*
* To obtain the license, contact the author: https://t.me/real_sergeych or email to
* real dot sergeych at gmail.
*/
import kotlinx.coroutines.test.runTest import kotlinx.coroutines.test.runTest
import kotlinx.datetime.Instant import kotlinx.datetime.Instant
import net.sergeych.bipack.BipackEncoder import net.sergeych.bipack.BipackEncoder

View File

@ -1,13 +1,3 @@
/*
* Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
*
* You may use, distribute and modify this code under the
* terms of the private license, which you must obtain from the author
*
* To obtain the license, contact the author: https://t.me/real_sergeych or email to
* real dot sergeych at gmail.
*/
class ToolsTest { class ToolsTest {
// @Test // @Test
// fun testRemoceCmd() { // fun testRemoceCmd() {

View File

@ -1,13 +1,3 @@
/*
* Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
*
* You may use, distribute and modify this code under the
* terms of the private license, which you must obtain from the author
*
* To obtain the license, contact the author: https://t.me/real_sergeych or email to
* real dot sergeych at gmail.
*/
import kotlinx.coroutines.* import kotlinx.coroutines.*
import kotlinx.coroutines.channels.Channel import kotlinx.coroutines.channels.Channel
import kotlinx.coroutines.channels.ReceiveChannel import kotlinx.coroutines.channels.ReceiveChannel

View File

@ -1,13 +1,3 @@
/*
* Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
*
* You may use, distribute and modify this code under the
* terms of the private license, which you must obtain from the author
*
* To obtain the license, contact the author: https://t.me/real_sergeych or email to
* real dot sergeych at gmail.
*/
import kotlin.test.fail import kotlin.test.fail
inline fun <reified T: Throwable>assertThrows(f: ()->Unit): T { inline fun <reified T: Throwable>assertThrows(f: ()->Unit): T {

View File

@ -1,13 +1,3 @@
/*
* Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
*
* You may use, distribute and modify this code under the
* terms of the private license, which you must obtain from the author
*
* To obtain the license, contact the author: https://t.me/real_sergeych or email to
* real dot sergeych at gmail.
*/
package net.sergeych.kiloparsec.adapter package net.sergeych.kiloparsec.adapter
import io.ktor.server.application.* import io.ktor.server.application.*
@ -20,42 +10,25 @@ import kotlinx.coroutines.channels.ClosedReceiveChannelException
import kotlinx.coroutines.isActive import kotlinx.coroutines.isActive
import kotlinx.coroutines.launch import kotlinx.coroutines.launch
import net.sergeych.crypto2.SigningKey import net.sergeych.crypto2.SigningKey
import net.sergeych.crypto2.toDump
import net.sergeych.kiloparsec.KiloInterface import net.sergeych.kiloparsec.KiloInterface
import net.sergeych.kiloparsec.KiloServerConnection import net.sergeych.kiloparsec.KiloServerConnection
import net.sergeych.kiloparsec.RemoteInterface import net.sergeych.kiloparsec.RemoteInterface
import net.sergeych.mp_logger.* import net.sergeych.mp_logger.*
import net.sergeych.tools.AtomicCounter import net.sergeych.tools.AtomicCounter
import kotlin.time.Duration.Companion.seconds import java.time.Duration
/**
* Create a ktor-based websocket server.
* This call install Routing and WebSockets with proper configuration.
*
* The course of action is:
*
* - create LocalInterface and populate it with functionality
* - call this method with localInterface
* - optionally, connect the same interface with TCP or UDP providers on supported platforms,
* in which case it might be useful to hae session creating function [createSession] separate.
*
* _Note_: [KiloInterface] as for now does not contain session creation in it as we suggest
* session could be transport specific.
*
* @param localInterface where the actual work is performed.
* @param path default http path to the websocket.
* @param serverKey optional key to authenticate the connection. If the client specify expected
* server key it should match of connection will not be established.
* @param createSession function to create a server session.
*/
fun <S> Application.setupWebsocketServer( fun <S> Application.setupWebsocketServer(
localInterface: KiloInterface<S>, localInterface: KiloInterface<S>,
path: String = "/kp", path: String = "/kp",
serverKey: SigningKey? = null, serverKey: SigningKey? = null,
createSession: () -> S, createSession: () -> S,
) { ) {
install(Routing)
install(WebSockets) { install(WebSockets) {
pingPeriod = 60.seconds //Duration.ofSeconds(15) pingPeriod = Duration.ofSeconds(15)
timeout = 45.seconds timeout = Duration.ofSeconds(15)
maxFrameSize = Long.MAX_VALUE maxFrameSize = Long.MAX_VALUE
masking = false masking = false
} }
@ -91,9 +64,12 @@ fun <S> Application.setupWebsocketServer(
} }
log.debug { "KSC started, looking for incoming frames" } log.debug { "KSC started, looking for incoming frames" }
for (f in incoming) { for (f in incoming) {
log.debug { "incoming frame: ${f.frameType}" }
if (f is Frame.Binary) if (f is Frame.Binary)
try { try {
input.send(f.readBytes().toUByteArray()) input.send(f.readBytes().toUByteArray().also {
log.debug { "in frame\n${it.toDump()}" }
})
} catch (_: RemoteInterface.ClosedException) { } catch (_: RemoteInterface.ClosedException) {
log.warning { "caught local closed exception (strange!), closing" } log.warning { "caught local closed exception (strange!), closing" }
break break

View File

@ -1,19 +1,8 @@
/*
* Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
*
* You may use, distribute and modify this code under the
* terms of the private license, which you must obtain from the author
*
* To obtain the license, contact the author: https://t.me/real_sergeych or email to
* real dot sergeych at gmail.
*/
package net.sergeych.kiloparsec package net.sergeych.kiloparsec
import assertThrows import assertThrows
import io.ktor.server.engine.* import io.ktor.server.engine.*
import io.ktor.server.netty.* import io.ktor.server.netty.*
import kotlinx.coroutines.delay
import kotlinx.coroutines.launch import kotlinx.coroutines.launch
import kotlinx.coroutines.test.runTest import kotlinx.coroutines.test.runTest
import net.sergeych.crypto2.initCrypto import net.sergeych.crypto2.initCrypto
@ -21,7 +10,6 @@ import net.sergeych.kiloparsec.adapter.setupWebsocketServer
import net.sergeych.kiloparsec.adapter.websocketClient import net.sergeych.kiloparsec.adapter.websocketClient
import net.sergeych.mp_logger.Log import net.sergeych.mp_logger.Log
import java.net.InetAddress import java.net.InetAddress
import kotlin.random.Random
import kotlin.test.Test import kotlin.test.Test
import kotlin.test.assertEquals import kotlin.test.assertEquals
import kotlin.test.assertFalse import kotlin.test.assertFalse
@ -62,12 +50,11 @@ class ClientTest {
} }
} }
val port = Random.nextInt(8080,9090) val ns: NettyApplicationEngine = embeddedServer(Netty, port = 8080, host = "0.0.0.0", module = {
val ns = embeddedServer(Netty, port = port, host = "0.0.0.0", module = {
setupWebsocketServer(serverInterface) { Session() } setupWebsocketServer(serverInterface) { Session() }
}).start(wait = false) }).start(wait = false)
val client = websocketClient<Unit>("ws://localhost:$port/kp") val client = websocketClient<Unit>("ws://localhost:8080/kp")
val states = mutableListOf<Boolean>() val states = mutableListOf<Boolean>()
val collector = launch { val collector = launch {
client.connectedStateFlow.collect { client.connectedStateFlow.collect {
@ -88,9 +75,6 @@ class ClientTest {
} }
// connection should now be closed // connection should now be closed
// the problem is: it needs some unspecified time to close
// as it is async process.
delay(100)
assertFalse { client.connectedStateFlow.value } assertFalse { client.connectedStateFlow.value }
// this should be run on automatically reopen connection // this should be run on automatically reopen connection

View File

@ -1,19 +1,8 @@
/*
* Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
*
* You may use, distribute and modify this code under the
* terms of the private license, which you must obtain from the author
*
* To obtain the license, contact the author: https://t.me/real_sergeych or email to
* real dot sergeych at gmail.
*/
package net.sergeych.kiloparsec.adapter package net.sergeych.kiloparsec.adapter
import io.ktor.network.selector.* import io.ktor.network.selector.*
import io.ktor.network.sockets.* import io.ktor.network.sockets.*
import io.ktor.utils.io.* import io.ktor.utils.io.*
import io.ktor.utils.io.writeByte
import kotlinx.coroutines.* import kotlinx.coroutines.*
import kotlinx.coroutines.CancellationException import kotlinx.coroutines.CancellationException
import kotlinx.coroutines.channels.Channel import kotlinx.coroutines.channels.Channel
@ -23,10 +12,14 @@ import kotlinx.coroutines.flow.flow
import kotlinx.coroutines.sync.Mutex import kotlinx.coroutines.sync.Mutex
import kotlinx.coroutines.sync.withLock import kotlinx.coroutines.sync.withLock
import kotlinx.datetime.Clock import kotlinx.datetime.Clock
import net.sergeych.kiloparsec.* import net.sergeych.kiloparsec.AsyncVarint
import net.sergeych.kiloparsec.KiloClient
import net.sergeych.kiloparsec.KiloServer
import net.sergeych.kiloparsec.LocalInterface
import net.sergeych.mp_logger.* import net.sergeych.mp_logger.*
import net.sergeych.mp_tools.globalLaunch import net.sergeych.mp_tools.globalLaunch
import net.sergeych.tools.AtomicCounter import net.sergeych.tools.AtomicCounter
import net.sergeych.tools.AtomicValue
import kotlin.time.Duration.Companion.seconds import kotlin.time.Duration.Companion.seconds
private val logCounter = AtomicCounter(0) private val logCounter = AtomicCounter(0)
@ -42,8 +35,8 @@ internal val PING_INACTIVITY_TIME = 30.seconds
*/ */
fun acceptTcpDevice(port: Int,localInterface: String = "0.0.0.0"): Flow<InetTransportDevice> { fun acceptTcpDevice(port: Int,localInterface: String = "0.0.0.0"): Flow<InetTransportDevice> {
val selectorManager = SelectorManager(Dispatchers.IO) val selectorManager = SelectorManager(Dispatchers.IO)
return flow {
val serverSocket = aSocket(selectorManager).tcp().bind(localInterface, port) val serverSocket = aSocket(selectorManager).tcp().bind(localInterface, port)
return flow {
while (true) { while (true) {
serverSocket.accept().let { sock -> serverSocket.accept().let { sock ->
emit(inetTransportDevice(sock, "srv")) emit(inetTransportDevice(sock, "srv"))
@ -81,7 +74,7 @@ private fun inetTransportDevice(
val outputBlocks = Channel<UByteArray>(4096) val outputBlocks = Channel<UByteArray>(4096)
val log = LogTag("TCPT${logCounter.incrementAndGet()}:$suffix:$networkAddress") val log = LogTag("TCPT${logCounter.incrementAndGet()}:$suffix:$networkAddress")
val job = AtomicAsyncValue<Job?>(null) val job = AtomicValue<Job?>(null)
val sockOutput = sock.openWriteChannel() val sockOutput = sock.openWriteChannel()
val sockInput = runCatching { sock.openReadChannel() }.getOrElse { val sockInput = runCatching { sock.openReadChannel() }.getOrElse {
@ -89,7 +82,7 @@ private fun inetTransportDevice(
throw IllegalStateException("failed to open read channel") throw IllegalStateException("failed to open read channel")
} }
suspend fun stop() { fun stop() {
job.mutate { job.mutate {
if ( it != null ) { if ( it != null ) {
log.debug { "stopping" } log.debug { "stopping" }
@ -98,7 +91,7 @@ private fun inetTransportDevice(
// The problem: on mac platofrms closing the socket does not close its input // The problem: on mac platofrms closing the socket does not close its input
// and output channels! // and output channels!
runCatching { sockInput.cancel() } runCatching { sockInput.cancel() }
runCatching { sockOutput.flushAndClose() } runCatching { sockOutput.close() }
if (!sock.isClosed) if (!sock.isClosed)
runCatching { runCatching {
log.debug { "closing socket by stop" } log.debug { "closing socket by stop" }
@ -115,8 +108,7 @@ private fun inetTransportDevice(
} }
var lastActiveAt = Clock.System.now() var lastActiveAt = Clock.System.now()
globalLaunch { job.value = globalLaunch {
job.reset(globalLaunch {
launch { launch {
log.debug { "opening read channel" } log.debug { "opening read channel" }
@ -148,7 +140,7 @@ private fun inetTransportDevice(
} }
} }
} }
})
launch { launch {
val outAccess = Mutex() val outAccess = Mutex()
var lastSentAt = Clock.System.now() var lastSentAt = Clock.System.now()

View File

@ -1,18 +1,7 @@
/*
* Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
*
* You may use, distribute and modify this code under the
* terms of the private license, which you must obtain from the author
*
* To obtain the license, contact the author: https://t.me/real_sergeych or email to
* real dot sergeych at gmail.
*/
package net.sergeych.kiloparsec.adapter package net.sergeych.kiloparsec.adapter
import io.ktor.network.sockets.* import io.ktor.network.sockets.*
import io.ktor.utils.io.core.* import io.ktor.utils.io.core.*
import kotlinx.io.readByteArray
import net.sergeych.crypto2.toDump import net.sergeych.crypto2.toDump
import net.sergeych.kiloparsec.adapter.UdpBlock.Companion.CANCEL_BLOCK import net.sergeych.kiloparsec.adapter.UdpBlock.Companion.CANCEL_BLOCK
import net.sergeych.kiloparsec.adapter.UdpBlock.Companion.ESCAPE_BYTE import net.sergeych.kiloparsec.adapter.UdpBlock.Companion.ESCAPE_BYTE
@ -108,6 +97,6 @@ sealed class UdpBlock {
} }
fun decode(datagram: Datagram) = fun decode(datagram: Datagram) =
decode(datagram.packet.readByteArray().toUByteArray()) decode(datagram.packet.readBytes().toUByteArray())
} }
} }

View File

@ -1,13 +1,3 @@
/*
* Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
*
* You may use, distribute and modify this code under the
* terms of the private license, which you must obtain from the author
*
* To obtain the license, contact the author: https://t.me/real_sergeych or email to
* real dot sergeych at gmail.
*/
package net.sergeych.kiloparsec.adapter package net.sergeych.kiloparsec.adapter
import io.ktor.network.sockets.* import io.ktor.network.sockets.*

View File

@ -1,13 +1,3 @@
/*
* Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
*
* You may use, distribute and modify this code under the
* terms of the private license, which you must obtain from the author
*
* To obtain the license, contact the author: https://t.me/real_sergeych or email to
* real dot sergeych at gmail.
*/
package net.sergeych.kiloparsec.adapter package net.sergeych.kiloparsec.adapter
import io.ktor.network.selector.* import io.ktor.network.selector.*
@ -97,7 +87,7 @@ fun acceptUdpDevice(
* the module automatically issues pings on inactivity when there is no data often enough * the module automatically issues pings on inactivity when there is no data often enough
* to maintain the connection open. * to maintain the connection open.
*/ */
suspend fun connectUdpDevice( fun connectUdpDevice(
hostPort: String, hostPort: String,
maxInactivityTimeout: Duration = 2.minutes, maxInactivityTimeout: Duration = 2.minutes,
) = connectUdpDevice(hostPort.toNetworkAddress(), maxInactivityTimeout) ) = connectUdpDevice(hostPort.toNetworkAddress(), maxInactivityTimeout)
@ -117,16 +107,16 @@ suspend fun connectUdpDevice(
* the module automatically issues pings on inactivity when there is no data often enough * the module automatically issues pings on inactivity when there is no data often enough
* to maintain the connection open. * to maintain the connection open.
*/ */
suspend fun connectUdpDevice( fun connectUdpDevice(
addr: NetworkAddress, addr: NetworkAddress,
maxInactivityTimeout: Duration = 2.minutes, maxInactivityTimeout: Duration = 2.minutes,
): InetTransportDevice { ): InetTransportDevice {
val selectorManager = SelectorManager(Dispatchers.IO) val selectorManager = SelectorManager(Dispatchers.IO)
val remoteAddress = InetSocketAddress(addr.host, addr.port) val remoteAddress = InetSocketAddress(addr.host, addr.port)
val socket = aSocket(selectorManager).udp().connect(remoteAddress)
val done = CompletableDeferred<Unit>() val done = CompletableDeferred<Unit>()
val socket = aSocket(selectorManager).udp().connect(remoteAddress)
val transport = UdpSocketTransport(object : UdpConnector { val transport = UdpSocketTransport(object : UdpConnector {
override suspend fun sendBlock(block: UdpBlock, toAddress: SocketAddress) { override suspend fun sendBlock(block: UdpBlock, toAddress: SocketAddress) {
socket.send(block.toDatagram(remoteAddress)) socket.send(block.toDatagram(remoteAddress))

View File

@ -1,13 +1,3 @@
/*
* Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
*
* You may use, distribute and modify this code under the
* terms of the private license, which you must obtain from the author
*
* To obtain the license, contact the author: https://t.me/real_sergeych or email to
* real dot sergeych at gmail.
*/
package net.sergeych.kiloparsec.adapter package net.sergeych.kiloparsec.adapter
import io.ktor.network.selector.* import io.ktor.network.selector.*
@ -24,7 +14,6 @@ import net.sergeych.mp_logger.LogTag
import net.sergeych.mp_logger.Loggable import net.sergeych.mp_logger.Loggable
import net.sergeych.mp_logger.debug import net.sergeych.mp_logger.debug
import net.sergeych.mp_logger.exception import net.sergeych.mp_logger.exception
import net.sergeych.mp_tools.globalDefer
import kotlin.time.Duration import kotlin.time.Duration
import kotlin.time.Duration.Companion.minutes import kotlin.time.Duration.Companion.minutes
@ -62,9 +51,7 @@ class UdpServer(val port: Int, localInterface: String = "0.0.0.0", maxInactivity
private val access = Mutex() private val access = Mutex()
private val selectorManager = SelectorManager(Dispatchers.IO) private val selectorManager = SelectorManager(Dispatchers.IO)
private val serverSocket = globalDefer { private val serverSocket = aSocket(selectorManager).udp().bind(InetSocketAddress(localInterface, port))
aSocket(selectorManager).udp().bind(InetSocketAddress(localInterface, port))
}
override suspend fun disconnectClient(address: SocketAddress) { override suspend fun disconnectClient(address: SocketAddress) {
access.withLock { sessions.remove(address) } access.withLock { sessions.remove(address) }
@ -78,7 +65,7 @@ class UdpServer(val port: Int, localInterface: String = "0.0.0.0", maxInactivity
flow { flow {
while (true) { while (true) {
try { try {
val datagram = serverSocket.await().receive() val datagram = serverSocket.receive()
val block = UdpBlock.decode(datagram) val block = UdpBlock.decode(datagram)
val remoteAddress = datagram.address val remoteAddress = datagram.address
@ -110,10 +97,10 @@ class UdpServer(val port: Int, localInterface: String = "0.0.0.0", maxInactivity
} }
override suspend fun sendBlock(block: UdpBlock, toAddress: SocketAddress) { override suspend fun sendBlock(block: UdpBlock, toAddress: SocketAddress) {
serverSocket.await().send(block.toDatagram(toAddress)) serverSocket.send(block.toDatagram(toAddress))
} }
suspend fun isClosed(): Boolean = serverSocket.await().isClosed val isClosed: Boolean get() = serverSocket.isClosed
/** /**
* Close the UDP server. Calling it will cause: * Close the UDP server. Calling it will cause:
@ -126,8 +113,8 @@ class UdpServer(val port: Int, localInterface: String = "0.0.0.0", maxInactivity
*/ */
suspend fun close() { suspend fun close() {
access.withLock { access.withLock {
if (!isClosed()) { if (!isClosed) {
runCatching { serverSocket.await().close() } runCatching { serverSocket.close() }
} }
} }
while (sessions.isNotEmpty()) { while (sessions.isNotEmpty()) {

View File

@ -1,13 +1,3 @@
/*
* Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
*
* You may use, distribute and modify this code under the
* terms of the private license, which you must obtain from the author
*
* To obtain the license, contact the author: https://t.me/real_sergeych or email to
* real dot sergeych at gmail.
*/
package net.sergeych.kiloparsec.adapter package net.sergeych.kiloparsec.adapter
import io.ktor.network.sockets.* import io.ktor.network.sockets.*

View File

@ -1,13 +1,3 @@
/*
* Copyright (c) 2025. Sergey S. Chernov - All Rights Reserved
*
* You may use, distribute and modify this code under the
* terms of the private license, which you must obtain from the author
*
* To obtain the license, contact the author: https://t.me/real_sergeych or email to
* real dot sergeych at gmail.
*/
package net.sergeych.kiloparsec.adapter package net.sergeych.kiloparsec.adapter
import assertThrows import assertThrows
@ -20,7 +10,7 @@ import kotlin.test.Test
import kotlin.test.assertEquals import kotlin.test.assertEquals
import kotlin.test.assertIs import kotlin.test.assertIs
class InternetTest { class InternetrTest {
class TestException : Exception("test1") class TestException : Exception("test1")
@Test @Test
@ -36,11 +26,9 @@ class InternetTest {
val cmdSave by command<String, Unit>() val cmdSave by command<String, Unit>()
val cmdLoad by command<Unit, String>() val cmdLoad by command<Unit, String>()
val cmdDrop by command<Unit, Unit>() val cmdDrop by command<Unit, Unit>()
val cmdPing by command<String, String>()
val cmdException by command<Unit, Unit>() val cmdException by command<Unit, Unit>()
val cmdCallClient by command<String, String>()
val serverInterface = KiloInterface<Session>().apply { val cli = KiloInterface<Session>().apply {
registerError { TestException() } registerError { TestException() }
onConnected { session.data = "start" } onConnected { session.data = "start" }
on(cmdSave) { session.data = it } on(cmdSave) { session.data = it }
@ -53,26 +41,15 @@ class InternetTest {
on(cmdDrop) { on(cmdDrop) {
throw LocalInterface.BreakConnectionException() throw LocalInterface.BreakConnectionException()
} }
on(cmdCallClient) {
remote.call(cmdPing, it)
} }
} val server = KiloServer(cli, acceptTcpDevice(port)) {
val server = KiloServer(serverInterface, acceptTcpDevice(port)) {
Session("unknown") Session("unknown")
} }
data class LocalSession(val localFoo: String) val client = KiloClient<Unit>() {
addErrors(cli)
val client = KiloClient {
addErrors(serverInterface)
session { LocalSession("unknown") }
// TODO: add register error variant // TODO: add register error variant
connect { connectTcpDevice("localhost:$port") } connect { connectTcpDevice("localhost:$port") }
local {
on(cmdPing) {
"pong! $it"
}
}
} }
assertEquals("start", client.call(cmdLoad)) assertEquals("start", client.call(cmdLoad))
@ -88,7 +65,7 @@ class InternetTest {
// reconnect? // reconnect?
assertEquals("start", client.call(cmdLoad)) assertEquals("start", client.call(cmdLoad))
assertEquals("pong! 42", client.call(cmdCallClient, "42"))
server.close() server.close()
} }
@ -127,7 +104,7 @@ class InternetTest {
val client = KiloClient<Unit>() { val client = KiloClient<Unit>() {
addErrors(cli) addErrors(cli)
connect { connectUdpDevice("127.0.0.1:$port") } connect { connectUdpDevice("localhost:$port") }
} }
assertEquals("start", client.call(cmdLoad)) assertEquals("start", client.call(cmdLoad))
@ -155,7 +132,7 @@ class InternetTest {
var data: String, var data: String,
) )
val port = 27170 + Random.nextInt(1, 900) val port = 27170 + Random.nextInt(1, 200)
val cmdSave by command<String, Unit>() val cmdSave by command<String, Unit>()
val cmdLoad by command<Unit, String>() val cmdLoad by command<Unit, String>()
@ -177,28 +154,19 @@ class InternetTest {
} }
} }
val uServer = UdpServer(port) val uServer = UdpServer(port)
KiloServer(cli, uServer.transportFlow) { KiloServer(cli, uServer.transportFlow) {
Session("unknown") Session("unknown")
} }
// second server
KiloServer(cli,acceptUdpDevice(uServer.port+1)) { Session("unknown2") }
val client = KiloClient<Unit>() { val client = KiloClient<Unit>() {
addErrors(cli) addErrors(cli)
connect { connectUdpDevice("127.0.0.1:$port") } connect { connectUdpDevice("localhost:$port") }
} }
val client2 = KiloClient<Unit>() { connect { connectUdpDevice("127.0.0.1:${port+1}") } }
assertEquals("start", client.call(cmdLoad)) assertEquals("start", client.call(cmdLoad))
assertEquals("start", client2.call(cmdLoad))
client.call(cmdSave, "foobar") client.call(cmdSave, "foobar")
client2.call(cmdSave, "buzz")
assertEquals("foobar", client.call(cmdLoad)) assertEquals("foobar", client.call(cmdLoad))
assertEquals("buzz", client2.call(cmdLoad))
val res = kotlin.runCatching { client.call(cmdException) } val res = kotlin.runCatching { client.call(cmdException) }
assertIs<TestException>(res.exceptionOrNull()) assertIs<TestException>(res.exceptionOrNull())