Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Tinder/Scarlet

A Retrofit inspired WebSocket client for Kotlin, Java, and Android
https://github.com/Tinder/Scarlet

Last synced: 3 months ago
JSON representation

A Retrofit inspired WebSocket client for Kotlin, Java, and Android

Host: GitHub
URL: https://github.com/Tinder/Scarlet
Owner: Tinder
License: other
Created: 2018-05-29T17:23:18.000Z (over 6 years ago)
Default Branch: main
Last Pushed: 2022-08-20T12:58:39.000Z (over 2 years ago)
Last Synced: 2024-08-01T01:27:59.190Z (6 months ago)
Language: Kotlin
Homepage:
Size: 1.45 MB
Stars: 3,208
Watchers: 55
Forks: 236
Open Issues: 103
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

awesome-kotlin - Scarlet - A Retrofit inspired WebSocket client for Kotlin, Java, and Android (Libraries)
awesome-list - Tinder/Scarlet - A Retrofit inspired WebSocket client for Kotlin, Java, and Android (Kotlin)
awesome-list - Scarlet

README

        Scarlet

===

[![CircleCI](https://circleci.com/gh/Tinder/Scarlet.svg?style=svg)](https://circleci.com/gh/Tinder/Scarlet)

A Retrofit inspired WebSocket client for Kotlin, Java, and Android.

Update

---

We are working on a new version of Scarlet that supports other persistent connection protocols: ServerSentEvent, Socket IO, STOMP, and MQTT. It can be found on the [`0.2.x`](https://github.com/Tinder/Scarlet/tree/0.2.x) branch.

Tutorial

---

- [Taming WebSocket with Scarlet][tutorial]

- [A talk][slides] at [Conference for Kotliners][kotliners]

Usage

---

In this example, we read the realtime Bitcoin price from [Gdax WebSocket Feed][gdax-websocket-feed].

For more information, please check out the [demo app][demo-app].

Declare a WebSocket client using an interface:

~~~ kotlin

interface GdaxService {

	@Receive

	fun observeWebSocketEvent(): Flowable

	@Send

	fun sendSubscribe(subscribe: Subscribe)

	@Receive

 	fun observeTicker(): Flowable

}

~~~

Use Scarlet to create an implementation:

~~~ kotlin

val scarletInstance = Scarlet.Builder()

    .webSocketFactory(okHttpClient.newWebSocketFactory("wss://ws-feed.gdax.com"))

    .addMessageAdapterFactory(MoshiMessageAdapter.Factory())

    .addStreamAdapterFactory(RxJava2StreamAdapterFactory())

    .build()

val gdaxService = scarletInstance.create()

~~~

Send a `Subscribe` message upon connection open and the server will start streaming tickers which contain the latest price.

~~~ kotlin

val BITCOIN_TICKER_SUBSCRIBE_MESSAGE = Subscribe(

    productIds = listOf("BTC-USD"),

    channels = listOf("ticker")

)

gdaxService.observeWebSocketEvent()

    .filter { it is WebSocket.Event.OnConnectionOpened<*> }

    .subscribe({

        gdaxService.sendSubscribe(BITCOIN_TICKER_SUBSCRIBE_MESSAGE)

    })

gdaxService.observeTicker()

    .subscribe({ ticker ->

        Log.d("Bitcoin price is ${ticker.price} at ${ticker.time}")

    })

~~~

###  Android

Scarlet is driven by a [StateMachine][state-machine].



TODO

Download

--------

Scarlet is available via Maven Central.

Snapshots of the development version are available in [Sonatype's `snapshots` repository][snap].

##### Maven:

```xml

    com.tinder.scarlet

    scarlet

    0.1.12

```

##### Gradle:

```groovy

implementation 'com.tinder.scarlet:scarlet:0.1.12'

```

### Plug-in Roadmap

`WebSocket.Factory`

- [x] `OkHttpClient`

- [x] `MockHttpServer`

`MessageAdapter.Factory`

- [x] `moshi`

- [x] `gson`

- [x] `protobuf`

- [x] `jackson`

- [ ] `simple-xml`

`StreamAdapter.Factory`

- [x] `RxJava2`

- [x] `RxJava1`

- [x] `Kotlin Coroutine`

`Lifecycle`

- [x] `AndroidLifecycle`

`BackoffStrategy`

- [x] `Linear`

- [x] `Exponential`

- [x] `ExponentialWithJitter`

Copyright

---

~~~

Copyright (c) 2018, Match Group, LLC

All rights reserved.

Redistribution and use in source and binary forms, with or without

modification, are permitted provided that the following conditions are met:

    * Redistributions of source code must retain the above copyright

      notice, this list of conditions and the following disclaimer.

    * Redistributions in binary form must reproduce the above copyright

      notice, this list of conditions and the following disclaimer in the

      documentation and/or other materials provided with the distribution.

    * Neither the name of Match Group, LLC nor the names of its contributors

      may be used to endorse or promote products derived from this software

      without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND

ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

DISCLAIMED. IN NO EVENT SHALL MATCH GROUP, LLC BE LIABLE FOR ANY

DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES

(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;

LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND

ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS

SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

~~~

 [gdax-websocket-feed]: https://docs.gdax.com/#websocket-feed

 [demo-app]: /demo/src/main/java/com/tinder/app

 [tutorial]: https://medium.com/tinder-engineering/taming-websocket-with-scarlet-f01125427677

 [slides]: https://speakerdeck.com/zhxnlai/taming-websocket-with-scarlet

 [kotliners]: https://www.conferenceforkotliners.com/

 [state-machine]: https://github.com/Tinder/StateMachine

 [snap]: https://oss.sonatype.org/content/repositories/snapshots/com/tinder/scarlet/