pilotclient/src/blackcore/fsd/killrequest.h

/* Copyright (C) 2019
 * swift project community / contributors
 *
 * This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
 * directory of this distribution. No part of swift project, including this file, may be copied, modified, propagated,
 * or distributed except according to the terms contained in the LICENSE file.
 */

//! \file

#ifndef BLACKCORE_FSD_KILLREQUEST_H
#define BLACKCORE_FSD_KILLREQUEST_H

#include "messagebase.h"

namespace BlackCore
{
    namespace Fsd
    {
        //! Kill request initiated from the server or supervisor.
        //! Client needs to disconnect immediatly upon receiving it.
        class BLACKCORE_EXPORT KillRequest : public MessageBase
        {
        public:
            //! Constructor
            KillRequest(const QString &sender, const QString &receiver, const QString &reason);

            //! Message converted to tokens
            QStringList toTokens() const;

            //! Construct from tokens
            static KillRequest fromTokens(const QStringList &tokens);

            //! PDU identifier
            static QString pdu() { return "$!!"; }

            QString m_reason; //!< reason for kill request/kicked

        private:
            KillRequest();
        };

        //! Equal to operator
        inline bool operator==(const KillRequest &lhs, const KillRequest &rhs)
        {
            return  lhs.sender() == rhs.sender() &&
                    lhs.receiver() == rhs.receiver() &&
                    lhs.m_reason == rhs.m_reason;
        }

        //! Not equal to operator
        inline bool operator!=(const KillRequest &lhs, const KillRequest &rhs)
        {
            return !(lhs == rhs);
        }
    }
}

#endif // guard