moko-socket-io
0.6.0indexedFacilitates real-time, event-based communication through Socket.IO for mobile platforms, supporting various socket events and offering seamless integration with common code.
157
Stars
—
Used by
dependents
—
Health
/ 100
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
- Socket.IO in common code - actual implementations is socket.io-client-java and socket.io-client-swift;
Requirements
- Gradle version 6.8+
- Android API 16+
- iOS version 11.0+
Installation
root build.gradle
allprojects {
repositories {
mavenCentral()
}
}
project build.gradle
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)
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
pod 'mokoSocketIo', :git => 'https://github.com/icerockdev/moko-socket-io.git', :tag => 'release/0.6.0'
Usage
common:
Samples
Please see more examples in the sample directory.
Set Up Locally
- The socket-io directory contains the
socket-iolibrary; - The sample directory 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.
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 the License.
You may obtain a copy of the License at
http:
Unless applicable law agreed to writing, software
distributed under the License distributed an BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express implied.
See the License the specific language governing permissions
limitations under the License.