From db634563b0be7e422ed1e3fa0750e8108f558de0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Obr=C3=A1til?= Date: Sat, 3 Jan 2015 09:47:18 +0100 Subject: [PATCH] Update README.md --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bd9773e..33f5acf 100644 --- a/README.md +++ b/README.md @@ -80,7 +80,11 @@ Invoked when some error occurs during connection. ### Properties #### `state: Socket.State` -Provides state of the socket. It can have 4 values represented by `Socket.State` enum: `Socket.State.CLOSED`, `Socket.State.OPENING`, `Socket.State.OPENED` or `Socket.State.CLOSING`. +Provides state of the socket. It can have 4 values represented by `Socket.State` enum: +- `Socket.State.CLOSED` +- `Socket.State.OPENING` +- `Socket.State.OPENED` +- `Socket.State.CLOSING` Initial state of socket is CLOSED. Invoking `open` method changes state to OPENING. If it's successfuly opened, it goes to OPENED state. If opening fails, it goes back to CLOSED. Socket goes to CLOSING state immediately after `close` method is called. When socket is closed (by the server or by calling close method), it goes to CLOSED state.