Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/icerockdev/moko-socket-io
MOKO SocketIo by IceRock is Socket.IO implementation Kotlin Multiplatform library
https://github.com/icerockdev/moko-socket-io
android ios kotlin kotlin-multiplatform kotlin-native moko socket-io
Last synced: 28 days ago
JSON representation
MOKO SocketIo by IceRock is Socket.IO implementation Kotlin Multiplatform library
- Host: GitHub
- URL: https://github.com/icerockdev/moko-socket-io
- Owner: icerockdev
- License: apache-2.0
- Created: 2020-05-05T12:12:02.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-08-24T14:37:26.000Z (3 months ago)
- Last Synced: 2024-09-29T01:02:43.851Z (about 1 month ago)
- Topics: android, ios, kotlin, kotlin-multiplatform, kotlin-native, moko, socket-io
- Language: Kotlin
- Homepage: https://moko.icerock.dev/
- Size: 166 KB
- Stars: 123
- Watchers: 11
- Forks: 23
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- kmp-awesome - MOKO SocketIo - Socket.IO implementation (Libraries / 🌎 Network)
README
[](http://www.apache.org/licenses/LICENSE-2.0) [ ](https://repo1.maven.org/maven2/dev/icerock/moko/socket-io) 
# Mobile Kotlin socket io
This is a Kotlin MultiPlatform library that provides real-time, event-based communication for iOS and Android.
## Table of Contents
- [Features](#features)
- [Requirements](#requirements)
- [Versions](#versions)
- [Installation](#installation)
- [Usage](#usage)
- [Samples](#samples)
- [Set Up Locally](#set-up-locally)
- [Contributing](#contributing)
- [License](#license)
## Features
- **Socket.IO in common code** - actual implementations is [socket.io-client-java](https://github.com/socketio/socket.io-client-java) and [socket.io-client-swift](https://github.com/socketio/socket.io-client-swift);
## Requirements
- Gradle version 6.8+
- Android API 16+
- iOS version 11.0+
## Installation
### root build.gradle
```groovy
allprojects {
repositories {
mavenCentral()
}
}
```
### project build.gradle
```groovy
dependencies {
commonMainApi("dev.icerock.moko:socket-io:0.6.0")
}
```
#### With JetBrains cocoapods plugin
project build.gradle
```
plugins {
kotlin("native.cocoapods")
}
...
kotlin {
cocoapods {
...
// 11.0 minimal supported
ios.deploymentTarget = "11.0"
// add native dependency
pod(name = "mokoSocketIo") {
source = git(url = "https://github.com/icerockdev/moko-socket-io.git") {
tag = "release/0.6.0"
}
}
}
}
```
Podfile
```
pod 'mokoSocketIo', :git => 'https://github.com/icerockdev/moko-socket-io.git', :tag => 'release/0.6.0'
```
(!) Check sample - https://github.com/Alex009/moko-socket-io-sample ([integration changes](https://github.com/Alex009/moko-socket-io-sample/commit/7439093217f9c041369540011d84d7109b2c1606))
#### With IceRock cocoapods plugin
project build.gradle
```
plugins {
id("dev.icerock.mobile.multiplatform.cocoapods")
}
...
cocoaPods {
podsProject = file("../ios-app/Pods/Pods.xcodeproj") // here should be path to Pods xcode project
pod("mokoSocketIo", onlyLink = true)
}
```
Podfile
```ruby
pod 'mokoSocketIo', :git => 'https://github.com/icerockdev/moko-socket-io.git', :tag => 'release/0.6.0'
```
## Usage
`common`:
```kotlin
val socket = Socket(
endpoint = "wss://my-super-server:8080",
config = SocketOptions(
queryParams = mapOf("token" to "MySuperToken"),
transport = SocketOptions.Transport.WEBSOCKET
)
) {
on(SocketEvent.Connect) {
println("connect")
}
on(SocketEvent.Connecting) {
println("connecting")
}
on(SocketEvent.Disconnect) {
println("disconnect")
}
on(SocketEvent.Error) {
println("error $it")
}
on(SocketEvent.Reconnect) {
println("reconnect")
}
on(SocketEvent.ReconnectAttempt) {
println("reconnect attempt $it")
}
on(SocketEvent.Ping) {
println("ping")
}
on(SocketEvent.Pong) {
println("pong")
}
on("employee.connected") { data ->
val serializer = DeliveryCar.serializer()
val json = JSON.nonstrict
val deliveryCar: DeliveryCar = json.parse(serializer, data)
//...
}
}
```
## Samples
Please see more examples in the [sample directory](sample).
## Set Up Locally
- The [socket-io directory](socket-io) contains the `socket-io` library;
- The [sample directory](sample) contains sample apps for Android and iOS; plus the mpp-library connected to the apps;
## Contributing
All development (both new features and bug fixes) is performed in the `develop` branch. This way `master` always contains the sources of the most recently released version. Please send PRs with bug fixes to the `develop` branch. Documentation fixes in the markdown files are an exception to this rule. They are updated directly in `master`.
The `develop` branch is pushed to `master` on release.
For more details on contributing please see the [contributing guide](CONTRIBUTING.md).
## License
Copyright 2020 IceRock MAG Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
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.