Skip to content

Latest commit

 

History

History
72 lines (59 loc) · 3.01 KB

README.md

File metadata and controls

72 lines (59 loc) · 3.01 KB
Raw

sijsop - SImple JSOn Protocol

sijsop provides a JSON-based wire or file protocol that provides extremely good bang-for-the-buck, as well as being very easy to implement in other languages. See the godoc for more information.

sijsop requires at least Go 1.7.

Repository Status

This (or a slightly different predecessor) is used for production code for a non-trivial system. It is used for the control plane of a system that pushes a lot of data through, but doesn't push a lot of these messages through.

This is actually perfectly suitable for systems where you're not pushing so many messages through that you care about JSON serialization overhead. This actually covers a lot of use cases nowadays; see also the number of REST systems out in the world serializing JSON. If you wouldn't blink at a REST system serializing JSON at the same rate you send network messages with this library, it'll perform fine.

This also has the advantage that it has been through a few revisions across a few languages; in particular, sending the type of a message separately is something quite nice for an otherwise JSON-based system.

However, perhaps the even greater utility of this repository is that it provides a very clean example of building a non-trivial, but also not super-complicated, network protocol on top of a socket. Debugging through the provided example is a great way to see how to do that in Go.

That it is also useful and something you can ship with if you want to is a nice bonus.

Code Signing

I will be signing this repository with the "jerf" keybase account. If you are viewing this repository through GitHub, you should see the commits as showing as "verified" in the commit view.

(Bear in mind that due to the nature of how git commit signing works, there may be runs of unverified commits; what matters is that the top one is signed.)

Changlog

  1. 1.0.2
  • Add the ability to set the indent on the JSON marshaling process, for debugging purposes. (You can set the indent up to make the messages on the wire more readable for debugging.)
  1. 1.0.1
  • Finish removing the restrictions around a 255-char limit on types. I mean, in my opinion you shouldn't have types that long, but there's no reason to limit you.
  • Remove the error return from Register for documentation simplicity.
  1. 1.0.0
  • Per ESR, this changes the protocol to pure text. This is API compatible with 0.9.0, but protocol incompatible.
  1. 0.9.0
  • This was pulled from some production code and then modified to be suitable for public release. The modifications haven't been tested. I used the predecessor in production code, and the test cases are passing, so I'm reasonably confident this is useful code, but I'm going to let it bake in a bit (and take some time later to switch my internal code to using this) to be sure before I declare it 1.0.