@otpjs/transports-socket.io NPM | npm.io

0.18.0 • Published 11 months ago

Install

Weekly downloads

-

License

MIT

Repository

Last release

11 months ago

Open Telecom Platform on JS

`@otpjs/transports-socket.io`

Enables communication with an otpjs node on the other side of a socket.io connection.

Usage

Installation

npm i @otpjs/transports-socket.io

Exports

`register(node: otp.Node, socket: socketIO.Socket, options = {})`

Builds a relay process on node for socket to provide inter-node communication.

Options

Parameter	Default	Description
`bridge`	`false`	Forwards node discovery messages, acts as relay
`type`	`Symbol.for("temporary")`	Node persistence strategy

Registration

Both sides of the transport must register the socket with @otpjs/transports-socket.io.

import otpOnSocketIO = require('@otpjs/transports-socket.io');

// stand up your socket.io server or client and otpjs node
// server
io.on('connect', (socket) => {
    otpOnSocketIO.register(node, socket, options);
})

// client
const socket = io();
otpOnSocketIO.register(node, socket, options);

Teardown

@otpjs/transports-socket.io handles disconnects gracefully. On disconnect, the remote node is deregistered from the local node. On reconnect, registers a node again.

To permanently destroy a node, invoke the returned destroy function.

const destroy = otpOnSocketIO(node, socket, options);

// When you want to permanently remove the node
destroy();

otp open telecom platform erlang javascript

@babel/runtime @otpjs/core @otpjs/serializer-json

@infinitebrahmanuniverse/nolb-_ot @everything-registry/sub-chunk-696 @zalastax/nolb-_ot

11 months ago

11 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago