r4wizard / kalm-msgpack-snappy

kalm-msgpack-snappy

msgpack and snappy serializer for Kalm

Install

npm install kalm-msgpack-snappy

Usage

Setting up your server:

    const Kalm = require('kalm');
    const msgpacksnappy = require('kalm-msgpack-snappy');

    const server = Kalm.listen({
        port: 3000,
        serial: msgpacksnappy
    });

    server.on('connection', (client) => {
        client.subscribe('/', (data) => {
            console.log(data);  // 'Hello from Browser!'
        });
    });

Using in your browser:

    // Install kalm and kalm-msgpack-snappy via a package manager (recommended).

    import Kalm from 'kalm';
    import msgpacksnappy from 'kalm-msgpack-snappy';

    const client = Kalm.connect({
        hostname: '127.0.0.1',  // Your server's hostname
        port: 3000,             // Your server's port
        serial: msgpacksnappy
    });

    client.write('Hello from Browser');

Contribute

Please do! This is an open source project - if you see something that you want, open an issue or file a pull request.

If you have a major change, it would be better to open an issue first so that we can talk about it.

I am always looking for more maintainers, as well. Get involved.

License

Apache 2.0 (c) 2017 Peter Corcoran - based on work by Frederic Charette (kalm-msgpack and kalm-snappy)