This is a Kotlin Multiplatform project, however it is implemented and works ONLY on JVM right now. This means any JVM project/platform can use this library, so Android and Java Desktop/Server applications can run it.
- Discover hosts in the same network
- Connect and transfer data among clients
Add the JitPack repository to your build file
allprojects {
repositories {
...
maven { url = uri("https://jitpack.io") }
}
}Add the dependency
implementation("com.github.DatL4g:Klient2Klient:$latestVersion")The discovery relies on a builder and provides the following options
setDiscoveryTimeout(milliSecondsOrDuration)after which time it stops discovering (searching for other hosts)setDiscoveryTimeoutListener{ }called in IO dispatcher but is a suspend function, so you can switch context easilysetDiscoverableTimeout(milliSecondsOrDuration)after which time it stops broadcasting to other hosts (cannot be discovered anymore)setDiscoverableTimeoutListener{ }called in IO dispatcher but is a suspend function, so you can switch context easilysetPing(milliSecondsOrDuration)at which interval it broadcasts to other hostssetPuffer(milliSecondsOrDuration)tolerance in which time the hosts need to ping again (since it's UDP, packages may be lost or not sent)setPort(int)on which port to broadcast and listensetHostFilter(regex)the discovered hosts need to match this (keep empty (and filterMatch in Host) for any or change the regex to ".*")setScope(coroutineScope)change the scope in which the discovery jobs are running insetHostIsClient(boolean)whether the current host should be discovered ass a client too (default off)build()create an instance of Discovery
The builder can be called using two different methods.
val discover = Discovery.Builder(coroutineScope /* optional */)
.setPort(1337)
.otherBuilderMethods()
.build()val discover = coroutineScope.discovery {
setPort(1337)
otherBuilderMethods()
}Basically the host holds three parameter
- name: the name of the host
- filterMatch: the String to match the hostFilter regex
- optionalInfo: any JsonElement
Call any of the following methods:
discover.makeDiscoverable(Host("name", "filterMatch" /* optional */, jsonElement /* optional */))discover.makeDiscoverable("name", "filterMatch" /* optional */, jsonElement /* optional */)discover.makeDiscoverable("name", "filterMatch" /* optional */, "{jsonString: true}" /* optional */)To stop being discoverable imply call
discover.stopBeingDiscoverable()discover.startDiscovery()
//or
discover.startDiscovery(hostIsClient)To stop discovery simply call
discover.stopDiscovery()To get the current list of found hosts synchronously use:
val setOfHosts = discover.peersThe host list can be collected to always get the latest items
discover.peersFlow.collect { hosts ->
// got new hosts
}The connection relies on a builder as well with these options:
fromDiscovery(discover)just to pass the peersforPeers(setOfHosts)pass the peers yourselfforPeer(host)only connect to one hostsetPort(int)the port on which the connection will be establishedsetScope(coroutineScope)change the scope in which the connection jobs are running inbuild()create an instance of Connection
The builder can be used two different ways again:
val connect = Connection.Builder(coroutineScope /* optional */)
.fromDiscovery(discover)
.setPort(7331)
.build()val connect = coroutineScope.connection {
fromDiscovery(discover)
setPort(7331)
}To start receiving just call, this will allow to get data from another host
connect.startReceiving()Stopping is as easy as starting
connect.stopReceiving()To send data to all connected hosts use
connect.send(bytes)To send data to one host only use
connect.send(bytes, host)Collecting data can be done using Flows again
connect.receiveData.collect { pair: Pair<Host, ByteArray> ->
// received data from another host
}When you face any bugs or problems please open an Issue.
To add functionality fork the project and create a pull request afterwards. You should know how that works if you are a developer :) You can add yourself to the list below if you want then.
| Avatar | Contributor |
|---|---|
| DatLag |
Supporting this project helps to keep it up-to-date. You can donate if you want or contribute to the project as well. This shows that the library is used by people and it's worth to maintain.