1.18.138 • Published 10 months ago

@arcblock/ws v1.18.138

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
10 months ago

Blocklet Server WebSocket

Blocklet Server PubSub base on Websocket and Phoenix Protocol

Usage

  1. WsServer
const { WsServer } = require('@arcblock/ws');

/**
 * @params {Object} opts
 *  @params {http.Server} opts.httpServer
 *  @params {String} opts.pathname default to '/websocket'
 *  @params {Function} opts.authenticate
 */
const wsServer = new WsServer({
  httpServer: http.createServer(),
  authenticate: (req, cb) => {
    const { searchParams } = new URL(req.url, `http://${req.headers.host || 'unknown'}`);
    const token = searchParams.get('token');
    if (!token) {
      cb(new Error('token not found'), null);
      return;
    }

    // custom logic for validate token
    const authInfo = validateToken(token);

    // if validate success
    cb(null, authInfo);

    // if validate error
    cb(new Error('validate fail'), null);
  },
});

// attach to httpServer(httpServer has passed by constructor)
wsSerer.attach();

// push message
wsServer.broadcast('blocklet.installed', data);
wsServer.broadcast('notification.create', data);
wsServer.broadcast('topic', 'event', data);
  1. WsClient

WsClient is inherited from Phoenix(source),

import WsClient from '@arcblock/ws/lib/client';

// create instance
const socket = new WsClient(`//${window.location.hostname}`, {
  // params will be passed to server through url
  params: () => ({
    // token is used for authentication
    token: window.localStorage.getItem('abt_node_login_token'),
  }),

  // Defaults to none
  logger: (type, msg, data) => console.log(type, msg, data),
});

// connect
socket.connect();

// add subscriber
socket.on('blocklet.installed', callback1);
socket.on('notification.create', callback2);

// remove subscriber
socket.off('blocklet.installed', callback1);
socket.off('notification.create', callback2);

// More flexible subscription
const subscription = socket.subscribe('topic', {});
subscription.on('event', ({ response }) => {
  // Do something with the event data
});

// disconnect
socket.disconnect(() => {
  // after disconnected...
});
  1. Hooks

It's very simple to create hooks in react apps.

1.18.138

10 months ago

1.18.137

10 months ago

1.18.136

10 months ago

1.18.135

1 year ago

1.18.134

1 year ago

1.18.133

1 year ago

1.18.132

1 year ago

1.18.131

1 year ago

1.18.130

1 year ago

1.18.129

1 year ago

1.18.128

1 year ago

1.18.127

1 year ago

1.18.126

1 year ago

1.18.125

1 year ago

1.18.124

1 year ago

1.18.123

1 year ago

1.18.122

1 year ago

1.18.121

1 year ago

1.18.120

1 year ago

1.18.119

1 year ago

1.18.118

1 year ago

1.18.117

1 year ago

1.18.116

1 year ago

1.18.115

1 year ago

1.18.114

1 year ago

1.18.113

1 year ago

1.18.112

1 year ago

1.18.111

1 year ago

1.18.110

2 years ago

1.18.109

2 years ago

1.18.108

2 years ago

1.18.107

2 years ago

1.18.106

2 years ago

1.18.105

2 years ago

1.18.104

2 years ago

1.18.96

2 years ago

1.18.99

2 years ago

1.18.98

2 years ago

1.18.97

2 years ago

1.18.103

2 years ago

1.18.102

2 years ago

1.18.101

2 years ago

1.18.100

2 years ago

1.18.95

2 years ago

1.18.94

2 years ago

1.18.93

2 years ago

1.18.85

2 years ago

1.18.89

2 years ago

1.18.88

2 years ago

1.18.87

2 years ago

1.18.86

2 years ago

1.18.92

2 years ago

1.18.91

2 years ago

1.18.90

2 years ago

1.18.81

2 years ago

1.18.84

2 years ago

1.18.83

2 years ago

1.18.82

2 years ago

1.18.80

2 years ago

1.18.70

2 years ago

1.18.74

2 years ago

1.18.73

2 years ago

1.18.72

2 years ago

1.18.71

2 years ago

1.18.78

2 years ago

1.18.77

2 years ago

1.18.76

2 years ago

1.18.75

2 years ago

1.18.79

2 years ago

1.18.69

2 years ago

1.18.67

2 years ago

1.18.66

2 years ago

1.18.68

2 years ago

1.18.41

3 years ago

1.18.40

3 years ago

1.18.45

3 years ago

1.18.44

3 years ago

1.18.43

3 years ago

1.18.42

3 years ago

1.18.49

3 years ago

1.18.48

3 years ago

1.18.47

3 years ago

1.18.46

3 years ago

1.18.38

3 years ago

1.18.39

3 years ago

1.18.63

2 years ago

1.18.62

2 years ago

1.18.61

2 years ago

1.18.60

2 years ago

1.18.65

2 years ago

1.18.64

2 years ago

1.18.52

3 years ago

1.18.51

3 years ago

1.18.50

3 years ago

1.18.56

3 years ago

1.18.55

3 years ago

1.18.54

3 years ago

1.18.53

3 years ago

1.18.59

2 years ago

1.18.58

2 years ago

1.18.57

2 years ago

1.18.34

3 years ago

1.18.33

3 years ago

