From 47e886410b0e1e9e2f40a3447d6a9a9c1c07928f Mon Sep 17 00:00:00 2001 From: Laurent Bercot Date: Thu, 9 Feb 2023 16:35:44 +0000 Subject: Clarify the use of shutdown() in s6-ioconnect Signed-off-by: Laurent Bercot --- doc/s6-ioconnect.html | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/doc/s6-ioconnect.html b/doc/s6-ioconnect.html index 2621ff6..4f7186b 100644 --- a/doc/s6-ioconnect.html +++ b/doc/s6-ioconnect.html @@ -73,6 +73,17 @@ suite, which is why the examples here involve TCP. Nevertheless, it can be used with connections across Unix domain sockets as well, and has its place in the s6 package. +
  • If one of the endpoints is a socket, s6-ioconnect will call +shutdown() +on it (for reading or writing, depending on the endpoint) when it +needs to transmit EOF. This is a necessary workaround to a +misdesign of the +socket API, but it could have unintended consequences +when the socket is shared among several processes that expect a +persistent connection. Most of the time, however, it is a mistake +to share a data socket between processes, so s6-ioconnect's behaviour +is suited to an overwhelming majority of cases, and the exceptions are +specialized enough that they won't need to use s6-ioconnect.
    • -- cgit v1.2.3