Artifacts summary

Krossbow offers a lot of possibilities so here is a summary of all available artifacts.

All these artifacts are published to Maven Central under the group ID org.hildan.krossbow and a common version.

STOMP artifacts

You should pick only one of the krossbow-stomp-* artifacts, depending on whether you need automatic serialization of frame bodies:

Artifact	Description
krossbow-stomp-core	The basic multiplatform STOMP client. It implements the STOMP 1.2 protocol on top of the web socket abstraction defined by the krossbow-websocket-core module.
krossbow-stomp-jackson	A superset of krossbow-stomp-core adding JSON conversion features using Jackson (JVM only)
krossbow-stomp-moshi	A superset of krossbow-stomp-core adding JSON conversion features using Moshi (JVM only)
krossbow-stomp-kxserialization	A superset of krossbow-stomp-core adding conversion features using Kotlinx Serialization library (multiplatform). You can leverage the multi-format capabilities of Kotlinx Serialization (JSON, protobuf, CBOR, ...).
krossbow-stomp-kxserialization-json	A superset of krossbow-stomp-kxserialization adding JSON helpers and the JSON format dependency.

Then add the dependency of your choice to your Gradle build. For instance, if you intend to use Krossbow with Kotlinx Serialization:

implementation("org.hildan.krossbow:krossbow-stomp-kxserialization:7.0.0")

Don't need STOMP?

If you're just interested in the web socket client without STOMP protocol, don't declare a STOMP artifact, but instead choose one of the web socket artifacts below.

Web Socket artifacts

The STOMP artifacts depend on a web socket API that needs an implementation. Krossbow provides implementations for the built-in web socket API of most platforms, and also adapters for 3rd-party web socket implementations:

Artifact	Description
krossbow-websocket-builtin	A multiplatform WebSocketClient implementation that adapts the built-in client for each supported platform without transitive dependency.
krossbow-websocket-ktor	A multiplatform WebSocketClient implementation based on Ktor 2.3.10's HttpClient.
krossbow-websocket-okhttp	A JVM implementation of the web socket API using OkHttp's client.
krossbow-websocket-sockjs	A multiplatform WebSocketClient implementation for use with SockJS servers. It uses Spring's SockJSClient on JVM, and npm sockjs-client for JavaScript (NodeJS and browser).
krossbow-websocket-spring	A JVM 8+ implementation of the web socket API using Spring's WebSocketClient. Provides both a normal WebSocket client and a SockJS one.

Peer dependencies

Some Krossbow modules are not opinionated and require some extra third-party peer dependencies. Make sure to read the usage section corresponding to the module of your choice for more details.