This repository was archived by the owner on Dec 5, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathactiveobserver_8h_source.html
140 lines (138 loc) · 17.3 KB
/
activeobserver_8h_source.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>swift: src/blackmisc/sharedstate/activeobserver.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">swift
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_9687d2aaac47be79d7525830e55feee8.html">blackmisc</a></li><li class="navelem"><a class="el" href="dir_f25614b65941ee0dadcd64e0ff9e808e.html">sharedstate</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">activeobserver.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="activeobserver_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// SPDX-FileCopyrightText: Copyright (C) 2017 swift Project Community / Contributors</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  </div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>  </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#ifndef BLACKMISC_SHAREDSTATE_ACTIVEOBSERVER_H</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#define BLACKMISC_SHAREDSTATE_ACTIVEOBSERVER_H</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>  </div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include "<a class="code" href="passiveobserver_8h.html">blackmisc/sharedstate/passiveobserver.h</a>"</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include "<a class="code" href="promise_8h.html">blackmisc/promise.h</a>"</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include "<a class="code" href="variant_8h.html">blackmisc/variant.h</a>"</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include "<a class="code" href="blackmiscexport_8h.html">blackmisc/blackmiscexport.h</a>"</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <QObject></span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <QSharedPointer></span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  </div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="keyword">namespace </span><a class="code" href="namespace_black_misc_1_1_shared_state.html">BlackMisc::SharedState</a></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> {</div>
<div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="class_black_misc_1_1_shared_state_1_1_c_active_observer.html"> 22</a></span>  <span class="keyword">class </span><a class="code" href="blackmiscexport_8h.html#aa81de5cca8395747bb5765234e28525a">BLACKMISC_EXPORT</a> <a class="code" href="class_black_misc_1_1_shared_state_1_1_c_active_observer.html">CActiveObserver</a> final : <span class="keyword">public</span> <a class="code" href="class_black_misc_1_1_shared_state_1_1_c_passive_observer.html">CPassiveObserver</a></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  {</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  Q_OBJECT</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="keyword">friend</span> <a class="codeRef" href="http://doc.qt.io/qt-5/qsharedpointer.html">QSharedPointer<CActiveObserver></a>;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> T, <span class="keyword">typename</span> F></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <a class="code" href="class_black_misc_1_1_shared_state_1_1_c_active_observer.html">CActiveObserver</a>(T *parent, F eventHandler) : <a class="code" href="class_black_misc_1_1_shared_state_1_1_c_passive_observer.html">CPassiveObserver</a>(parent, eventHandler)</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  {}</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  </div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> T, <span class="keyword">typename</span> F></div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="class_black_misc_1_1_shared_state_1_1_c_active_observer.html#a1a6b31fc4989fb6fea9372503861b600"> 34</a></span>  <span class="keyword">static</span> <span class="keyword">auto</span> <a class="code" href="class_black_misc_1_1_shared_state_1_1_c_active_observer.html#a1a6b31fc4989fb6fea9372503861b600">create</a>(T *parent, F eventHandler)</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  {</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keywordflow">return</span> <a class="codeRef" href="http://doc.qt.io/qt-5/qsharedpointer.html#create">QSharedPointer<CActiveObserver>::create</a>(parent, eventHandler);</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  }</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <a class="code" href="class_black_misc_1_1_c_variant.html">CVariant</a> request(<span class="keyword">const</span> <a class="code" href="class_black_misc_1_1_c_variant.html">CVariant</a> &param);</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keywordtype">void</span> requestAsync(<span class="keyword">const</span> <a class="code" href="class_black_misc_1_1_c_variant.html">CVariant</a> &param, std::function<<span class="keywordtype">void</span>(<span class="keyword">const</span> <a class="code" href="class_black_misc_1_1_c_variant.html">CVariant</a> &)> callback);</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  </div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="class_black_misc_1_1_shared_state_1_1_c_active_observer.html#add0a348f276d5423b5fdd1f5fc003873"> 47</a></span>  <a class="codeRef" href="http://doc.qt.io/qt-5/qweakpointer.html">QWeakPointer<const CActiveObserver></a> <a class="code" href="class_black_misc_1_1_shared_state_1_1_c_active_observer.html#add0a348f276d5423b5fdd1f5fc003873">weakRef</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> qSharedPointerCast<const CActiveObserver>(<a class="code" href="class_black_misc_1_1_shared_state_1_1_c_passive_observer.html#abc0caee694a33c5eb42902780f78ec4a">CPassiveObserver::weakRef</a>()); }</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  signals:</div>
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="class_black_misc_1_1_shared_state_1_1_c_active_observer.html#a84318a9903bbc77be87fe1b63e9d9cac"> 51</a></span>  <span class="keywordtype">void</span> <a class="code" href="class_black_misc_1_1_shared_state_1_1_c_active_observer.html#a84318a9903bbc77be87fe1b63e9d9cac">requestPosted</a>(<span class="keyword">const</span> <a class="code" href="class_black_misc_1_1_c_variant.html">BlackMisc::CVariant</a> &param, <a class="code" href="class_black_misc_1_1_c_promise.html">BlackMisc::CPromise<BlackMisc::CVariant></a> o_reply);</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  };</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> }</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor">#endif</span></div>
<div class="ttc" id="ablackmiscexport_8h_html"><div class="ttname"><a href="blackmiscexport_8h.html">blackmiscexport.h</a></div></div>
<div class="ttc" id="ablackmiscexport_8h_html_aa81de5cca8395747bb5765234e28525a"><div class="ttname"><a href="blackmiscexport_8h.html#aa81de5cca8395747bb5765234e28525a">BLACKMISC_EXPORT</a></div><div class="ttdeci">#define BLACKMISC_EXPORT</div><div class="ttdoc">Export a class or function from the library.</div><div class="ttdef"><b>Definition:</b> <a href="blackmiscexport_8h_source.html#l00019">blackmiscexport.h:19</a></div></div>
<div class="ttc" id="aclass_black_misc_1_1_c_promise_html"><div class="ttname"><a href="class_black_misc_1_1_c_promise.html">BlackMisc::CPromise</a></div><div class="ttdoc">A promise-based interface to QFuture, similar to std::promise for std::future.</div><div class="ttdef"><b>Definition:</b> <a href="promise_8h_source.html#l00075">promise.h:76</a></div></div>
<div class="ttc" id="aclass_black_misc_1_1_c_variant_html"><div class="ttname"><a href="class_black_misc_1_1_c_variant.html">BlackMisc::CVariant</a></div><div class="ttdoc">Wrapper around QVariant which provides transparent access to CValueObject methods of the contained ob...</div><div class="ttdef"><b>Definition:</b> <a href="variant_8h_source.html#l00056">variant.h:63</a></div></div>
<div class="ttc" id="aclass_black_misc_1_1_shared_state_1_1_c_active_observer_html"><div class="ttname"><a href="class_black_misc_1_1_shared_state_1_1_c_active_observer.html">BlackMisc::SharedState::CActiveObserver</a></div><div class="ttdoc">Extends CPassiveObserver with the ability to send requests and receive replies.</div><div class="ttdef"><b>Definition:</b> <a href="activeobserver_8h_source.html#l00022">activeobserver.h:23</a></div></div>
<div class="ttc" id="aclass_black_misc_1_1_shared_state_1_1_c_active_observer_html_a1a6b31fc4989fb6fea9372503861b600"><div class="ttname"><a href="class_black_misc_1_1_shared_state_1_1_c_active_observer.html#a1a6b31fc4989fb6fea9372503861b600">BlackMisc::SharedState::CActiveObserver::create</a></div><div class="ttdeci">static auto create(T *parent, F eventHandler)</div><div class="ttdoc">Factory method.</div><div class="ttdef"><b>Definition:</b> <a href="activeobserver_8h_source.html#l00034">activeobserver.h:34</a></div></div>
<div class="ttc" id="aclass_black_misc_1_1_shared_state_1_1_c_active_observer_html_a84318a9903bbc77be87fe1b63e9d9cac"><div class="ttname"><a href="class_black_misc_1_1_shared_state_1_1_c_active_observer.html#a84318a9903bbc77be87fe1b63e9d9cac">BlackMisc::SharedState::CActiveObserver::requestPosted</a></div><div class="ttdeci">void requestPosted(const BlackMisc::CVariant &param, BlackMisc::CPromise< BlackMisc::CVariant > o_reply)</div><div class="ttdoc">Emitted by request and requestAsync.</div></div>
<div class="ttc" id="aclass_black_misc_1_1_shared_state_1_1_c_active_observer_html_add0a348f276d5423b5fdd1f5fc003873"><div class="ttname"><a href="class_black_misc_1_1_shared_state_1_1_c_active_observer.html#add0a348f276d5423b5fdd1f5fc003873">BlackMisc::SharedState::CActiveObserver::weakRef</a></div><div class="ttdeci">QWeakPointer< const CActiveObserver > weakRef() const</div><div class="ttdoc">Get a QWeakPointer pointing to this object.</div><div class="ttdef"><b>Definition:</b> <a href="activeobserver_8h_source.html#l00047">activeobserver.h:47</a></div></div>
<div class="ttc" id="aclass_black_misc_1_1_shared_state_1_1_c_passive_observer_html"><div class="ttname"><a href="class_black_misc_1_1_shared_state_1_1_c_passive_observer.html">BlackMisc::SharedState::CPassiveObserver</a></div><div class="ttdoc">Endpoint which can subscribe to events emitted by CPassiveMutator.</div><div class="ttdef"><b>Definition:</b> <a href="passiveobserver_8h_source.html#l00026">passiveobserver.h:27</a></div></div>
<div class="ttc" id="aclass_black_misc_1_1_shared_state_1_1_c_passive_observer_html_abc0caee694a33c5eb42902780f78ec4a"><div class="ttname"><a href="class_black_misc_1_1_shared_state_1_1_c_passive_observer.html#abc0caee694a33c5eb42902780f78ec4a">BlackMisc::SharedState::CPassiveObserver::weakRef</a></div><div class="ttdeci">QWeakPointer< const CPassiveObserver > weakRef() const</div><div class="ttdoc">Get a QWeakPointer pointing to this object.</div><div class="ttdef"><b>Definition:</b> <a href="passiveobserver_8h_source.html#l00055">passiveobserver.h:55</a></div></div>
<div class="ttc" id="anamespace_black_misc_1_1_shared_state_html"><div class="ttname"><a href="namespace_black_misc_1_1_shared_state.html">BlackMisc::SharedState</a></div><div class="ttdoc">Utilities for sharing state between multiple objects.</div><div class="ttdef"><b>Definition:</b> <a href="application_8h_source.html#l00050">application.h:51</a></div></div>
<div class="ttc" id="apassiveobserver_8h_html"><div class="ttname"><a href="passiveobserver_8h.html">passiveobserver.h</a></div></div>
<div class="ttc" id="apromise_8h_html"><div class="ttname"><a href="promise_8h.html">promise.h</a></div></div>
<div class="ttc" id="aqsharedpointer_html"><div class="ttname"><a href="http://doc.qt.io/qt-5/qsharedpointer.html">QSharedPointer</a></div></div>
<div class="ttc" id="aqsharedpointer_html_create"><div class="ttname"><a href="http://doc.qt.io/qt-5/qsharedpointer.html#create">QSharedPointer::create</a></div><div class="ttdeci">QSharedPointer< T > create(Args &&... args)</div></div>
<div class="ttc" id="aqweakpointer_html"><div class="ttname"><a href="http://doc.qt.io/qt-5/qweakpointer.html">QWeakPointer</a></div></div>
<div class="ttc" id="avariant_8h_html"><div class="ttname"><a href="variant_8h.html">variant.h</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Dec 3 2023 18:38:40 for swift by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>