X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=blobdiff_plain;f=src%2Fcore%2Fnetsplit.h;fp=src%2Fcore%2Fnetsplit.h;h=b68cb8fcdaf9c148e2420546e231b413e9cd4498;hp=4b6b16009cde95bcdc296f38e13b8fbaf716c5a8;hb=694f9bfbf7f1af19108461c7e00d133e55082bce;hpb=61c8d84d1c849373e0f115dc748ed45cff95287d diff --git a/src/core/netsplit.h b/src/core/netsplit.h index 4b6b1600..b68cb8fc 100644 --- a/src/core/netsplit.h +++ b/src/core/netsplit.h @@ -30,113 +30,114 @@ class Network; class Netsplit : public QObject { - Q_OBJECT + Q_OBJECT public: - Netsplit(Network *network, QObject *parent = 0); - - inline Network *network() const { return _network; } - - //! Add a user to the netsplit - /** Call this method if you noticed a netsplit. - * \note This method doesn't check if it really is a netsplit. - * \note Check with isNetsplit(const QString &quitMessage) before calling it! - * - * \param sender The sender string of the quitting user - * \param channels The channels that user shared with us - * \param msg The quit message - */ - void userQuit(const QString &sender, const QStringList &channels, const QString &msg); - - //! Remove a user from the netsplit - /** Call this method if a user joined after a netsplit occured. - * - * \param sender The sender string of the joined user - * \param channel The channel that user shares with us - * \return true if user was found in the netsplit - */ - bool userJoined(const QString &sender, const QString &channel); - - //! Check if user has joined since netsplit - /** This method shows if a user has already joined after being hit by netsplit - * \note The method doesn't check if the user was recorded in the netsplit! - * - * \param sender The sender string of the user - * \param channel The channel the user shares with us - * \return true if user joined after a netsplit - */ - bool userAlreadyJoined(const QString &sender, const QString &channel); - - //! Add mode to user - /** Use this method to buffer userspecific channel modes until netsplitJoin is emitted. - * - * \param sender The sender string of the user - * \param channel The channel the user shares with us - * \return true if user joined after a netsplit - */ - void addMode(const QString &sender, const QString &channel, const QString &mode); - - //! Check if a string matches the criteria for a netsplit - /** \param quitMessage The message to be checked - * \return true if the message is a netsplit - */ - static bool isNetsplit(const QString &quitMessage); + Netsplit(Network *network, QObject *parent = 0); + + inline Network *network() const { return _network; } + + //! Add a user to the netsplit + /** Call this method if you noticed a netsplit. + * \note This method doesn't check if it really is a netsplit. + * \note Check with isNetsplit(const QString &quitMessage) before calling it! + * + * \param sender The sender string of the quitting user + * \param channels The channels that user shared with us + * \param msg The quit message + */ + void userQuit(const QString &sender, const QStringList &channels, const QString &msg); + + //! Remove a user from the netsplit + /** Call this method if a user joined after a netsplit occured. + * + * \param sender The sender string of the joined user + * \param channel The channel that user shares with us + * \return true if user was found in the netsplit + */ + bool userJoined(const QString &sender, const QString &channel); + + //! Check if user has joined since netsplit + /** This method shows if a user has already joined after being hit by netsplit + * \note The method doesn't check if the user was recorded in the netsplit! + * + * \param sender The sender string of the user + * \param channel The channel the user shares with us + * \return true if user joined after a netsplit + */ + bool userAlreadyJoined(const QString &sender, const QString &channel); + + //! Add mode to user + /** Use this method to buffer userspecific channel modes until netsplitJoin is emitted. + * + * \param sender The sender string of the user + * \param channel The channel the user shares with us + * \return true if user joined after a netsplit + */ + void addMode(const QString &sender, const QString &channel, const QString &mode); + + //! Check if a string matches the criteria for a netsplit + /** \param quitMessage The message to be checked + * \return true if the message is a netsplit + */ + static bool isNetsplit(const QString &quitMessage); signals: - //! A bulk-join of netsplitted users timed out - /** Whenever the internal join-timer times out, we consider the bulk-join to be finished and emit that signal - * for every channel. This is the end of a netsplit. - * \param net The network - * \param channel The IRC channel - * \param users A list of all users that joined that channel - * \param modes A list of all modes the users got set after joining again - * \param quitMessage The Quitmessage and thus the servers that got split - */ - void netsplitJoin(Network *net, const QString &channel, const QStringList &users, const QStringList &modes, const QString &quitMessage); - - //! A (probably bulk-) join of netsplitted users. - /** If users hit by the split joined before the netsplit is considered over, join the users with a normal join. - * \param net The network - * \param channel The IRC channel - * \param users A list of all users that joined that channel - * \param modes A list of all modes the users got set after joining again - */ - void earlyJoin(Network *net, const QString &channel, const QStringList &users, const QStringList &modes); - - //! A bulk-quit of netsplitted users timed out - /** Whenever the internal quit-timer times out, we consider the bulk-quit to be finished and emit that signal - * for every channel. - * \param net The network - * \param channel The IRC channel - * \param users A list of all users that quitted in that channel - * \param quitMessage The Quitmessage and thus the servers that got split - */ - void netsplitQuit(Network *net, const QString &channel, const QStringList &users, const QString &quitMessage); - - //! The Netsplit is considered finished - /** This signal is emitted right after all netsplitJoin signals have been sent or whenever the - * internal timer signals a timeout. - * Simply delete the object and remove it from structures when you receive that signal. - */ - void finished(); + //! A bulk-join of netsplitted users timed out + /** Whenever the internal join-timer times out, we consider the bulk-join to be finished and emit that signal + * for every channel. This is the end of a netsplit. + * \param net The network + * \param channel The IRC channel + * \param users A list of all users that joined that channel + * \param modes A list of all modes the users got set after joining again + * \param quitMessage The Quitmessage and thus the servers that got split + */ + void netsplitJoin(Network *net, const QString &channel, const QStringList &users, const QStringList &modes, const QString &quitMessage); + + //! A (probably bulk-) join of netsplitted users. + /** If users hit by the split joined before the netsplit is considered over, join the users with a normal join. + * \param net The network + * \param channel The IRC channel + * \param users A list of all users that joined that channel + * \param modes A list of all modes the users got set after joining again + */ + void earlyJoin(Network *net, const QString &channel, const QStringList &users, const QStringList &modes); + + //! A bulk-quit of netsplitted users timed out + /** Whenever the internal quit-timer times out, we consider the bulk-quit to be finished and emit that signal + * for every channel. + * \param net The network + * \param channel The IRC channel + * \param users A list of all users that quitted in that channel + * \param quitMessage The Quitmessage and thus the servers that got split + */ + void netsplitQuit(Network *net, const QString &channel, const QStringList &users, const QString &quitMessage); + + //! The Netsplit is considered finished + /** This signal is emitted right after all netsplitJoin signals have been sent or whenever the + * internal timer signals a timeout. + * Simply delete the object and remove it from structures when you receive that signal. + */ + void finished(); private slots: - void joinTimeout(); - void quitTimeout(); + void joinTimeout(); + void quitTimeout(); private: - Network *_network; - QString _quitMsg; - // key: channel name - // value: senderstring, list of modes - QHash > _joins; - QHash _quits; - QHash _quitsWithMessageSent; - bool _sentQuit; - QTimer _joinTimer; - QTimer _quitTimer; - QTimer _discardTimer; - int _joinCounter; - int _quitCounter; + Network *_network; + QString _quitMsg; + // key: channel name + // value: senderstring, list of modes + QHash > _joins; + QHash _quits; + QHash _quitsWithMessageSent; + bool _sentQuit; + QTimer _joinTimer; + QTimer _quitTimer; + QTimer _discardTimer; + int _joinCounter; + int _quitCounter; }; + #endif // NETSPLIT_H