Revision e87bd7c7 doc/classdiagrams/urtware.uml

View differences:

doc/classdiagrams/urtware.uml
39 39 
  - {field} {static} _evtSource : urt_osEventSource_t
40 40 
    'Mutex used for synchronization.
41 41 
  - {field} {static} _lock : urt_osMutex_t
42 
    'System execution/health status.
43 
  - {field} {static} _status : urt_status_t
42 44 
  .. URT_CFG_PUBSUB_ENABLED == true ..
43 45 
    'List of topics ordered by their identifiers.
44 46 
  - {field} {static} _topics : urt_topic_t*
......
48 50 
  __
49 51 
    'Initializes the urt_core_t object.
50 52 
  + {method} urtCoreInit (void) : urt_status_t
53 
    'Retrieves the current system status.
54 
  + {method} urtCoreGetStatus (void) : urt_status_t
51 55 
    'Starts all node threads (nodes will block before the loop).
52 56 
  + {method} urtCoreStartNodes (void) : urt_status_t
53 
    'Nodes can use this function to synchronize globally.
54 
  + {method} urtCoreSynchronizeNodes (node : urt_node_t*, stage : urt_nodestage_t) : urt_status_t
55 
    'Stops all nodes.
56 
  + {method} urtCoreStopNodes (void) : urt_status_t
57 
    'Nodes can use this function to synchronize.
58 
  + {method} urtCoreSynchronize (node : urt_node_t*) : urt_status_t
59 
    'Stops all nodes and propagates a specified reason.
60 
  + {method} urtCoreStopNodes (reason : urt_status_t) : urt_status_t
57 61 
  .. URT_CFG_PUBSUB_ENABLED == true ..
58 62 
    'Retrieves a topic given an identifier.
59 63 
  + {method} urtCoreGetTopic (id : urt_topicid_t) : urt_topic_t*
......
75 79 
    urt_nodeLoopCallback_t (node : urt_node_t*, events : urt_osEventMask_t, arg : void*) : urt_osEventMask_t
76 80 
  }
77 81 

  		




  
  82
  
    
  /' Function type to be called during shutdown phase of node threads. '/


  		




  
  83
  
    
  $type("urt_nodeShutdownCallback_t") {


  		




  
  84
  
    
      'Takes the node, an error code defining the cause of the shutdown and optional parameters as argumnets.


  		




  
  85
  
    
    urt_nodeShutdownCallback_t (node : urt_node_t*, cause : urt_status_t, arg : void*) : void


  		




  
  86
  
    
  }


  		




  
  87
  
    

  		




  78
  88
  
    
  /' Node structure. '/


  		




  79
  89
  
    
  $structure("urt_node_t") {


  		




  80
  90
  
    
      'Pointer to the next node in a list.


  		




  81
  91
  
    
    + {field} next : urt_node_t*


  		




  82
  92
  
    
      'Pointer to the node thread.


  		




  83
  93
  
    
    + {field} thread : urt_osThread_t*


  		




  84
  
  
    
      'Callback function to be called during the setup phase.


  		




  
  94
  
    
      'Optional callback function to be called during the setup phase.


  		




  85
  95
  
    
    + {field} setupcallback : urt_nodeSetupCallback_t*


  		




  86
  96
  
    
      'Optional parameters for the setup callback function.


  		




  87
  97
  
    
    + {field} setupparams : void*


  		




  ......




  89
  99
  
    
    + {field} loopcallback : urt_nodeLoopCallback_t*


  		




  90
  100
  
    
      'Optional parameters for the loop callback function.


  		




  91
  101
  
    
    + {field} loopparams : void*


  		




  
  102
  
    
      'Optional callback function to be called during the shutdown phase.


  		




  
  103
  
    
    + {field} shutdowncallback : urt_nodeShutdownCallback_t*


  		




  
  104
  
    
      'Optional parameters for the shutdown callback function.


  		




  
  105
  
    
    + {field} shutdownparams : void*


  		




  92
  106
  
    
      'Execution stage of the node.


  		




  93
  107
  
    
    + {field} stage : urt_nodestage_t


  		




  94
  108
  
    
      'Event listener for middleware-wide control events.


  		




  ......




  100
  114
  
    
    'The main() function of the node thread.


  		




  101
  115
  
    
    - {method} {static} _main : urt_osThreadFunction_t


  		




  102
  116
  
    
      'Initializes an urt_node_t object.


  		




  103
  
  
    
    + {method} urtNodeInit (node : urt_node_t*, thread : urt_osThread_t*, setupcallback : urt_nodeSetupCallback_t*, setupparams : void*, loopcallback : urt_nodeLoopCallback_t*, loopparams : void*) : urt_status_t


  		




  
  117
  
    
    + {method} urtNodeInit (node : urt_node_t*, thread : urt_osThread_t*, setupcallback : urt_nodeSetupCallback_t*, setupparams : void*, loopcallback : urt_nodeLoopCallback_t*, loopparams : void*, shutdowncallback : urt_nodeShutdownCallback_t*, shutodwnparams : void*) : urt_status_t


  		




  104
  118
  
    
  }


  		




  105
  119
  
    
} /'node'/


  		




  106
  120
  
    

  		




  ......




  119
  133
  
    
!startsub DEPENDENCIES


  		




  120
  134
  
    

  		




  121
  135
  
    
urt_node_t "1" o-- "0..1" urt_node_t


  		




  122
  
  
    
urt_node_t "1" o-- "1" urt_nodeSetupCallback_t


  		




  
  136
  
    
urt_node_t "1" o-- "0..1" urt_nodeSetupCallback_t


  		




  123
  137
  
    
urt_node_t <.. urt_nodeSetupCallback_t


  		




  124
  138
  
    
urt_node_t "1" o-- "1" urt_nodeLoopCallback_t


  		




  125
  139
  
    
urt_node_t <.. urt_nodeLoopCallback_t


  		




  
  140
  
    
urt_node_t "1" o-- "0..1" urt_nodeShutdownCallback_t


  		




  
  141
  
    
urt_node_t <.. urt_nodeShutdownCallback_t


  		




  126
  142
  
    

  		




  127
  143
  
    
!includesub pubsub.uml!DEPENDENCIES


  		




  128
  144
  
    

  		












Also available in:  Unified diff