1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
|
/*
* Copyright 2003-2021 The Music Player Daemon Project
* http://www.musicpd.org
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#ifndef MPD_RESPONSE_HXX
#define MPD_RESPONSE_HXX
#include "protocol/Ack.hxx"
#include "util/Compiler.h"
#include <cstdarg>
#include <cstddef>
template<typename T> struct ConstBuffer;
class Client;
class TagMask;
class Response {
Client &client;
/**
* This command's index in the command list. Used to generate
* error messages.
*/
const unsigned list_index;
/**
* This command's name. Used to generate error messages.
*/
const char *command = "";
public:
Response(Client &_client, unsigned _list_index) noexcept
:client(_client), list_index(_list_index) {}
Response(const Response &) = delete;
Response &operator=(const Response &) = delete;
/**
* Returns a const reference to the associated #Client object.
* This should only be used to access a client's settings, to
* determine how to format the response. For this reason, the
* returned reference is "const".
*/
const Client &GetClient() const noexcept {
return client;
}
/**
* Accessor for Client::tag_mask. Can be used if caller wants
* to avoid including Client.hxx.
*/
gcc_pure
TagMask GetTagMask() const noexcept;
void SetCommand(const char *_command) noexcept {
command = _command;
}
bool Write(const void *data, size_t length) noexcept;
bool Write(const char *data) noexcept;
bool FormatV(const char *fmt, std::va_list args) noexcept;
gcc_printf(2,3)
bool Format(const char *fmt, ...) noexcept;
static constexpr size_t MAX_BINARY_SIZE = 8192;
/**
* Write a binary chunk; this writes the "binary" line, the
* given chunk and the trailing newline.
*
* @return true on success
*/
bool WriteBinary(ConstBuffer<void> payload) noexcept;
void Error(enum ack code, const char *msg) noexcept;
void FormatError(enum ack code, const char *fmt, ...) noexcept;
};
#endif
|
