Browse Source

update README.md

pull/1780/head
Ethan Buchman 8 years ago
parent
commit
fbbf82ec64
1 changed files with 7 additions and 4 deletions
  1. +7
    -4
      README.md

+ 7
- 4
README.md View File

@ -17,13 +17,14 @@ Other implementations:
This repository holds a number of important pieces:
- `types/types.proto`
- the protobuf file definig TMSP message types, and the optional grpc interface.
- use `protoc --go_out=plugins=grpc:. types.proto` to from the `types` dir to generate the `types/types.pb.go` file
- see `protoc --help` and [the grpc docs](www.grpc.io/docs) for examples and details of other languages
- the protobuf file defining TMSP message types, and the optional grpc interface.
- run `protoc --go_out=plugins=grpc:. types.proto` in the `types` dir to generate the `types/types.pb.go` file
- see `protoc --help` and [the grpc docs](https://www.grpc.io/docs) for examples and details of other languages
- golang implementation of TMSP client and server
- two implementations:
- asynchronous, ordered message passing over unix or tcp
- asynchronous, ordered message passing over unix or tcp;
- messages are serialized using protobuf and length prefixed
- grpc
- TendermintCore runs a client, and the application runs a server
@ -42,6 +43,8 @@ Since this is a streaming protocol, all messages are encoded with a length-prefi
For example, if the Protobuf3 encoded TMSP message is `0xDEADBEEF` (4 bytes), the length-prefixed message is `0x0104DEADBEEF`. If the Protobuf3 encoded TMSP message is 65535 bytes long, the length-prefixed message would be like `0x02FFFF...`.
Note this prefixing does not apply for grpc.
## Message types
TMSP requests/responses are simple Protobuf messages. Check out the [schema file](https://github.com/tendermint/tmsp/blob/master/types/types.proto).


Loading…
Cancel
Save