Statistics
| Branch: | Revision:

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

History | View | Annotate | Download (16.885 KB)

1 ee83a495 Thomas Schöpping
<?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="614px" preserveAspectRatio="none" style="width:1105px;height:614px;" version="1.1" viewBox="0 0 1105 614" width="1105px" zoomAndPan="magnify"><defs><filter height="300%" id="fhpxeg92jwboq" 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="507" y="26.708">µRtWare</text><text fill="#000000" font-family="sans-serif" font-size="18" lengthAdjust="spacingAndGlyphs" textLength="265" x="419" y="47.6611">urtFrtSubscriberUnsubscribe()</text><text fill="#000000" font-family="sans-serif" font-size="18" lengthAdjust="spacingAndGlyphs" textLength="0" x="554.5" y="68.6143"/><path d="M605,72.8594 L605,183.6563 L1093,183.6563 L1093,82.8594 L1083,72.8594 L605,72.8594 " fill="#FBFB77" filter="url(#fhpxeg92jwboq)" style="stroke: #A80036; stroke-width: 1.0;"/><path d="M1083,72.8594 L1083,82.8594 L1093,82.8594 L1083,72.8594 " fill="#FBFB77" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0;" x1="605" x2="738" y1="85.4258" y2="85.4258"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="0" x="742" y="89.4263"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="78" x="742" y="89.4263">subscriber</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="132" x="824" y="89.4263">: urt_frtsubscriber_t*</text><line style="stroke: #A80036; stroke-width: 1.0;" x1="960" x2="1093" y1="85.4258" y2="85.4258"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="249" x="611" y="105.0591">The FRT subscriber to be unsubscribed.</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="76" x="611" y="120.1919">Must not be</text><text fill="#000000" font-family="monospace" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="32" x="691" y="120.1919">NULL</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="4" x="723" y="120.1919">.</text><line style="stroke: #A80036; stroke-width: 1.0;" x1="605" x2="1093" y1="128.2578" y2="128.2578"/><line style="stroke: #A80036; stroke-width: 1.0;" x1="605" x2="1093" y1="130.2578" y2="130.2578"/><line style="stroke: #A80036; stroke-width: 1.0;" x1="605" x2="778" y1="140.8242" y2="140.8242"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="0" x="782" y="144.8247"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="45" x="782" y="144.8247">return</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="85" x="831" y="144.8247">: urt_status_t</text><line style="stroke: #A80036; stroke-width: 1.0;" x1="920" x2="1093" y1="140.8242" y2="140.8242"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="49" x="611" y="160.4575">Returns</text><text fill="#000000" font-family="monospace" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="104" x="664" y="160.4575">URT_STATUS_OK</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="68" x="772" y="160.4575">on sucess.</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="49" x="611" y="175.5903">Returns</text><text fill="#000000" font-family="monospace" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="128" x="664" y="175.5903">URT_STATUS_ERROR</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="282" x="796" y="175.5903">if the subscriber is not associated to a topic.</text><ellipse cx="849" cy="213.6563" fill="#000000" filter="url(#fhpxeg92jwboq)" rx="10" ry="10" style="stroke: none; stroke-width: 1.0;"/><polygon fill="#FEFECE" filter="url(#fhpxeg92jwboq)" points="786.5,243.6563,911.5,243.6563,923.5,255.6563,911.5,267.6563,786.5,267.6563,774.5,255.6563,786.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="786.5" y="259.4644">Associated to a topic?</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="20" x="754.5" y="253.062">yes</text><text fill="#000000" font-family="sans-serif" font-size="11" lengthAdjust="spacingAndGlyphs" textLength="14" x="923.5" y="253.062">no</text><rect fill="#FEFECE" filter="url(#fhpxeg92jwboq)" height="33.9688" rx="12.5" ry="12.5" style="stroke: #A80036; stroke-width: 1.5;" width="124" x="627.5" y="277.6563"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacingAndGlyphs" textLength="104" x="637.5" y="298.7949">unregister event</text><path d="M10,321.625 L10,558.6172 A0,0 0 0 0 10,558.6172 L612,558.6172 A0,0 0 0 0 612,558.6172 L612,444.1211 L632,440.1211 L612,436.1211 L612,331.625 L602,321.625 L10,321.625 A0,0 0 0 0 10,321.625 " fill="#FBFB77" filter="url(#fhpxeg92jwboq)" style="stroke: #A80036; stroke-width: 1.0;"/><path d="M602,321.625 L602,331.625 L612,331.625 L602,321.625 " fill="#FBFB77" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0;" x1="10" x2="240" y1="334.1914" y2="334.1914"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="134" x="244" y="338.1919">urt_basesubscriber_t</text><line style="stroke: #A80036; stroke-width: 1.0;" x1="382" x2="612" 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="182.5" y1="394.7227" y2="394.7227"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="249" x="186.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="439.5" x2="612" 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="248.5" y1="440.1211" y2="440.1211"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="117" x="252.5" y="444.1216">urt_frtsubscriber_t</text><line style="stroke: #A80036; stroke-width: 1.0;" x1="373.5" x2="612" y1="440.1211" y2="440.1211"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 1.0,2.0;" x1="10" x2="138.5" y1="455.2539" y2="455.2539"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="337" x="142.5" y="459.2544">URT_CFG_PUBSUB_QOS_DEADLINECHECKS == true</text><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 1.0,2.0;" x1="483.5" x2="612" y1="455.2539" y2="455.2539"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="110" x="16" y="474.8872">deadlineOffset</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="23" x="130" y="474.8872">← 0</text><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 1.0,2.0;" x1="10" x2="153" y1="485.5195" y2="485.5195"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="308" x="157" y="489.52">URT_CFG_PUBSUB_QOS_JITTERCHECKS == true</text><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 1.0,2.0;" x1="469" x2="612" y1="485.5195" y2="485.5195"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="66" x="16" y="505.1528">maxJitter</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="23" x="86" y="505.1528">← 0</text><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 1.0,2.0;" x1="10" x2="20.5" y1="515.7852" y2="515.7852"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="573" x="24.5" y="519.7856">URT_CFG_PUBSUB_QOS_JITTERCHECKS == true || URT_CFG_PUBSUB_PROFILING == true</text><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 1.0,2.0;" x1="601.5" x2="612" y1="515.7852" y2="515.7852"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="84" x="16" y="535.4185">minLatency</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="52" x="104" y="535.4185">← 0xF..F</text><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="88" x="16" y="550.5513">maxLatency</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="23" x="108" y="550.5513">← 0</text><rect fill="#FEFECE" filter="url(#fhpxeg92jwboq)" height="33.9688" rx="12.5" ry="12.5" style="stroke: #A80036; stroke-width: 1.5;" width="115" x="632" y="423.1367"/><text fill="#000000" font-family="sans-serif" font-size="12" lengthAdjust="spacingAndGlyphs" textLength="95" x="642" y="444.2754">reset members</text><path d="M476.5,577.0508 L476.5,602.1836 A0,0 0 0 0 476.5,602.1836 L658.5,602.1836 A0,0 0 0 0 658.5,602.1836 L658.5,595.0508 L678.5,589.6172 L658.5,587.0508 L658.5,587.0508 L648.5,577.0508 L476.5,577.0508 A0,0 0 0 0 476.5,577.0508 " fill="#FBFB77" filter="url(#fhpxeg92jwboq)" style="stroke: #A80036; stroke-width: 1.0;"/><path d="M648.5,577.0508 L648.5,587.0508 L658.5,587.0508 L648.5,577.0508 " fill="#FBFB77" style="stroke: #A80036; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="49" x="482.5" y="594.1177">Returns</text><text fill="#000000" font-family="monospace" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="104" x="535.5" y="594.1177">URT_STATUS_OK</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="4" x="639.5" y="594.1177">.</text><ellipse cx="689.5" cy="589.6172" fill="#FFFFFF" filter="url(#fhpxeg92jwboq)" rx="11" ry="11" style="stroke: #000000; stroke-width: 1.0;"/><ellipse cx="689.5" cy="589.6172" fill="#000000" rx="6" ry="6" style="stroke: #7F7F7F; stroke-width: 1.0;"/><path d="M771.5,277.6563 L771.5,302.7891 A0,0 0 0 0 771.5,302.7891 L977.5,302.7891 A0,0 0 0 0 977.5,302.7891 L977.5,295.6563 L997.5,290.2227 L977.5,287.6563 L977.5,287.6563 L967.5,277.6563 L771.5,277.6563 A0,0 0 0 0 771.5,277.6563 " fill="#FBFB77" filter="url(#fhpxeg92jwboq)" style="stroke: #A80036; stroke-width: 1.0;"/><path d="M967.5,277.6563 L967.5,287.6563 L977.5,287.6563 L967.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="777.5" y="294.7231">Returns</text><text fill="#000000" font-family="monospace" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="128" x="830.5" y="294.7231">URT_STATUS_ERROR</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="4" x="958.5" y="294.7231">.</text><ellipse cx="1008.5" cy="290.2227" fill="#FFFFFF" filter="url(#fhpxeg92jwboq)" rx="11" ry="11" style="stroke: #000000; stroke-width: 1.0;"/><ellipse cx="1008.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="849" x2="849" y1="183.6563" y2="203.6563"/><polygon fill="#A80036" points="845,193.6563,849,203.6563,853,193.6563,849,197.6563" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.5;" x1="689.5" x2="689.5" y1="311.625" y2="423.1367"/><polygon fill="#A80036" points="685.5,413.1367,689.5,423.1367,693.5,413.1367,689.5,417.1367" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.5;" x1="689.5" x2="689.5" y1="457.1055" y2="578.6172"/><polygon fill="#A80036" points="685.5,568.6172,689.5,578.6172,693.5,568.6172,689.5,572.6172" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.5;" x1="774.5" x2="689.5" y1="255.6563" y2="255.6563"/><line style="stroke: #A80036; stroke-width: 1.5;" x1="689.5" x2="689.5" y1="255.6563" y2="277.6563"/><polygon fill="#A80036" points="685.5,267.6563,689.5,277.6563,693.5,267.6563,689.5,271.6563" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.5;" x1="923.5" x2="1008.5" y1="255.6563" y2="255.6563"/><line style="stroke: #A80036; stroke-width: 1.5;" x1="1008.5" x2="1008.5" y1="255.6563" y2="279.2227"/><polygon fill="#A80036" points="1004.5,269.2227,1008.5,279.2227,1012.5,269.2227,1008.5,273.2227" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.5;" x1="849" x2="849" y1="223.6563" y2="243.6563"/><polygon fill="#A80036" points="845,233.6563,849,243.6563,853,233.6563,849,237.6563" style="stroke: #A80036; stroke-width: 1.0;"/><!--MD5=[7f51ce052709f97e2cd9b849f6a8caff]
2
@startuml
3
4
title **µRtWare**\nurtFrtSubscriberUnsubscribe()\n
5
6
7
note
8
  - - **subscriber** : urt_frtsubscriber_t* - -
