Revision 2d315870 doc/classdiagrams/pubsub.uml

View differences:

doc/classdiagrams/pubsub.uml
67 67
    + {field} numMessagesReceived : uint64_t
68 68
  }
69 69

  
70
  /' Function type to be called when calculating the usefulness of a message. '/
71
  $function("urt_srtusefulnessfunc_t") {
72
    'Takes a delay and optionally parameters as arguments and returns a float in [0, 1].
73
    urt_srtusefulnessfunc_t (dt : urt_delay_t, params : void*) : float
74
  }
75

  
76 70
  /' NRT subscriber type. '/
77 71
  $structure("urt_nrtsubscriber_t") {
78 72
    .. URT_CFG_PUBSUB_PROFILING == true ..
......
96 90
  /' SRT subscriber type. '/
97 91
  $structure("urt_srtsubscriber_t") {
98 92
      'Callback to calculate usefulness of a message
99
    + {field} usefulnesscb : urt_srtusefulnessfunc_t*
93
    + {field} usefulnesscb : urt_usefulness_f*
100 94
      'Optional parameters for the usefulness callback function.
101 95
    + {field} cbparams : void*
102 96
    .. URT_CFG_PUBSUB_PROFILING == true ..
......
108 102
      'Initializes a urt_srtsubscriber_t object.
109 103
    + {method} urtSrtSubscriberInit (subscriber : urt_srtsubscriber_t*) : void
110 104
      'Tries to subscribe to a topic, sets all parameters and optionally contributes a list of messages to the topic.
111
    + {method} urtSrtSubscriberSubscribe (subscriber : urt_srtsubscriber_t*, topic : urt_topic_t*, messages : urt_message_t*, usefulnesscb : urt_srtusefulnessfunc_t*, cbparams : void*) : urt_status_t
105
    + {method} urtSrtSubscriberSubscribe (subscriber : urt_srtsubscriber_t*, topic : urt_topic_t*, messages : urt_message_t*, usefulnesscb : urt_usefulness_f*, cbparams : void*) : urt_status_t
112 106
      'Fetches the next message in the buffer, optionally copies the payload and optionally returns the latency.
113 107
    + {method} urtSrtSubscriberFetchNextMessage (subscriber : urt_srtsubscriber_t*, payload : void*, bytes : size_t, latency : urt_delay_t*) : urt_status_t
114 108
      'Fetches the latest message, optionally copies the payload and optionally returns the latency.
......
238 232

  
239 233
!startsub DEPENDENCIES
240 234

  
241
urt_message_t "1" o-- "0..1" urt_message_t
235
urt_message_t "1" o- "0,1" urt_message_t
236

  
237
urt_basesubscriber_t "1" o-- "0,1" urt_message_t
242 238

  
243 239
urt_nrtsubscriber_t --|> urt_basesubscriber_t
244
urt_nrtsubscriber_t ..> urt_message_t
245 240

  
246 241
urt_srtsubscriber_t --|> urt_basesubscriber_t
247
urt_srtsubscriber_t "1" o-- "0..1" urt_srtusefulnessfunc_t
248
urt_srtsubscriber_t ..> urt_message_t
249 242

  
250 243
urt_frtsubscriber_t --|> urt_basesubscriber_t
251
urt_frtsubscriber_t ..> urt_message_t
252 244

  
253 245
urt_hrtsubscriber_t --|> urt_basesubscriber_t
254
urt_hrtsubscriber_t "1" o-- "0..1" urt_hrtsubscriber_t
255
urt_hrtsubscriber_t ..> urt_message_t
246
urt_hrtsubscriber_t "1" o- "0,1" urt_hrtsubscriber_t
256 247

  
257 248
urt_publisher_t "1" o- "1" urt_topic_t
258 249
urt_publisher_t ..> urt_message_t
259 250

  
260
urt_topic_t "1" o-- "0..1" urt_topic_t
261
urt_topic_t "1" o- "0..1" urt_hrtsubscriber_t
251
urt_topic_t "1" o- "0,1" urt_topic_t
252
urt_topic_t "1" o- "0,1" urt_hrtsubscriber_t
262 253
urt_topic_t "1" *-- "1" urt_message_t
263 254

  
264 255
!endsub

Also available in: Unified diff