Skip to content

docs: document dotted-decimal conversion between Peer.ip and Ping.canaries #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
VasilevNStas wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: document dotted-decimal conversion between Peer.ip and Ping.canaries #46

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion ping.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,9 @@ message Ping {
// unreachable Nodes can be retired. MUST NOT contain more entries
// than the fleet size (dozens); the Node SHOULD discard or
// truncate a Ping whose canaries map exceeds that bound to prevent
// unbounded map allocation per session.
// unbounded map allocation per session. When producing keys from
// Peer.ip (four raw bytes, network byte order), the client MUST
// convert each byte to its decimal representation and join with
// dots before inserting into this map.
map<string, uint32> canaries = 2;
}
2 changes: 2 additions & 0 deletions pong.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@ message Property {
// Node nears expiry.
message Peer {
// Public IPv4 of the peer as four raw bytes (network byte order).
// Clients MUST convert this to dotted-decimal form
// ("203.0.113.7") when using the address as a Ping.canaries key.
bytes ip = 1;

// TCP port on which the peer accepts client connections. Valid
Expand Down