Files
engine.io-client-java/README.md
Naoyuki Kanezawa d4e2e28ace update README
2013-08-25 01:45:08 +09:00

76 lines
1.7 KiB
Markdown

# Engine.IO-client.java
[![Build Status](https://travis-ci.org/nkzawa/engine.io-client.java.png?branch=master)](https://travis-ci.org/nkzawa/engine.io-client.java)
This is the Engine.IO Client Library for Java, which is simply ported from the [JavaScript client](https://github.com/LearnBoost/engine.io-client).
See also: [Socket.IO-client.java](https://github.com/nkzawa/socket.io-client.java)
## Installation
The latest artifact is available on Maven Central. Add the following dependency to your `pom.xml`.
```xml
<dependencies>
<dependency>
<groupId>com.github.nkzawa</groupId>
<artifactId>engine.io-client</artifactId>
<version>0.1.2</version>
</dependency>
</dependencies>
```
## Usage
Engine.IO-client.java has the similar api with the JS client. You can use `Socket` to connect:
```java
socket = new Socket("ws://localhost") {
@Override
public void onopen() {
socket.send("hi");
socket.close();
}
@Override
public void onmessage(String data) {}
@Override
public void onclose() {}
@Override
public void onerror(Exception err) {}
};
socket.open();
```
You can receive events as follows:
```java
socket.on(Socket.EVENT_ERROR, new Emitter.Listener() {
@Override
public void call(Object... args) {
Exception err = (Exception)args[0];
}
});
```
How to set options:
```java
opts = new Socket.Options();
opts.cookie = "foo=1;";
socket = new Socket("ws://localhost", opts) { ... };
```
See the Javadoc for more details.
http://nkzawa.github.io/engine.io-client.java/apidocs/
## Features
This library supports all of the features the JS client does, including events, options and upgraging transport. Android is fully supported.
## License
MIT