A Retrofit inspired WebSocket client for Kotlin, Java, and Android
Clone or download
Latest commit d2d0909 Jan 15, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Update docker image Oct 25, 2018
demo Fix demo app Oct 31, 2018
example Update Asset Jun 14, 2018
gradle/wrapper Revert change to gradle-wrapper.properties Aug 24, 2018
scarlet-core-internal Merge branch 'master' into ahe/update-build-tools Jul 1, 2018
scarlet-core Merge branch 'master' into ahe/update-build-tools Jul 1, 2018
scarlet-lifecycle-android Fix tests Oct 25, 2018
scarlet-message-adapter-builtin Merge branch 'master' into ahe/update-build-tools Jul 1, 2018
scarlet-message-adapter-gson Merge branch 'master' of github.com:Tinder/Scarlet into vishesh/repla… Aug 9, 2018
scarlet-message-adapter-jackson add line to force build Oct 19, 2018
scarlet-message-adapter-moshi Merge branch 'master' of github.com:Tinder/Scarlet into vishesh/repla… Aug 9, 2018
scarlet-message-adapter-protobuf Merge branch 'master' into ahe/update-build-tools Jul 1, 2018
scarlet-stream-adapter-builtin Merge branch 'master' into ahe/update-build-tools Jul 1, 2018
scarlet-stream-adapter-coroutines update test to trigger CI build Nov 5, 2018
scarlet-stream-adapter-rxjava Merge branch 'master' into ahe/update-build-tools Jul 1, 2018
scarlet-stream-adapter-rxjava2 Merge branch 'master' into ahe/update-build-tools Jul 1, 2018
scarlet-test-utils Update header copyright Jun 22, 2018
scarlet-websocket-mockwebserver Merge branch 'master' into ahe/update-build-tools Jul 1, 2018
scarlet-websocket-okhttp Merge branch 'master' into ahe/update-build-tools Jul 1, 2018
scarlet Fix formatting Oct 25, 2018
.gitignore create JacksonMessageAdapter Oct 17, 2018
KotlinStyle.xml Init project Jun 14, 2018
LICENSE Add LICENSE Jun 14, 2018
README.md Update README.md Jan 15, 2019
build.gradle Updated coroutines to stable version (include kotlin 1.3.0 release bump) Nov 4, 2018
dependencies.gradle Updated coroutines to stable version (include kotlin 1.3.0 release bump) Nov 4, 2018
gradle.properties Migrate to AndroidX Oct 25, 2018
gradlew Init project Jun 14, 2018
gradlew.bat Init project Jun 14, 2018
jitpack.yml Support Jitpack Jun 19, 2018
publish-jitpack.sh Use the latest state machine Oct 24, 2018
publish.sh Use the latest state machine Oct 24, 2018
settings.gradle Use the latest state machine Oct 24, 2018

README.md

Scarlet

CircleCI Release

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 branch and is available at com.github.tinder:scarlet:0.2.1-alpha4.

Tutorial

Usage

In this example, we read the realtime Bitcoin price from Gdax WebSocket Feed. For more information, please check out the demo app.

Declare a WebSocket client using an interface:

interface GdaxService {
	@Receive
	fun observeWebSocketEvent(): Flowable<WebSocket.Event>
	@Send
	fun sendSubscribe(subscribe: Subscribe)
	@Receive
 	fun observeTicker(): Flowable<Ticker>
}

Use Scarlet to create an implementation:

val scarletInstance = Scarlet.Builder()
    .webSocketFactory(okHttpClient.newWebSocketFactory("wss://ws-feed.gdax.com"))
    .addMessageAdapterFactory(MoshiMessageAdapter.Factory())
    .addStreamAdapterFactory(RxJava2StreamAdapter.Factory())
    .build()

val gdaxService = scarletInstance.create<GdaxService>()

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

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.

TODO

Download

While we are working on Bintray support, Scarlet is available via JitPack.

Maven:
<repository>
    <id>jitpack.io</id>
    <url>https://jitpack.io</url>
</repository>
<dependency>
    <groupId>com.github.tinder.scarlet</groupId>
    <artifactId>scarlet</artifactId>
    <version>0.1.6</version>
</dependency>
Gradle:
repositories {
    // ...
    maven { url "https://jitpack.io" }
}

implementation 'com.github.tinder.scarlet:scarlet:$0.1.6'

Plug-in Roadmap

WebSocket.Factory

  • OkHttpClient
  • MockHttpServer

MessageAdapter.Factory

  • moshi
  • gson
  • protobuf
  • jackson
  • simple-xml

StreamAdapter.Factory

  • RxJava2
  • RxJava1
  • Kotlin Coroutine

Lifecycle

  • AndroidLifecycle

BackoffStrategy

  • Linear
  • Exponential
  • 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.