https://github.com/nicojanssens/apprtc-socket-js
Socket for transferring messages via the AppRtc WebSocket server
https://github.com/nicojanssens/apprtc-socket-js
Last synced: 5 months ago
JSON representation
Socket for transferring messages via the AppRtc WebSocket server
- Host: GitHub
- URL: https://github.com/nicojanssens/apprtc-socket-js
- Owner: nicojanssens
- License: mit
- Created: 2016-01-28T21:35:35.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-08-02T20:38:58.000Z (almost 8 years ago)
- Last Synced: 2025-01-03T03:12:02.862Z (5 months ago)
- Language: JavaScript
- Size: 33.2 KB
- Stars: 4
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://circleci.com/gh/nicojanssens/apprtc-socket-js)
[](https://npmjs.org/package/apprtc-socket)
# AppRtc Socket
## Summary
Socket using the AppRtc WebSocket server to exchange messages between *two* peers. This socket is developed to exchange lightweight signaling messages, *not* for transmitting (large) binaries.
## Features
- supports text message exchange between two peers identified by a unique key
- offers callback and promise based API
- can be browserified
## Install
```
npm install apprtc-socket
```
## Usage
### Callbacks
```js
const socket = require('apprtc-socket');
const myId = 'foo'; // replace with unique key
const peerId = 'bar'; // replace with unique key
const mySocket = socket(myId, peerId);
// socket is connected and ready to use
mySocket.on('ready', () => {
// send text message to peer
mySocket.send('test message');
// close socket
mySocket.close();
});
mySocket.on('message', (message) => {
// incoming text message
});
mySocket.on('close', () => {
// socket is closed
});
mySocket.on('error', (error) => {
// ooops
});
// activate the connection
mySocket.connect();
```
### Promises
```js
const socket = require('apprtc-socket');
const myId = 'foo'; // replace with unique key
const peerId = 'bar'; // replace with unique key
const mySocket = socket(myId, peerId);
mySocket.on('message', (message) => {
// incoming text message
});
mySocket.on('error', (error) => {
// ooops
});
// activate the connection
mySocket.connectP()
// socket is connected and ready to use
.then(() => {
// send text message to peer
mySocket.send('test message');
// close socket
return mySocket.closeP();
})
.then(() => {
// socket is closed
})
.catch((error) => {
// ooops
});
```
## API
### `var mySocket = socket(myId, peerId)`
Create a new AppRtcSocket connection. Both interacting peers must be identified by a unique key.
### `mySocket.connect()`
Connect to the AppRtc WebSocket server and register a connection. The id of the AppRtc room that both peers use to exchange messages is a commutative hash calculated from both peers' unique keys. This function fires a `ready` event once the registration succeeds.
### `mySocket.connectP()`
Connect to the AppRtc WebSocket server and register a connection. Instead of firing a `ready` event, this function returns a promise that gets fulfilled once the registration succeeds.
### `mySocket.send(data)`
Send text data to the connected peer. `data` should be of type
`String`, other data types can be transformed into a `String` with `JSON.stringify`.
### `mySocket.close()`
Close a connection. Fires a `close` event once complete.
### `mySocket.closeP()`
Close a connection. Instead of firing a `close` event, this function returns a promise that gets fulfilled once the connection has closed.
## Events
### `mySocket.on('ready', () => {})`
Fired when the socket is ready to use.
### `mySocket.on('message', (message) => {})`
Received a message from the AppRtc server. `message` is always a `String`.
### `mySocket.on('close', () => {})`
Fired when the connection has closed.
### `mySocket.on('error', () => {})`
Fired when a fatal error occurs.
## Examples
See examples directory.