X-Git-Url: http://git.ipfire.org/?p=thirdparty%2Fsystemd.git;a=blobdiff_plain;f=man%2Fsd_bus_get_fd.xml;h=69261af93efa5c11e804c1c2340504a95884880f;hp=d9586f9003e27a7c26c5ea0dcc1b23792eede1a8;hb=201632e314e6568d46da4ae01a6f1717335f434b;hpb=e14db3507243034b96cf4a1172d3bb1bf51b8471 diff --git a/man/sd_bus_get_fd.xml b/man/sd_bus_get_fd.xml index d9586f9003e..69261af93ef 100644 --- a/man/sd_bus_get_fd.xml +++ b/man/sd_bus_get_fd.xml @@ -26,7 +26,7 @@ sd_bus_get_events sd_bus_get_timeout - Get the file descriptor, I/O events and time-out to wait for from a message bus + Get the file descriptor, I/O events and timeout to wait for from a message bus object @@ -79,13 +79,13 @@ POLLIN, POLLOUT, … events, or negative on error. - sd_bus_get_timeout() returns the time-out in µs to pass to to + sd_bus_get_timeout() returns the timeout in µs to pass to to poll() 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 UINT64_MAX 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 poll() (which expects milliseconds), @@ -93,7 +93,7 @@ doesn't sleep for shorter than necessary, which might result in unintended busy looping (alternatively, use ppoll3 - instead of plain poll(), which understands time-outs with nano-second + instead of plain poll(), which understands timeouts with nano-second granularity). 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 sd_bus_get_fd() should be polled for the events indicated by sd_bus_get_events(), and the I/O call should block for that up - to the time-out returned by sd_bus_get_timeout(). After each I/O polling + to the timeout returned by sd_bus_get_timeout(). After each I/O polling call the bus connection needs to process incoming or outgoing data, by invoking sd_bus_process3.