9
  The FRT 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_frtsubscriber_t - -
31
    .. URT_CFG_PUBSUB_QOS_DEADLINECHECKS == true ..
32
    **deadlineOffset** ← 0
33
    .. URT_CFG_PUBSUB_QOS_JITTERCHECKS == true ..
34
    **maxJitter** ← 0
35
    .. URT_CFG_PUBSUB_QOS_JITTERCHECKS == true || URT_CFG_PUBSUB_PROFILING == true ..
36
    **minLatency** ← 0xF..F
37
    **maxLatency** ← 0
38
  endnote
39
  stop
40
  note
41
    Returns ""URT_STATUS_OK"".
42
  endnote
43
else (no)
44
  stop
45
  note
46
    Returns ""URT_STATUS_ERROR"".
47
  endnote
48
endif
49
50
51
@enduml
52
53
PlantUML version 1.2020.00(Sat Jan 11 13:30:53 CET 2020)
54
(GPL source distribution)
55
Java Runtime: OpenJDK Runtime Environment
56
JVM: OpenJDK 64-Bit Server VM
57
Java Version: 11.0.6+10-post-Ubuntu-1ubuntu118.04.1
58
Operating System: Linux
59
Default Encoding: UTF-8
60
Language: en
61
Country: US
62
--></g></svg>