micro/network/proto/network.proto
2019-09-13 03:03:55 +01:00

73 lines
1.6 KiB
Protocol Buffer

syntax = "proto3";
package go.micro.network;
import "github.com/micro/go-micro/router/proto/router.proto";
// Network service is usesd to gain visibility into networks
service Network {
rpc ListNodes(ListRequest) returns (ListResponse) {};
rpc ListPeers(PeerRequest) returns (PeerResponse) {};
rpc Topology(TopologyRequest) returns (TopologyResponse) {};
rpc ListRoutes(go.micro.router.Request) returns (go.micro.router.ListResponse) {};
}
// Empty request
message ListRequest {}
// ListResponse is returned by ListNodes
message ListResponse {
// network nodes
repeated Node nodes = 1;
}
// PeerRequest requests list of peers
message PeerRequest {
// node id
string id = 1;
}
// PeerResponse is returned by ListPeers
message PeerResponse {
repeated Node peers = 1;
}
// TopologyRequest list node topology
message TopologyRequest {
// node id
string id = 1;
}
// TopologyResponse is returned by Topology
message TopologyResponse {
Peer topology = 1;
}
// Node is network node
message Node {
// node id
string id = 1;
// node address
string address = 2;
}
// Connect is sent when the node connects to the network
message Connect {
// network mode
Node node = 1;
}
// Close is sent when the node disconnects from the network
message Close {
// network node
Node node = 1;
}
// Peer is used to advertise node peers
message Peer {
// network node
Node node = 1;
// node peers
repeated Peer peers = 2;
}