#include <Client.hxx>
Definition at line 47 of file Client.hxx.
◆ SubscribeResult
Enumerator |
---|
OK | success
|
INVALID | invalid channel name
|
ALREADY | already subscribed to this channel
|
FULL | too many subscriptions
|
Definition at line 148 of file Client.hxx.
◆ Client()
◆ ~Client()
◆ AllowFile()
void Client::AllowFile |
( |
Path |
path_fs | ) |
const |
Is this client allowed to use the specified local file?
Note that this function is vulnerable to timing/symlink attacks. We cannot fix this as long as there are plugins that open a file by its name, and not by file descriptor / callbacks.
Throws #std::runtime_error on error.
- Parameters
-
path_fs | the absolute path name in filesystem encoding |
◆ Close()
◆ GetDatabase()
Wrapper for Instance::GetDatabase().
◆ GetDatabaseOrThrow()
const Database& Client::GetDatabaseOrThrow |
( |
| ) |
const |
Wrapper for Instance::GetDatabaseOrThrow().
◆ GetPermission()
unsigned Client::GetPermission |
( |
| ) |
const |
|
inline |
◆ GetStorage()
◆ GetUID()
int Client::GetUID |
( |
| ) |
const |
|
inline |
returns the uid of the client process, or a negative value if the uid is unknown
Definition at line 121 of file Client.hxx.
◆ IdleAdd()
void Client::IdleAdd |
( |
unsigned |
flags | ) |
|
◆ IdleNotify()
void Client::IdleNotify |
( |
| ) |
|
Send "idle" response to this client.
◆ IdleWait()
bool Client::IdleWait |
( |
unsigned |
flags | ) |
|
◆ IsConnected()
bool Client::IsConnected |
( |
| ) |
const |
|
inline |
◆ IsExpired()
gcc_pure bool Client::IsExpired |
( |
| ) |
const |
|
inlinenoexcept |
◆ IsLocal()
bool Client::IsLocal |
( |
| ) |
const |
|
inline |
Is this client running on the same machine, connected with a local (UNIX domain) socket?
Definition at line 129 of file Client.hxx.
◆ IsSubscribed()
gcc_pure bool Client::IsSubscribed |
( |
const char * |
channel_name | ) |
const |
|
inlinenoexcept |
◆ PushMessage()
◆ SetExpired()
void Client::SetExpired |
( |
| ) |
|
◆ SetPermission()
void Client::SetPermission |
( |
unsigned |
_permission | ) |
|
|
inline |
◆ Subscribe()
◆ Unsubscribe()
bool Client::Unsubscribe |
( |
const char * |
channel | ) |
|
◆ UnsubscribeAll()
void Client::UnsubscribeAll |
( |
| ) |
|
◆ Write() [1/2]
bool Client::Write |
( |
const void * |
data, |
|
|
size_t |
length |
|
) |
| |
◆ Write() [2/2]
bool Client::Write |
( |
const char * |
data | ) |
|
Write a null-terminated string.
◆ cmd_list
◆ idle_flags
unsigned Client::idle_flags |
idle flags pending on this client, to be sent as soon as the client enters "idle"
Definition at line 69 of file Client.hxx.
◆ idle_subscriptions
unsigned Client::idle_subscriptions |
idle flags that the client wants to receive
Definition at line 72 of file Client.hxx.
◆ idle_waiting
bool Client::idle_waiting |
is this client waiting for an "idle" response?
Definition at line 65 of file Client.hxx.
◆ messages
A list of messages this client has received.
Definition at line 88 of file Client.hxx.
◆ num
◆ num_subscriptions
unsigned Client::num_subscriptions |
The number of subscriptions in subscriptions.
Used to limit the number of subscriptions.
Definition at line 83 of file Client.hxx.
◆ partition
◆ permission
unsigned Client::permission |
◆ player_control
◆ playlist
◆ subscriptions
std::set<std::string> Client::subscriptions |
A list of channel names this client is subscribed to.
Definition at line 77 of file Client.hxx.
◆ uid
the uid of the client process, or -1 if unknown
Definition at line 58 of file Client.hxx.
The documentation for this class was generated from the following file: