diff options
author | Tim Cooper <tim.cooper@layeh.com> | 2015-07-31 18:50:34 +0300 |
---|---|---|
committer | Mikkel Krautz <mikkel@krautz.dk> | 2016-05-08 17:45:52 +0300 |
commit | 92320bffba64ef0e611cb6b2d8ea010625881e8f (patch) | |
tree | 2fa73b52835b8c5f1f7dc67247c60ad236c6a597 /src/murmur/MurmurRPC.proto | |
parent | af631631e4ce2efb3f16b4ac08dfda8441338855 (diff) |
grpc: add comment about incomplete embedded protobuf messages
Diffstat (limited to 'src/murmur/MurmurRPC.proto')
-rw-r--r-- | src/murmur/MurmurRPC.proto | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/src/murmur/MurmurRPC.proto b/src/murmur/MurmurRPC.proto index 751335b3e..8394aa7e9 100644 --- a/src/murmur/MurmurRPC.proto +++ b/src/murmur/MurmurRPC.proto @@ -2,6 +2,16 @@ syntax = "proto2"; package MurmurRPC; +// Note about embedded messages: +// +// To help save bandwidth, the protocol does not always send complete embedded +// messages (i.e. an embeddded message with all of the fields filled in). These +// incomplete messages only contain enough identifying information to get more +// information from the message's corresponding "Get" method. For example: +// +// User.server only ever contains the server ID. Calling ServerGet(User.server) +// will return a Server message with the server's status and uptime. + message Void { } |