Statistics
| Branch: | Revision:

urtware / doc / activitydiagrams / subscriber / urtNrtSubscriberUnsubscribe.svg @ ee83a495

History | View | Annotate | Download (15.188 KB)

1
<?xml version="1.0" encoding="UTF-8" standalone="no"?><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" contentScriptType="application/ecmascript" contentStyleType="text/css" height="553px" preserveAspectRatio="none" style="width:781px;height:553px;" version="1.1" viewBox="0 0 781 553" width="781px" zoomAndPan="magnify"><defs><filter height="300%" id="f17b15liqbym63" width="300%" x="-1" y="-1"><feGaussianBlur result="blurOut" stdDeviation="2.0"/><feColorMatrix in="blurOut" result="blurOut2" type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 .4 0"/><feOffset dx="4.0" dy="4.0" in="blurOut2" result="blurOut3"/><feBlend in="SourceGraphic" in2="blurOut3" mode="normal"/></filter></defs><g><text fill="#000000" font-family="sans-serif" font-size="18" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="89" x="345" y="26.708">µRtWare</text><text fill="#000000" font-family="sans-serif" font-size="18" lengthAdjust="spacingAndGlyphs" textLength="269" x="255" y="47.6611">urtNrtSubscriberUnsubscribe()</text><text fill="#000000" font-family="sans-serif" font-size="18" lengthAdjust="spacingAndGlyphs" textLength="0" x="392.5" y="68.6143"/><path d="M281,72.8594 L281,183.6563 L769,183.6563 L769,82.8594 L759,72.8594 L281,72.8594 " fill="#FBFB77" filter="url(#f17b15liqbym63)" style="stroke: #A80036; stroke-width: 1.0;"/><path d="M759,72.8594 L759,82.8594 L769,82.8594 L759,72.8594 " fill="#FBFB77" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0;" x1="281" x2="412" y1="85.4258" y2="85.4258"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="0" x="416" y="89.4263"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="78" x="416" y="89.4263">subscriber</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="136" x="498" y="89.4263">: urt_nrtsubscriber_t*</text><line style="stroke: #A80036; stroke-width: 1.0;" x1="638" x2="769" y1="85.4258" y2="85.4258"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="252" x="287" y="105.0591">The NRT subscriber to be unsubscribed.</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="76" x="287" y="120.1919">Must not be</text><text fill="#000000" font-family="monospace" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="32" x="367" y="120.1919">NULL</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="4" x="399" y="120.1919">.</text><line style="stroke: #A80036; stroke-width: 1.0;" x1="281" x2="769" y1="128.2578" y2="128.2578"/><line style="stroke: #A80036; stroke-width: 1.0;" x1="281" x2="769" y1="130.2578" y2="130.2578"/><line style="stroke: #A80036; stroke-width: 1.0;" x1="281" x2="454" y1="140.8242" y2="140.8242"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="0" x="458" y="144.8247"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="45" x="458" y="144.8247">return</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="85" x="507" y="144.8247">: urt_status_t</text><line style="stroke: #A80036; stroke-width: 1.0;" x1="596" x2="769" y1="140.8242" y2="140.8242"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="49" x="287" y="160.4575">Returns</text><text fill="#000000" font-family="monospace" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="104" x="340" y="160.4575">URT_STATUS_OK</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="68" x="448" y="160.4575">on sucess.</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="49" x="287" y="175.5903">Returns</text><text fill="#000000" font-family="monospace" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="128" x="340" y="175.5903">URT_STATUS_ERROR</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="282" x="472" y="175.5903">if the subscriber is not associated to a topic.</text><ellipse cx="525" cy="213.6563" fill="#000000" filter="url(#f17b15liqbym63)" rx="10" ry="10" style="stroke: none; stroke-width: 1.0;"/><polygon fill="#FEFECE" filter="url(#f17b15liqbym63)" points="462.5,243.6563,587.5,243.6563,599.5,255.6563,587.5,267.6563,462.5,267.6563,450.5,255.6563,462.5,243.6563" style="stroke: #A80036; stroke-width: 1.5;"/><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="125" x="462.5" y="259.4644">Associated to a topic?</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="20" x="430.5" y="253.062">yes</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="14" x="599.5" y="253.062">no</text><rect fill="#FEFECE" filter="url(#f17b15liqbym63)" height="33.9688" rx="12.5" ry="12.5" style="stroke: #A80036; stroke-width: 1.5;" width="124" x="303.5" y="277.6563"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacingAndGlyphs" textLength="104" x="313.5" y="298.7949">unregister event</text><path d="M10,321.625 L10,498.0859 A0,0 0 0 0 10,498.0859 L288,498.0859 A0,0 0 0 0 288,498.0859 L288,413.8555 L308,409.8555 L288,405.8555 L288,331.625 L278,321.625 L10,321.625 A0,0 0 0 0 10,321.625 " fill="#FBFB77" filter="url(#f17b15liqbym63)" style="stroke: #A80036; stroke-width: 1.0;"/><path d="M278,321.625 L278,331.625 L288,331.625 L278,321.625 " fill="#FBFB77" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0;" x1="10" x2="78" y1="334.1914" y2="334.1914"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="134" x="82" y="338.1919">urt_basesubscriber_t</text><line style="stroke: #A80036; stroke-width: 1.0;" x1="220" x2="288" y1="334.1914" y2="334.1914"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="37" x="16" y="353.8247">topic</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="11" x="57" y="353.8247">←</text><text fill="#000000" font-family="monospace" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="32" x="72" y="353.8247">NULL</text><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="93" x="16" y="368.9575">lastMessage</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="11" x="113" y="368.9575">←</text><text fill="#000000" font-family="monospace" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="32" x="128" y="368.9575">NULL</text><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="128" x="16" y="384.0903">lastMessageTime</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="23" x="148" y="384.0903">← 0</text><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 1.0,2.0;" x1="10" x2="20.5" y1="394.7227" y2="394.7227"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="249" x="24.5" y="398.7231">URT_CFG_PUBSUB_PROFILING == true</text><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 1.0,2.0;" x1="277.5" x2="288" y1="394.7227" y2="394.7227"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="101" x="16" y="414.356">sumLatencies</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="23" x="121" y="414.356">← 0</text><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="173" x="16" y="429.4888">numMessagesReceived</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="23" x="193" y="429.4888">← 0</text><line style="stroke: #A80036; stroke-width: 1.0;" x1="10" x2="84.5" y1="440.1211" y2="440.1211"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="121" x="88.5" y="444.1216">urt_nrtsubscriber_t</text><line style="stroke: #A80036; stroke-width: 1.0;" x1="213.5" x2="288" y1="440.1211" y2="440.1211"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 1.0,2.0;" x1="10" x2="20.5" y1="455.2539" y2="455.2539"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="249" x="24.5" y="459.2544">URT_CFG_PUBSUB_PROFILING == true</text><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 1.0,2.0;" x1="277.5" x2="288" y1="455.2539" y2="455.2539"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="84" x="16" y="474.8872">minLatency</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="52" x="104" y="474.8872">← 0xF..F</text><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="88" x="16" y="490.02">maxLatency</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="23" x="108" y="490.02">← 0</text><rect fill="#FEFECE" filter="url(#f17b15liqbym63)" height="33.9688" rx="12.5" ry="12.5" style="stroke: #A80036; stroke-width: 1.5;" width="115" x="308" y="392.8711"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacingAndGlyphs" textLength="95" x="318" y="414.0098">reset members</text><path d="M152.5,516.5195 L152.5,541.6523 A0,0 0 0 0 152.5,541.6523 L334.5,541.6523 A0,0 0 0 0 334.5,541.6523 L334.5,534.5195 L354.5,529.0859 L334.5,526.5195 L334.5,526.5195 L324.5,516.5195 L152.5,516.5195 A0,0 0 0 0 152.5,516.5195 " fill="#FBFB77" filter="url(#f17b15liqbym63)" style="stroke: #A80036; stroke-width: 1.0;"/><path d="M324.5,516.5195 L324.5,526.5195 L334.5,526.5195 L324.5,516.5195 " fill="#FBFB77" style="stroke: #A80036; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="49" x="158.5" y="533.5864">Returns</text><text fill="#000000" font-family="monospace" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="104" x="211.5" y="533.5864">URT_STATUS_OK</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="4" x="315.5" y="533.5864">.</text><ellipse cx="365.5" cy="529.0859" fill="#FFFFFF" filter="url(#f17b15liqbym63)" rx="11" ry="11" style="stroke: #000000; stroke-width: 1.0;"/><ellipse cx="365.5" cy="529.0859" fill="#000000" rx="6" ry="6" style="stroke: #7F7F7F; stroke-width: 1.0;"/><path d="M447.5,277.6563 L447.5,302.7891 A0,0 0 0 0 447.5,302.7891 L653.5,302.7891 A0,0 0 0 0 653.5,302.7891 L653.5,295.6563 L673.5,290.2227 L653.5,287.6563 L653.5,287.6563 L643.5,277.6563 L447.5,277.6563 A0,0 0 0 0 447.5,277.6563 " fill="#FBFB77" filter="url(#f17b15liqbym63)" style="stroke: #A80036; stroke-width: 1.0;"/><path d="M643.5,277.6563 L643.5,287.6563 L653.5,287.6563 L643.5,277.6563 " fill="#FBFB77" style="stroke: #A80036; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="49" x="453.5" y="294.7231">Returns</text><text fill="#000000" font-family="monospace" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="128" x="506.5" y="294.7231">URT_STATUS_ERROR</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="4" x="634.5" y="294.7231">.</text><ellipse cx="684.5" cy="290.2227" fill="#FFFFFF" filter="url(#f17b15liqbym63)" rx="11" ry="11" style="stroke: #000000; stroke-width: 1.0;"/><ellipse cx="684.5" cy="290.2227" fill="#000000" rx="6" ry="6" style="stroke: #7F7F7F; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.5;" x1="525" x2="525" y1="183.6563" y2="203.6563"/><polygon fill="#A80036" points="521,193.6563,525,203.6563,529,193.6563,525,197.6563" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.5;" x1="365.5" x2="365.5" y1="311.625" y2="392.8711"/><polygon fill="#A80036" points="361.5,382.8711,365.5,392.8711,369.5,382.8711,365.5,386.8711" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.5;" x1="365.5" x2="365.5" y1="426.8398" y2="518.0859"/><polygon fill="#A80036" points="361.5,508.0859,365.5,518.0859,369.5,508.0859,365.5,512.0859" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.5;" x1="450.5" x2="365.5" y1="255.6563" y2="255.6563"/><line style="stroke: #A80036; stroke-width: 1.5;" x1="365.5" x2="365.5" y1="255.6563" y2="277.6563"/><polygon fill="#A80036" points="361.5,267.6563,365.5,277.6563,369.5,267.6563,365.5,271.6563" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.5;" x1="599.5" x2="684.5" y1="255.6563" y2="255.6563"/><line style="stroke: #A80036; stroke-width: 1.5;" x1="684.5" x2="684.5" y1="255.6563" y2="279.2227"/><polygon fill="#A80036" points="680.5,269.2227,684.5,279.2227,688.5,269.2227,684.5,273.2227" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.5;" x1="525" x2="525" y1="223.6563" y2="243.6563"/><polygon fill="#A80036" points="521,233.6563,525,243.6563,529,233.6563,525,237.6563" style="stroke: #A80036; stroke-width: 1.0;"/><!--MD5=[00216dfafa1ac0082c086d741efdd298]
2
@startuml
3

    
4
title **µRtWare**\nurtNrtSubscriberUnsubscribe()\n
5

    
6

    
7
note
8
  - - **subscriber** : urt_nrtsubscriber_t* - -
