Permalink
Browse files

add events to readme

  • Loading branch information...
1 parent 7d62cbe commit f6ca78d65f162e5dea1e6acd25ee6b19e4c2a65c @tj committed Oct 16, 2012
Showing with 11 additions and 0 deletions.
  1. +11 −0 Readme.md
View
@@ -14,6 +14,17 @@
- supports arbitrary binary message (msgpack, json, BLOBS, etc)
- supports JSON messages out of the box
+## Events
+
+ - `close` when server or connection is closed
+ - `error` (err) when an-handled socket error occurs
+ - `ignored error` (err) when an axon-handled socket error occurs, but is ignored
+ - `socket error` (err) emitted regardless of handling, for logging purposes
+ - `reconnect attempt` when a reconnection attempt is made
+ - `connect` when connected to the peer, or a peer connection is accepted
+ - `disconnect` when an accepted peer disconnects
+ - `bind` when the server is bound
+
## Patterns
- push / pull

0 comments on commit f6ca78d

Please sign in to comment.