README.md

RxSSE

Server-Sent Events client for Android and Java applications.

Built with Kotlin, RxJava and OkHttp.

Usage

Create an RxSSE instance with a default client:

val rxsse = RxSSE()

Or with a pre-configured client:

val client = OkHttpClient.Builder().build()
val rxsse = RxSSE(client)

Then use it to connect to URLs:

rxsse
    .connectTo("https://localhost/events")
    .subscribe { println("Received: $it") }

Or customize the request:

val request = Request.Builder().url(myUrl).build()
rxsse
    .connectTo(request)
    .subscribe { println("Received: $it") }

The connection is synchronous by default. Use subscribeOn / observeOn if you want it to run on another thread:

rxsse
    .connectTo("https://localhost/events")
    .subscribeOn(Schedulers.io())
    .observeOn(AndroidSchedulers.mainThread())
    .subscribe { println("Received: $it") }

You can use RxJava's retry operators to reconnect if there is an error. For example, try to reconnect after a fixed timeout:

rxsse
    .connectTo("https://localhost/events")
    .retryWhen { it.flatMap { Flowable.timer(5, TimeUnit.SECONDS) } }
    .subscribe { println("Received: $it") }

Finally, don't forget to close the connection:

val disposable = rxsse
    .connectTo("https://localhost/events")
    .subscribeOn(Schedulers.io())
    .subscribe { println("Received: $it") }

// Close the connection
disposable.dispose()

Download

Available on JCenter with:

• Gradle:

compile 'com.saladevs:rxsse:0.2.0'

• Maven:

<dependency>
  <groupId>com.saladevs</groupId>
  <artifactId>rxsse</artifactId>
  <version>0.2.0</version>
</dependency>

TODO

• Add tests.

• Implement automatic retries.

• Automatically send Last-Event-ID header on retries.

Contributing

Contributions and feedback are welcome!

Please create an issue to discuss it first :)

License

Copyright 2017 Enric Sala

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.