3.9.15 • Published 2 years ago

tchannel v3.9.15

Weekly downloads
1,011
License
-
Repository
github
Last release
2 years ago

TChannel

network multiplexing and framing protocol for RPC

Stability: stable

stable

Example

var TChannel = require('tchannel');

var server = new TChannel();
var client = new TChannel();

var serverChan = server.makeSubChannel({
    serviceName: 'server'
});

// normal response
serverChan.register('func1', function onReq(req, res, arg2, arg3) {
    console.log('func1 responding', { arg2: arg2.toString(), arg3: arg3.toString() });
    res.headers.as = 'raw';
    res.sendOk('result', 'indeed it did');
});

// err response
serverChan.register('func2', function onReq2(req, res) {
    res.headers.as = 'raw';
    res.sendNotOk(null, 'it failed');
});

server.listen(4040, '127.0.0.1', function onListen() {
    var clientChan = client.makeSubChannel({
        serviceName: 'server',
        peers: [server.hostPort],
        requestDefaults: {
            hasNoParent: true,
            headers: { 'as': 'raw', 'cn': 'example-client' }
        }
    });

    clientChan.request({
        serviceName: 'server',
        timeout: 1000
    }).send('func1', 'arg 1', 'arg 2', function onResp(err, res, arg2, arg3) {
        console.log('normal res:', { arg2: arg2.toString(), arg3: arg3.toString() });
    });

    clientChan.request({
        serviceName: 'server'
    }).send('func2', 'arg 1', 'arg 2', function onResp(err, res, arg2, arg3) {
        console.log('err res: ', { ok: res.ok, message: String(arg3) });
    });
});

This example registers two functions on the "server". "func 1" always works and "func 2" always returns an error. The client sends a request for each function, then prints the result.

Note that every instance is bidirectional. New connections are initiated on demand.

Overview

TChannel is a network protocol with the following goals:

  • request / response model
  • multiple requests multiplexed across the same TCP socket
  • out of order responses
  • streaming request and responses
  • all frames checksummed
  • transport arbitrary payloads
  • easy to implement in multiple languages
  • near-redis performance

This protocol is intended to run on datacenter networks for inter-process communication.

Protocol

TChannel frames have a fixed length header and 3 variable length fields. The underlying protocol does not assign meaning to these fields, but the included client/server implementation uses the first field to represent a unique endpoint or function name in an RPC model. The next two fields can be used for arbitrary data. Some suggested way to use the 3 fields are:

  • URI path, HTTP method and headers as JSON, body
  • function name, headers, thrift / protobuf

Note however that the only encoding supported by TChannel is UTF-8. If you want JSON, you'll need to stringify and parse outside of TChannel.

This design supports efficient routing and forwarding of data where the routing information needs to parse only the first or second field, but the 3rd field is forwarded without parsing.

There is no notion of client and server in this system. Every TChannel instance is capable of making or receiving requests, and thus requires a unique port on which to listen. This requirement may change in the future.

Performance

On a Macbook Pro, we see around 50,000 ops/sec from a single node process talking to one other node process.

Documentation

See the docs folder.

Further examples

See the examples folder

Installation

npm install tchannel

Tests

npm test

Contributors

  • mranney
  • jwolski
  • Raynos
  • jcorbin
  • kriskowal
  • shannili
  • rf

MIT Licenced

3.9.14-uber-1

2 years ago

3.9.15

2 years ago

4.0.1

5 years ago

4.0.0

5 years ago

3.10.1

5 years ago

3.10.0

5 years ago

3.9.13

6 years ago

3.9.12

8 years ago

3.9.11

8 years ago

3.9.10

8 years ago

3.9.9

9 years ago

3.9.8

9 years ago

3.9.7

9 years ago

3.9.6

9 years ago

3.9.4

9 years ago

3.9.3

9 years ago

3.9.2

9 years ago

3.9.1

9 years ago

3.9.0

9 years ago

3.8.5

9 years ago

3.8.4

9 years ago

3.8.3

9 years ago

3.8.2

9 years ago

3.8.0

9 years ago

3.7.3

9 years ago

3.7.2

9 years ago

3.7.0

9 years ago

3.6.24

9 years ago

3.6.23

9 years ago

3.6.22

9 years ago

3.6.21

9 years ago

3.6.20

9 years ago

3.6.19

9 years ago

3.6.18

9 years ago

3.6.17

9 years ago

3.6.16

9 years ago

2.10.8

9 years ago

3.6.15

9 years ago

3.6.14

9 years ago

2.10.7

9 years ago

3.6.13

9 years ago

3.6.12

9 years ago

3.6.11

9 years ago

3.6.10

9 years ago

3.6.9

9 years ago

3.6.8

9 years ago

3.6.7

9 years ago

3.6.6

9 years ago

3.6.4-hotfix1

10 years ago

3.6.5

10 years ago

2.10.6

10 years ago

3.6.4

10 years ago

2.10.5

10 years ago

3.6.3

10 years ago

3.6.2

10 years ago

3.6.1

10 years ago

3.6.0

10 years ago

3.5.42

10 years ago

3.5.41

10 years ago

3.5.40

10 years ago

3.5.39

10 years ago

3.5.38

10 years ago

3.5.37

10 years ago

3.5.36

10 years ago

3.5.35

