This repository has been archived by the owner on Sep 26, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
/
teos.chain_monitor.html
476 lines (335 loc) · 28 KB
/
teos.chain_monitor.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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>teos.chain_monitor — pyton-teos documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="teos.cleaner" href="teos.cleaner.html" />
<link rel="prev" title="teos.carrier" href="teos.carrier.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home" alt="Documentation Home"> pyton-teos
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="teos.html">teos package</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="teos.html#subpackages">Subpackages</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="teos.html#submodules">Submodules</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="teos.api.html">teos.api</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.appointments_dbm.html">teos.appointments_dbm</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.block_processor.html">teos.block_processor</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.builder.html">teos.builder</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.carrier.html">teos.carrier</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">teos.chain_monitor</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.cleaner.html">teos.cleaner</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.extended_appointment.html">teos.extended_appointment</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.gatekeeper.html">teos.gatekeeper</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.inspector.html">teos.inspector</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.internal_api.html">teos.internal_api</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.lightning_server.html">teos.lightning_server</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.logger.html">teos.logger</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.responder.html">teos.responder</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.rpc.html">teos.rpc</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.teosd.html">teos.teosd</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.tools.html">teos.tools</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.users_dbm.html">teos.users_dbm</a></li>
<li class="toctree-l3"><a class="reference internal" href="teos.watcher.html">teos.watcher</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="common.html">common package</a></li>
<li class="toctree-l1"><a class="reference internal" href="contrib.html">contrib package</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">pyton-teos</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> »</li>
<li><a href="teos.html">teos package</a> »</li>
<li>teos.chain_monitor</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/teos.chain_monitor.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-teos.chain_monitor">
<span id="teos-chain-monitor"></span><h1>teos.chain_monitor<a class="headerlink" href="#module-teos.chain_monitor" title="Permalink to this headline">¶</a></h1>
<dl class="py class">
<dt id="teos.chain_monitor.ChainMonitor">
<em class="property">class </em><code class="sig-name descname">ChainMonitor</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">receiving_queues</span></em>, <em class="sig-param"><span class="n">block_processor</span></em>, <em class="sig-param"><span class="n">bitcoind_feed_params</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/chain_monitor.html#ChainMonitor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.chain_monitor.ChainMonitor" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>The <a class="reference internal" href="#teos.chain_monitor.ChainMonitor" title="teos.chain_monitor.ChainMonitor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ChainMonitor</span></code></a> is in charge of monitoring the blockchain (via <code class="docutils literal notranslate"><span class="pre">bitcoind</span></code>) to detect new blocks on top
of the best chain. If a new best block is spotted, the chain monitor will notify the given queues.</p>
<p>The <a class="reference internal" href="#teos.chain_monitor.ChainMonitor" title="teos.chain_monitor.ChainMonitor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ChainMonitor</span></code></a> monitors the chain using two methods: <code class="docutils literal notranslate"><span class="pre">zmq</span></code> and <code class="docutils literal notranslate"><span class="pre">polling</span></code>. Blocks are only notified
once per queue and the notification is triggered by the method that detects the block faster.</p>
<p>The <a class="reference internal" href="#teos.chain_monitor.ChainMonitor" title="teos.chain_monitor.ChainMonitor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ChainMonitor</span></code></a> lifecycle goes through 4 states: idle, listening, active and terminated.
When a <a class="reference internal" href="#teos.chain_monitor.ChainMonitor" title="teos.chain_monitor.ChainMonitor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ChainMonitor</span></code></a> instance is created, it is not yet monitoring the chain and the <code class="docutils literal notranslate"><span class="pre">status</span></code> attribute
is set to <code class="docutils literal notranslate"><span class="pre">ChainMonitorStatus.IDLE</span></code>.
Once the <code class="docutils literal notranslate"><span class="pre">monitor_chain</span></code> method is called, the chain monitor changes <code class="docutils literal notranslate"><span class="pre">status</span></code> to
<code class="docutils literal notranslate"><span class="pre">ChainMonitorStatus.LISTENING</span></code>, and starts monitoring the chain for new blocks; it does not yet notify the
receiving queues, but keeps the block hashes in the order they where spotted in an internal queue.
Once the <code class="docutils literal notranslate"><span class="pre">activate</span></code> method is called, the <code class="docutils literal notranslate"><span class="pre">status</span></code> changes to <code class="docutils literal notranslate"><span class="pre">ChainMonitorStatus.ACTIVE</span></code>, and the receiving
queues are notified in order for all the block hashes that are in the internal queue or any new one that is
detected.
Finally, once the <code class="docutils literal notranslate"><span class="pre">terminate</span></code> method is called, the <code class="docutils literal notranslate"><span class="pre">status</span></code> is changed to <code class="docutils literal notranslate"><span class="pre">ChainMonitorStatus.TERMINATED</span></code>,
the chain monitor stops monitoring the chain and no receiving queue will be notified about new blocks (including
any block that is currently in the internal queue). A final <code class="docutils literal notranslate"><span class="pre">"END"</span></code> message is sent to all the subscribers.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>receiving_queues</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code>) – a list of <code class="xref py py-obj docutils literal notranslate"><span class="pre">Queue</span></code> objects that will be notified when the chain_monitor is
active and it received new blocks hashes.</p></li>
<li><p><strong>block_processor</strong> (<a class="reference internal" href="teos.block_processor.html#teos.block_processor.BlockProcessor" title="teos.block_processor.BlockProcessor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">BlockProcessor</span></code></a>) – a <code class="xref py py-obj docutils literal notranslate"><span class="pre">BlockProcessor</span></code> instance.</p></li>
<li><p><strong>bitcoind_feed_params</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code>) – a dict with the feed (ZMQ) connection parameters.</p></li>
</ul>
</dd>
</dl>
<dl class="py attribute">
<dt id="teos.chain_monitor.ChainMonitor.logger">
<code class="sig-name descname">logger</code><a class="headerlink" href="#teos.chain_monitor.ChainMonitor.logger" title="Permalink to this definition">¶</a></dt>
<dd><p>The logger for this component.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">Logger</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="teos.chain_monitor.ChainMonitor.last_tips">
<code class="sig-name descname">last_tips</code><a class="headerlink" href="#teos.chain_monitor.ChainMonitor.last_tips" title="Permalink to this definition">¶</a></dt>
<dd><p>A list of last chain tips. Used as a sliding window to avoid notifying about old tips.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="teos.chain_monitor.ChainMonitor.check_tip">
<code class="sig-name descname">check_tip</code><a class="headerlink" href="#teos.chain_monitor.ChainMonitor.check_tip" title="Permalink to this definition">¶</a></dt>
<dd><p>An event that is triggered at fixed time intervals and controls the polling thread.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">Event</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="teos.chain_monitor.ChainMonitor.lock">
<code class="sig-name descname">lock</code><a class="headerlink" href="#teos.chain_monitor.ChainMonitor.lock" title="Permalink to this definition">¶</a></dt>
<dd><p>A lock used to protect concurrent access to the queues by the zmq and polling threads.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">Condition</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="teos.chain_monitor.ChainMonitor.zmqSubSocket">
<code class="sig-name descname">zmqSubSocket</code><a class="headerlink" href="#teos.chain_monitor.ChainMonitor.zmqSubSocket" title="Permalink to this definition">¶</a></dt>
<dd><p>A socket to connect to <code class="docutils literal notranslate"><span class="pre">bitcoind</span></code> via <code class="docutils literal notranslate"><span class="pre">zmq</span></code>.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">socket</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="teos.chain_monitor.ChainMonitor.polling_delta">
<code class="sig-name descname">polling_delta</code><a class="headerlink" href="#teos.chain_monitor.ChainMonitor.polling_delta" title="Permalink to this definition">¶</a></dt>
<dd><p>Time between polls (in seconds).</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">int</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="teos.chain_monitor.ChainMonitor.max_block_window_size">
<code class="sig-name descname">max_block_window_size</code><a class="headerlink" href="#teos.chain_monitor.ChainMonitor.max_block_window_size" title="Permalink to this definition">¶</a></dt>
<dd><p>Max size of <code class="docutils literal notranslate"><span class="pre">last_tips</span></code>.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">int</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="teos.chain_monitor.ChainMonitor.queue">
<code class="sig-name descname">queue</code><a class="headerlink" href="#teos.chain_monitor.ChainMonitor.queue" title="Permalink to this definition">¶</a></dt>
<dd><p>A queue where blocks are stored before they are processed.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">Queue</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="teos.chain_monitor.ChainMonitor.status">
<code class="sig-name descname">status</code><a class="headerlink" href="#teos.chain_monitor.ChainMonitor.status" title="Permalink to this definition">¶</a></dt>
<dd><p>The current status of the monitor, either <code class="docutils literal notranslate"><span class="pre">ChainMonitorStatus.IDLE</span></code>,
<code class="docutils literal notranslate"><span class="pre">ChainMonitorStatus.LISTENING</span></code>, <code class="docutils literal notranslate"><span class="pre">ChainMonitorStatus.ACTIVE</span></code> or <code class="docutils literal notranslate"><span class="pre">ChainMonitorStatus.TERMINATED</span></code>.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><a class="reference internal" href="#teos.chain_monitor.ChainMonitorStatus" title="teos.chain_monitor.ChainMonitorStatus"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ChainMonitorStatus</span></code></a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.chain_monitor.ChainMonitor.activate">
<code class="sig-name descname">activate</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/chain_monitor.html#ChainMonitor.activate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.chain_monitor.ChainMonitor.activate" title="Permalink to this definition">¶</a></dt>
<dd><p>Changes the <code class="docutils literal notranslate"><span class="pre">status</span></code> of the <a class="reference internal" href="#teos.chain_monitor.ChainMonitor" title="teos.chain_monitor.ChainMonitor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ChainMonitor</span></code></a> from listening to active. It creates a new thread that runs
the <code class="docutils literal notranslate"><span class="pre">notify_subscribers</span></code> method, which is in charge of notifying the receiving queue for each block hash that
is added to the internal queue.</p>
<dl class="field-list simple">
<dt class="field-odd">Raises</dt>
<dd class="field-odd"><p><strong>RuntimeError</strong> – if the <code class="docutils literal notranslate"><span class="pre">status</span></code> was not <code class="docutils literal notranslate"><span class="pre">ChainMonitor.LISTENING</span></code> when the method was called.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.chain_monitor.ChainMonitor.enqueue">
<code class="sig-name descname">enqueue</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">block_hash</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/chain_monitor.html#ChainMonitor.enqueue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.chain_monitor.ChainMonitor.enqueue" title="Permalink to this definition">¶</a></dt>
<dd><p>Adds a new block hash to the internal queue of the <a class="reference internal" href="#teos.chain_monitor.ChainMonitor" title="teos.chain_monitor.ChainMonitor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ChainMonitor</span></code></a> and the internal state. The state contains
the list of <code class="docutils literal notranslate"><span class="pre">last_tips</span></code> to prevent notifying about old blocks. <code class="docutils literal notranslate"><span class="pre">last_tips</span></code> is bounded to
<code class="docutils literal notranslate"><span class="pre">max_block_window_size</span></code>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>block_hash</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – the new best tip.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>True if the state was successfully updated, False otherwise.</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">bool</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.chain_monitor.ChainMonitor.monitor_chain">
<code class="sig-name descname">monitor_chain</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/chain_monitor.html#ChainMonitor.monitor_chain"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.chain_monitor.ChainMonitor.monitor_chain" title="Permalink to this definition">¶</a></dt>
<dd><p>Changes the <code class="docutils literal notranslate"><span class="pre">status</span></code> of the <a class="reference internal" href="#teos.chain_monitor.ChainMonitor" title="teos.chain_monitor.ChainMonitor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ChainMonitor</span></code></a> from idle to listening. It initializes the <code class="docutils literal notranslate"><span class="pre">last_tips</span></code> list
to terminate the current best tip (by querying the <a class="reference internal" href="teos.block_processor.html#teos.block_processor.BlockProcessor" title="teos.block_processor.BlockProcessor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">BlockProcessor</span></code></a>)
and creates two threads, one per each monitoring approach (<code class="docutils literal notranslate"><span class="pre">zmq</span></code> and <code class="docutils literal notranslate"><span class="pre">polling</span></code>).</p>
<dl class="field-list simple">
<dt class="field-odd">Raises</dt>
<dd class="field-odd"><p><strong>RuntimeError</strong> – if the <code class="docutils literal notranslate"><span class="pre">status</span></code> was not <code class="docutils literal notranslate"><span class="pre">ChainMonitor.IDLE</span></code> when the method was called.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.chain_monitor.ChainMonitor.monitor_chain_polling">
<code class="sig-name descname">monitor_chain_polling</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/chain_monitor.html#ChainMonitor.monitor_chain_polling"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.chain_monitor.ChainMonitor.monitor_chain_polling" title="Permalink to this definition">¶</a></dt>
<dd><p>Monitors <code class="docutils literal notranslate"><span class="pre">bitcoind</span></code> via polling. Once the method is fired, it keeps monitoring as long as the <code class="docutils literal notranslate"><span class="pre">status</span></code>
attribute is not <code class="docutils literal notranslate"><span class="pre">ChainMonitorStatus.TERMINATED</span></code>. Polling is performed once every <code class="docutils literal notranslate"><span class="pre">polling_delta</span></code> seconds.
If a new best tip is found, it is added to the internal queue.</p>
</dd></dl>
<dl class="py method">
<dt id="teos.chain_monitor.ChainMonitor.monitor_chain_zmq">
<code class="sig-name descname">monitor_chain_zmq</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/chain_monitor.html#ChainMonitor.monitor_chain_zmq"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.chain_monitor.ChainMonitor.monitor_chain_zmq" title="Permalink to this definition">¶</a></dt>
<dd><p>Monitors <code class="docutils literal notranslate"><span class="pre">bitcoind</span></code> via zmq. Once the method is fired, it keeps monitoring as long as the <code class="docutils literal notranslate"><span class="pre">status</span></code>
attribute is not <code class="docutils literal notranslate"><span class="pre">ChainMonitorStatus.TERMINATED</span></code>. If a new best tip is found, it is added to the internal
queue.</p>
</dd></dl>
<dl class="py method">
<dt id="teos.chain_monitor.ChainMonitor.notify_subscribers">
<code class="sig-name descname">notify_subscribers</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/chain_monitor.html#ChainMonitor.notify_subscribers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.chain_monitor.ChainMonitor.notify_subscribers" title="Permalink to this definition">¶</a></dt>
<dd><p>Once the method is fired, it keeps getting the elements added to the internal queue and notifies the receiving
queues about them. It terminates whenever the internal state is set to <code class="docutils literal notranslate"><span class="pre">ChainMonitorStatus.TERMINATED</span></code>.</p>
</dd></dl>
<dl class="py method">
<dt id="teos.chain_monitor.ChainMonitor.terminate">
<code class="sig-name descname">terminate</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/chain_monitor.html#ChainMonitor.terminate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.chain_monitor.ChainMonitor.terminate" title="Permalink to this definition">¶</a></dt>
<dd><p>Changes the <code class="docutils literal notranslate"><span class="pre">status</span></code> of the <a class="reference internal" href="#teos.chain_monitor.ChainMonitor" title="teos.chain_monitor.ChainMonitor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ChainMonitor</span></code></a> to terminated and sends the “END” message to the internal
queue. All the threads will stop as soon as possible.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt id="teos.chain_monitor.ChainMonitorStatus">
<em class="property">class </em><code class="sig-name descname">ChainMonitorStatus</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">value</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/chain_monitor.html#ChainMonitorStatus"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.chain_monitor.ChainMonitorStatus" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></p>
<p>An enumeration.</p>
<dl class="py attribute">
<dt id="teos.chain_monitor.ChainMonitorStatus.ACTIVE">
<code class="sig-name descname">ACTIVE</code><em class="property"> = 2</em><a class="headerlink" href="#teos.chain_monitor.ChainMonitorStatus.ACTIVE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="teos.chain_monitor.ChainMonitorStatus.IDLE">
<code class="sig-name descname">IDLE</code><em class="property"> = 0</em><a class="headerlink" href="#teos.chain_monitor.ChainMonitorStatus.IDLE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="teos.chain_monitor.ChainMonitorStatus.LISTENING">
<code class="sig-name descname">LISTENING</code><em class="property"> = 1</em><a class="headerlink" href="#teos.chain_monitor.ChainMonitorStatus.LISTENING" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt id="teos.chain_monitor.ChainMonitorStatus.TERMINATED">
<code class="sig-name descname">TERMINATED</code><em class="property"> = 3</em><a class="headerlink" href="#teos.chain_monitor.ChainMonitorStatus.TERMINATED" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="teos.cleaner.html" class="btn btn-neutral float-right" title="teos.cleaner" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="teos.carrier.html" class="btn btn-neutral float-left" title="teos.carrier" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2019, Talaia Labs
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>