X-Git-Url: https://git.quassel-irc.org/?a=blobdiff_plain;ds=sidebyside;f=src%2Fcore%2Fcorebasichandler.h;h=4c41dded19be704071c5227389a51cdd08a91da5;hb=106d151d994fb26fd4586c6adf60a165075961a9;hp=20d057fc4d49fc3d19a686abec5c610fe2d8e2bd;hpb=695758015a80eb8c158a9ac4c0f1c0b547e70df3;p=quassel.git diff --git a/src/core/corebasichandler.h b/src/core/corebasichandler.h index 20d057fc..4c41dded 100644 --- a/src/core/corebasichandler.h +++ b/src/core/corebasichandler.h @@ -54,11 +54,43 @@ public: signals: void displayMsg(Message::Type, BufferInfo::Type, const QString &target, const QString &text, const QString &sender = "", Message::Flags flags = Message::None); - void putCmd(const QString &cmd, const QList ¶ms, const QByteArray &prefix = QByteArray()); - void putRawLine(const QByteArray &msg); + + /** + * Sends the raw (encoded) line, adding to the queue if needed, optionally with higher priority. + * + * @see CoreNetwork::putRawLine() + */ + void putRawLine(const QByteArray &msg, const bool prepend = false); + + /** + * Sends the command with encoded parameters, with optional prefix or high priority. + * + * @see CoreNetwork::putCmd(const QString &cmd, const QList ¶ms, const QByteArray &prefix = QByteArray(), const bool prepend = false) + */ + void putCmd(const QString &cmd, const QList ¶ms, const QByteArray &prefix = QByteArray(), const bool prepend = false); + + /** + * Sends the command for each set of encoded parameters, with optional prefix or high priority. + * + * @see CoreNetwork::putCmd(const QString &cmd, const QList> ¶ms, const QByteArray &prefix = QByteArray(), const bool prepend = false) + */ + void putCmd(const QString &cmd, const QList> ¶ms, const QByteArray &prefix = QByteArray(), const bool prepend = false); protected: - void putCmd(const QString &cmd, const QByteArray ¶m, const QByteArray &prefix = QByteArray()); + /** + * Sends the command with one parameter, with optional prefix or high priority. + * + * @param[in] cmd Command to send, ignoring capitalization + * @param[in] param Parameter for the command, encoded within a QByteArray + * @param[in] prefix Optional command prefix + * @param[in] prepend + * @parmblock + * If true, the command is prepended into the start of the queue, otherwise, it's appended to + * the end. This should be used sparingly, for if either the core or the IRC server cannot + * maintain PING/PONG replies, the other side will close the connection. + * @endparmblock + */ + void putCmd(const QString &cmd, const QByteArray ¶m, const QByteArray &prefix = QByteArray(), const bool prepend = false); inline CoreNetwork *network() const { return _network; } inline CoreSession *coreSession() const { return _network->coreSession(); }