Mamanyonyo/akashi-esquizolandia
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix documentation and weird formatting

Browse Source
This commit is contained in:
Salanto 2021-07-10 16:58:15 +02:00
parent 8994ba2626
commit e109c6b4df
2 changed files with 26 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
core/include/http_advertiser.h
View File

@ -34,17 +34,22 @@ public:
*/
explicit HTTPAdvertiser();
/**
* @brief Deconstructor for the HTTP_Advertiser class. Yes, that's it. Can't say more about it.
*/
~HTTPAdvertiser();
public slots:
/**
* @brief msAdvertiseServer Establishes a connection with masterserver to
* register or update the listing on the masterserver.
* @brief Establishes a connection with masterserver to register or update the listing on the masterserver.
*/
void msAdvertiseServer();
/**
* @brief msRequestFinished Reads the information send as a reply for further
* error handling.
* @brief Reads the information send as a reply for further error handling.
* @param reply Response data from the masterserver. Information contained is send to the console if debug is enabled.
*/
void msRequestFinished(QNetworkReply *reply);
@ -62,42 +67,42 @@ public slots:
private:
/**
* @brief m_manager NetworkAccessManager for HTTP Advertiser.
* @brief Pointer to the network manager, necessary to execute POST requests to the masterserver.
*/
QNetworkAccessManager* m_manager;
/**
* @brief m_name Current name of the server.
* @brief Name of the server send to the masterserver. Changing this will change the display name in the serverlist
*/
QString m_name;
/**
* @brief m_description Current description of the server.
* @brief Description of the server that is displayed in the client when the server is selected.
*/
QString m_description;
/**
* @brief m_port Current port for AO2-Clients.
* @brief Client port for the AO2-Client.
*/
int m_port;
/**
* @brief m_ws_port Websocket proxy port for WebAO-Clients.
* @brief Websocket proxy port for WebAO users.
*/
int m_ws_port;
/**
* @brief m_players Maximum number of connected clients.
* @brief Maximum amount of clients that can be connected to the server.
*/
int m_players;
/**
* @brief m_masterserver URL of the masterserver being advertised to.
* @brief URL of the masterserver that m_manager posts to. This is almost never changed.
*/
QUrl m_masterserver;
/**
* @brief m_debug If debug information is displayed in console.
* @brief Controls if network replies are printed to console. Should only be true if issues communicating with masterserver appear.
*/
bool m_debug;
};

12
core/src/http_advertiser.cpp
View File

@ -7,23 +7,29 @@ HTTPAdvertiser::HTTPAdvertiser()
this, &HTTPAdvertiser::msRequestFinished);
}
HTTPAdvertiser::~HTTPAdvertiser()
{
m_manager->deleteLater();
}
void HTTPAdvertiser::msAdvertiseServer()
{
if (m_masterserver.isValid()) {
QNetworkRequest request((QUrl (m_masterserver)));
QUrl url(m_masterserver);
QNetworkRequest request(url);
request.setHeader(QNetworkRequest::ContentTypeHeader, "application/json");
QJsonObject json;
json["port"] = m_port;
if (!(m_ws_port == -1)) {
if (m_ws_port != -1) {
json["ws_port"] = m_ws_port;
}
json["players"] = m_players;
json["name"] = m_name;
if (!(m_description.isEmpty())) {
if (!m_description.isEmpty()) {
json["description"] = m_description;
}