Skip to content

Commit

Permalink
Update diagrams and Managed Subscribe Readme (#51)
Browse files Browse the repository at this point in the history
* Update diagrams and Managed Subscribe Readme

* fix spelling mistake and add accepted words

* Update diagrams
  • Loading branch information
devkelley authored Oct 12, 2023
1 parent db4064e commit 3de8d13
Show file tree
Hide file tree
Showing 10 changed files with 349 additions and 15 deletions.
18 changes: 18 additions & 0 deletions docs/design/diagrams/managed_subscribe_consumer_sequence.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
@startuml Managed Subscribe Consumer
title Managed Subscribe Sequence from Consumer's Perspective
participant "Digital Twin Consumer" as DTConsumer
participant Ibeji
participant Broker

autonumber

DTConsumer -> Ibeji: FindById - request
DTConsumer <- Ibeji: FindById - response
DTConsumer -> Ibeji: GetSubscriptionInfo (entity_id, constraints)
Ibeji -> DTConsumer: GetSubscriptionInfo - response
note right of DTConsumer: SubInfo {topic, broker endpoint info}
DTConsumer -> Broker: Subscribe (SubInfo.topic)
DTConsumer <- Broker : data
DTConsumer -> Broker: Unsubscribe (SubInfo.topic)
DTConsumer x<- Broker: data
@enduml
28 changes: 28 additions & 0 deletions docs/design/diagrams/managed_subscribe_consumer_sequence.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 9 additions & 4 deletions docs/design/diagrams/managed_subscribe_interceptor_sequence.puml
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
@startuml Managed Subscribe Interceptor
title Managed Subscribe Interceptor Sequence
participant "Digital Twin Provider" as DTProvider
box "Ibeji"
participant "Managed Subscribe Module" as ManagedSubscribeModule
participant Ibeji
participant "InVehicle Digital Twin" as Ibeji
end box

autonumber

Expand All @@ -11,8 +13,10 @@ ManagedSubscribeModule -> ManagedSubscribeModule: Intercepts Register request

alt contains `ManagedSubscribe` Entry
note right of DTProvider
// Entry that indicates to Ibeji that the Provider
// wants to utilize the Managed Subscribe Module.
Entry that indicates to Ibeji that
the Provider wants to utilize the
Managed Subscribe Module.

{
protocol: "grpc"
operations: ["ManagedSubscribe"]
Expand All @@ -23,7 +27,8 @@ end note
ManagedSubscribeModule -> ManagedSubscribeModule: Store provider callback.
ManagedSubscribeModule -> ManagedSubscribeModule: Modify the request's `ManagedSubscribe` endpointInfo.
note right of ManagedSubscribeModule
// Points to the Managed Subscribe gRPC endpoint
Points to the Managed Subscribe gRPC endpoint

{
protocol: "grpc"
operations: ["ManagedSubscribe"]
Expand Down
Loading

0 comments on commit 3de8d13

Please sign in to comment.