9
  The NRT subscriber to be unsubscribed.
10
  Must not be ""NULL"".
11
  ====
12
  - - **return** : urt_status_t - -
13
  Returns ""URT_STATUS_OK"" on sucess.
14
  Returns ""URT_STATUS_ERROR"" if the subscriber is not associated to a topic.
15
endnote
16

    
17

    
18
start
19
if (Associated to a topic?) then (yes)
20
  :unregister event;
21
  :reset members;
22
  note
23
    - - urt_basesubscriber_t - -
24
    **topic** ← ""NULL""
25
    **lastMessage** ← ""NULL""
26
    **lastMessageTime** ← 0
27
    .. URT_CFG_PUBSUB_PROFILING == true ..
28
    **sumLatencies** ← 0
29
    **numMessagesReceived** ← 0
30
    - - urt_nrtsubscriber_t - -
31
    .. URT_CFG_PUBSUB_PROFILING == true ..
32
    **minLatency** ← 0xF..F
33
    **maxLatency** ← 0
34
  endnote
35
  stop
36
  note
37
    Returns ""URT_STATUS_OK"".
38
  endnote
39
else (no)
40
  stop
41
  note
42
    Returns ""URT_STATUS_ERROR"".
43
  endnote
44
endif
45

    
46

    
47
@enduml
48

    
49
PlantUML version 1.2020.00(Sat Jan 11 13:30:53 CET 2020)
50
(GPL source distribution)
51
Java Runtime: OpenJDK Runtime Environment
52
JVM: OpenJDK 64-Bit Server VM
53
Java Version: 11.0.6+10-post-Ubuntu-1ubuntu118.04.1
54
Operating System: Linux
55
Default Encoding: UTF-8
56
Language: en
57
Country: US
58
--></g></svg>