frostfs-api-go/bootstrap/service.proto

43 lines
1.8 KiB
Protocol Buffer
Raw Normal View History

2019-11-18 13:34:06 +00:00
syntax = "proto3";
package bootstrap;
2020-03-31 07:05:26 +00:00
option go_package = "github.com/nspcc-dev/neofs-api-go/bootstrap";
2020-02-05 13:58:06 +00:00
option csharp_namespace = "NeoFS.API.Bootstrap";
2019-11-18 13:34:06 +00:00
2019-11-18 16:22:08 +00:00
import "service/meta.proto";
import "service/verify.proto";
2019-11-18 13:34:06 +00:00
import "bootstrap/types.proto";
import "github.com/gogo/protobuf/gogoproto/gogo.proto";
option (gogoproto.stable_marshaler_all) = true;
// 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.
2019-11-18 13:34:06 +00:00
service Bootstrap {
// Process is method that allows to register node in the network and receive actual netmap
2019-11-18 13:34:06 +00:00
rpc Process(Request) returns (bootstrap.SpreadMap);
}
message Request {
2020-04-16 08:31:09 +00:00
// Node state
enum State {
// used by default
Unknown = 0;
// used to inform that node online
Online = 1;
// used to inform that node offline
Offline = 2;
}
// Type is NodeType, can be InnerRingNode (type=1) or StorageNode (type=2)
2019-11-18 16:22:08 +00:00
int32 type = 1 [(gogoproto.customname) = "Type" , (gogoproto.nullable) = false, (gogoproto.customtype) = "NodeType"];
// Info contains information about node
2019-11-18 16:22:08 +00:00
bootstrap.NodeInfo info = 2 [(gogoproto.nullable) = false];
2020-04-16 08:31:09 +00:00
// State contains node status
State state = 3;
2019-11-18 16:22:08 +00:00
// RequestMetaHeader contains information about request meta headers (should be embedded into message)
service.RequestMetaHeader Meta = 98 [(gogoproto.embed) = true, (gogoproto.nullable) = false];
// RequestVerificationHeader is a set of signatures of every NeoFS Node that processed request (should be embedded into message)
service.RequestVerificationHeader Verify = 99 [(gogoproto.embed) = true, (gogoproto.nullable) = false];
2019-11-18 13:34:06 +00:00
}