SergeychWorks/kiloparsec
1
0 Fork 0
Code Issues 2 Pull Requests Packages Projects Releases 7 Wiki Activity

0.3.2: UDP support

Browse Source
This commit is contained in:
sergeych committed 2024-08-11 14:17:54 +02:00
1 parent f6fbf8e58e
commit 4d178d951f
15 files changed
+905 -84
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

README.md
+29 -10
View File
@@ -1,18 +1,21 @@
# Kiloparsec
__Recommended version is `0.3.1`: to keep the code compatible with current and further versions we
ask to upgrade to `0.3.1` at least.__
__Recommended version is `0.3.2`: to keep the code compatible with current and further versions we
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.
The new generation of __PARanoid SECurity__ protocol, advanced, faster, more secure. It also allows connecting any "
block device" transport to the same local interface. Out if the box it
provides the following transports:
| name | JVM | JS | native |
|----------------|-----|----|----------|
| TCP/IP server | ✓ | | >= 0.2.6 |
| TCP/IP client | ✓ | | >= 0.2.6 |
| Websock server | ✓ | | |
| Websock client | ✓ | ✓ | ✓ |
| name | JVM | JS | native |
|----------------|--------|----|--------|
| TCP/IP server | ✓ | | 0.2.6+ |
| TCP/IP client | ✓ | | 0.2.6+ |
| UDP server | 0.3.2+ | | 0.3.2+ |
| UDP client | 0.3.2+ | | 0.3.2+ |
| Websock server | ✓ | | |
| Websock client | ✓ | ✓ | ✓ |
### Note on version compatibility
@@ -23,7 +26,7 @@ format. The format from 0.3.0 onwards is supposed to keep compatible.
- iosArm64, iosX64
- macosArm64, macosArm64
- linxArm64, linuxX64
- linuxArm64, linuxX64
### Non-native targets
@@ -67,7 +70,7 @@ It could be, depending on your project structure, something like:
```kotlin
val commonMain by getting {
dependencies {
api("net.sergeych:kiloparsec:0.3.1")
api("net.sergeych:kiloparsec:0.3.2")
}
}
```
@@ -171,6 +174,22 @@ In short, there are two functions that implements asynchronous TCP/IP transport
- [connectTcpDevice](https://code.sergeych.net/docs/kiloparsec/kiloparsec/net.sergeych.kiloparsec.adapter/connect-tcp-device.html) to connect to the server
## UDP client and server
Is very much straightforward, same as with TCP/IP:
- [UDP server creation](https://code.sergeych.net/docs/kiloparsec/kiloparsec/net.sergeych.kiloparsec.adapter/accept-udp-device.html)
- [Connect UDP client](https://code.sergeych.net/docs/kiloparsec/kiloparsec/net.sergeych.kiloparsec.adapter/connect-udp-device.html)
### UDP specifics
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.
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.
## Reusing code between servers
The same instance of the [KiloInterface](https://code.sergeych.net/docs/kiloparsec/kiloparsec/net.sergeych.kiloparsec/-kilo-interface/index.html?query=open%20class%20KiloInterface%3CS%3E%20:%20LocalInterface%3CKiloScope%3CS%3E%3E) could easily be reused with all instances of servers with different protocols.