1UDP-RECEIVER(1) Udpcast UDP-RECEIVER(1)
2
6 udp-receiver - receive files broadcast by udp-sender
7
9 ./udp-receiver [--file file] [--pipe pipe] [--portbase portbase]
10 [--interface net-interface] [--log file] [--ttl time-to-live]
11 [--mcast-rdv-address mcast-rdv-address] [--nokbd] [--exitWait
12 milliseconds] [--stat-period n] [--print-uncompressed-position flag]
13
15 "Udp-receiver" is used to receive files sent by "udp-sender" (for
16 instance a disk image).
17
19 Basic options
20 --file file
21 Writes received data to file. If this parameter is not supplied,
22 received data is written to stdout instead.
23 --pipe command
25 Sends data through pipe after receiving it. This is useful for
26 decompressing the data, or for filling in unused filesystem blocks
27 that may have been stripped out by udp-sender. The command gets a
28 direct handle on the output file or device, and thus may seek
29 inside it, if needed. "Udpcast" itself also keeps a handle on the
30 file, which is used for an informational progress display. The
31 command's stdin is a pipe from udp-receiver. Example: "udp-receiver
32 -p "gzip -dc""
33 --log file
35 Logs some stuff into file.
36 --nosync
38 Do not open target in synchronous mode. This is the default when
39 writing to a file or a pipe.
40 --sync
42 Write to target in synchronous mode. This is the default when
43 writing to a device (character or block)
44 --nokbd
46 Do not read start signal from keyboard, and do not display any
47 message telling the user to press any key to start.
48 --start-timeout sec
50 receiver aborts at start if it doesn't see a sender within this
51 many seconds. Furthermore, the sender needs to start transmission
52 of data within this delay. Once transmission is started, the
53 timeout no longer applies.
54 --receive-timeout sec
56 receiver aborts during transmission if it doesn't see a packet from
57 the sender within this many seconds. This timeout only applies once
58 transmission has started.
59 Networking options
61 --portbase portbase
62 Default ports to use for udpcast. Two ports are used: portbase and
63 portbase+1 . Thus, Portbase must be even. Default is 9000. The same
64 portbase must be specified for both "udp-sender" and
65 "udp-receiver".
66 --interface interface
68 Network interface used to send out the data. Default is "eth0"
69 --ttl ttl
71 Time to live for connection request packet (by default connection
72 request is broadcast to the LAN's broadcast address. If ttl is set,
73 the connection request is multicast instead to 224.0.0.1 with the
74 given ttl, which should enable udpcast to work between LANs. Not
75 tested though.
76 --mcast-rdv-address address
78 Uses a non-standard multicast address for the control connection
79 (which is used by the sender and receivers to "find" each other).
80 This is not the address that is used to transfer the data. By
81 default "mcast-rdv-address" is the Ethernet broadcast address if
82 "ttl" is 1, and 224.0.0.1 otherwise. This setting should not be
83 used except in very special situations, such as when 224.0.0.1
84 cannot be used for policy reasons.
85 --exit-wait milliseconds
87 When transmission is over, receiver will wait for this time after
88 receiving the final REQACK. This is done in order to guard against
89 loss of the final ACK. Is 500 milliseconds by default.
90 --ignore-lost-data
92 Do not stop reception when data loss is detected, but instead fill
93 with random data. This is useful for multimedia transmission where
94 100% integrity is not need.
95 Statistics options
97 --stat-period seconds
98 Every so much milliseconds, print some statistics to stderr: how
99 much bytes received so far log, position in uncompressed file (if
100 applicable), overall bitrate... By default, this is printed every
101 half second.
102 --print-uncompressed-position flag
104 By default, udp-receiver only prints the position in uncompressed
105 file if the 2 following conditions are met:
106 • Output is piped via a compressor ("-p " option).
108 • The final output is seekable (file or device)
110 With the "--print-uncompressed-position", options, you can change
112 this behavior:
113 • If flag is 0, uncompressed position will never be printed, even
115 if above conditions are met
116 • If flag is 1, uncompressed position will always be printed,
118 even if above conditions are not met
119
121 udp-sender
122
124 Alain Knaff
125current January 22, 2022 UDP-RECEIVER(1)