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.teosd.html
440 lines (302 loc) · 20.8 KB
/
teos.teosd.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
<!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.teosd — 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.tools" href="teos.tools.html" />
<link rel="prev" title="teos.rpc" href="teos.rpc.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"><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 current"><a class="current reference internal" href="#">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.teosd</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/teos.teosd.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.teosd">
<span id="teos-teosd"></span><h1>teos.teosd<a class="headerlink" href="#module-teos.teosd" title="Permalink to this headline">¶</a></h1>
<dl class="py class">
<dt id="teos.teosd.TeosDaemon">
<em class="property">class </em><code class="sig-name descname">TeosDaemon</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em>, <em class="sig-param"><span class="n">sk</span></em>, <em class="sig-param"><span class="n">logger</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/teosd.html#TeosDaemon"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.teosd.TeosDaemon" 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.teosd.TeosDaemon" title="teos.teosd.TeosDaemon"><code class="xref py py-class docutils literal notranslate"><span class="pre">TeosDaemon</span></code></a> organizes the code to initialize all the components of teos, start the service, stop and
teardown.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>config</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code>) – the configuration object.</p></li>
<li><p><strong>sk</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">PrivateKey</span></code>) – the <code class="xref py py-obj docutils literal notranslate"><span class="pre">PrivateKey</span></code> of the tower.</p></li>
<li><p><strong>logger</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Logger</span></code>) – the logger instance.</p></li>
</ul>
</dd>
</dl>
<dl class="py attribute">
<dt id="teos.teosd.TeosDaemon.stop_command_event">
<code class="sig-name descname">stop_command_event</code><a class="headerlink" href="#teos.teosd.TeosDaemon.stop_command_event" title="Permalink to this definition">¶</a></dt>
<dd><p>The event that will be set to initiate a graceful shutdown.</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">threading.Event</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="teos.teosd.TeosDaemon.stop_event">
<code class="sig-name descname">stop_event</code><a class="headerlink" href="#teos.teosd.TeosDaemon.stop_event" title="Permalink to this definition">¶</a></dt>
<dd><p>The event that services running on different processes will monitor
in order to be informed that they should shutdown.</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">multiprocessing.Event</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="teos.teosd.TeosDaemon.block_processor">
<code class="sig-name descname">block_processor</code><a class="headerlink" href="#teos.teosd.TeosDaemon.block_processor" title="Permalink to this definition">¶</a></dt>
<dd><p>The block processor instance.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><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">teos.block_processor.BlockProcessor</span></code></a></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="teos.teosd.TeosDaemon.db_manager">
<code class="sig-name descname">db_manager</code><a class="headerlink" href="#teos.teosd.TeosDaemon.db_manager" title="Permalink to this definition">¶</a></dt>
<dd><p>The db manager for appointments.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><a class="reference internal" href="teos.appointments_dbm.html#teos.appointments_dbm.AppointmentsDBM" title="teos.appointments_dbm.AppointmentsDBM"><code class="xref py py-obj docutils literal notranslate"><span class="pre">teos.appointments_dbm.AppointmentsDBM</span></code></a></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="teos.teosd.TeosDaemon.watcher">
<code class="sig-name descname">watcher</code><a class="headerlink" href="#teos.teosd.TeosDaemon.watcher" title="Permalink to this definition">¶</a></dt>
<dd><p>The watcher instance.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><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">teos.watcher.Watcher</span></code></a></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="teos.teosd.TeosDaemon.watcher_thread">
<code class="sig-name descname">watcher_thread</code><a class="headerlink" href="#teos.teosd.TeosDaemon.watcher_thread" title="Permalink to this definition">¶</a></dt>
<dd><p>After <code class="docutils literal notranslate"><span class="pre">bootstrap_components</span></code>, the thread that
runs the Watcher monitoring (set to <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code> beforehand).</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">multithreading.Thread</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="teos.teosd.TeosDaemon.responder_thread">
<code class="sig-name descname">responder_thread</code><a class="headerlink" href="#teos.teosd.TeosDaemon.responder_thread" title="Permalink to this definition">¶</a></dt>
<dd><p>After <code class="docutils literal notranslate"><span class="pre">bootstrap_components</span></code>, the thread that
runs the Responder monitoring (set to <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code> beforehand).</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">multithreading.Thread</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="teos.teosd.TeosDaemon.chain_monitor">
<code class="sig-name descname">chain_monitor</code><a class="headerlink" href="#teos.teosd.TeosDaemon.chain_monitor" title="Permalink to this definition">¶</a></dt>
<dd><p>The <code class="docutils literal notranslate"><span class="pre">ChainMonitor</span></code> instance.</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.html#teos.chain_monitor.ChainMonitor" title="teos.chain_monitor.ChainMonitor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">teos.chain_monitor.ChainMonitor</span></code></a></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="teos.teosd.TeosDaemon.self.api_proc">
<code class="sig-prename descclassname">self.</code><code class="sig-name descname">api_proc</code><a class="headerlink" href="#teos.teosd.TeosDaemon.self.api_proc" title="Permalink to this definition">¶</a></dt>
<dd><p>Once the rpc process
is created, the instance of either <code class="docutils literal notranslate"><span class="pre">Popen</span></code> or <code class="docutils literal notranslate"><span class="pre">Process</span></code> that is serving the public API (set to
<code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code> beforehand).</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">subprocess.Popen</span></code> or <code class="xref py py-obj docutils literal notranslate"><span class="pre">multiprocessing.Process</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="teos.teosd.TeosDaemon.self.rpc_process">
<code class="sig-prename descclassname">self.</code><code class="sig-name descname">rpc_process</code><a class="headerlink" href="#teos.teosd.TeosDaemon.self.rpc_process" title="Permalink to this definition">¶</a></dt>
<dd><p>The instance of the internal RPC server; only set if running.</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">multiprocessing.Process</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt id="teos.teosd.TeosDaemon.self.internal_api">
<code class="sig-prename descclassname">self.</code><code class="sig-name descname">internal_api</code><a class="headerlink" href="#teos.teosd.TeosDaemon.self.internal_api" title="Permalink to this definition">¶</a></dt>
<dd><p>The InternalAPI instance.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><a class="reference internal" href="teos.internal_api.html#teos.internal_api.InternalAPI" title="teos.internal_api.InternalAPI"><code class="xref py py-obj docutils literal notranslate"><span class="pre">teos.internal_api.InternalAPI</span></code></a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt id="teos.teosd.TeosDaemon.bootstrap_components">
<code class="sig-name descname">bootstrap_components</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/teosd.html#TeosDaemon.bootstrap_components"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.teosd.TeosDaemon.bootstrap_components" title="Permalink to this definition">¶</a></dt>
<dd><p>Performs the initial setup of the components. It loads the appointments and tracker for the watcher and the
responder (if any), and awakes the components. It also populates the block queues with any missing data, in
case the tower has been offline for some time. Finally, it starts the chain monitor.</p>
</dd></dl>
<dl class="py method">
<dt id="teos.teosd.TeosDaemon.handle_signals">
<code class="sig-name descname">handle_signals</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">signum</span></em>, <em class="sig-param"><span class="n">frame</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/teosd.html#TeosDaemon.handle_signals"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.teosd.TeosDaemon.handle_signals" title="Permalink to this definition">¶</a></dt>
<dd><p>Handles signals by initiating a graceful shutdown.</p>
</dd></dl>
<dl class="py method">
<dt id="teos.teosd.TeosDaemon.start">
<code class="sig-name descname">start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/teosd.html#TeosDaemon.start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.teosd.TeosDaemon.start" title="Permalink to this definition">¶</a></dt>
<dd><p>This method implements the whole lifetime cycle of the the TEOS tower. This method does not return.</p>
</dd></dl>
<dl class="py method">
<dt id="teos.teosd.TeosDaemon.start_services">
<code class="sig-name descname">start_services</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/teosd.html#TeosDaemon.start_services"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.teosd.TeosDaemon.start_services" title="Permalink to this definition">¶</a></dt>
<dd><p>Readies the tower by setting up signal handling, and starting all the services.</p>
</dd></dl>
<dl class="py method">
<dt id="teos.teosd.TeosDaemon.teardown">
<code class="sig-name descname">teardown</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/teosd.html#TeosDaemon.teardown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.teosd.TeosDaemon.teardown" title="Permalink to this definition">¶</a></dt>
<dd><p>Shuts down all services and closes the DB, then exits. This method does not return.</p>
</dd></dl>
</dd></dl>
<dl class="py function">
<dt id="teos.teosd.get_config">
<code class="sig-name descname">get_config</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">command_line_conf</span></em>, <em class="sig-param"><span class="n">data_dir</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/teosd.html#get_config"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.teosd.get_config" title="Permalink to this definition">¶</a></dt>
<dd><p>Combines the command line config with the config loaded from the file and the default config in order to construct
the final config object.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>command_line_conf</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">dict</span></code>) – a collection of the command line parameters.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A dictionary containing all the system’s configuration parameters.</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 function">
<dt id="teos.teosd.main">
<code class="sig-name descname">main</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">config</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/teos/teosd.html#main"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#teos.teosd.main" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="teos.tools.html" class="btn btn-neutral float-right" title="teos.tools" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="teos.rpc.html" class="btn btn-neutral float-left" title="teos.rpc" 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>