cordova/sockets-for-cordova
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source 
Added API documentation of socket state property
This commit is contained in:
Martin Obrátil 2014-12-19 23:28:52 +01:00
parent df1d4f8272
commit 354fdc668f
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -78,6 +78,12 @@ Invoked after connection close. Native resources are released after this handler
#### `onError: (message: string) => void` #### `onError: (message: string) => void`
Invoked when some error occurs during connection. Invoked when some error occurs during connection.
### Properties
#### `state: Socket.State`
Represents state of the socket. It can have three values represented by `Socket.State` enum: `Socket.State.CLOSED`, `Socket.State.OPENING` or `Socket.State.OPENED`.
Initial state of socket is CLOSED. After open is called, it switches to OPENING. If it is successfuly opened, it goes to OPENED state. If opening fails, it goes back to CLOSE. When socket is closed (by the server or by calling close method), it goes to CLOSED as well.
### Methods ### Methods
#### `open(host, port, onSuccess?, onError?): void` #### `open(host, port, onSuccess?, onError?): void`
Establishes connection with the remote host. Establishes connection with the remote host.