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
|
%global _empty_manifest_terminate_build 0
Name: python-filebus
Version: 0.3.5
Release: 1
Summary: A user space multicast named pipe implementation backed by a regular file
License: Apache Software License
URL: https://github.com/pipebus/filebus
Source0: https://mirrors.aliyun.com/pypi/web/packages/16/8b/bf68abbf4d301e111e87a09d2f2ce439277219f6a9a9c836533bcaaa86f9/filebus-0.3.5.tar.gz
BuildArch: noarch
Requires: python3-filelock
%description
# filebus
A userspace multicast named pipe implementation, backed by a regular
file, and accessed via a filebus stdio stream.
## Motivation
Imagine a stream of binary data like `/dev/urandom` that one wishes
for programs to be able to consume in a multicast fashion. An
obvious solution would be to redirect the binary data to a log file,
and then launch a separate `tail` command for each program that needs to
consume output from the log. However, this is not sustainable because
the log size will eventually grow too large if it is unbounded.
In order to solve this problem with `filebus`, simply pipe the live
stream to a filebus producer as follows:
```
strings /dev/urandom | filebus --filename /tmp/urandom.filebus producer
```
This command causes the file `/tmp/urandom.filebus` to behave like a
multicast pipe for filebus consumers which are launched like this:
```
filebus --filename /tmp/urandom.filebus consumer
```
## Implementation details
The on-disk file is updated via atomic rename while a lock is held.
File locking makes it safe for multiple producers to concurrently
produce to the same stream.
The filebus `--back-pressure` protocol uses deleted files to indicate
consumed buffers. File locking ensures that exactly one
consumer will consume and delete each buffer, and producers will
not attempt to write a new buffer until the previous buffer has been
consumed. A producer writes an empty buffer in order to indicate
EOF, and a consumer will terminate when it reads the empty buffer.
## Caveats
The `--back-pressure` option implement a lossless protocol, but this
protocol causes only a single consumer to receive a given buffer.
However, it is possible for an unlimited number of consumers which
are not using the `--back-pressure` option to eavesdrop on this stream
(provided they have been granted file read permission at the OS level),
albeit in a lossy manner.
In the absence of the `--back-pressure` option, consumers will
certainly lose chunks at high data rates, but lower data rates should
be lossless, and consumers should always be able to observe the most
recent chunk if it has not been quickly replaced by another.
## Alternative implementations
The bash implementation currently currently reads newline delimited
chunks, whereas the python implementation uses the `--sleep-interval`
and `--block-size` arguments to delimit chunks. The python
implementation is agnostic to the underlying stream in the sense that
it explicitly does not interpret any stream content as a delimiter,
which is a desirable property for filebus, but not essential for many
use cases.
## Usage
```
usage: filebus [-h] [--back-pressure] [--block-size N]
[--impl {bash,python}] [--lossless] [--no-file-monitoring]
[--filename FILE] [--sleep-interval N] [-v]
{producer,consumer} ...
filebus 0.2.0
A user space multicast named pipe implementation backed by a regular file
positional arguments:
{producer,consumer}
producer connect producer side of stream
consumer connect consumer side of stream
optional arguments:
-h, --help show this help message and exit
--back-pressure enable lossless back pressure protocol (unconsumed
chunks cause producers to block)
--block-size N maximum block size in units of bytes
--impl {bash,python}, --implementation {bash,python}
choose an alternative filebus implementation
(alternative implementations interoperate with
eachother)
--lossless an alias for --back-pressure
--no-file-monitoring disable filesystem event monitoring
--filename FILE path of the data file (the producer updates it via
atomic rename)
--sleep-interval N check for new messages at least once every N
seconds
-v, --verbose verbose logging (each occurence increases
verbosity)
```
%package -n python3-filebus
Summary: A user space multicast named pipe implementation backed by a regular file
Provides: python-filebus
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-filebus
# filebus
A userspace multicast named pipe implementation, backed by a regular
file, and accessed via a filebus stdio stream.
## Motivation
Imagine a stream of binary data like `/dev/urandom` that one wishes
for programs to be able to consume in a multicast fashion. An
obvious solution would be to redirect the binary data to a log file,
and then launch a separate `tail` command for each program that needs to
consume output from the log. However, this is not sustainable because
the log size will eventually grow too large if it is unbounded.
In order to solve this problem with `filebus`, simply pipe the live
stream to a filebus producer as follows:
```
strings /dev/urandom | filebus --filename /tmp/urandom.filebus producer
```
This command causes the file `/tmp/urandom.filebus` to behave like a
multicast pipe for filebus consumers which are launched like this:
```
filebus --filename /tmp/urandom.filebus consumer
```
## Implementation details
The on-disk file is updated via atomic rename while a lock is held.
File locking makes it safe for multiple producers to concurrently
produce to the same stream.
The filebus `--back-pressure` protocol uses deleted files to indicate
consumed buffers. File locking ensures that exactly one
consumer will consume and delete each buffer, and producers will
not attempt to write a new buffer until the previous buffer has been
consumed. A producer writes an empty buffer in order to indicate
EOF, and a consumer will terminate when it reads the empty buffer.
## Caveats
The `--back-pressure` option implement a lossless protocol, but this
protocol causes only a single consumer to receive a given buffer.
However, it is possible for an unlimited number of consumers which
are not using the `--back-pressure` option to eavesdrop on this stream
(provided they have been granted file read permission at the OS level),
albeit in a lossy manner.
In the absence of the `--back-pressure` option, consumers will
certainly lose chunks at high data rates, but lower data rates should
be lossless, and consumers should always be able to observe the most
recent chunk if it has not been quickly replaced by another.
## Alternative implementations
The bash implementation currently currently reads newline delimited
chunks, whereas the python implementation uses the `--sleep-interval`
and `--block-size` arguments to delimit chunks. The python
implementation is agnostic to the underlying stream in the sense that
it explicitly does not interpret any stream content as a delimiter,
which is a desirable property for filebus, but not essential for many
use cases.
## Usage
```
usage: filebus [-h] [--back-pressure] [--block-size N]
[--impl {bash,python}] [--lossless] [--no-file-monitoring]
[--filename FILE] [--sleep-interval N] [-v]
{producer,consumer} ...
filebus 0.2.0
A user space multicast named pipe implementation backed by a regular file
positional arguments:
{producer,consumer}
producer connect producer side of stream
consumer connect consumer side of stream
optional arguments:
-h, --help show this help message and exit
--back-pressure enable lossless back pressure protocol (unconsumed
chunks cause producers to block)
--block-size N maximum block size in units of bytes
--impl {bash,python}, --implementation {bash,python}
choose an alternative filebus implementation
(alternative implementations interoperate with
eachother)
--lossless an alias for --back-pressure
--no-file-monitoring disable filesystem event monitoring
--filename FILE path of the data file (the producer updates it via
atomic rename)
--sleep-interval N check for new messages at least once every N
seconds
-v, --verbose verbose logging (each occurence increases
verbosity)
```
%package help
Summary: Development documents and examples for filebus
Provides: python3-filebus-doc
%description help
# filebus
A userspace multicast named pipe implementation, backed by a regular
file, and accessed via a filebus stdio stream.
## Motivation
Imagine a stream of binary data like `/dev/urandom` that one wishes
for programs to be able to consume in a multicast fashion. An
obvious solution would be to redirect the binary data to a log file,
and then launch a separate `tail` command for each program that needs to
consume output from the log. However, this is not sustainable because
the log size will eventually grow too large if it is unbounded.
In order to solve this problem with `filebus`, simply pipe the live
stream to a filebus producer as follows:
```
strings /dev/urandom | filebus --filename /tmp/urandom.filebus producer
```
This command causes the file `/tmp/urandom.filebus` to behave like a
multicast pipe for filebus consumers which are launched like this:
```
filebus --filename /tmp/urandom.filebus consumer
```
## Implementation details
The on-disk file is updated via atomic rename while a lock is held.
File locking makes it safe for multiple producers to concurrently
produce to the same stream.
The filebus `--back-pressure` protocol uses deleted files to indicate
consumed buffers. File locking ensures that exactly one
consumer will consume and delete each buffer, and producers will
not attempt to write a new buffer until the previous buffer has been
consumed. A producer writes an empty buffer in order to indicate
EOF, and a consumer will terminate when it reads the empty buffer.
## Caveats
The `--back-pressure` option implement a lossless protocol, but this
protocol causes only a single consumer to receive a given buffer.
However, it is possible for an unlimited number of consumers which
are not using the `--back-pressure` option to eavesdrop on this stream
(provided they have been granted file read permission at the OS level),
albeit in a lossy manner.
In the absence of the `--back-pressure` option, consumers will
certainly lose chunks at high data rates, but lower data rates should
be lossless, and consumers should always be able to observe the most
recent chunk if it has not been quickly replaced by another.
## Alternative implementations
The bash implementation currently currently reads newline delimited
chunks, whereas the python implementation uses the `--sleep-interval`
and `--block-size` arguments to delimit chunks. The python
implementation is agnostic to the underlying stream in the sense that
it explicitly does not interpret any stream content as a delimiter,
which is a desirable property for filebus, but not essential for many
use cases.
## Usage
```
usage: filebus [-h] [--back-pressure] [--block-size N]
[--impl {bash,python}] [--lossless] [--no-file-monitoring]
[--filename FILE] [--sleep-interval N] [-v]
{producer,consumer} ...
filebus 0.2.0
A user space multicast named pipe implementation backed by a regular file
positional arguments:
{producer,consumer}
producer connect producer side of stream
consumer connect consumer side of stream
optional arguments:
-h, --help show this help message and exit
--back-pressure enable lossless back pressure protocol (unconsumed
chunks cause producers to block)
--block-size N maximum block size in units of bytes
--impl {bash,python}, --implementation {bash,python}
choose an alternative filebus implementation
(alternative implementations interoperate with
eachother)
--lossless an alias for --back-pressure
--no-file-monitoring disable filesystem event monitoring
--filename FILE path of the data file (the producer updates it via
atomic rename)
--sleep-interval N check for new messages at least once every N
seconds
-v, --verbose verbose logging (each occurence increases
verbosity)
```
%prep
%autosetup -n filebus-0.3.5
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "\"/%h/%f.gz\"\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-filebus -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Tue Jun 20 2023 Python_Bot <Python_Bot@openeuler.org> - 0.3.5-1
- Package Spec generated
|
