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

Update README.md

Browse Source
This commit is contained in:
Nikita 2024-01-18 23:47:16 +04:00 committed by GitHub
parent 6d50ac284b
commit b7dbe44a07
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 29 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
README.md
View File

@ -1,8 +1,8 @@
sockets-for-cordova sockets-for-cordova
=================== ===================
This Cordova plugin provides JavaScript API, that allows you to communicate with server through TCP protocol. This Cordova plugin provides JavaScript API, that allows you to communicate with the server through TCP protocol.
Currently we support these platforms: iOS, Android, WP8. Currently, we support these platforms: iOS, Android, WP8.
You can also get information about this plugin from our blog post http://www.blocshop.cz/blog/?p=6 You can also get information about this plugin from our blog post http://www.blocshop.cz/blog/?p=6
@ -10,27 +10,27 @@ You can also get information about this plugin from our blog post http://www.blo
Install this plugin simply by: Install this plugin simply by:
`cordova plugin add cz.blocshop.socketsforcordova` `cordova plugin add cordova-plugin-socket-tcp`
or you can use GIT repository for most recent version: for the Ionic Framework
`cordova plugin add https://github.com/blocshop/sockets-for-cordova` `ionic cordova plugin add cordova-plugin-socket-tcp`
## Sample usage ## Sample usage
Here is simple example of how to connect to remote server, consume data from it and close the connection. Here is a simple example of how to connect to a remote server, consume data from it, and close the connection.
Create instance of Socket type: Create an instance of Socket type:
``` ```
var socket = new Socket(); var socket = new Socket();
``` ```
Set data consumer, error and close handlers: Set data consumer, error, and close handlers:
``` ```
socket.onData = function(data) { socket.onData = function(data) {
// invoked after new batch of data is received (typed array of bytes Uint8Array) // invoked after new batch of data is received (typed array of bytes Uint8Array)
}; };
socket.onError = function(errorMessage) { socket.onError = function(errorMessage) {
// invoked after error occurs during connection // invoked after an error occurs during connection
}; };
socket.onClose = function(hasError) { socket.onClose = function(hasError) {
// invoked after connection close // invoked after connection close
@ -42,14 +42,14 @@ socket.open(
"someremoteserver.com", "someremoteserver.com",
1234, 1234,
function() { function() {
// invoked after successful opening of socket // invoked after the successful opening of the socket
}, },
function(errorMessage) { function(errorMessage) {
// invoked after unsuccessful opening of socket // invoked after unsuccessful opening of the socket
}); });
``` ```
Send "Hello world" to server: Send "Hello world" to the server:
``` ```
var dataString = "Hello world"; var dataString = "Hello world";
var data = new Uint8Array(dataString.length); var data = new Uint8Array(dataString.length);
@ -59,7 +59,7 @@ for (var i = 0; i < data.length; i++) {
socket.write(data); socket.write(data);
``` ```
Close the connection gracefully by sending FIN to server: Close the connection gracefully by sending FIN to the server:
``` ```
socket.shutdownWrite(); socket.shutdownWrite();
``` ```
@ -72,10 +72,10 @@ socket.close();
## API ## API
### Event handlers ### Event handlers
#### `onData: (data: Uint8Array) => void` #### `onData: (data: Uint8Array) => void`
Invoked after new batch of data is received by the client. Data are represented as typed array of bytes (`Uint8Array`). Invoked after a new batch of data is received by the client. Data are represented as a typed array of bytes (`Uint8Array`).
#### `onClose: (hasError: boolean) => void` #### `onClose: (hasError: boolean) => void`
Invoked after connection close. Native resources are released after this handler is invoked. Parameter `hasError` indicates whether connection was closed as a result of some error. Invoked after connection closed. Native resources are released after this handler is invoked. The parameter `hasError` indicates whether the connection was closed as a result of some error.
#### `onError: (message: string) => void` #### `onError: (message: string) => void`
Invoked when some error occurs during connection. Invoked when some error occurs during connection.
@ -88,10 +88,10 @@ Provides state of the socket. It can have 4 values represented by `Socket.State`
- `Socket.State.OPENED` - `Socket.State.OPENED`
- `Socket.State.CLOSING` - `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. The initial state of the socket is CLOSED. Invoking `open` method changes the state to OPENING. If it's successfully opened, it goes to OPENED state. If the opening fails, it goes back to CLOSED. Socket goes to CLOSING state immediately after `close` method is called. When the socket is closed (by the server or by calling the close method), it goes to CLOSED state.
##### Example ##### Example
Check if socket is connected: Check if the socket is connected:
``` ```
if (socket.state == Socket.State.OPENED) { if (socket.state == Socket.State.OPENED) {
console.log("Socket is opened"); console.log("Socket is opened");
@ -100,26 +100,26 @@ if (socket.state == Socket.State.OPENED) {
### Methods ### Methods
#### `open(host, port, onSuccess?, onError?): void` #### `open(host, port, onSuccess?, onError?): void`
Establishes connection with the remote host. Establishes a connection with the remote host.
| parameter | type | description | | parameter | type | description |
| ----------- |-----------------------------|--------------| | ----------- |-----------------------------|--------------|
| `host` | `string` | Remote host/ip address | | `host` | `string` | Remote host/ip address |
| `port` | `number` | Tcp port number | | `port` | `number` | Tcp port number |
| `onSuccess` | `() => void` | Success callback - called after successfull connection to the remote host. (optional)| | `onSuccess` | `() => void` | Success callback - called after successful connection to the remote host. (optional)|
| `onError` | `(message: string) => void` | Error callback - called when some error occurs during connecting 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` #### `write(data, onSuccess?, onError?): void`
Sends data to remote host. Sends data to the remote host.
| parameter | type | description | | parameter | type | description |
| ----------- |-----------------------------|--------------| | ----------- |-----------------------------|--------------|
| `data` | `Uint8Array` | Typed array of bytes, that will be written to output stream. | | `data` | `Uint8Array` | Typed array of bytes, that will be written to the output stream. |
| `onSuccess` | `() => void` | Success callback - called after data are successfully written to the output stream. (optional)| | `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)| | `onError` | `(message: string) => void` | Error callback - called when some error occurs during the writing of data to the output stream. (optional)|
#### `shutdownWrite(onSuccess?, onError?): void` #### `shutdownWrite(onSuccess?, onError?): void`
Sends `FIN` to remote host and finishes data sending. You cannot call `write` method after you call `shutdownWrite`, otherwise `onError` callback (of `write` method) will be called. Sends `FIN` to the remote host and finishes data sending. You cannot call `write` method after you call `shutdownWrite`, otherwise `onError` callback (of `write` method) will be called.
| parameter | type | description | | parameter | type | description |
| ----------- |-----------------------------|--------------| | ----------- |-----------------------------|--------------|
@ -127,11 +127,11 @@ Sends `FIN` to remote host and finishes data sending. You cannot call `write` me
| `onError` | `(message: string) => void` | Error callback - called when some error occurs during this procedure. (optional)| | `onError` | `(message: string) => void` | Error callback - called when some error occurs during this procedure. (optional)|
#### `close(onSuccess?, onError?): void` #### `close(onSuccess?, onError?): void`
Closes the connection. `onClose` event handler is called when connection is successfuly closed. Closes the connection. `onClose` event handler is called when the connection is successfully closed.
| parameter | type | description | | parameter | type | description |
| ----------- |-----------------------------|--------------| | ----------- |-----------------------------|--------------|
| `onSuccess` | `() => void` | Success callback, called after connection is successfully closed. `onClose` event handler is called before that callback. (optional)| | `onSuccess` | `() => void` | Success callback, called after the connection is successfully closed. `onClose` event handler is called before that callback. (optional)|
| `onError` | `(message: string) => void` | Error callback, called when some error occurs during this procedure. (optional)| | `onError` | `(message: string) => void` | Error callback, called when some error occurs during this procedure. (optional)|
## BSD License ## BSD License
@ -141,9 +141,9 @@ All rights reserved.
Redistribution and use in source and binary forms, with or without Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 1. Redistributions of source code must retain the above copyright notice, this list of conditions, and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions, and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. All advertising materials mentioning features or use of this software must display the following acknowledgement: This product includes software developed by the Blocshop s.r.o.. 3. All advertising materials mentioning features or use of this software must display the following acknowledgment: This product includes software developed by the Blocshop s.r.o.
4. Neither the name of the Blocshop s.r.o. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. 4. Neither the name of the Blocshop s.r.o. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY Blocshop s.r.o. ''AS IS'' AND ANY THIS SOFTWARE IS PROVIDED BY Blocshop s.r.o. ''AS IS'' AND ANY
@ -152,7 +152,7 @@ WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER, CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.