Subscription Service
Protobuf Definition#
service SubscriptionService { rpc SubscribeToLsNodes(TopologySubscription) returns (stream LsNodeEvent) {} rpc SubscribeToLsLinks(TopologySubscription) returns (stream LsLinkEvent) {} rpc SubscribeToLsPrefixes(TopologySubscription) returns (stream LsPrefixEvent) {} rpc SubscribeToLsSrv6Sids(TopologySubscription) returns (stream LsSrv6SidEvent) {} rpc SubscribeToLsNodeEdges(TopologySubscription) returns (stream LsNodeEdgeEvent) {} rpc SubscribeToTelemetryData(TelemetrySubscription) returns (stream TelemetryEvent) {}}Methods#
SubscribeToLsNodes()#
rpc SubscribeToLsNodes(TopologySubscription) returns (stream LsNodeEvent) {}See also: TopologySubscription, LsNodeEvent
Description#
Takes a TopologySubscription with the specified keys and properties and returns a stream of LsNodeEvents. An LsNodeEvent contains an update to a single LsNode. Only LsNodes matching one of the specified keys are returned and only properties specified in properties are set.
- Omitting keys streams LsNodeEvents for all available LsNodes.
- Omitting properties streams LsNodeEvents for LsNodes with all available properties.
Examples#
| keys | properties | LsNodeEvents |
|---|---|---|
| [ "nodeKey1", "nodeKey2" ] | [ "Name", "Asn", "RouterIp" ] | Streams LsNodeEvents for LsNodes for the two specified keys with the three requested properties. |
| - | [ "Name", "Asn", "RouterIp" ] | Streams LsNodeEvents for all available LsNodes with the three requested properties. |
| [ "nodeKey1", "nodeKey2" ] | - | Streams LsNodeEvents for LsNodes for the two specified keys with all available properties. |
| - | - | Streams LsNodeEvents for all available LsNodes with all available properties. |
SubscribeToLsLinks()#
rpc SubscribeToLsLinks(TopologySubscription) returns (stream LsLinkEvent) {}See also: TopologySubscription, LsLinkEvent
Description#
See method SubscribeToLsNodes(). It follows the same principle regarding keys and properties.
SubscribeToLsPrefixes()#
rpc SubscribeToLsPrefixes(TopologySubscription) returns (stream LsPrefixEvent) {}See also: TopologySubscription, LsPrefixEvent
Description#
See method SubscribeToLsNodes(). It follows the same principle regarding keys and properties.
SubscribeToLsSrv6Sids()#
rpc SubscribeToLsSrv6Sids(TopologySubscription) returns (stream LsSrv6SidEvent) {}See also: TopologySubscription, LsSrv6SidEvent
Description#
See method SubscribeToLsNodes(). It follows the same principle regarding keys and properties.
SubscribeToLsNodeEdges()#
rpc SubscribeToLsNodeEdges(TopologySubscription) returns (stream LsNodeEdgeEvent) {}See also: TopologySubscription, LsNodeEdgeEvent
Description#
See method SubscribeToLsNodes(). It follows the same principle regarding keys and properties.
SubscribeToTelemetryData()#
rpc SubscribeToTelemetryData(TelemetrySubscription) returns (stream TelemetryEvent) {}See also: TelemetrySubscription, TelemetryResponse
Description#
Takes a TelemetrySubscription with the specified ipv4addresses and properties and returns a stream of TelemetryEvents. A TelemetryEvent contains an update to a single event tied to an ipv4address.
- Omitting ipv4addresses streams TelemetryEvents for all available ipv4addresses.
- Omitting properties streams TelemetryEvents with all available properties.
Examples#
| ipv4addresses | properties | TelemetryEvent |
|---|---|---|
| [ "1.2.3.4", "2.3.4.5" ] | [ "DataRate", "PacketsSent", "PacketsReceived" ] | Streams TelemetryEvents for the two specified ipv4addresses with the three requested properties. |
| - | [ "DataRate", "PacketsSent", "PacketsReceived" ] | Streams TelemetryEvents for all available ipv4addresses with the three specified properties. |
| [ "1.2.3.4", "2.3.4.5" ] | - | Streams TelemetryEvents for the two specified ipv4addresses with all available properties. |
| - | - | Streams TelemetryEvents for all available ipv4addresses with all available properties. |