10 years ago

2.10.4

10 years ago

3.5.34

10 years ago

3.5.33

10 years ago

3.5.32

10 years ago

3.5.31

10 years ago

2.10.3

10 years ago

3.5.30

10 years ago

3.5.29

10 years ago

3.5.28

10 years ago

3.5.27

10 years ago

3.5.26

10 years ago

3.5.25

10 years ago

3.5.24

10 years ago

3.5.23

10 years ago

3.5.22

10 years ago

3.5.21

10 years ago

3.5.20

10 years ago

3.5.19

10 years ago

3.5.18

10 years ago

3.5.17

10 years ago

3.5.16

10 years ago

2.10.2

10 years ago

3.5.15

10 years ago

3.5.14

10 years ago

3.5.13

10 years ago

3.5.12

10 years ago

3.5.10

10 years ago

3.5.9

10 years ago

3.5.8

10 years ago

3.5.7

10 years ago

3.5.6

10 years ago

3.5.5

10 years ago

3.5.4

10 years ago

3.5.3

10 years ago

3.5.2

10 years ago

3.5.1

10 years ago

3.5.0

10 years ago

3.4.4

10 years ago

3.4.3

10 years ago

3.4.2

10 years ago

3.4.1

10 years ago

3.4.0

10 years ago

3.2.4

10 years ago

3.3.1

10 years ago

3.2.3

10 years ago

3.3.0

10 years ago

3.2.2

10 years ago

3.2.1

10 years ago

3.2.0

10 years ago

3.1.0

10 years ago

3.0.3

10 years ago

3.0.1

10 years ago

3.0.0

10 years ago

2.10.1

10 years ago

2.10.0

10 years ago

2.9.3

10 years ago

2.9.2

10 years ago

2.9.1

10 years ago

2.9.0

10 years ago

2.8.3

10 years ago

2.8.2

10 years ago

2.8.1

10 years ago

2.8.0

10 years ago

2.7.4

10 years ago

2.7.3

10 years ago

2.7.2

10 years ago

2.7.1

10 years ago

2.7.0

10 years ago

2.6.5

10 years ago

2.6.6

10 years ago

2.6.4

10 years ago

2.6.3

10 years ago

2.6.2

10 years ago

2.6.1

10 years ago

2.5.1

10 years ago

2.5.0

10 years ago

2.4.9

10 years ago

2.4.8

10 years ago

2.4.7

10 years ago

2.4.6

10 years ago

2.4.5

10 years ago

2.4.4

10 years ago

2.4.3

10 years ago

2.4.2

10 years ago

2.4.1

10 years ago

2.4.0

10 years ago

2.3.1

10 years ago

2.3.0

10 years ago

2.2.2

10 years ago

2.2.1

10 years ago

2.2.0

10 years ago

2.1.7

10 years ago

2.1.6

10 years ago

2.1.5

10 years ago

2.1.3

10 years ago

2.1.2

10 years ago

2.1.1

10 years ago

2.1.0

10 years ago

2.0.6

10 years ago

2.0.5

10 years ago

2.0.4

10 years ago

2.0.3

10 years ago

2.0.2

10 years ago

2.0.1

10 years ago

2.0.0

10 years ago

2.0.0-rc13

10 years ago

2.0.0-rc12

10 years ago

2.0.0-rc11

10 years ago

2.0.0-rc10

10 years ago

2.0.0-rc9

10 years ago

2.0.0-rc8

10 years ago

2.0.0-rc7

10 years ago

2.0.0-rc6

10 years ago

2.0.0-rc5

10 years ago

2.0.0-rc4

10 years ago

2.0.0-rc3

10 years ago

2.0.0-rc2

10 years ago

2.0.0-rc1

10 years ago

2.0.0-beta31

10 years ago

2.0.0-beta30

10 years ago

2.0.0-beta29

10 years ago

2.0.0-beta28

10 years ago

2.0.0-beta27

10 years ago

2.0.0-beta26

10 years ago

2.0.0-beta25

10 years ago

2.0.0-beta24

10 years ago

2.0.0-beta23

10 years ago

2.0.0-beta22

10 years ago

2.0.0-beta21

10 years ago

2.0.0-beta20

10 years ago

2.0.0-beta19

10 years ago

1.3.2

10 years ago

2.0.0-beta18

10 years ago

2.0.0-beta17

10 years ago

2.0.0-beta16

10 years ago

2.0.0-beta15

10 years ago

2.0.0-beta14

10 years ago

2.0.0-beta13

10 years ago

2.0.0-beta12

10 years ago

2.0.0-beta11

10 years ago

2.0.0-beta10

10 years ago

2.0.0-beta9

10 years ago

2.0.0-beta8

10 years ago

2.0.0-beta7

10 years ago

2.0.0-beta6

10 years ago

2.0.0-beta5

10 years ago

2.0.0-beta4

10 years ago

2.0.0-beta3

10 years ago

2.0.0-beta2

10 years ago

2.0.0-beta1

10 years ago

2.0.0-alpha4

10 years ago

2.0.0-alpha3

10 years ago

2.0.0-alpha2

10 years ago

2.0.0-alpha1

10 years ago

1.3.1

10 years ago

1.3.0

10 years ago

1.2.7

10 years ago

1.2.6

10 years ago

1.2.5

10 years ago