pusher-websocket-kmp
0.1.8indexedEnables code sharing across applications with Compose Multiplatform, organizing platform-specific and common code, while integrating SwiftUI for iOS apps.
4
Stars
—
Used by
dependents
—
Health
/ 100
Enables code sharing across applications with Compose Multiplatform, organizing platform-specific and common code, while integrating SwiftUI for iOS apps.
A Kotlin Multiplatform library for working with Pusher Channels, providing real-time WebSocket support across Android, iOS, and desktop targets.
Add the library to your Kotlin Multiplatform project.
// build.gradle.kts (project)
repositories {
mavenCentral()
}
// build.gradle.kts (shared module)
kotlin {
sourceSets {
commonMain.dependencies {
implementation("uk.co.lidbit:pusher-websocket-kmp:<latest-version>")
}
}
}
On iOS this library wraps PusherSwift
via Kotlin/Native cinterop. Kotlin compiles bindings against PusherSwift but does not
bundle its binary, and native framework dependencies are not resolved transitively
through Gradle/Maven. This means PusherSwift must be present at the final link step of your
iOS app, so every consuming project has to add it once.
Add PusherSwift to your iOS app with Swift Package Manager:
https://github.com/pusher/pusher-websocket-swift with the
Up to Next Major Version rule from 10.1.10.PusherSwift product to your app target.PusherSwift requires a minimum deployment target of iOS 13.0, so make sure your app target is set to 13.0 or higher. It only needs to be declared once, in the final iOS app.
val options = PusherOptions.Builder()
.setCluster("YOUR_CLUSTER") // or use .setHost(...)
.setAutoReconnect(true)
.setUseTls(true)
.build()
val pusher = PusherClient(
apiKey = "YOUR_PUSHER_KEY",
options = options
)
pusher.connect(
onConnectionStateChange = { current, previous ->
println("Connection changed from $previous to $current")
},
onError = { message, code, exception ->
println("Connection error: $message (), exception: ")
}
)
pusher.subscribe(
channel = "my-channel",
onSuccess = {
println("Successfully subscribed to my-channel")
},
onEvent = { event ->
println("Received event: ${event.name} with data: ${event.data}")
},
"my-event"
)
// or create your own using the ChannelAuthorizer interface
val channelAuthorizer = HttpChannelAuthorizer(
endpoint = "https://example.domain/broadcasting/auth",
headers = {
mapOf(
to ,
)
},
)
options = PusherOptions.Builder()
.setCluster()
.setChannelAuthorizer(channelAuthorizer)
.build()
pusher = PusherClient(, options)
pusher.connect()
pusher.subscribePrivate(
channel = ,
onSuccess = {
println()
},
onAuthenticationFailure = { message, error ->
println()
},
onEvent = { event ->
println()
},
)
pusher.disconnect()
You can customize the PusherOptions using the Builder class. Below is a list of available
configuration options:
Contributions welcome! Please open an issue or submit a pull request.
MIT
Inspired by:
// or create your own using the UserAuthenticator interface
val userAuthenticator = HttpUserAuthenticator(
endpoint = "https://example.domain/broadcasting/auth",
headers = {
mapOf(
"Authorization" to "Bearer {token}",
)
},
)
val options = PusherOptions.Builder()
.setCluster("YOUR_CLUSTER")
.setUserAuthenticator(userAuthenticator)
.build()
val pusher = PusherClient("YOUR_PUSHER_KEY", options)
pusher.connect()
pusher.subscribePresence(
channel = "presence-my-channel",
onSuccess = {
println("Subscribed to presence channel")
},
onUsersInformationReceived = { users ->
// only available for jvm client
println("Initial users: $users")
},
onUserCountChanged = { count ->
println("User count changed: $count")
},
userSubscribed = { user ->
println("User subscribed: $user")
},
userUnsubscribed = { user ->
println("User unsubscribed: $user")
},
onAuthenticationFailure = { message, error ->
println("Presence auth failed: $message, exception: $error")
},
onEvent = { event ->
println("Presence event: ${event.name}")
},
"presence-event"
)
| Option | JVM | iOS | Description |
|---|
setHost(host: String) | ✅ | ✅ | Connect to a custom host instead of using a cluster. |
setCluster(cluster: String) | ✅ | ✅ | Use a predefined Pusher cluster (e.g., "eu"). Ignored if host is set. |
setProxy(proxy: Proxy) | ✅ | ❌ | Set a proxy for WebSocket connections. |
setActivityTimeout(timeout: Duration) | ✅ | ✅ | Time until a ping is sent if no activity is detected. |
setPongTimeout(timeout: Long) | ✅ | ❌ | Time in ms to wait for a pong after sending a ping. |
setAutoReconnect(autoReconnect: Boolean) | ✅ | ✅ | Automatically reconnect after disconnection. |
setMaxReconnectGapInSeconds(seconds: Int) | ✅ | ❌ | Max delay between reconnection attempts. |
setMaxReconnectionAttempts(attempts: Int) | ✅ | ❌ | Max number of reconnection attempts before giving up. |
setUseTls(useTLS: Boolean) | ✅ | ✅ | Use secure WebSocket (WSS) connections. |
setChannelAuthorizer(authorizer: ChannelAuthorizer) | ✅ | ✅ | Custom authorizer for private channels. |
setUserAuthenticator(authenticator: UserAuthenticator) | ✅ | ✅ | Custom authenticator for presence channels. |
setWsPort(port: Int) | ✅ | ✅ | Override default unencrypted WebSocket port (80). |
setWssPort(port: Int) | ✅ | ✅ | Override default encrypted WebSocket port (443). |
Surfaced from shared tags and platforms — no rankings paid for.