2016-08-06 23:27:53 +02:00
# smartsocket
2018-03-15 02:29:40 +01:00
2016-09-26 16:59:06 +02:00
easy and secure websocket communication, TypeScript ready
2016-08-06 23:27:53 +02:00
2016-09-03 16:03:57 +02:00
## Availabililty
2018-03-15 02:29:40 +01:00
2017-07-07 22:38:10 +02:00
[](https://www.npmjs.com/package/smartsocket)
[](https://GitLab.com/pushrocks/smartsocket)
[](https://github.com/pushrocks/smartsocket)
[](https://pushrocks.gitlab.io/smartsocket/)
2016-09-03 16:03:57 +02:00
## Status for master
2018-03-15 02:29:40 +01:00
2017-07-07 22:38:10 +02:00
[](https://GitLab.com/pushrocks/smartsocket/commits/master)
[](https://GitLab.com/pushrocks/smartsocket/commits/master)
[](https://www.npmjs.com/package/smartsocket)
2016-09-03 16:03:57 +02:00
[](https://david-dm.org/pushrocks/smartsocket)
[](https://www.bithound.io/github/pushrocks/smartsocket/master/dependencies/npm)
[](https://www.bithound.io/github/pushrocks/smartsocket)
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
2017-07-07 22:38:10 +02:00
[](http://standardjs.com/)
2016-08-06 23:27:53 +02:00
## Usage
2018-03-15 02:29:40 +01:00
2017-07-07 22:38:10 +02:00
Use TypeScript for best in class instellisense.
2016-08-06 23:27:53 +02:00
2018-03-17 17:18:53 +01:00
Under the hood we use socket.io and shortid for managed data exchange.
### Serverside
```typescript
import * as smartsocket from 'smartsocket';
import * as q from q; // q is a promise library
// The "Smartsocket" listens on a port and can receive new "SocketConnection" requests.
let mySmartsocket = new smartsocket.Smartsocket({
port: 3000 // the port smartsocket will listen on
});
2018-03-17 17:52:01 +01:00
// optional:
// run this with anothoer existing server like express
declare var someExpressServer // read the express docs about how express actually works
mySmartsocket.setServer(someExpressServer)
2018-03-17 17:18:53 +01:00
// A "SocketRole" can be referenced by "SocketFunction"s.
// All "SocketRequest"s carry authentication data for a specific "SocketRole".
// "SocketFunction"s know which "SocketRole"s are allowed to execute them
let mySocketRole = new smartsocket.SocketRole({
name: 'someRoleName',
passwordHash: 'someHashedString'
});
// A "SocketFunction" executes a referenced function and passes in any data of the corresponding "SocketRequest".
// The referenced function must return a promise and resolve with data of type any.
// Any "SocketRequest" carries a unique identifier. If the referenced function's promise resolved any passed on argument will be returned to the requesting party
let testSocketFunction1 = new smartsocket.SocketFunction({
funcName: 'testSocketFunction1',
funcDef: data => {
console.log('testSocketFunction1 executed successfully!');
},
allowedRoles: [mySocketRole] // all roles that have access to a specific function
});
// A "Smartsocket" exposes a .clientCall() that gets
// 1. the name of the "SocketFunction" on the client side
// 2. the data to pass in
// 3. And a target "SocketConnection" (there can be multiple connections at once)
// any unique id association is done internally
mySmartsocket.clientCall('restart', data, someTargetConnection).then(responseData => {});
```
#### Client side
```typescript
import * as smartsocket from 'smartsocket';
// A "SmartsocketClient" is different from a "Smartsocket" in that it doesn't expose any public address.
// Thus any new "SocketConnection"s must be innitiated from a "SmartsocketClient".
let testSmartsocketClient = new smartsocket.SmartsocketClient({
port: testConfig.port,
url: 'http://localhost',
password: 'testPassword',
alias: 'testClient1',
role: 'testRole1'
});
// You can .connect() and .disconnect() from a "Smartsocket"
testSmartsocketClient.connect().then(() => {
done();
});
// The client can also specify "SocketFunction"s. It can also specify "SocketRole"s in case a client connects to multiple servers at once
let testSocketFunction2 = new smartsocket.SocketFunction({
funcName: 'testSocketFunction2',
funcDef: data => {}, // the function to execute, has to return promise
allowedRoles: []
});
// A "SmartsocketClient" can call functions on the serverside using .serverCall() analog to the "Smartsocket"'s .clientCall method.
mySmartsocketClient.serverCall('function', functionCallData).then(functionResponseData => {
// the functionResponseData comes from the server... awesome, right?
});
```
> **NOTE:**
> you can easily chain dependent requests on either the server or client side with promises.
> `data` is always a js object that you can design for your specific needs.
> It supports buffers for large binary data network exchange.
2017-07-07 22:38:10 +02:00
For further information read the linked docs at the top of this README.
2016-08-07 15:14:53 +02:00
2017-07-07 22:38:10 +02:00
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
2018-03-15 02:29:40 +01:00
> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
2016-08-07 14:58:20 +02:00
2017-07-07 22:38:10 +02:00
[](https://push.rocks)
