servers.h

Go to the documentation of this file.

/***********************************************************************
Copyright (c) 1996-2020 Freeciv21 and Freeciv contributors. This file is
 /\/\             part of Freeciv21. Freeciv21 is free software: you can
   \_\  _..._    redistribute it and/or modify it under the terms of the
   (" )(_..._)      GNU General Public License  as published by the Free
    ^^  // \\      Software Foundation, either version 3 of the License,
                  or (at your option) any later version. You should have
received a copy of the GNU General Public License along with Freeciv21.
                              If not, see https://www.gnu.org/licenses/.
***********************************************************************/
 
#pragma once
 
#include <QNetworkDatagram>
#include <QUdpSocket>
 
#define SERVER_LAN_PORT 4555
#define SERVER_LAN_TTL 1
#define SERVER_LAN_VERSION 2
 
enum server_scan_status {
  SCAN_STATUS_ERROR = 0,
  SCAN_STATUS_WAITING,
  SCAN_STATUS_PARTIAL,
  SCAN_STATUS_DONE,
  SCAN_STATUS_ABORT
};
 
class fcUdpScan : public QUdpSocket {
public:
  static void drop();
  static fcUdpScan *i();
  ~fcUdpScan() override = default;
  ;
  bool begin_scan(struct server_scan *scan);
  enum server_scan_status get_server_list(struct server_scan *scan);
public slots:
  void readPendingDatagrams();
private slots:
  void sockError(QAbstractSocket::SocketError socketError);
 
private:
  struct server_scan *fcudp_scan;
  fcUdpScan(QObject *parent = 0);
  static fcUdpScan *m_instance;
  QList<QNetworkDatagram> datagram_list;
};
 
struct str_players {
  char *name;
  char *type;
  char *host;
  char *nation;
};
struct server {
  char *host;
  int port;
  char *capability;
  char *patches;
  char *version;
  char *state;
  char *topic;
  char *message;
  str_players *players;
  int nplayers;
  int humans;
};
 
#define SPECLIST_TAG server
#define SPECLIST_TYPE struct server
#include "speclist.h"
 
#define server_list_iterate(serverlist, pserver)                            \
  TYPED_LIST_ITERATE(struct server, serverlist, pserver)
#define server_list_iterate_end LIST_ITERATE_END
 
struct server_scan;
 
enum server_scan_type {
  SERVER_SCAN_LOCAL,  // Local servers, detected through a LAN scan
  SERVER_SCAN_GLOBAL, // Global servers, read from the metaserver
  SERVER_SCAN_LAST
};
 
typedef void (*ServerScanErrorFunc)(struct server_scan *scan,
                                    const char *message);
 
struct server_scan *server_scan_begin(enum server_scan_type type,
                                      ServerScanErrorFunc error_func);
enum server_scan_type server_scan_get_type(const struct server_scan *scan);
enum server_scan_status server_scan_poll(struct server_scan *scan);
struct server_list *server_scan_get_list(struct server_scan *scan);
void server_scan_finish(struct server_scan *scan);