From 4f408bd952e3ddac2168ddbd2ca2c88a561bf91f Mon Sep 17 00:00:00 2001
From: Max Kellermann <max@musicpd.org>
Date: Wed, 20 Mar 2019 12:57:26 +0100
Subject: [PATCH] event/ServerSocket, doc, ...: refer to AF_LOCAL as "local
socket"
.. and not "UNIX domain socket. Be consistent about the naming.
---
doc/plugins.rst | 2 +-
doc/protocol.rst | 6 +++---
src/config/Net.hxx | 6 +++---
src/event/ServerSocket.cxx | 2 +-
src/event/ServerSocket.hxx | 2 +-
src/net/SocketUtil.cxx | 2 +-
src/net/SocketUtil.hxx | 2 +-
src/net/ToString.cxx | 2 +-
8 files changed, 12 insertions(+), 12 deletions(-)
diff --git a/doc/plugins.rst b/doc/plugins.rst
index 69549e5a7..06742ca24 100644
--- a/doc/plugins.rst
+++ b/doc/plugins.rst
@@ -849,7 +849,7 @@ It is highly recommended to configure a fixed format, because a stream cannot sw
* - **port P**
- Binds the HTTP server to the specified port.
* - **bind_to_address ADDR**
- - Binds the HTTP server to the specified address (IPv4, IPv6 or UNIX socket). Multiple addresses in parallel are not supported.
+ - Binds the HTTP server to the specified address (IPv4, IPv6 or local socket). Multiple addresses in parallel are not supported.
* - **encoder NAME**
- Chooses an encoder plugin. A list of encoder plugins can be found in the encoder plugin reference :ref:`encoder_plugins`.
* - **max_clients MC**
diff --git a/doc/protocol.rst b/doc/protocol.rst
index bbe1a655b..c103efe64 100644
--- a/doc/protocol.rst
+++ b/doc/protocol.rst
@@ -721,7 +721,7 @@ run playlist plugins instead of the hard-coded simple
`m3u` parser. They can access playlists in
the music directory (relative path including the suffix),
playlists in arbitrary location (absolute path including the suffix;
-allowed only for clients that are connected via UNIX domain socket), or
+allowed only for clients that are connected via local socket), or
remote playlists (absolute URI with a supported scheme).
:command:`listplaylist {NAME}`
@@ -931,7 +931,7 @@ The music database
This command may be used to list metadata of remote
files (e.g. URI beginning with "http://" or "smb://").
- Clients that are connected via UNIX domain socket may
+ Clients that are connected via local socket may
use this command to read the tags of an arbitrary local
file (URI is an absolute path).
@@ -1222,7 +1222,7 @@ Reflection
:command:`config`
Dumps configuration values that may be interesting for
the client. This command is only permitted to "local"
- clients (connected via UNIX domain socket).
+ clients (connected via local socket).
The following response attributes are available:
diff --git a/src/config/Net.hxx b/src/config/Net.hxx
index 2b40d966c..b077f883e 100644
--- a/src/config/Net.hxx
+++ b/src/config/Net.hxx
@@ -23,14 +23,14 @@
class ServerSocket;
/**
- * Sets the address or unix socket of a ServerSocket instance
+ * Sets the address or local socket of a ServerSocket instance
* There are three possible ways
* 1) Set address to a valid ip address and specify port.
* server_socket will listen on this address/port tuple.
* 2) Set address to null and specify port.
* server_socket will listen on ANY address on that port.
- * 3) Set address to a path of a unix socket. port is ignored.
- * server_socket will listen on this unix socket.
+ * 3) Set address to a path of a local socket. port is ignored.
+ * server_socket will listen on this local socket.
*
* Throws #std::runtime_error on error.
*
diff --git a/src/event/ServerSocket.cxx b/src/event/ServerSocket.cxx
index 73e070c9e..38f84b873 100644
--- a/src/event/ServerSocket.cxx
+++ b/src/event/ServerSocket.cxx
@@ -392,7 +392,7 @@ ServerSocket::AddPath(AllocatedPath &&path)
#else /* !HAVE_UN */
(void)path;
- throw std::runtime_error("UNIX domain socket support is disabled");
+ throw std::runtime_error("Local socket support is disabled");
#endif /* !HAVE_UN */
}
diff --git a/src/event/ServerSocket.hxx b/src/event/ServerSocket.hxx
index 8a36dded7..91c129458 100644
--- a/src/event/ServerSocket.hxx
+++ b/src/event/ServerSocket.hxx
@@ -90,7 +90,7 @@ public:
void AddHost(const char *hostname, unsigned port);
/**
- * Add a listener on a Unix domain socket.
+ * Add a listener on a local socket.
*
* Throws #std::runtime_error on error.
*
diff --git a/src/net/SocketUtil.cxx b/src/net/SocketUtil.cxx
index f2910e7a0..94ce47d0d 100644
--- a/src/net/SocketUtil.cxx
+++ b/src/net/SocketUtil.cxx
@@ -35,7 +35,7 @@ socket_bind_listen(int domain, int type, int protocol,
throw MakeSocketError("Failed to create socket");
#ifdef HAVE_UN
- if (domain == AF_UNIX) {
+ if (domain == AF_LOCAL) {
/* Prevent access until right permissions are set */
fchmod(fd.Get(), 0);
}
diff --git a/src/net/SocketUtil.hxx b/src/net/SocketUtil.hxx
index e27ae89b4..873ec4861 100644
--- a/src/net/SocketUtil.hxx
+++ b/src/net/SocketUtil.hxx
@@ -32,7 +32,7 @@ class SocketAddress;
/**
* Creates a socket listening on the specified address. This is a
* shortcut for socket(), bind() and listen().
- * When a unix socket is created (domain == AF_UNIX), its
+ * When a local socket is created (domain == AF_LOCAL), its
* permissions will be stripped down to prevent unauthorized
* access. The caller is responsible to apply proper permissions
* at a later point.
diff --git a/src/net/ToString.cxx b/src/net/ToString.cxx
index abfbd88d5..e9867d835 100644
--- a/src/net/ToString.cxx
+++ b/src/net/ToString.cxx
@@ -106,7 +106,7 @@ ToString(SocketAddress address) noexcept
{
#ifdef HAVE_UN
if (address.GetFamily() == AF_LOCAL)
- /* return path of UNIX domain sockets */
+ /* return path of local socket */
return LocalAddressToString(*(const sockaddr_un *)address.GetAddress(),
address.GetSize());
#endif