Started on heartbeats, fixed example

Author: forresthopkinsa

README.md

@@ -1,15 +1,17 @@
-# STOMP protocol via WebSocket for Android
+# Websockets on Android
 
 [![Release](https://jitpack.io/v/forresthopkinsa/StompProtocolAndroid.svg)](https://jitpack.io/#forresthopkinsa/StompProtocolAndroid)
 
 ## Overview
 
-**Note that this is a FORK of a project by NaikSoftware! This version is made to avoid using RetroLambda! (Scroll down to see other changes)**
+**Note that this is a FORK of a project by NaikSoftware! This version was originally made to avoid using RetroLambda.**
+
+*(It now has [many other differences](#changes-in-this-fork).)*
 
 This library provides support for [STOMP protocol](https://stomp.github.io/) over Websockets.
 
-At now library works only as client for any backend that supports STOMP, such as
-NodeJS (e.g. using StompJS) or Spring Boot ([with WebSocket support](https://spring.io/guides/gs/messaging-stomp-websocket/)).
+Right now, the library works as a client for any backend that supports STOMP, such as
+Node.js (e.g. using StompJS) or Spring Boot ([with WebSocket support](https://spring.io/guides/gs/messaging-stomp-websocket/)).
 
 Add library as gradle dependency (Versioning info [here](https://jitpack.io/#forresthopkinsa/StompProtocolAndroid)):
 
@@ -28,12 +30,10 @@ You can use this library two ways:
 - Using the old JACK toolchain
   - If you have Java 8 compatiblity and Jack enabled, this library will work for you
 - Using the new Native Java 8 support
-  - As of this writing, you must be using Android Studio Canary to use this feature.
+  - As of this writing, you must be using Android Studio Beta to use this feature.
   - Has been tested in the following environments:
-    - Beta 2, Gradle plugin v3.0.0-beta2
-    - Beta 1, Gradle plugin v3.0.0-beta1
-    - Canary 9, Gradle plugin v3.0.0-alpha9
-    - Canary 8, Gradle plugin v3.0.0-alpha8
+    - Beta 1-9, Gradle plugin v3.0.0-beta(1-9)
+    - Canary 8-9, Gradle plugin v3.0.0-alpha(8-9)
   - It *should* work in all 3.0.0+ versions
   - You can find more info on the [Releases Page](https://github.com/forresthopkinsa/StompProtocolAndroid/releases)
 
@@ -101,7 +101,7 @@ Check out the [upstream example server](https://github.com/NaikSoftware/stomp-pr
  });
 
  client.send("/app/hello", "world").subscribe(
-     aVoid -> Log.d(TAG, "Sent data!"),
+     () -> Log.d(TAG, "Sent data!"),
      error -> Log.e(TAG, "Encountered error while sending data!", error)
  );
 
@@ -131,8 +131,8 @@ client.lifecycle().subscribe(lifecycleEvent -> {
             Log.d(TAG, "Stomp connection opened");
             break;
         case CLOSED:
-             Log.d(TAG, "Stomp connection closed");
-             break;
+            Log.d(TAG, "Stomp connection closed");
+            break;
         case ERROR:
             Log.e(TAG, "Stomp connection error", lifecycleEvent.getException());
             break;
@@ -152,6 +152,16 @@ Yes, it's safe to pass `null` for either (or both) of the last two arguments. Th
 
 Note: This method is only supported using OkHttp, not JWS.
 
+**Heartbeating**
+
+STOMP Heartbeat implementation is in progress. Right now, you can send a heartbeat request header upon initial websocket connect:
+
+``` java
+// ask server to send us heartbeat every ten seconds
+client.setHeartbeat(10000);
+client.connect();
+```
+
 **Support**
 
 Right now, the library only supports sending and receiving messages. ACK messages and transactions are not implemented yet.
@@ -254,6 +264,9 @@ These are the possible changes you need to make to your code for this branch, if
         Log.i(TAG, "Received message: " + message.getPayload());
     });
     ```
+- Rudimentary heartbeat mechanism
+  - You can use `StompClient.setHeartbeat(ms interval)` to send a heartbeat header to the server
+  - WIP; currently we don't deal with those heartbeats in any way other than printing them to console
 
 ## Additional Reading
 

build.gradle

@@ -8,7 +8,7 @@ buildscript {
         }
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:3.0.0-beta2'
+        classpath 'com.android.tools.build:gradle:3.0.0-beta6'
         classpath 'com.github.dcendents:android-maven-gradle-plugin:1.5'
 
         // NOTE: Do not place your application dependencies here; they belong

example-client/src/main/java/ua/naiksoftware/stompclientexample/MainActivity.java

@@ -1,7 +1,7 @@
 package ua.naiksoftware.stompclientexample;
 
-import android.support.v7.app.AppCompatActivity;
 import android.os.Bundle;
+import android.support.v7.app.AppCompatActivity;
 import android.support.v7.widget.LinearLayoutManager;
 import android.support.v7.widget.RecyclerView;
 import android.util.Log;
@@ -11,15 +11,12 @@
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
 
-import org.java_websocket.WebSocket;
-
 import java.text.SimpleDateFormat;
 import java.util.ArrayList;
 import java.util.Date;
 import java.util.List;
 import java.util.Locale;
 
-import rx.Observable;
 import rx.Subscription;
 import rx.android.schedulers.AndroidSchedulers;
 import rx.schedulers.Schedulers;
@@ -56,7 +53,7 @@ public void disconnectStomp(View view) {
     }
 
     public void connectStomp(View view) {
-        mStompClient = Stomp.over(WebSocket.class, "ws://" + ANDROID_EMULATOR_LOCALHOST
+        mStompClient = Stomp.over(Stomp.ConnectionProvider.JWS, "ws://" + ANDROID_EMULATOR_LOCALHOST
                 + ":" + RestClient.SERVER_PORT + "/example-endpoint/websocket");
 
         mStompClient.lifecycle()
@@ -90,10 +87,10 @@ public void connectStomp(View view) {
 
     public void sendEchoViaStomp(View v) {
         mStompClient.send("/topic/hello-msg-mapping", "Echo STOMP " + mTimeFormat.format(new Date()))
-                .compose(applySchedulers())
-                .subscribe(aVoid -> {
-                    Log.d(TAG, "STOMP echo send successfully");
-                }, throwable -> {
+                .unsubscribeOn(Schedulers.newThread())
+                .subscribeOn(Schedulers.io())
+                .observeOn(AndroidSchedulers.mainThread())
+                .subscribe(() -> Log.d(TAG, "STOMP echo send successfully"), throwable -> {
                     Log.e(TAG, "Error send STOMP echo", throwable);
                     toast(throwable.getMessage());
                 });
@@ -102,10 +99,10 @@ public void sendEchoViaStomp(View v) {
     public void sendEchoViaRest(View v) {
         mRestPingSubscription = RestClient.getInstance().getExampleRepository()
                 .sendRestEcho("Echo REST " + mTimeFormat.format(new Date()))
-                .compose(applySchedulers())
-                .subscribe(aVoid -> {
-                    Log.d(TAG, "REST echo send successfully");
-                }, throwable -> {
+                .unsubscribeOn(Schedulers.newThread())
+                .subscribeOn(Schedulers.io())
+                .observeOn(AndroidSchedulers.mainThread())
+                .subscribe(aVoid -> Log.d(TAG, "REST echo send successfully"), throwable -> {
                     Log.e(TAG, "Error send REST echo", throwable);
                     toast(throwable.getMessage());
                 });
@@ -122,13 +119,6 @@ private void toast(String text) {
         Toast.makeText(this, text, Toast.LENGTH_SHORT).show();
     }
 
-    protected <T> Observable.Transformer<T, T> applySchedulers() {
-        return rObservable -> rObservable
-                .unsubscribeOn(Schedulers.newThread())
-                .subscribeOn(Schedulers.io())
-                .observeOn(AndroidSchedulers.mainThread());
-    }
-
     @Override
     protected void onDestroy() {
         mStompClient.disconnect();

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
-#Tue Aug 01 08:03:03 MST 2017
+#Tue Sep 05 08:26:08 MST 2017
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-4.1-rc-1-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-4.1-all.zip

lib/src/main/java/ua/naiksoftware/stomp/AbstractConnectionProvider.java

@@ -76,6 +76,11 @@ private Completable initSocket() {
                 .startWith(block);
     }
 
+    // Doesn't do anything at all, only here as a stub
+    public Completable setHeartbeat(int ms) {
+        return Completable.complete();
+    }
+
     /**
      * Most important method: connects to websocket and notifies program of messages.
      * <p>

lib/src/main/java/ua/naiksoftware/stomp/ConnectionProvider.java

@@ -30,4 +30,6 @@ public interface ConnectionProvider {
      * Automatically emits Lifecycle.CLOSE
      */
     Completable disconnect();
+
+    Completable setHeartbeat(int ms);
 }

lib/src/main/java/ua/naiksoftware/stomp/Stomp.java

@@ -50,7 +50,7 @@ public static StompClient over(@NonNull ConnectionProvider connectionProvider, S
     public static StompClient over(@NonNull ConnectionProvider connectionProvider, String uri, @Nullable Map<String, String> connectHttpHeaders, @Nullable OkHttpClient okHttpClient) {
         if (connectionProvider == ConnectionProvider.JWS) {
             if (okHttpClient != null) {
-                throw new IllegalArgumentException("You cannot pass a webSocketClient with 'org.java_websocket.WebSocket'. use null instead.");
+                throw new IllegalArgumentException("You cannot pass an OkHttpClient when using JWS. Use null instead.");
             }
             return createStompClient(new WebSocketsConnectionProvider(uri, connectHttpHeaders));
         }

lib/src/main/java/ua/naiksoftware/stomp/client/StompClient.java

@@ -44,6 +44,7 @@ public class StompClient {
     private Parser parser;
     private Subscription lifecycleSub;
     private List<StompHeader> mHeaders;
+    private int heartbeat;
 
     public StompClient(ConnectionProvider connectionProvider) {
         mConnectionProvider = connectionProvider;
@@ -78,6 +79,18 @@ public void setParser(Parser parser) {
         this.parser = parser;
     }
 
+    /**
+     * Sets the heartbeat interval to request from the server.
+     * <p>
+     * Not very useful yet, because we don't have any heartbeat logic on our side.
+     *
+     * @param ms heartbeat time in milliseconds
+     */
+    public void setHeartbeat(int ms) {
+        heartbeat = ms;
+        mConnectionProvider.setHeartbeat(ms).subscribe();
+    }
+
     /**
      * Connect without reconnect if connected
      */
@@ -86,7 +99,7 @@ public void connect() {
     }
 
     /**
-     * If already connected and reconnect=false - nope
+     * Connect to websocket. If already connected, this will silently fail.
      *
      * @param _headers HTTP headers to send in the INITIAL REQUEST, i.e. during the protocol upgrade
      */
@@ -100,6 +113,7 @@ public void connect(@Nullable List<StompHeader> _headers) {
                         case OPENED:
                             List<StompHeader> headers = new ArrayList<>();
                             headers.add(new StompHeader(StompHeader.VERSION, SUPPORTED_VERSIONS));
+                            headers.add(new StompHeader(StompHeader.HEART_BEAT, "0," + heartbeat));
                             if (_headers != null) headers.addAll(_headers);
                             mConnectionProvider.send(new StompMessage(StompCommand.CONNECT, headers, null).compile())
                                     .subscribe();