WebSocket and Socket.IO client for Android

A very simple bare-minimum WebSocket and Socket.IO client for Android.

Credits

The hybi parser is based on code from the faye project. Faye is Copyright (c) 2009-2012 James Coglan. Many thanks for the great open-source library!

The hybi parser was ported from JavaScript to Java by Eric Butler [email protected].

The WebSocket client was written by Eric Butler [email protected].

The Socket.IO client was written by Koushik Dutta.

WebSocket Usage

List<BasicNameValuePair> extraHeaders = Arrays.asList(
    new BasicNameValuePair("Cookie", "session=abcd")
);

WebSocketClient client = new WebSocketClient(URI.create("wss://irccloud.com"), new WebSocketClient.Listener() {
    @Override
    public void onConnect() {
        Log.d(TAG, "Connected!");
    }

    @Override
    public void onMessage(String message) {
        Log.d(TAG, String.format("Got string message! %s", message));
    }

    @Override
    public void onMessage(byte[] data) {
        Log.d(TAG, String.format("Got binary message! %s", toHexString(data)));
    }

    @Override
    public void onDisconnect(int code, String reason) {
        Log.d(TAG, String.format("Disconnected! Code: %d Reason: %s", code, reason));
    }

    @Override
    public void onError(Exception error) {
        Log.e(TAG, "Error!", error);
    }

}, extraHeaders);

client.connect();

// Later… 
client.send("hello!");
client.send(new byte[] { 0xDE, 0xAD, 0xBE, 0xEF });
client.disconnect();

Socket.IO Usage

SocketIOClient client = new SocketIOClient(URI.create("wss://example.com"), new SocketIOClient.Handler() {
    @Override
    public void onConnect() {
        Log.d(TAG, "Connected!");
    }

    @Override
    public void on(String event, JSONArray arguments) {
        Log.d(TAG, String.format("Got event %s: %s", event, arguments.toString()));
    }
    
    @Override
    public void onJSON(JSONObject json) {
    	try {
    		Log.d(TAG, String.format("Got JSON Object: %s", json.toString()));
    	} catch(JSONException e) {
    	}
    }

    @Override
    public void onMessage(String message) {
    	Log.d(TAG, String.format("Got message: %s", message));
    }

    @Override
    public void onDisconnect(int code, String reason) {
        Log.d(TAG, String.format("Disconnected! Code: %d Reason: %s", code, reason));
    }

    @Override
    public void onError(Exception error) {
        Log.e(TAG, "Error!", error);
    }
    
    @Override
    public void onConnectToEndpoint(String endpoint) {
    	Log.d(TAG, "Connected to:" + endpoint);

    }
});

client.connect();

// Later… 
client.emit("Message"); //Message
JSONArray arguments = new JSONArray();
arguments.put("first argument");
JSONObject second = new JSONObject();
second.put("dictionary", true);
client.emit(second); //JSON Message
arguments.put(second);
client.emit("hello", arguments); //Event
client.disconnect();

/*How to use Acknowledges
*Call any of the emit() methods 
*with the Acknowledge parameter.
*
*Each message must have a new
*Acknowledge object as they
*are matched against the Message Id.
*/
client.emit("Message", new Acknowledge {

	@Override
	public void acknowledge(String[] args) {
		//Perform your acknowledge handling here
	}
});

TODO

• Run autobahn tests
• Investigate using naga instead of threads.

License

(The MIT License)

Copyright (c) 2009-2012 James Coglan
Copyright (c) 2012 Eric Butler 
Copyright (c) 2012 Koushik Dutta 

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the 'Software'), to deal in
the Software without restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.