https://github.com/t-fowl/socket-io-coroutines

Kotlin coroutine extensions for the socket.io java client library
https://github.com/t-fowl/socket-io-coroutines

coroutines kotlin socket-io

Last synced: about 1 month ago
JSON representation

Kotlin coroutine extensions for the socket.io java client library

• Host: GitHub
• URL: https://github.com/t-fowl/socket-io-coroutines
• Owner: T-Fowl
• License: mit
• Created: 2021-07-27T06:31:19.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-03-10T13:59:08.000Z (almost 2 years ago)
• Last Synced: 2024-11-15T04:11:15.597Z (2 months ago)
• Topics: coroutines, kotlin, socket-io
• Language: Kotlin
• Homepage:
• Size: 102 KB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# socket-io-coroutines

![Build](https://github.com/T-Fowl/socket-io-coroutines/workflows/Build/badge.svg)

![Maven Central](https://img.shields.io/maven-central/v/com.tfowl.socketio/socket-io-coroutines)

![GitHub](https://img.shields.io/github/license/T-Fowl/socket-io-coroutines)

Simple kotlin coroutine extensions for the socket.io java client library.

## Usage

Connecting:

```kotlin

try {

    val connectedSocket = socket.connectAwait()

} catch(t: SocketIOConnectionException) {

    

}

``` 

Emitting Events:

```kotlin

val result = socket.emitAwait("event_name", arguments())

```

Listening for one-time events:

```kotlin

val result = emitter.onceAwait("event_name")

```

Events as a flow:

```kotlin

emitter.onFlow("event_name")

    .collect { event -> doStuff(event) }

```

## Versions

Library is designed, compiled and tested against `io.socket:socket.io-client:1.0.1`.

Currently there is no guarantee of working on older or newer versions.

## Download

Add a gradle dependency to your project:

Groovy

```groovy

repositories {

    mavenCentral()

}

implementation "com.tfowl.socketio:socket-io-coroutines:$socketIoCoroutinesVersion"

```

Kotlin DSL

```kotlin

repositories {

    mavenCentral()

}

implementation("com.tfowl.socketio:socket-io-coroutines:$socketIoCoroutinesVersion")

```

Add a maven dependency to your project:

```xml

    com.tfowl.socketio

    socket-io-coroutines

    ${socketIoCoroutinesVersion}

```

## License

```

MIT License

Copyright (c) 2021 Thomas Fowler

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

SOFTWARE.

```