Android Faye Client

This is a simple Faye Client for android. It can publish-subscribe messaging between Faye server.

Support

• SSL WebSocket connection
• Subscribe multic-channel
• Set the meta message
• RxJava FayeClient

Usage

Setup FayeClient

// Initial Meta Message
MetaMessage meta = new MetaMessate();
// Initinal FayeClient
FayeClient mClient = new FayeClient("wws://fayesample.com/fayeservice", meta);

// Set FayeClient listener
mClient.setListener(new FayeClientListener() {
        @Override
        public void onConnectedServer(FayeClient fc) {
            Log.i(LOG_TAG, "Connected");
         }

        @Override
        public void onDisconnectedServer(FayeClient fc) {
            Log.i(LOG_TAG, "Disconnected");
        }

        @Override
        public void onReceivedMessage(FayeClient fc, String msg) {
            Log.i(LOG_TAG, "Message: " + msg);
        }
    });

// Connect to server
mClient.connectServer();;

Subscribe channel

You have two locations can subscribe channel. (1) Subscribe channel in the onConnectedServer(). If FayeClient calls onConnectedServer() method that mean is FayeClient is connected the Faye Server.

mClient.setListener(new FayeClientListener() {
    @Override
    public void onConnectedServer(FayeClient fc) {
       Log.i(LOG_TAG, "Connected");
       fc.subscribeChannel("/channel-1");
       fc.subscribeChannel("/channel-2");
    }
    ...
});

(2) Subscribe channe not in onConnectedServer(). Through this way, you must be check FayeClient is connected the Faye Server.

if(mClient.isConnectedServer()) {
  mClient.subscribeChannel("/channel-3");
}

Publish message

if(mClient.isConnectedServer()) {
  // Normal publish
  mClient.publish("/channel-1", "The sample message");

  // Include ext and id
  JSONObject jsonExt = new JSONObject();
  JSONObject jsonId = new JSONObject();
  try {
    jsonExt.put("key", 123456);
    jsonId.put("user", "abc");
  } catch(JSONExecption e) {

  }
  mClient.publich("/channel-2", "The message include ext and id", jsonExt.toString(), jsonId.toString());
}

Unsubscribe channel

// Unsubscribe one channel
mClient.unsubscribeChanne("/channel-1");

// Unsubscribe multi-channels
String channels[] = {"/channel-5", "/channel-2", "/channel-4"};
mClient.unsubscribeChannels(channels);

// Unsubscribe all channel
mClient.unsubscribeAll();

Disconnect server

public void stopFayeClient() {
  HandlerThread thread = new HandlerThread("TerminateThread");
  thread.start();
  new Handler(thread.getLooper()).post(new Runnable() {
    @Override
    public void run() {
      if(mClient.isConnectedServer()) {
        mClient.disconnectServer();
      }
    }
  });
}

Setting Meta Messsage

You can set handshake, connect, disconnect ,subscribe and unsubscribe's "ext" and "id" fields.
The Meta Message detail you can look Bayeux protocol.

MetaMessage message = new MetaMessage();
// Set handshake's ext and id
JSONObject jsonExt = new JSONObject();
JSONObject jsonId = new JSONObject();
try {
    jsonExt.put("key", 123456);
    jsonId.put("user", "abc");
} catch(JSONExecption e) {

}

message.setHandshakeExt(jsonExt.toString());
message.setHandshakeId(jsonExt.toString());
// Set handshake's supportConnectionTypes field
// Default supportConnectionTypes field includes "long-polling", "callback-polling", "websocket" and "iframe".
String types[] = {"long-polling", callback-polling};
message.setSupportConnectionTypes(types);

// Set connect's ext and id
message.setConnectExt(jsonExt.toString());
message.setConnectId(jsonId.toString());

// Set disconnect's ext and id
message.setDisconnectExt(jsonExt.toString());
message.setDisconnectId(jsonId.toString());

// Set subscribe's ext and id
message.setSubscribeExt(jsonExt.toString());
message.setSubscribeId(jsonId.toString());

// Set unsubscribe's ext and id
message.setUnsubscribeExt(jsonExt.toString());
message.setUnsubscribeId(jsonId.toString());

// Set all ext and id, at once
message.setAllExt(jsonExt.toString());
message.setAllId(jsonId.toString());

Reactive Usage

// Connect to server
FayeClient mClient = new FayeClient("wws://fayesample.com/fayeservice", meta);
Subscription mSubscribe = mClient.observable(new Action1<RxEvent>() {
	@Override
	public void call(RxEvent event) {
		if(event instanceof RxEventConnected) {
			mClient.subscribeChannel("/channel-1");
		}

		if(event instanceof RxEventDisconnected) {
			Log.d("FayeClient", "Disconnect to server");
		}

		if(event instanceof RxEventMessage) {
			Log.d("FayeClient", ((RxEventMessage) event).message());
		}
	}
});

// Unsubscribe
mSubscribe.unsubscribe();

References

• Faye (github repo)
• Bayeux Protocol
• Android-Faye-Client (saulpower's github repo)
• android-faye-client (Google code)

License

   Copyright 2015 Sheng-Yuan, Wang (Elirex)

   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.