diff options
author | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2020-05-22 09:39:36 +0200 |
---|---|---|
committer | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2020-05-26 10:28:59 +0200 |
commit | 201632e314e6568d46da4ae01a6f1717335f434b (patch) | |
tree | 82756ddbfcb3f0232f657e96c4330b7771d935e8 /man/sd_bus_get_fd.xml | |
parent | e14db3507243034b96cf4a1172d3bb1bf51b8471 (diff) | |
download | systemd-201632e314e6568d46da4ae01a6f1717335f434b.tar.gz |
tree-wide: s/time-out/timeout/g
See 3f9a0a522f2029e9295ea5e9984259022be88413 for justification.
Diffstat (limited to 'man/sd_bus_get_fd.xml')
-rw-r--r-- | man/sd_bus_get_fd.xml | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/man/sd_bus_get_fd.xml b/man/sd_bus_get_fd.xml index d9586f9003..69261af93e 100644 --- a/man/sd_bus_get_fd.xml +++ b/man/sd_bus_get_fd.xml @@ -26,7 +26,7 @@ <refname>sd_bus_get_events</refname> <refname>sd_bus_get_timeout</refname> - <refpurpose>Get the file descriptor, I/O events and time-out to wait for from a message bus + <refpurpose>Get the file descriptor, I/O events and timeout to wait for from a message bus object</refpurpose> </refnamediv> @@ -79,13 +79,13 @@ <constant>POLLIN</constant>, <constant>POLLOUT</constant>, … events, or negative on error. </para> - <para><function>sd_bus_get_timeout()</function> returns the time-out in µs to pass to to + <para><function>sd_bus_get_timeout()</function> returns the timeout in µs to pass to to <function>poll()</function> or a similar call when waiting for events on the specified bus - connection. The returned time-out may be zero, in which case a subsequent I/O polling call + connection. The returned timeout may be zero, in which case a subsequent I/O polling call should be invoked in non-blocking mode. The returned timeout may be <constant>UINT64_MAX</constant> in which case the I/O polling call may block indefinitely, - without any applied time-out. Note that the returned time-out should be considered only a - maximum sleeping time. It is permissible (and even expected) that shorter time-outs are used by + without any applied timeout. Note that the returned timeout should be considered only a + maximum sleeping time. It is permissible (and even expected) that shorter timeouts are used by the calling program, in case other event sources are polled in the same event loop. Note that the returned time-value is relative and specified in microseconds. When converting this value in order to pass it as third argument to <function>poll()</function> (which expects milliseconds), @@ -93,7 +93,7 @@ doesn't sleep for shorter than necessary, which might result in unintended busy looping (alternatively, use <citerefentry project='man-pages'><refentrytitle>ppoll</refentrytitle><manvolnum>3</manvolnum></citerefentry> - instead of plain <function>poll()</function>, which understands time-outs with nano-second + instead of plain <function>poll()</function>, which understands timeouts with nano-second granularity).</para> <para>These three functions are useful to hook up a bus connection object with an external or @@ -101,7 +101,7 @@ each invocation of the I/O polling call, all three functions should be invoked: the file descriptor returned by <function>sd_bus_get_fd()</function> should be polled for the events indicated by <function>sd_bus_get_events()</function>, and the I/O call should block for that up - to the time-out returned by <function>sd_bus_get_timeout()</function>. After each I/O polling + to the timeout returned by <function>sd_bus_get_timeout()</function>. After each I/O polling call the bus connection needs to process incoming or outgoing data, by invoking <citerefentry><refentrytitle>sd_bus_process</refentrytitle><manvolnum>3</manvolnum></citerefentry>. </para> |