X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcore%2Fcorebasichandler.h;h=acd05c1f41a862a4bb947476e23a39400c637b61;hp=d04beed2d2665c8b56c15c16af10489ad0288be8;hb=ee8b9f55860e340c1600188fddcfd557c7489f66;hpb=513c0edce6f4c69f16e6a00c144877e8d5940096

diff --git a/src/core/corebasichandler.h b/src/core/corebasichandler.h
index d04beed2..acd05c1f 100644
--- a/src/core/corebasichandler.h
+++ b/src/core/corebasichandler.h
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2005-10 by the Quassel Project                          *
+ *   Copyright (C) 2005-2018 by the Quassel Project                        *
  *   devel@quassel-irc.org                                                 *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
@@ -15,7 +15,7 @@
  *   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.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *
  ***************************************************************************/
 
 #ifndef COREBASICHANDLER_H
@@ -31,41 +31,75 @@
 
 class CoreSession;
 
-class CoreBasicHandler : public BasicHandler {
-  Q_OBJECT
+class CoreBasicHandler : public BasicHandler
+{
+    Q_OBJECT
 
 public:
-  CoreBasicHandler(CoreNetwork *parent = 0);
-
-  QString serverDecode(const QByteArray &string);
-  QStringList serverDecode(const QList<QByteArray> &stringlist);
-  QString channelDecode(const QString &bufferName, const QByteArray &string);
-  QStringList channelDecode(const QString &bufferName, const QList<QByteArray> &stringlist);
-  QString userDecode(const QString &userNick, const QByteArray &string);
-  QStringList userDecode(const QString &userNick, const QList<QByteArray> &stringlist);
-
-  QByteArray serverEncode(const QString &string);
-  QList<QByteArray> serverEncode(const QStringList &stringlist);
-  QByteArray channelEncode(const QString &bufferName, const QString &string);
-  QList<QByteArray> channelEncode(const QString &bufferName, const QStringList &stringlist);
-  QByteArray userEncode(const QString &userNick, const QString &string);
-  QList<QByteArray> userEncode(const QString &userNick, const QStringList &stringlist);
+    CoreBasicHandler(CoreNetwork *parent = 0);
+
+    QString serverDecode(const QByteArray &string);
+    QStringList serverDecode(const QList<QByteArray> &stringlist);
+    QString channelDecode(const QString &bufferName, const QByteArray &string);
+    QStringList channelDecode(const QString &bufferName, const QList<QByteArray> &stringlist);
+    QString userDecode(const QString &userNick, const QByteArray &string);
+    QStringList userDecode(const QString &userNick, const QList<QByteArray> &stringlist);
+
+    QByteArray serverEncode(const QString &string);
+    QList<QByteArray> serverEncode(const QStringList &stringlist);
+    QByteArray channelEncode(const QString &bufferName, const QString &string);
+    QList<QByteArray> channelEncode(const QString &bufferName, const QStringList &stringlist);
+    QByteArray userEncode(const QString &userNick, const QString &string);
+    QList<QByteArray> userEncode(const QString &userNick, const QStringList &stringlist);
 
 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<QByteArray> &params, const QByteArray &prefix = QByteArray());
-  void putRawLine(const QByteArray &msg);
+    void displayMsg(Message::Type, BufferInfo::Type, const QString &target, const QString &text, const QString &sender = "", Message::Flags flags = Message::None);
+
+    /**
+     * 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<QByteArray> &params, const QByteArray &prefix = QByteArray(), const bool prepend = false)
+     */
+    void putCmd(const QString &cmd, const QList<QByteArray> &params, 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<QList<QByteArray>> &params, const QByteArray &prefix = QByteArray(), const bool prepend = false)
+     */
+    void putCmd(const QString &cmd, const QList<QList<QByteArray>> &params, const QByteArray &prefix = QByteArray(), const bool prepend = false);
 
 protected:
-  void displayMsg(Message::Type, QString target, const QString &text, const QString &sender = "", Message::Flags flags = Message::None);
-  void putCmd(const QString &cmd, const QByteArray &param, 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 &param, const QByteArray &prefix = QByteArray(), const bool prepend = false);
 
-  inline CoreNetwork *network() const { return _network; }
-  inline CoreSession *coreSession() const { return _network->coreSession(); }
+    inline CoreNetwork *network() const { return _network; }
+    inline CoreSession *coreSession() const { return _network->coreSession(); }
 
-  BufferInfo::Type typeByTarget(const QString &target) const;
+    BufferInfo::Type typeByTarget(const QString &target) const;
 
 private:
-  CoreNetwork *_network;
+    CoreNetwork *_network;
 };
+
+
 #endif