-
Notifications
You must be signed in to change notification settings - Fork 0
/
Noso.Headers.html
300 lines (287 loc) · 12.9 KB
/
Noso.Headers.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
<!DOCTYPE html>
<html lang="en">
<head>
<title>NosoNode: Noso.Headers</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="generator" content="PasDoc 0.16.0-snapshot">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="tipuesearch/tipuesearch.css">
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
</head>
<body>
<div class="container"><div class="navigation">
<h2><a href="index.html">NosoNode</a></h2><ul><li><a href="AllUnits.html">Units</a></li><li><a href="ClassHierarchy.html">Class Hierarchy</a></li><li><a href="AllClasses.html">Classes, Interfaces, Objects and Records</a></li><li><a href="AllTypes.html">Types</a></li><li><a href="AllVariables.html">Variables</a></li><li><a href="AllConstants.html">Constants</a></li><li><a href="AllFunctions.html">Functions and Procedures</a></li><li><a href="AllIdentifiers.html">Identifiers</a></li><li><form class="search-form" action="tipue_results.html"><div class="search-input"><input type="text" name="q" id="tipue_search_input" pattern=".{1,}" title="At least 1 characters" required><div class="search-button"><input type="button" id="tipue_search_button" onclick="this.form.submit();"></div></div></form>
<div style="clear: both"></div>
</li></ul></div><div class="content">
<h1 class="unit">Unit Noso.Headers</h1>
<div class="sections">
<div class="one_section"><a class="section" href="#PasDoc-Description">Description</a></div><div class="one_section"><a class="section" href="#PasDoc-Uses">Uses</a></div><div class="one_section"><a class="section" href="#PasDoc-Classes">Classes, Interfaces, Objects and Records</a></div><div class="one_section"><a class="section" href="#PasDoc-FuncsProcs">Functions and Procedures</a></div><div class="one_section">Types</div><div class="one_section">Constants</div><div class="one_section"><a class="section" href="#PasDoc-Variables">Variables</a></div></div>
<span id="PasDoc-Description"></span><h2 class="description">Description</h2>
<p>
Standalone unit to control headers file.</p>
<span id="PasDoc-Uses"></span><h2 class="uses">Uses</h2>
<ul class="useslist"><li>Classes</li><li><a href="Noso.Crypto.html">Noso.Crypto</a></li><li><a href="Noso.Debug.html">Noso.Debug</a></li><li><a href="Noso.General.html">Noso.General</a></li><li>SysUtils</li></ul><h2 class="overview">Overview</h2>
<span id="PasDoc-Classes"></span><h3 class="cio">Classes, Interfaces, Objects and Records</h3>
<table class="classestable wide_list">
<tr class="listheader">
<th class="itemname">Name</th>
<th class="itemdesc">Description</th>
</tr>
<tr class="list">
<td class="itemname">Packed Record <a class="bold" href="Noso.Headers.TBlockSummary.html"><code>TBlockSummary</code></a></td>
<td class="itemdesc"> Record to hold summary data for a block </td>
</tr>
</table>
<span id="PasDoc-FuncsProcs"></span><h3 class="summary">Functions and Procedures</h3>
<table class="summary wide_list">
<tr class="list">
<td class="itemcode"><code>function <strong><a href="Noso.Headers.html#AddRecordToHeaders-Int64-String-String-">AddRecordToHeaders</a></strong>(const BlockNumber: Int64; const BlockHash, SumHash: String): Boolean;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code>function <strong><a href="Noso.Headers.html#CreateHeadersFile">CreateHeadersFile</a></strong>(): Boolean;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code>function <strong><a href="Noso.Headers.html#GetHeadersAsMemoryStream-TMemoryStream-">GetHeadersAsMemoryStream</a></strong>(var Stream: TMemoryStream): Int64;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code>function <strong><a href="Noso.Headers.html#GetHeadersAsStringFromBlock-Integer-">GetHeadersAsStringFromBlock</a></strong>(FromBlock: Integer): String;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code>function <strong><a href="Noso.Headers.html#GetHeadersCount">GetHeadersCount</a></strong>(): Integer;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code>function <strong><a href="Noso.Headers.html#GetLastHeaderBlock">GetLastHeaderBlock</a></strong>(): Integer;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code>function <strong><a href="Noso.Headers.html#GetSummaryFileHash">GetSummaryFileHash</a></strong>(): String;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code>function <strong><a href="Noso.Headers.html#RemoveLastHeaderRecord">RemoveLastHeaderRecord</a></strong>(): Boolean;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code>function <strong><a href="Noso.Headers.html#SaveMemoryStreamAsHeaders-TMemoryStream-">SaveMemoryStreamAsHeaders</a></strong>(var Stream: TMemoryStream): Boolean;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code>function <strong><a href="Noso.Headers.html#SetHeadersFileName-String-">SetHeadersFileName</a></strong>(const Filename: String): Boolean;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code>procedure <strong><a href="Noso.Headers.html#SetSummaryFileHash">SetSummaryFileHash</a></strong>();</code></td>
</tr>
</table>
<span id="PasDoc-Variables"></span><h3 class="summary">Variables</h3>
<table class="summary wide_list">
<tr class="list">
<td class="itemcode"><code><strong><a href="Noso.Headers.html#CurrentSummaryFileHash">CurrentSummaryFileHash</a></strong>: String = '';</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><strong><a href="Noso.Headers.html#HeadersFileCriticalSection">HeadersFileCriticalSection</a></strong>: TRTLCriticalSection;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code><strong><a href="Noso.Headers.html#SummaryFile">SummaryFile</a></strong>: file of <a href="Noso.Headers.TBlockSummary.html">TBlockSummary</a>;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><strong><a href="Noso.Headers.html#SummaryFilename">SummaryFilename</a></strong>: String = 'blchhead.nos';</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Functions and Procedures</h3>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><span id="AddRecordToHeaders-Int64-String-String-"></span><code>function <strong>AddRecordToHeaders</strong>(const BlockNumber: Int64; const BlockHash, SumHash: String): Boolean;</code></td>
</tr>
<tr><td colspan="1">
<p>
Adds a new record to the headers file. </p>
<p>
<p>
<p>
<p></p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>BlockNumber</dt>
<dd>The block number to be added.</dd>
<dt>BlockHash</dt>
<dd>The hash of the block.</dd>
<dt>SumHash</dt>
<dd>The sum hash associated with the block.</dd>
</dl>
<h6 class="description_section">Returns</h6>
<p class="return"><code>True</code> if the record was added successfully; otherwise, <code>False</code>.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><span id="CreateHeadersFile"></span><code>function <strong>CreateHeadersFile</strong>(): Boolean;</code></td>
</tr>
<tr><td colspan="1">
<p>
Creates a new headers file or overwrites an existing one. </p>
<p>
</p>
<h6 class="description_section">Returns</h6>
<p class="return"><code>True</code> if the headers file was created successfully; otherwise, <code>False</code>.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><span id="GetHeadersAsMemoryStream-TMemoryStream-"></span><code>function <strong>GetHeadersAsMemoryStream</strong>(var Stream: TMemoryStream): Int64;</code></td>
</tr>
<tr><td colspan="1">
<p>
Loads the headers file into a memory stream. </p>
<p>
<p></p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>Stream</dt>
<dd>The memory stream to load the headers into.</dd>
</dl>
<h6 class="description_section">Returns</h6>
<p class="return">The size of the loaded headers in bytes.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><span id="GetHeadersAsStringFromBlock-Integer-"></span><code>function <strong>GetHeadersAsStringFromBlock</strong>(FromBlock: Integer): String;</code></td>
</tr>
<tr><td colspan="1">
<p>
Retrieves headers data as a string starting from a specified block. </p>
<p>
<p></p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>FromBlock</dt>
<dd>The block number from which to start retrieving headers.</dd>
</dl>
<h6 class="description_section">Returns</h6>
<p class="return">A string representing the headers data from the specified block.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><span id="GetHeadersCount"></span><code>function <strong>GetHeadersCount</strong>(): Integer;</code></td>
</tr>
<tr><td colspan="1">
<p>
Retrieves the number of records in the headers file. </p>
<p>
</p>
<h6 class="description_section">Returns</h6>
<p class="return">The number of records in the headers file.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><span id="GetLastHeaderBlock"></span><code>function <strong>GetLastHeaderBlock</strong>(): Integer;</code></td>
</tr>
<tr><td colspan="1">
<p>
Retrieves the block number of the last record in the headers file. </p>
<p>
</p>
<h6 class="description_section">Returns</h6>
<p class="return">The block number of the last record.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><span id="GetSummaryFileHash"></span><code>function <strong>GetSummaryFileHash</strong>(): String;</code></td>
</tr>
<tr><td colspan="1">
<p>
Retrieves the current hash of the summary file. </p>
<p>
</p>
<h6 class="description_section">Returns</h6>
<p class="return">The hash of the summary file.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><span id="RemoveLastHeaderRecord"></span><code>function <strong>RemoveLastHeaderRecord</strong>(): Boolean;</code></td>
</tr>
<tr><td colspan="1">
<p>
Removes the last record from the headers file. </p>
<p>
</p>
<h6 class="description_section">Returns</h6>
<p class="return"><code>True</code> if the record was removed successfully; otherwise, <code>False</code>.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><span id="SaveMemoryStreamAsHeaders-TMemoryStream-"></span><code>function <strong>SaveMemoryStreamAsHeaders</strong>(var Stream: TMemoryStream): Boolean;</code></td>
</tr>
<tr><td colspan="1">
<p>
Saves the contents of a memory stream as the headers file. </p>
<p>
<p></p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>Stream</dt>
<dd>The memory stream containing the headers data.</dd>
</dl>
<h6 class="description_section">Returns</h6>
<p class="return"><code>True</code> if the stream was saved successfully; otherwise, <code>False</code>.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><span id="SetHeadersFileName-String-"></span><code>function <strong>SetHeadersFileName</strong>(const Filename: String): Boolean;</code></td>
</tr>
<tr><td colspan="1">
<p>
Sets the path and name of the headers file. </p>
<p>
<p></p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>Filename</dt>
<dd>The path and name of the headers file.</dd>
</dl>
<h6 class="description_section">Returns</h6>
<p class="return"><code>True</code> if the file name was set successfully; otherwise, <code>False</code>.</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><span id="SetSummaryFileHash"></span><code>procedure <strong>SetSummaryFileHash</strong>();</code></td>
</tr>
<tr><td colspan="1">
<p>
Sets the hash of the summary file to reflect the current file state. </p>
</td></tr>
</table>
<h3 class="detail">Variables</h3>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><span id="CurrentSummaryFileHash"></span><code><strong>CurrentSummaryFileHash</strong>: String = '';</code></td>
</tr>
<tr><td colspan="1">
<p>
The current hash of the summary file. </p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><span id="HeadersFileCriticalSection"></span><code><strong>HeadersFileCriticalSection</strong>: TRTLCriticalSection;</code></td>
</tr>
<tr><td colspan="1">
<p>
Critical section for synchronizing access to the headers file. </p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><span id="SummaryFile"></span><code><strong>SummaryFile</strong>: file of <a href="Noso.Headers.TBlockSummary.html">TBlockSummary</a>;</code></td>
</tr>
<tr><td colspan="1">
<p>
The file handle for the summary file. </p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><span id="SummaryFilename"></span><code><strong>SummaryFilename</strong>: String = 'blchhead.nos';</code></td>
</tr>
<tr><td colspan="1">
<p>
The path and name of the summary file. </p>
</td></tr>
</table>
<hr><span class="appinfo"><em>Generated by <a href="https://pasdoc.github.io/">PasDoc 0.16.0-snapshot</a>. </em>
</span>
</div></div></body></html>