Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
becvert committed Jul 20, 2017
1 parent 63e79b9 commit 9ad0ab6
Showing 1 changed file with 3 additions and 54 deletions.
57 changes: 3 additions & 54 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,58 +4,7 @@ This plugin allows you to run a single, lightweight, barebone WebSocket Server f

This is not a background service. When the cordova view is destroyed/terminated, the server is stopped.

## Changelog ##

#### 1.4.5

- [Android] upgrading to [org:java-websocket:1.3.4](https://github.com/TooTallNate/Java-WebSocket)
- [iOS] fixing crash when tcpNoDelay not defined

#### 1.4.4

- [Android] fixed NPE when getting HostAddress. 'addr' or 'remoteAddr' fields may be null.
- [Android] fixed WebsocketNotConnectedException when calling send
- [Android] upgrading to [org:java-websocket:1.3.3](https://github.com/TooTallNate/Java-WebSocket)

#### 1.4.3

- plugin.xml: moving js clobbers from global to only supported platforms
- [Android] switching back to [org:java-websocket:1.3.2](https://github.com/TooTallNate/Java-WebSocket)

#### 1.4.2

- fixed error when a connection is open before the start success callback occurs

#### 1.4.1

- new tcpNoDelay option

#### 1.4.0

- onStart, onDidNotStart and onStop handlers replaced with success and failure callbacks
- added generic onFailure handler (assume the server is unexpectedly stopped in this handler)
- [iOS] fixed crash on stop and close (dealloc)

#### 1.3.1

- adding state 'open' or 'closed' to the `conn` object

#### 1.3.0

- getInterfaces returns the ipv4 and ipv6 addresses organized by network interface
- onOpen, onMessage and onClose handlers share the same `conn` instances
- [Android] switching to [com.pusher:java-websocket:1.4.1](https://github.com/pusher/java-websocket)
- [iOS] IPv6 support [30a98b0](https://github.com/couchbasedeps/PocketSocket/commit/30a98b0c62763e11ee5b3e7097a8c8b4b66674f9)


#### 1.2.1

- [iOS] fixed crash (error retrieving URL query string)

#### 1.2.0

- new onDidNotStart handler in the start method
- getInterfaces returns ipv4 and ipv6 addresses
[CHANGELOG](https://github.com/becvert/cordova-plugin-websocket-server/blob/master/CHANGELOG.md)

## Installation ##

Expand Down Expand Up @@ -95,7 +44,7 @@ Binds to all available network interfaces ('0.0.0.0').
'onMessage' : function(conn, msg) {
console.log(conn, msg);
},
'onClose' : function(conn, code, reason) {
'onClose' : function(conn, code, reason, wasClean) {
console.log('A user disconnected from %s', conn.remoteAddr);
},
// Other options
Expand Down Expand Up @@ -157,4 +106,4 @@ It depends on [the couchbasedeps PocketSocket Server](https://github.com/couchba

## Licence ##

The MIT License
The MIT License

0 comments on commit 9ad0ab6

Please sign in to comment.