Getting Started

About

JavaPhoenixClient is a JVM port of the phoenix.js client written in Kotlin. The goal is to have as close to the same behavior across platforms, regardless of which client you are using. There is a similar project built for iOS platforms at SwiftPhoenixClient

Installation

JavaPhoenixClient is hosted in jcenter. You will need to add jcenter() to your repositories in ./build.gradle or ./app/build.gradle

repositories {
  google()
  jcenter()
  //.. 
}

You can now add the dependency to your project. Be sure to check releases for the latest release version.

dependencies {
  implementation 'com.github.dsrees:JavaPhoenixClient:x.y.z'
}

Dependencies

Currently, JavaPhoenixClient depends upon OkHttp3 and Gson.

OkHttp

OkHttp provides the underlying socket implementation.

Note about Version

JavaPhoenixClient ships with OkHttp 3.12.2 to maintain support pre-lollipop. The 3.12.x branch will be supported through December 31, 2020. After that, JavaPhoenixClient will be updated to the latest OkHttp.

Gson

Gson provides JSON mapping into the Message object. It is a goal to eventually use kotlinx.serialization