npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

sc-codec-pbf

v1.0.2

Published

Minimal binary codec for SocketCluster based on pbf

Downloads

2

Readme

sc-codec-pbf

Minimal binary codec for SC based on pbf.
This codec helps reduce bandwidth usage and is ideal for games and other high-throughput applications.

This module is designed to be hooked up on both the client and server.

This codec also assumes you're using one proto message type per SocketCluster client/worker instance for maximum efficiency, and that you're either sending objects that can be encoded with that message, or strings.

To install, use:

npm install --save sc-codec-pbf

Install pbf and compile a JavaScript module from a .proto file:

# example.proto
message Example {
  int64 x = 1;
  int64 y = 2;
  string playerID = 3;
  PlayerState playerState = 4;
  enum PlayerState {
    MOVING = 0;
    TALKING = 1;
    IN_COMBAT = 2;
  }
}
$ npm install -g pbf
$ pbf example.proto > example.js

On the server, inside worker.js, you should use:

var scCodecPbf = require('sc-codec-pbf');

// ...pbf
// This needs to go inside the run function - Near the top.
var Example = require('./example.js').Example;
worker.scServer.setCodecEngine(new scCodecPbf(Example));

On the client-side, you can either include the sc-codec-pbf module using your favorite bundler such as Browserify or Webpack or you can include the sc-codec-pbf.js file using a script tag; this will expose the scCodecPbf object globally. To use it, you just need to add it on connect:

var socket = socketCluster.connect({
  // ...
  codecEngine: new scCodecPbf(Example)
});

socket.emit('playerUpdate', {
  x: 500,
  y: 204,
  playerID: 'sdshu8ijodln',
  playerState: 0
})

Note that the codec used on the client and on the server always need to match.

Early Benchmarks

This hasn't been extensively battle tested yet, but early comparisons show a reduction of around half from sc-codec-min-bin. With the example above, Chrome WS frame inspector showed:

  • JSON Stringify/Parse: 87 bytes
  • sc-codec-min-bin: 54 bytes
  • sc-codec-pbf: 27 bytes

Contributing

To build the global script for the browser:

browserify -s scCodecPbf index.js > sc-codec-pbf.js