1.18.37

3 years ago

1.18.36

3 years ago

1.18.35

3 years ago

1.18.1

3 years ago

1.18.0

3 years ago

1.18.5

3 years ago

1.18.4

3 years ago

1.18.3

3 years ago

1.18.2

3 years ago

1.18.9

3 years ago

1.18.8

3 years ago

1.18.7

3 years ago

1.18.6

3 years ago

1.18.30

3 years ago

1.18.32

3 years ago

1.18.31

3 years ago

1.17.23

3 years ago

1.18.23

3 years ago

1.18.22

3 years ago

1.18.21

3 years ago

1.18.20

3 years ago

1.18.27

3 years ago

1.18.26

3 years ago

1.18.25

3 years ago

1.18.24

3 years ago

1.18.28

3 years ago

1.18.12

3 years ago

1.18.11

3 years ago

1.18.10

3 years ago

1.18.16

3 years ago

1.18.15

3 years ago

1.18.14

3 years ago

1.18.13

3 years ago

1.18.19

3 years ago

1.18.18

3 years ago

1.18.17

3 years ago

1.17.22

3 years ago

1.17.21

3 years ago

1.17.20

3 years ago

1.17.15

3 years ago

1.17.14

3 years ago

1.17.13

3 years ago

1.17.12

3 years ago

1.17.19

3 years ago

1.17.18

3 years ago

1.17.17

3 years ago

1.17.16

3 years ago

1.16.10

3 years ago

1.16.14

3 years ago

1.16.13

3 years ago

1.16.12

3 years ago

1.16.17

3 years ago

1.16.16

3 years ago

1.16.15

3 years ago

1.17.11

3 years ago

1.17.10

3 years ago

1.6.10

3 years ago

1.17.2

3 years ago

1.17.1

3 years ago

1.17.0

3 years ago

1.17.6

3 years ago

1.17.5

3 years ago

1.17.4

3 years ago

1.17.3

3 years ago

1.17.9

3 years ago

1.17.8

3 years ago

1.17.7

3 years ago

1.16.7

3 years ago

1.16.6

3 years ago

1.16.5

3 years ago

1.16.9

3 years ago

1.16.8

3 years ago

1.15.0

3 years ago

1.15.4

3 years ago

1.15.3

3 years ago

1.15.2

3 years ago

1.15.1

3 years ago

1.14.20

3 years ago

1.15.7

3 years ago

1.14.21

3 years ago

1.15.6

3 years ago

1.14.22

3 years ago

1.15.5

3 years ago

1.14.23

3 years ago

1.14.24

3 years ago

1.14.25

3 years ago

1.16.3

3 years ago

1.16.2

3 years ago

1.16.1

3 years ago

1.16.0

3 years ago

1.16.4

3 years ago

1.14.19

4 years ago

1.14.1

4 years ago

1.14.0

4 years ago

1.14.5

4 years ago

1.14.4

4 years ago

1.14.3

4 years ago

1.14.2

4 years ago

1.14.9

4 years ago

1.13.75

4 years ago

1.14.8

4 years ago

1.13.74

4 years ago

1.14.7

4 years ago

1.13.77

4 years ago

1.14.6

4 years ago

1.13.76

4 years ago

1.13.71

4 years ago

1.13.70

4 years ago

1.13.73

4 years ago

1.13.72

4 years ago

1.13.79

4 years ago

1.13.78

4 years ago

1.13.66

4 years ago

1.13.65

4 years ago

1.13.68

4 years ago

1.13.67

4 years ago

1.13.69

4 years ago

1.13.80

4 years ago

1.13.86

4 years ago

1.14.10

4 years ago

1.13.85

4 years ago

1.14.11

4 years ago

1.14.12

4 years ago

1.13.82

4 years ago

1.13.81

4 years ago

1.13.84

4 years ago

1.13.83

4 years ago

1.14.17

4 years ago

1.14.18

4 years ago

1.14.13

4 years ago

1.14.14

4 years ago

1.14.15

4 years ago

1.14.16

4 years ago

1.13.57

4 years ago

1.13.56

4 years ago

1.13.59

4 years ago

1.13.58

4 years ago

1.13.64

4 years ago

1.13.63

4 years ago

1.13.60

4 years ago

1.13.62

4 years ago

1.13.61

4 years ago

1.13.53

4 years ago

1.13.52

4 years ago

1.13.55

4 years ago

1.13.54

4 years ago

1.13.51

4 years ago

1.13.50

4 years ago

1.13.49

4 years ago

1.13.46

4 years ago

1.13.48

4 years ago

1.13.47

4 years ago

1.13.45

4 years ago

1.13.42

4 years ago

1.13.31

4 years ago

1.13.41

4 years ago

1.13.30

4 years ago

1.13.44

4 years ago

1.13.33

4 years ago

1.13.32

4 years ago

1.13.40

4 years ago

1.13.39

4 years ago

1.13.28

4 years ago

1.13.38

4 years ago

1.13.29

4 years ago

1.13.35

4 years ago

1.13.34

4 years ago

1.13.37

4 years ago

1.13.36

4 years ago

1.13.27

4 years ago

1.13.26

4 years ago

1.13.25

4 years ago

1.13.24

4 years ago

1.13.23

4 years ago

1.13.22

4 years ago