Freeciv21
Develop your civilization from humble roots to a global empire
meta.h File Reference
#include "support.h"
+ Include dependency graph for meta.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define DEFAULT_META_SERVER_NO_SEND   true
 
#define DEFAULT_META_SERVER_ADDR   FREECIV_META_URL
 
#define METASERVER_REFRESH_INTERVAL   (3 * 60)
 
#define METASERVER_MIN_UPDATE_INTERVAL   7
 

Enumerations

enum  meta_flag { META_INFO , META_REFRESH , META_GOODBYE }
 

Functions

const char * default_meta_patches_string ()
 The default metaserver patches for this server. More...
 
const char * default_meta_message_string ()
 Return static string with default info line to send to metaserver. More...
 
const char * get_meta_patches_string ()
 The metaserver patches. More...
 
const char * get_meta_message_string ()
 The metaserver message. More...
 
const char * get_user_meta_message_string ()
 The metaserver message set by user. More...
 
void maybe_automatic_meta_message (const char *automatic)
 Update meta message. More...
 
void set_meta_patches_string (const char *string)
 Set the metaserver patches string. More...
 
void set_meta_message_string (const char *string)
 Set the metaserver message string. More...
 
void set_user_meta_message_string (const char *string)
 Set user defined metaserver message string. More...
 
QString meta_addr_port ()
 Return string describing both metaserver name and port. More...
 
void server_close_meta ()
 Stop sending updates to metaserver. More...
 
bool server_open_meta (bool persistent)
 Lookup the correct address for the metaserver. More...
 
bool is_metaserver_open ()
 Are we sending info to the metaserver? More...
 
bool send_server_info_to_metaserver (enum meta_flag flag)
 Control when we send info to the metaserver. More...
 

Macro Definition Documentation

◆ DEFAULT_META_SERVER_ADDR

#define DEFAULT_META_SERVER_ADDR   FREECIV_META_URL

Definition at line 21 of file meta.h.

◆ DEFAULT_META_SERVER_NO_SEND

#define DEFAULT_META_SERVER_NO_SEND   true

Definition at line 20 of file meta.h.

◆ METASERVER_MIN_UPDATE_INTERVAL

#define METASERVER_MIN_UPDATE_INTERVAL   7

Definition at line 23 of file meta.h.

◆ METASERVER_REFRESH_INTERVAL

#define METASERVER_REFRESH_INTERVAL   (3 * 60)

Definition at line 22 of file meta.h.

Enumeration Type Documentation

◆ meta_flag

enum meta_flag
Enumerator
META_INFO 
META_REFRESH 
META_GOODBYE 

Definition at line 25 of file meta.h.

Function Documentation

◆ default_meta_message_string()

const char* default_meta_message_string ( )

Return static string with default info line to send to metaserver.

Definition at line 63 of file meta.cpp.

Referenced by establish_new_connection(), server_open_meta(), set_user_meta_message_string(), and write_init_script().

◆ default_meta_patches_string()

const char* default_meta_patches_string ( )

The default metaserver patches for this server.

Definition at line 58 of file meta.cpp.

Referenced by server_open_meta(), sg_load_game(), and write_init_script().

◆ get_meta_message_string()

const char* get_meta_message_string ( )

The metaserver message.

Definition at line 80 of file meta.cpp.

Referenced by send_lanserver_response(), send_to_metaserver(), and write_init_script().

◆ get_meta_patches_string()

const char* get_meta_patches_string ( )

The metaserver patches.

Definition at line 75 of file meta.cpp.

Referenced by send_to_metaserver(), sg_save_game(), and write_init_script().

◆ get_user_meta_message_string()

const char* get_user_meta_message_string ( )

The metaserver message set by user.

Definition at line 97 of file meta.cpp.

Referenced by maybe_automatic_meta_message().

◆ is_metaserver_open()

bool is_metaserver_open ( )

Are we sending info to the metaserver?

Definition at line 464 of file meta.cpp.

Referenced by metaconnection_command(), metamessage_action(), metamessage_command(), and metapatches_command().

◆ maybe_automatic_meta_message()

void maybe_automatic_meta_message ( const char *  automatic)

Update meta message.

Set it to user meta message, if it is available. Otherwise use provided message. It is ok to call this with nullptr message. Then it only replaces current meta message with user meta message if available.

Definition at line 112 of file meta.cpp.

Referenced by establish_new_connection().

◆ meta_addr_port()

QString meta_addr_port ( )

Return string describing both metaserver name and port.

Definition at line 163 of file meta.cpp.

Referenced by close_metaserver_connection(), metaserver_command(), open_metaserver_connection(), sg_save_game(), and write_init_script().

◆ send_server_info_to_metaserver()

◆ server_close_meta()

void server_close_meta ( )

Stop sending updates to metaserver.

Definition at line 436 of file meta.cpp.

Referenced by close_connections_and_socket(), close_metaserver_connection(), and metaserver_failed().

◆ server_open_meta()

bool server_open_meta ( bool  persistent)

Lookup the correct address for the metaserver.

Definition at line 445 of file meta.cpp.

Referenced by open_metaserver_connection().

◆ set_meta_message_string()

void set_meta_message_string ( const char *  string)

◆ set_meta_patches_string()

void set_meta_patches_string ( const char *  string)

Set the metaserver patches string.

Definition at line 132 of file meta.cpp.

Referenced by metapatches_command(), server_open_meta(), and sg_load_game().

◆ set_user_meta_message_string()

void set_user_meta_message_string ( const char *  string)

Set user defined metaserver message string.

Definition at line 148 of file meta.cpp.

Referenced by metamessage_action(), and metamessage_command().