push.rocks/smartsocket
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update README

Browse Source
This commit is contained in:
Philipp Kunz 2016-08-07 15:12:21 +02:00
parent 309284ab68
commit b327dbba21
1 changed files with 21 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -7,9 +7,9 @@ easy and secure websocket communication
## Usage ## Usage
We recommend the use of typescript. We recommend the use of typescript.
### Serverside
```typescript ```typescript
// serverside
import * as smartsocket from "smartsocket" import * as smartsocket from "smartsocket"
let mySmartsocket = new smartsocket.Smartsocket({ let mySmartsocket = new smartsocket.Smartsocket({
port: 3000 // the port smartsocket will listen on port: 3000 // the port smartsocket will listen on
@ -17,30 +17,44 @@ let mySmartsocket = new smartsocket.Smartsocket({
let mySocketRole = new smartsocket.SocketRole({ let mySocketRole = new smartsocket.SocketRole({
name: "someRoleName", name: "someRoleName",
passwordHash: "someHasedString" passwordHash: "someHashedString"
}); });
let mySocketFunction = new smartsocket.SocketFunction({ let mySocketFunction = new smartsocket.SocketFunction({
func:() => {}, the function to execute name:"newService",
func:(data) => {
}, the function to execute
roles:[mySocketRole] // all roles that have access to a specific function roles:[mySocketRole] // all roles that have access to a specific function
}); });
mySmartsocket.registerRole(mySocketRole); mySmartsocket.registerRole(mySocketRole);
mySmartsocket.clientCall.select("client1","restart",data)
.then((responseData) => {
// Client side });
```
#### Client side
```typescript
let mySmartsocketClient = new smartsocket.SmartsocketClient({ let mySmartsocketClient = new smartsocket.SmartsocketClient({
url: "somedomain.com", // url, note: will only work over https, no http supported. url: "somedomain.com", // url, note: will only work over https, no http supported.
port: 3000 port: 3000
role:"dockerhost", // some role, in this example a dockerhost vm, role:"dockerhost", // some role, in this example a dockerhost vm,
password:"somePassword" password:"somePassword",
alias:"client1"
}); });
let mySocketFunction2 = new smartsocket.SocketFunction({ let mySocketFunction2 = new smartsocket.SocketFunction({
func:() => {}, the function to execute name:"restart",
func:(data) => {}, the function to execute
roles: [mySocketRole] // all roles that have access to a specific function roles: [mySocketRole] // all roles that have access to a specific function
}); });
mySmartsocketClient.registerFunction(mySocketFunction2); mySmartsocketClient.registerFunction(mySocketFunction2);
mySmartsocketClient.serverCall("newService",data)
.then((responseData) => {
});;
``` ```