micro/network/router/proto/router.proto

syntax = "proto3";

// Router service is used by the proxy to lookup routes
service Router {
        rpc Watch(WatchRequest) returns (stream TableEvent) {};
	rpc Lookup(LookupRequest) returns (LookupResponse) {};
        rpc List(ListRequest) returns (ListResponse) {};
}

// LookupRequest is made to Lookup
message LookupRequest {
	Query query = 1;
}

// LookupResponse is returned by Lookup
message LookupResponse {
	repeated Route routes = 1;
}

// WatchRequest is made to Watch Router
message WatchRequest {}

// EventType is TableEvent type
enum EventType {
        Create = 0;
        Delete = 1;
        Update = 2;
}

// TableEvent is streamed by WatchRequest
message TableEvent {
        // time of table event
        EventType type = 1;
        // unix timestamp of event
        int64 timestamp = 2;
        // service route
	Route route = 3;
}

// ListRequest is made to List routes
message ListRequest {}

// ListResponse is returned by List
message ListResponse {
	repeated Route routes = 1;
}

// Query is passed in a LookupRequest
message Query {
	// service to lookup
	string service = 1;
}

// Route is a service route
message Route {
	// service for the route
	string service = 1;
	// the address that advertise this route
	string address = 2;
	// gateway as the next hop
	string gateway = 3;
	// the network for this destination
	string network = 4;
	// the network link
	string link = 5;
	// the metric / score of this route
	int64 metric = 6;
}