Mobile Kotlin socket io

This is a Kotlin MultiPlatform library that provides real-time, event-based communication for iOS and Android.

Features
Requirements
Versions
Installation
Usage
Samples
Set Up Locally
Contributing
License

Features

Socket.IO in common code - actual implementations is socket.io-client-java and socket.io-client-swift;

Requirements

Gradle version 6.0+
Android API 16+
iOS version 9.0+

Versions

kotlin 1.3.72
- 0.1.0
kotlin 1.4.10
- 0.2.0

Installation

root build.gradle

allprojects {
    repositories {
        maven { url = "https://dl.bintray.com/icerockdev/moko" }
    }
}

project build.gradle

dependencies {
    commonMainApi("dev.icerock.moko:socket-io:0.2.0")
    commonMainApi("org.jetbrains.kotlinx:kotlinx-serialization-core:1.0.0-RC")
}

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.2.0'

Usage

common:

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.

Set Up Locally

The socket-io directory contains the socket-io library;
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 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.

alexpogrebnyak/moko-socket-io