realloc/frostfs-api-go
1
0
Fork 0
forked from TrueCloudLab/frostfs-api-go
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs: add bootstrap proto documentation

Browse source
This commit is contained in:
Evgeniy Kulikov 2019-11-20 19:21:45 +03:00 • committed by alexvanin
parent 811bcbd14f
commit 84ac6f55a3
2 changed files with 13 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

9
bootstrap/service.proto
View file

@ -7,14 +7,19 @@ import "github.com/gogo/protobuf/gogoproto/gogo.proto";
option (gogoproto.stable_marshaler_all) = true;
// The Bootstrap service definition.
// Bootstrap service allows neofs-node to connect to the network. Node should
// perform at least one bootstrap request in the epoch to stay in the network
// for the next epoch.
service Bootstrap {
// Process is method that allows to register node in the network and receive actual netmap
rpc Process(Request) returns (bootstrap.SpreadMap);
}
// Request message to communicate between DHT nodes
message Request {
// Type is NodeType, can be InnerRingNode (type=1) or StorageNode (type=2)
int32 type = 1 [(gogoproto.customname) = "Type" , (gogoproto.nullable) = false, (gogoproto.customtype) = "NodeType"];
// Info contains information about node
bootstrap.NodeInfo info = 2 [(gogoproto.nullable) = false];
// TTL must be larger than zero, it decreased in every neofs-node
uint32 TTL = 3;
}