Skip to content

Latest commit

 

History

History
59 lines (52 loc) · 2.71 KB

class_overview.md

File metadata and controls

59 lines (52 loc) · 2.71 KB

UDMI / Docs / UDMIS / Class Diagram

UDMIS Class Architecture

The class structure of the UDMIS subsystem layers a set of business-logic (i.e. the UDMIS part) on top of common foundations for message handling and basic system facilities. This structure is not about the functionality (e.g. what the system does from the outside), but rather the underlying foundation of how things are structures to provide testability, monitoring, diagnostics, etc...

classDiagram
direction BT
class ContainerBase
class LocalMessagePipe
class MessageBase
class MessageDispatcher {
<<Interface>>

}
class MessageDispatcherImpl
class MessagePipe {
<<Interface>>

}
class SimpleMqttPipe
class StateHandler
class TargetHandler
class UdmiServicePod
class UdmisComponent

LocalMessagePipe  -->  MessageBase 
MessageBase  -->  ContainerBase 
MessageBase  ..>  MessagePipe 
MessageDispatcher  ..>  MessageDispatcherImpl : «create»
MessageDispatcherImpl  -->  ContainerBase 
MessageDispatcherImpl  ..>  MessageDispatcher 
MessageDispatcherImpl "1" *--> "messagePipe 1" MessagePipe 
SimpleMqttPipe  -->  MessageBase 
StateHandler  -->  UdmisComponent 
TargetHandler  -->  UdmisComponent 
UdmiServicePod "1" *--> "stateHandler 1" StateHandler 
UdmiServicePod "1" *--> "targetHandler 1" TargetHandler 
UdmisComponent  -->  ContainerBase 
UdmisComponent "1" *--> "dispatcher 1" MessageDispatcher
Loading
  • ContainerBase: Abstract class that provides system-wide common functionality for generic components, e.g. logging.
  • MessagePipe: Interface for other components that require a message pipe of some kind.
    • MessageBase: Abstract class providing common functionality for all message pipe implementations.
      • LocalMessagePipe: Simple in-process pipe implementation primarily designed for testing.
      • SimpleMqttPipe: Message pipe implementation that uses a local MQTT broker for communication.
      • (CloudMqttPipe: A more involved version of the simple pipe that works with cloud endpoint. Might be the same as the simple version.)
      • (PubSubPipe: Eventually, there will also be a PubSub pipe available for GCP deployments.)
  • MessageDispatcher: Interface for type-savvy message handling, rather than handling raw strings or JSON messages.
    • MessageDispatcherImpl: Implementation of the message dispatcher interface.
  • UdmisComponent: Base class for common functionality implementing higher-level functions.
    • StateHandler: Specific handler for dealing with UDMIS state message updates (business logic).
    • TargetHandler: Specific handler for dealing with UDMIS target messages (business logic).
  • UdmiServicePod: Container main class that instantiates subcomponents according to configuration parameters.