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

Update README.md

Browse Source 
Added description of API
This commit is contained in:
Martin Obrátil 2014-10-18 22:59:20 +02:00
parent cb9c7c63dc
commit 94d7be1791
1 changed files with 47 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@ -2,3 +2,50 @@ sockets-for-cordova
===================
Cordova plugin for socket network communication
## API
### Event handlers
#### `onData: (data: Int8Array) => void`
Called when new batch of data was send from server to client. Data are represented as typed array of bytes (`Int8Array`).
#### `onClose: (hasError: boolean) => void`
Called after connection was successfully closed. Parameter `hasError` indicates whether connection was closed as a result of some error.
#### `onError: (message: string) => void`
Called when some error occurs on opened connection.
### Methods
#### `open(host, port, onSuccess?, onError?): void`
Establishes connection with the remote host.
| parameter | type | description |
| ----------- |-----------------------------|--------------|
| `host` | `string` | Remote host/ip address |
| `port` | `number` | Tcp port number |
| `onSuccess` | `() => void` | Success callback, called after successfull connection to the remote host. (optional)|
| `onError` | `(message: string) => void` | Error callback, called when some error occurs during connecting to the remote host. (optional)|
#### `write(data, onSuccess?, onError?): void`
Sends data to the remote host.
| parameter | type | description |
| ----------- |-----------------------------|--------------|
| `data` | `Int8Array` | Typed array of bytes to be written to the output stream |
| `onSuccess` | `() => void` | Success callback, called after data are successfully written to the output stream. (optional)|
| `onError` | `(message: string) => void` | Error callback, called when some error occurs during writing of data to the output stream. (optional)|
#### `shutdownWrite(onSuccess?, onError?): void`
Finishes sending of data by sending `FIN` to remote host. If you call `write` after invoking `shutdownWrite`, callback `onError` (of `write` method) will be called.
| parameter | type | description |
| ----------- |-----------------------------|--------------|
| `onSuccess` | `() => void` | Success callback, called after sending of all data is finished. (optional)|
| `onError` | `(message: string) => void` | Error callback, called when some error occurs during this procedure. (optional)|
#### `close(onSuccess?, onError?): void`
Closes the connection. `onClose` event handler is called when closing of socket was succesfull.
| parameter | type | description |
| ----------- |-----------------------------|--------------|
| `onSuccess` | `() => void` | Success callback, called after connection was successfully closed. `onClose` event handler is called after that callback. (optional)|
| `onError` | `(message: string) => void` | Error callback, called when some error occurs during this procedure. (optional)|