Skip to content

Latest commit

 

History

History
26 lines (19 loc) · 1.23 KB

README.md

File metadata and controls

26 lines (19 loc) · 1.23 KB
Raw

The protocol buffer example repository

This is a quick intro into how to create and maintain a protocol buffer repository.

The Goomerang library assumes the user has a protocol buffers repository, which is shared by server and clients. That guarantees the exchanged types are compatibles at a binary level for a specific repository version.

Protocol buffers works with an IDL (Interface definition language) which then it's converted for the relevant target languages by the protocol buffer compiler:

graph LR;
IDL-->ProtoCompiler;
ProtoCompiler-->Go;
ProtoCompiler-->Python;
ProtoCompiler-->...;
Loading

The first thing the user needs to do is to download and install the proto compiler .

Then create the IDLs. The protos found in the README.md examples, can be found on this repo IDL.

Once we have the IDLs ready, we can use the protocol buffer compiler for generating the resultant code, that should be shared with clients and servers. An example of the coomands are provided on this repo Makefile .