7a3f4edf4a
This is so that tests can use the logic without having to call in main as well. Furthermore, this way, Qt actually recognises it as a library, and makes it easier to import to tests.
75 lines
2.8 KiB
C++
75 lines
2.8 KiB
C++
//////////////////////////////////////////////////////////////////////////////////////
|
|
// akashi - a server for Attorney Online 2 //
|
|
// Copyright (C) 2020 scatterflower //
|
|
// //
|
|
// This program is free software: you can redistribute it and/or modify //
|
|
// it under the terms of the GNU Affero General Public License as //
|
|
// published by the Free Software Foundation, either version 3 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 Affero General Public License for more details. //
|
|
// //
|
|
// You should have received a copy of the GNU Affero General Public License //
|
|
// along with this program. If not, see <https://www.gnu.org/licenses/>. //
|
|
//////////////////////////////////////////////////////////////////////////////////////
|
|
#ifndef PACKET_MANAGER_H
|
|
#define PACKET_MANAGER_H
|
|
|
|
#include <QByteArray>
|
|
#include <QDebug>
|
|
#include <QString>
|
|
#include <QStringList>
|
|
|
|
/**
|
|
* @brief An Attorney Online 2 compatible packet.
|
|
*
|
|
* @see https://github.com/AttorneyOnline/docs/blob/master/docs/development/network.md for a general explanation
|
|
* on Attorney Online 2's network protocol.
|
|
*/
|
|
class AOPacket {
|
|
public:
|
|
/**
|
|
* @brief Creates an AOPacket with the given header and contents.
|
|
*
|
|
* @param p_header The header for the packet.
|
|
* @param p_contents The contents of the packet.
|
|
*/
|
|
AOPacket(QString p_header, QStringList p_contents);
|
|
|
|
/**
|
|
* @brief AOPacket Interprets a string of a full (header + content) packet into an AOPacket.
|
|
*
|
|
* @param packet The string to interpret.
|
|
*/
|
|
AOPacket(QString packet);
|
|
|
|
/**
|
|
* @brief Returns the string representation of the packet.
|
|
*
|
|
* @return See brief description.
|
|
*/
|
|
QString toString();
|
|
|
|
/**
|
|
* @brief Convenience function over AOPacket::toString() + QString::toUtf8().
|
|
*
|
|
* @return A UTF-8 representation of the packet.
|
|
*/
|
|
QByteArray toUtf8();
|
|
|
|
/**
|
|
* @brief The string that indentifies the type of the packet.
|
|
*/
|
|
QString header;
|
|
|
|
/**
|
|
* @brief The list of parameters for the packet. Can be empty.
|
|
*/
|
|
QStringList contents;
|
|
};
|
|
|
|
#endif // PACKET_MANAGER_H
|