event/ServerSocket, doc, ...: refer to AF_LOCAL as "local socket"
.. and not "UNIX domain socket. Be consistent about the naming.
This commit is contained in:
parent
7de8fd04a4
commit
4f408bd952
@ -849,7 +849,7 @@ It is highly recommended to configure a fixed format, because a stream cannot sw
|
|||||||
* - **port P**
|
* - **port P**
|
||||||
- Binds the HTTP server to the specified port.
|
- Binds the HTTP server to the specified port.
|
||||||
* - **bind_to_address ADDR**
|
* - **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**
|
* - **encoder NAME**
|
||||||
- Chooses an encoder plugin. A list of encoder plugins can be found in the encoder plugin reference :ref:`encoder_plugins`.
|
- Chooses an encoder plugin. A list of encoder plugins can be found in the encoder plugin reference :ref:`encoder_plugins`.
|
||||||
* - **max_clients MC**
|
* - **max_clients MC**
|
||||||
|
@ -721,7 +721,7 @@ run playlist plugins instead of the hard-coded simple
|
|||||||
`m3u` parser. They can access playlists in
|
`m3u` parser. They can access playlists in
|
||||||
the music directory (relative path including the suffix),
|
the music directory (relative path including the suffix),
|
||||||
playlists in arbitrary location (absolute 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).
|
remote playlists (absolute URI with a supported scheme).
|
||||||
|
|
||||||
:command:`listplaylist {NAME}`
|
:command:`listplaylist {NAME}`
|
||||||
@ -931,7 +931,7 @@ The music database
|
|||||||
This command may be used to list metadata of remote
|
This command may be used to list metadata of remote
|
||||||
files (e.g. URI beginning with "http://" or "smb://").
|
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
|
use this command to read the tags of an arbitrary local
|
||||||
file (URI is an absolute path).
|
file (URI is an absolute path).
|
||||||
|
|
||||||
@ -1222,7 +1222,7 @@ Reflection
|
|||||||
:command:`config`
|
:command:`config`
|
||||||
Dumps configuration values that may be interesting for
|
Dumps configuration values that may be interesting for
|
||||||
the client. This command is only permitted to "local"
|
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:
|
The following response attributes are available:
|
||||||
|
|
||||||
|
@ -23,14 +23,14 @@
|
|||||||
class ServerSocket;
|
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
|
* There are three possible ways
|
||||||
* 1) Set address to a valid ip address and specify port.
|
* 1) Set address to a valid ip address and specify port.
|
||||||
* server_socket will listen on this address/port tuple.
|
* server_socket will listen on this address/port tuple.
|
||||||
* 2) Set address to null and specify port.
|
* 2) Set address to null and specify port.
|
||||||
* server_socket will listen on ANY address on that port.
|
* server_socket will listen on ANY address on that port.
|
||||||
* 3) Set address to a path of a unix socket. port is ignored.
|
* 3) Set address to a path of a local socket. port is ignored.
|
||||||
* server_socket will listen on this unix socket.
|
* server_socket will listen on this local socket.
|
||||||
*
|
*
|
||||||
* Throws #std::runtime_error on error.
|
* Throws #std::runtime_error on error.
|
||||||
*
|
*
|
||||||
|
@ -392,7 +392,7 @@ ServerSocket::AddPath(AllocatedPath &&path)
|
|||||||
#else /* !HAVE_UN */
|
#else /* !HAVE_UN */
|
||||||
(void)path;
|
(void)path;
|
||||||
|
|
||||||
throw std::runtime_error("UNIX domain socket support is disabled");
|
throw std::runtime_error("Local socket support is disabled");
|
||||||
#endif /* !HAVE_UN */
|
#endif /* !HAVE_UN */
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -90,7 +90,7 @@ public:
|
|||||||
void AddHost(const char *hostname, unsigned port);
|
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.
|
* Throws #std::runtime_error on error.
|
||||||
*
|
*
|
||||||
|
@ -35,7 +35,7 @@ socket_bind_listen(int domain, int type, int protocol,
|
|||||||
throw MakeSocketError("Failed to create socket");
|
throw MakeSocketError("Failed to create socket");
|
||||||
|
|
||||||
#ifdef HAVE_UN
|
#ifdef HAVE_UN
|
||||||
if (domain == AF_UNIX) {
|
if (domain == AF_LOCAL) {
|
||||||
/* Prevent access until right permissions are set */
|
/* Prevent access until right permissions are set */
|
||||||
fchmod(fd.Get(), 0);
|
fchmod(fd.Get(), 0);
|
||||||
}
|
}
|
||||||
|
@ -32,7 +32,7 @@ class SocketAddress;
|
|||||||
/**
|
/**
|
||||||
* Creates a socket listening on the specified address. This is a
|
* Creates a socket listening on the specified address. This is a
|
||||||
* shortcut for socket(), bind() and listen().
|
* 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
|
* permissions will be stripped down to prevent unauthorized
|
||||||
* access. The caller is responsible to apply proper permissions
|
* access. The caller is responsible to apply proper permissions
|
||||||
* at a later point.
|
* at a later point.
|
||||||
|
@ -106,7 +106,7 @@ ToString(SocketAddress address) noexcept
|
|||||||
{
|
{
|
||||||
#ifdef HAVE_UN
|
#ifdef HAVE_UN
|
||||||
if (address.GetFamily() == AF_LOCAL)
|
if (address.GetFamily() == AF_LOCAL)
|
||||||
/* return path of UNIX domain sockets */
|
/* return path of local socket */
|
||||||
return LocalAddressToString(*(const sockaddr_un *)address.GetAddress(),
|
return LocalAddressToString(*(const sockaddr_un *)address.GetAddress(),
|
||||||
address.GetSize());
|
address.GetSize());
|
||||||
#endif
|
#endif
|
||||||
|
Loading…
Reference in New Issue
Block a user