Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/elpheria/rpc-websockets

JSON-RPC 2.0 implementation over WebSockets for Node.js and JavaScript/TypeScript
https://github.com/elpheria/rpc-websockets

aws chat distributed-systems events gcp iot messaging multiplayer nodejs push-notifications remote-procedure-calls rpc rpc-api rpc-client rpc-framework rpc-server scalable serverless typescript websocket-server

Last synced: 11 days ago
JSON representation

JSON-RPC 2.0 implementation over WebSockets for Node.js and JavaScript/TypeScript

Awesome Lists containing this project

README 

        


  

    

  

  


  


    WebSockets for Node.js and JavaScript/TypeScript with JSON RPC 2.0 support on top.  


  

                

  

  

		

  

  

		

  

  

    

  

  







## About



The **rpc-websockets** library enables developers to easily implement their business logic that includes messaging between users, machines or any devices. It provides a possibility to send and receive JSON data through the WebSocket communication protocol in order to support two-way notification push, running RPC methods and firing any types of event signalling. Only clients can call RPC methods and not vice versa at the moment. Both frontend (HTML/JS-based) and backend (Node.js-based) development environments are supported.



**rpc-websockets** is built on Node.js and supports both LTS and Current versions.



Use the free OSS edition in order to implement and manage your own WebSocket server instances, or subscribe for our [Pro plan](#pro-features) and have us manage your instances and provide you with management of your methods, events and notifications on an easy-to-use Web Management portal.



## Quick start



Install our OSS library in your project:

```

npm install rpc-websockets

```



Write your source code using `rpc-websockets`:

```js

var WebSocket = require('rpc-websockets').Client

var WebSocketServer = require('rpc-websockets').Server



// instantiate Server and start listening for requests

var server = new WebSocketServer({

  port: 8080,

  host: 'localhost'

})



// register an RPC method

server.register('sum', function(params) {

  return params[0] + params[1]

})



// ...and maybe a protected one also

server.register('account', function() {

  return ['confi1', 'confi2']

}).protected()



// create an event

server.event('feedUpdated')



// get events

console.log(server.eventList())



// emit an event to subscribers

server.emit('feedUpdated')



// close the server

server.close()



// instantiate Client and connect to an RPC server

var ws = new WebSocket('ws://localhost:8080')



ws.on('open', function() {

  // call an RPC method with parameters

  ws.call('sum', [5, 3]).then(function(result) {

    require('assert').equal(result, 8)

  })



  // send a notification to an RPC server

  ws.notify('openedNewsModule')



  // subscribe to receive an event

  ws.subscribe('feedUpdated')



  ws.on('feedUpdated', function() {

    updateLogic()

  })



  // unsubscribe from an event

  ws.unsubscribe('feedUpdated')



  // login your client to be able to use protected methods

  ws.login({'username': 'confi1', 'password':'foobar'}).then(function() {

    ws.call('account').then(function(result) {

      require('assert').equal(result, ['confi1', 'confi2'])

    })

  }).catch(function(error) {

    console.log('auth failed')

  })



  // close a websocket connection

  ws.close()

})

```



## Documentation



Please consult our [API documentation](API.md) for both WebSocket server and client JavaScript and TypeScript classes.



## OSS Features



Features of the free open-source edition.



![OSS Features](assets/oss-features.png)



All library's open-source features are documented in our [API documentation](API.md) and can be used free of charge. You are free to implement your solutions based on provided methods in any way you are comfortable with, as long as you use our work along our very permissive [license](LICENSE) conditions.



## Pro Features



In order to support your production-ready environments, we can provide you with additional features built on top of our free OSS edition along with the skill set to turn your business case or a Proof-of-Concept idea into reality.



![Pro Features](assets/pro-features.png)



Describe us your use case by [contacting us](mailto:[email protected]?subject=Pro%20Plan%20enquiry) and we will swiftly get back to you with a proposed solution that meets your needs.



## Professional support



We offer professional support for **rpc-websockets** and beyond. We have many years of expertise on building robust, scalable Node.js applications and can help you overcome issues and challenges preventing you to ship your great products. We excel in software architecture and implementation, being able to provide you with development, planning, consulting, training and customization services. Feel free to [contact us](mailto:[email protected]?subject=rpc-websockets%20support%20enquiry) so we can discuss how to help you finish your products!



## Users



**rpc-websockets** is being actively used in production by multiple companies in a variety of different use cases.






Scratchbox 

Loom Network 

uniqCast 

LeapDAO 

Klika Tech, Inc. 

Kodebox, Inc. 

Hey-Group S.A./N.V. 

Hylo, Inc. 

Witnet Foundation 

Scale Leap 

Codice Foundation, Inc. 

Holo Ltd. 

Solana Labs, Inc. 

Filecoin 



## Sponsors

Become a sponsor and get your logo on project's README on GitHub with a link to your site. Feel free to [contact us](mailto:[email protected]?subject=Sponsors) for the arrangement!



## License



This library is licensed under LGPLv3. Please see [LICENSE](LICENSE) for licensing details.