From 9afb013574e9a988e6fb3365c164fd8250dbaaa6 Mon Sep 17 00:00:00 2001 From: Thomas Versteeg Date: Fri, 2 Mar 2018 10:41:08 +0000 Subject: [PATCH] doc: clarify platform specific pipe naming Pipe naming conventions differ on Windows and Unix. This commit calls out the naming conventions and requirements. PR-URL: https://github.com/libuv/libuv/pull/1765 Reviewed-By: Colin Ihrig Reviewed-By: Bartosz Sosnowski --- docs/src/guide/processes.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/src/guide/processes.rst b/docs/src/guide/processes.rst index 49df4e93..19ce0572 100644 --- a/docs/src/guide/processes.rst +++ b/docs/src/guide/processes.rst @@ -290,7 +290,9 @@ A client which wants to connect to a domain socket will use:: void uv_pipe_connect(uv_connect_t *req, uv_pipe_t *handle, const char *name, uv_connect_cb cb); -where ``name`` will be ``echo.sock`` or similar. +where ``name`` will be ``echo.sock`` or similar. On Unix systems, ``name`` must +point to a valid file (e.g. ``/tmp/echo.sock``). On Windows, ``name`` follows a +``\\?\pipe\echo.sock`` format. .. _socat: http://www.dest-unreach.org/socat/