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.appointments_dbm.html
690 lines (544 loc) · 45.6 KB
/
teos.appointments_dbm.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
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
<!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.appointments_dbm — 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.block_processor" href="teos.block_processor.html" />
<link rel="prev" title="teos.api" href="teos.api.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 current"><a class="current reference internal" href="#">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"><a class="reference internal" href="teos.chain_monitor.html">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.appointments_dbm</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/teos.appointments_dbm.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.appointments_dbm">
<span id="teos-appointments-dbm"></span><h1>teos.appointments_dbm<a class="headerlink" href="#module-teos.appointments_dbm" title="Permalink to this headline">¶</a></h1>
<dl class="py class">
<dt id="teos.appointments_dbm.AppointmentsDBM">
<em class="property">class </em><code class="sig-name descname">AppointmentsDBM</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">db_path</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/appointments_dbm.html#AppointmentsDBM"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.appointments_dbm.AppointmentsDBM" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="common.db_manager.html#common.db_manager.DBManager" title="common.db_manager.DBManager"><code class="xref py py-class docutils literal notranslate"><span class="pre">common.db_manager.DBManager</span></code></a></p>
<p>The <a class="reference internal" href="#teos.appointments_dbm.AppointmentsDBM" title="teos.appointments_dbm.AppointmentsDBM"><code class="xref py py-class docutils literal notranslate"><span class="pre">AppointmentsDBM</span></code></a> is in charge of interacting with the appointments database (<code class="docutils literal notranslate"><span class="pre">LevelDB</span></code>).
Keys and values are stored as bytes in the database but processed as strings by the manager.</p>
<p>The database is split in six prefixes:</p>
<blockquote>
<div><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">WATCHER_PREFIX</span></code>, defined as <code class="docutils literal notranslate"><span class="pre">b'w</span></code>, is used to store <a class="reference internal" href="teos.watcher.html#teos.watcher.Watcher" title="teos.watcher.Watcher"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Watcher</span></code></a> appointments.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">RESPONDER_PREFIX</span></code>, defines as <code class="docutils literal notranslate"><span class="pre">b'r</span></code>, is used to store <a class="reference internal" href="teos.responder.html#teos.responder.Responder" title="teos.responder.Responder"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Responder</span></code></a> trackers.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">WATCHER_LAST_BLOCK_KEY</span></code>, defined as <code class="docutils literal notranslate"><span class="pre">b'bw</span></code>, is used to store the last block hash known by the <a class="reference internal" href="teos.watcher.html#teos.watcher.Watcher" title="teos.watcher.Watcher"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Watcher</span></code></a>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">RESPONDER_LAST_BLOCK_KEY</span></code>, defined as <code class="docutils literal notranslate"><span class="pre">b'br</span></code>, is used to store the last block hash known by the <a class="reference internal" href="teos.responder.html#teos.responder.Responder" title="teos.responder.Responder"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Responder</span></code></a>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">LOCATOR_MAP_PREFIX</span></code>, defined as <code class="docutils literal notranslate"><span class="pre">b'm</span></code>, is used to store the <code class="docutils literal notranslate"><span class="pre">locator:uuid</span></code> maps.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">TRIGGERED_APPOINTMENTS_PREFIX</span></code>, defined as <code class="docutils literal notranslate"><span class="pre">b'ta</span></code>, is used to stored triggered appointments (appointments that have been handed to the <a class="reference internal" href="teos.responder.html#teos.responder.Responder" title="teos.responder.Responder"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Responder</span></code></a>.)</p></li>
</ul>
</div></blockquote>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>db_path</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – the path (relative or absolute) to the system folder containing the database. A fresh
database will be created if the specified path does not contain one.</p>
</dd>
</dl>
<dl class="py attribute">
<dt id="teos.appointments_dbm.AppointmentsDBM.logger">
<code class="sig-name descname">logger</code><a class="headerlink" href="#teos.appointments_dbm.AppointmentsDBM.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="field-list simple">
<dt class="field-odd">Raises</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ValueError</strong> – If the provided <code class="docutils literal notranslate"><span class="pre">db_path</span></code> is not a string.</p></li>
<li><p><strong>plyvel.Error</strong> – If the db is currently unavailable (being used by another process).</p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt id="teos.appointments_dbm.AppointmentsDBM.batch_create_triggered_appointment_flag">
<code class="sig-name descname">batch_create_triggered_appointment_flag</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">uuids</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/appointments_dbm.html#AppointmentsDBM.batch_create_triggered_appointment_flag"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.appointments_dbm.AppointmentsDBM.batch_create_triggered_appointment_flag" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a flag that signals that an appointment has been triggered for every appointment in the given list.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>uuids</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code>) – a list of identifiers for the appointments to flag.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.appointments_dbm.AppointmentsDBM.batch_delete_responder_trackers">
<code class="sig-name descname">batch_delete_responder_trackers</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">uuids</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/appointments_dbm.html#AppointmentsDBM.batch_delete_responder_trackers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.appointments_dbm.AppointmentsDBM.batch_delete_responder_trackers" title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes multiple trackers from the database.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>uuids</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code>) – a list of 16-byte hex-encoded strings identifying the trackers to be deleted.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.appointments_dbm.AppointmentsDBM.batch_delete_triggered_appointment_flag">
<code class="sig-name descname">batch_delete_triggered_appointment_flag</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">uuids</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/appointments_dbm.html#AppointmentsDBM.batch_delete_triggered_appointment_flag"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.appointments_dbm.AppointmentsDBM.batch_delete_triggered_appointment_flag" title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes a list of flag signaling that some appointment have been triggered.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>uuids</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code>) – the identifier of the flag to be removed.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.appointments_dbm.AppointmentsDBM.batch_delete_watcher_appointments">
<code class="sig-name descname">batch_delete_watcher_appointments</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">uuids</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/appointments_dbm.html#AppointmentsDBM.batch_delete_watcher_appointments"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.appointments_dbm.AppointmentsDBM.batch_delete_watcher_appointments" title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes multiple appointments from the database.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>uuids</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code>) – a list of 16-byte hex-encoded strings identifying the appointments to be deleted.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.appointments_dbm.AppointmentsDBM.create_append_locator_map">
<code class="sig-name descname">create_append_locator_map</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">locator</span></em>, <em class="sig-param"><span class="n">uuid</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/appointments_dbm.html#AppointmentsDBM.create_append_locator_map"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.appointments_dbm.AppointmentsDBM.create_append_locator_map" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a <code class="docutils literal notranslate"><span class="pre">locator:uuid</span></code> map.</p>
<p>If the map already exists, the new <code class="docutils literal notranslate"><span class="pre">uuid</span></code> is appended to the existing ones (if it is not already there).</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>locator</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – a 16-byte hex-encoded string used as the key of the map.</p></li>
<li><p><strong>uuid</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – a 16-byte hex-encoded unique id to create (or add to) the map.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.appointments_dbm.AppointmentsDBM.create_triggered_appointment_flag">
<code class="sig-name descname">create_triggered_appointment_flag</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">uuid</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/appointments_dbm.html#AppointmentsDBM.create_triggered_appointment_flag"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.appointments_dbm.AppointmentsDBM.create_triggered_appointment_flag" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a flag that signals that an appointment has been triggered.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>uuid</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – the identifier of the flag to be created.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.appointments_dbm.AppointmentsDBM.delete_locator_map">
<code class="sig-name descname">delete_locator_map</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">locator</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/appointments_dbm.html#AppointmentsDBM.delete_locator_map"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.appointments_dbm.AppointmentsDBM.delete_locator_map" title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes a <code class="docutils literal notranslate"><span class="pre">locator:uuid</span></code> map.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>locator</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – a 16-byte hex-encoded string identifying the map to delete.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>True if the locator map was deleted from the database or it was non-existent, 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.appointments_dbm.AppointmentsDBM.delete_responder_tracker">
<code class="sig-name descname">delete_responder_tracker</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">uuid</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/appointments_dbm.html#AppointmentsDBM.delete_responder_tracker"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.appointments_dbm.AppointmentsDBM.delete_responder_tracker" title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes a tracker from the database.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>uuid</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – a 16-byte hex-encoded string identifying the tracker to be deleted.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>True if the tracker was deleted from the database or it was non-existent, 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.appointments_dbm.AppointmentsDBM.delete_triggered_appointment_flag">
<code class="sig-name descname">delete_triggered_appointment_flag</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">uuid</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/appointments_dbm.html#AppointmentsDBM.delete_triggered_appointment_flag"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.appointments_dbm.AppointmentsDBM.delete_triggered_appointment_flag" title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes a flag that signals that an appointment has been triggered.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>uuid</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – the identifier of the flag to be removed.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>True if the flag was deleted from the database or it was non-existent, 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.appointments_dbm.AppointmentsDBM.delete_watcher_appointment">
<code class="sig-name descname">delete_watcher_appointment</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">uuid</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/appointments_dbm.html#AppointmentsDBM.delete_watcher_appointment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.appointments_dbm.AppointmentsDBM.delete_watcher_appointment" title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes an appointment from the database.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>uuid</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – a 16-byte hex-encoded string identifying the appointment to be deleted.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>True if the appointment was deleted from the database or it was non-existent, 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.appointments_dbm.AppointmentsDBM.get_last_known_block">
<code class="sig-name descname">get_last_known_block</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">key</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/appointments_dbm.html#AppointmentsDBM.get_last_known_block"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.appointments_dbm.AppointmentsDBM.get_last_known_block" title="Permalink to this definition">¶</a></dt>
<dd><p>Loads the last known block given a key.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>key</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – the identifier of the db to look into (either <code class="docutils literal notranslate"><span class="pre">WATCHER_LAST_BLOCK_KEY</span></code> or
<code class="docutils literal notranslate"><span class="pre">RESPONDER_LAST_BLOCK_KEY</span></code>).</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><p>A 32-byte hex-encoded str representing the last known block hash.</p>
<p>Returns <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code> if the entry is not found.</p>
</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">str</span></code> or <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.appointments_dbm.AppointmentsDBM.load_all_triggered_flags">
<code class="sig-name descname">load_all_triggered_flags</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/appointments_dbm.html#AppointmentsDBM.load_all_triggered_flags"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.appointments_dbm.AppointmentsDBM.load_all_triggered_flags" title="Permalink to this definition">¶</a></dt>
<dd><p>Loads all the appointment triggered flags from the database.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>a list of all the uuids of the triggered appointments.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.appointments_dbm.AppointmentsDBM.load_appointments_db">
<code class="sig-name descname">load_appointments_db</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">prefix</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/appointments_dbm.html#AppointmentsDBM.load_appointments_db"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.appointments_dbm.AppointmentsDBM.load_appointments_db" title="Permalink to this definition">¶</a></dt>
<dd><p>Loads all data from the appointments database given a prefix. Two prefixes are defined: <code class="docutils literal notranslate"><span class="pre">WATCHER_PREFIX</span></code> and
<code class="docutils literal notranslate"><span class="pre">RESPONDER_PREFIX</span></code>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>prefix</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – the prefix of the data to load.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><p>A dictionary containing the requested data (appointments or trackers) indexed by <code class="docutils literal notranslate"><span class="pre">uuid</span></code>.</p>
<p>Returns an empty dictionary if no data is found.</p>
</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">dict</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.appointments_dbm.AppointmentsDBM.load_last_block_hash_responder">
<code class="sig-name descname">load_last_block_hash_responder</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/appointments_dbm.html#AppointmentsDBM.load_last_block_hash_responder"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.appointments_dbm.AppointmentsDBM.load_last_block_hash_responder" title="Permalink to this definition">¶</a></dt>
<dd><p>Loads the last known block hash of the <a class="reference internal" href="teos.responder.html#teos.responder.Responder" title="teos.responder.Responder"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Responder</span></code></a> from the database.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p><p>A 32-byte hex-encoded string representing the last known block hash if found.</p>
<p>Returns <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code> otherwise.</p>
</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code> or <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.appointments_dbm.AppointmentsDBM.load_last_block_hash_watcher">
<code class="sig-name descname">load_last_block_hash_watcher</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/appointments_dbm.html#AppointmentsDBM.load_last_block_hash_watcher"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.appointments_dbm.AppointmentsDBM.load_last_block_hash_watcher" title="Permalink to this definition">¶</a></dt>
<dd><p>Loads the last known block hash of the <a class="reference internal" href="teos.watcher.html#teos.watcher.Watcher" title="teos.watcher.Watcher"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Watcher</span></code></a> from the database.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p><p>A 32-byte hex-encoded string representing the last known block hash if found.</p>
<p>Returns <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code> otherwise.</p>
</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code> or <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.appointments_dbm.AppointmentsDBM.load_locator_map">
<code class="sig-name descname">load_locator_map</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">locator</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/appointments_dbm.html#AppointmentsDBM.load_locator_map"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.appointments_dbm.AppointmentsDBM.load_locator_map" title="Permalink to this definition">¶</a></dt>
<dd><p>Loads the <code class="docutils literal notranslate"><span class="pre">locator:uuid</span></code> map of a given <code class="docutils literal notranslate"><span class="pre">locator</span></code> from the database.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>locator</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – a 16-byte hex-encoded string representing the appointment locator.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><p>The requested <code class="docutils literal notranslate"><span class="pre">locator:uuid</span></code> map if found.</p>
<p>Returns <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code> otherwise.</p>
</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">dict</span></code> or <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.appointments_dbm.AppointmentsDBM.load_responder_tracker">
<code class="sig-name descname">load_responder_tracker</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">uuid</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/appointments_dbm.html#AppointmentsDBM.load_responder_tracker"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.appointments_dbm.AppointmentsDBM.load_responder_tracker" title="Permalink to this definition">¶</a></dt>
<dd><p>Loads a tracker from the database using <code class="docutils literal notranslate"><span class="pre">RESPONDER_PREFIX</span></code> as a prefix to the given <code class="docutils literal notranslate"><span class="pre">uuid</span></code>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>uuid</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – the tracker’s unique identifier.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><p>A dictionary containing the tracker data if they <code class="docutils literal notranslate"><span class="pre">key</span></code> is found.</p>
<p>Returns <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code> otherwise.</p>
</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">dict</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.appointments_dbm.AppointmentsDBM.load_responder_trackers">
<code class="sig-name descname">load_responder_trackers</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/appointments_dbm.html#AppointmentsDBM.load_responder_trackers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.appointments_dbm.AppointmentsDBM.load_responder_trackers" title="Permalink to this definition">¶</a></dt>
<dd><p>Loads all the trackers from the database (all entries with the <code class="docutils literal notranslate"><span class="pre">RESPONDER_PREFIX</span></code> prefix).</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>A dictionary with all the trackers stored in the database. An empty dictionary if there are
none.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.appointments_dbm.AppointmentsDBM.load_watcher_appointment">
<code class="sig-name descname">load_watcher_appointment</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">uuid</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/appointments_dbm.html#AppointmentsDBM.load_watcher_appointment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.appointments_dbm.AppointmentsDBM.load_watcher_appointment" title="Permalink to this definition">¶</a></dt>
<dd><p>Loads an appointment from the database using <code class="docutils literal notranslate"><span class="pre">WATCHER_PREFIX</span></code> as prefix to the given <code class="docutils literal notranslate"><span class="pre">uuid</span></code>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>uuid</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – the appointment’s unique identifier.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p><p>A dictionary containing the appointment data if they <code class="docutils literal notranslate"><span class="pre">key</span></code> is found.</p>
<p>Returns <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code> otherwise.</p>
</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">dict</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.appointments_dbm.AppointmentsDBM.load_watcher_appointments">
<code class="sig-name descname">load_watcher_appointments</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">include_triggered</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/appointments_dbm.html#AppointmentsDBM.load_watcher_appointments"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.appointments_dbm.AppointmentsDBM.load_watcher_appointments" title="Permalink to this definition">¶</a></dt>
<dd><p>Loads all the appointments from the database (all entries with the <code class="docutils literal notranslate"><span class="pre">WATCHER_PREFIX</span></code> prefix).</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>include_triggered</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">bool</span></code>) – whether to include the appointments flagged as triggered or not. False
by default.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A dictionary with all the appointments stored in the database. An empty dictionary if there
are none.</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">dict</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.appointments_dbm.AppointmentsDBM.store_last_block_hash_responder">
<code class="sig-name descname">store_last_block_hash_responder</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/appointments_dbm.html#AppointmentsDBM.store_last_block_hash_responder"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.appointments_dbm.AppointmentsDBM.store_last_block_hash_responder" title="Permalink to this definition">¶</a></dt>
<dd><p>Stores a block hash as the last known block of the <a class="reference internal" href="teos.responder.html#teos.responder.Responder" title="teos.responder.Responder"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Responder</span></code></a>.</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 block hash to be stored (32-byte hex-encoded)</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>True if the block hash was stored in the db. 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.appointments_dbm.AppointmentsDBM.store_last_block_hash_watcher">
<code class="sig-name descname">store_last_block_hash_watcher</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/appointments_dbm.html#AppointmentsDBM.store_last_block_hash_watcher"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.appointments_dbm.AppointmentsDBM.store_last_block_hash_watcher" title="Permalink to this definition">¶</a></dt>
<dd><p>Stores a block hash as the last known block of the <a class="reference internal" href="teos.watcher.html#teos.watcher.Watcher" title="teos.watcher.Watcher"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Watcher</span></code></a>.</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 block hash to be stored (32-byte hex-encoded)</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>True if the block hash was stored in the db. 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.appointments_dbm.AppointmentsDBM.store_responder_tracker">
<code class="sig-name descname">store_responder_tracker</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">uuid</span></em>, <em class="sig-param"><span class="n">tracker</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/appointments_dbm.html#AppointmentsDBM.store_responder_tracker"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.appointments_dbm.AppointmentsDBM.store_responder_tracker" title="Permalink to this definition">¶</a></dt>
<dd><p>Stores a tracker in the database using the <code class="docutils literal notranslate"><span class="pre">RESPONDER_PREFIX</span></code> prefix.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>uuid</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – the identifier of the appointment to be stored.</p></li>
<li><p><strong>tracker</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code>) – a tracker encoded as a dictionary.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>True if the tracker was stored in the db. 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.appointments_dbm.AppointmentsDBM.store_watcher_appointment">
<code class="sig-name descname">store_watcher_appointment</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">uuid</span></em>, <em class="sig-param"><span class="n">appointment</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/appointments_dbm.html#AppointmentsDBM.store_watcher_appointment"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.appointments_dbm.AppointmentsDBM.store_watcher_appointment" title="Permalink to this definition">¶</a></dt>
<dd><p>Stores an appointment in the database using the <code class="docutils literal notranslate"><span class="pre">WATCHER_PREFIX</span></code> prefix.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>uuid</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – the identifier of the appointment to be stored.</p></li>
<li><p><strong>appointment</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code>) – an appointment encoded as a dictionary.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>True if the appointment was stored in the db. 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.appointments_dbm.AppointmentsDBM.update_locator_map">
<code class="sig-name descname">update_locator_map</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">locator</span></em>, <em class="sig-param"><span class="n">locator_map</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/appointments_dbm.html#AppointmentsDBM.update_locator_map"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.appointments_dbm.AppointmentsDBM.update_locator_map" title="Permalink to this definition">¶</a></dt>
<dd><p>Updates a <code class="docutils literal notranslate"><span class="pre">locator:uuid</span></code> map in the database by deleting one of it’s uuid. It will only work as long as
the given <code class="docutils literal notranslate"><span class="pre">locator_map</span></code> is a subset of the current one and it’s not empty.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>locator</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>) – a 16-byte hex-encoded string used as the key of the map.</p></li>
<li><p><strong>locator_map</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code>) – a list of uuids to replace the current one on the db.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="teos.block_processor.html" class="btn btn-neutral float-right" title="teos.block_processor" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="teos.api.html" class="btn btn-neutral float-left" title="teos.api" 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>