Freeciv21
Develop your civilization from humble roots to a global empire
connection.h File Reference
#include <ctime>
#include <QList>
#include <QString>
#include "shared.h"
#include "support.h"
#include "timing.h"
#include "fc_types.h"
#include "specenum_gen.h"
#include "speclist.h"
#include "specvec.h"
+ Include dependency graph for connection.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  socket_packet_buffer
 
struct  packet_header
 
struct  connection
 

Macros

#define MAX_LEN_PACKET   4096
 
#define MAX_LEN_CAPSTR   512
 
#define MAX_LEN_PASSWORD
 
#define MAX_LEN_CONTENT   (MAX_LEN_PACKET - 20)
 
#define MAX_LEN_BUFFER   (MAX_LEN_PACKET * 128)
 
#define SPECENUM_NAME   cmdlevel
 
#define SPECENUM_VALUE0   ALLOW_NONE
 
#define SPECENUM_VALUE0NAME   "none"
 
#define SPECENUM_VALUE1   ALLOW_INFO
 
#define SPECENUM_VALUE1NAME   "info"
 
#define SPECENUM_VALUE2   ALLOW_BASIC
 
#define SPECENUM_VALUE2NAME   "basic"
 
#define SPECENUM_VALUE3   ALLOW_CTRL
 
#define SPECENUM_VALUE3NAME   "ctrl"
 
#define SPECENUM_VALUE4   ALLOW_ADMIN
 
#define SPECENUM_VALUE4NAME   "admin"
 
#define SPECENUM_VALUE5   ALLOW_HACK
 
#define SPECENUM_VALUE5NAME   "hack"
 
#define SPECENUM_COUNT   CMDLEVEL_COUNT
 
#define SPECLIST_TAG   conn
 
#define SPECLIST_TYPE   struct connection
 
#define conn_list_iterate(connlist, pconn)    TYPED_LIST_ITERATE(struct connection, connlist, pconn)
 
#define conn_list_iterate_end   LIST_ITERATE_END
 
#define SPECVEC_TAG   byte
 
#define SPECVEC_TYPE   unsigned char
 
#define SPECLIST_TAG   conn_pattern
 
#define SPECLIST_TYPE   struct conn_pattern
 
#define conn_pattern_list_iterate(plist, ppatern)    TYPED_LIST_ITERATE(struct conn_pattern, plist, ppatern)
 
#define conn_pattern_list_iterate_end   LIST_ITERATE_END
 
#define SPECENUM_NAME   conn_pattern_type
 
#define SPECENUM_VALUE0   CPT_USER
 
#define SPECENUM_VALUE0NAME   "user"
 
#define SPECENUM_VALUE1   CPT_HOST
 
#define SPECENUM_VALUE1NAME   "host"
 
#define SPECENUM_VALUE2   CPT_IP
 
#define SPECENUM_VALUE2NAME   "ip"
 

Typedefs

typedef void(* conn_close_fn_t) (struct connection *pconn)
 

Enumerations

enum  auth_status {
  AS_NOT_ESTABLISHED = 0 , AS_FAILED , AS_REQUESTING_NEW_PASS , AS_REQUESTING_OLD_PASS ,
  AS_ESTABLISHED
}
 

Functions

void connections_set_close_callback (conn_close_fn_t func)
 Register the close_callback. More...
 
void connection_close (struct connection *pconn, const QString &reason)
 Call the conn_close_callback. More...
 
int read_socket_data (QIODevice *sock, struct socket_packet_buffer *buffer)
 Read data from socket, and check if a packet is ready. More...
 
void flush_connection_send_buffer_all (struct connection *pc)
 Flush'em. More...
 
bool connection_send_data (struct connection *pconn, const unsigned char *data, int len)
 Write data to socket. More...
 
void connection_do_buffer (struct connection *pc)
 Turn on buffering, using a counter so that calls may be nested. More...
 
void connection_do_unbuffer (struct connection *pc)
 Turn off buffering if internal counter of number of times buffering was turned on falls to zero, to handle nested buffer/unbuffer pairs. More...
 
void conn_list_do_buffer (struct conn_list *dest)
 Convenience functions to buffer a list of connections. More...
 
void conn_list_do_unbuffer (struct conn_list *dest)
 Convenience functions to unbuffer a list of connections. More...
 
struct connectionconn_by_user (const char *user_name)
 Find connection by exact user name, from game.all_connections, case-insensitve. More...
 
struct connectionconn_by_user_prefix (const char *user_name, enum m_pre_result *result)
 
struct connectionconn_by_number (int id)
 Find connection by id, from game.all_connections. More...
 
struct socket_packet_buffernew_socket_packet_buffer ()
 Return malloced struct, appropriately initialized. More...
 
void connection_common_init (struct connection *pconn)
 Initialize common part of connection structure. More...
 
void connection_common_close (struct connection *pconn)
 Connection closing part common to server and client. More...
 
void conn_set_capability (struct connection *pconn, const char *capability)
 Set the network capability string for 'pconn'. More...
 
void free_compression_queue (struct connection *pconn)
 Free compression queue for given connection. More...
 
void conn_reset_delta_state (struct connection *pconn)
 Remove all is-game-info cached packets from the connection. More...
 
void conn_compression_freeze (struct connection *pconn)
 Freeze the connection. More...
 
bool conn_compression_thaw (struct connection *pconn)
 Thaw the connection. More...
 
bool conn_compression_frozen (const struct connection *pconn)
 Returns TRUE if the connection is frozen. More...
 
void conn_list_compression_freeze (const struct conn_list *pconn_list)
 Freeze a connection list. More...
 
void conn_list_compression_thaw (const struct conn_list *pconn_list)
 Thaw a connection list. More...
 
const char * conn_description (const struct connection *pconn, bool is_private=true)
 ° Return pointer to static string containing a description for this ° connection, based on pconn->name, pconn->addr, and (if applicable) ° pconn->playing->name. More...
 
bool conn_controls_player (const struct connection *pconn)
 Returns TRUE if the given connection is attached to a player which it also controls (i.e. More...
 
bool conn_is_global_observer (const struct connection *pconn)
 Returns TRUE if the given connection is a global observer. More...
 
enum cmdlevel conn_get_access (const struct connection *pconn)
 Returns the current access level of the given connection. More...
 
struct playerconn_get_player (const struct connection *pconn)
 Returns the player that this connection is attached to, or nullptr. More...
 
bool can_conn_edit (const struct connection *pconn)
 Return TRUE iff the connection is currently allowed to edit. More...
 
bool can_conn_enable_editing (const struct connection *pconn)
 Return TRUE iff the connection is allowed to start editing. More...
 
int get_next_request_id (int old_request_id)
 Get next request id. More...
 
struct conn_patternconn_pattern_new (enum conn_pattern_type type, const char *wildcard)
 Creates a new connection pattern. More...
 
void conn_pattern_destroy (struct conn_pattern *ppattern)
 Free a connection pattern. More...
 
bool conn_pattern_match (const struct conn_pattern *ppattern, const struct connection *pconn)
 Returns TRUE whether the connection fits the connection pattern. More...
 
bool conn_pattern_list_match (const struct conn_pattern_list *plist, const struct connection *pconn)
 Returns TRUE whether the connection fits one of the connection patterns. More...
 
size_t conn_pattern_to_string (const struct conn_pattern *ppattern, char *buf, size_t buf_len)
 Put a string reprentation of the pattern in 'buf'. More...
 
struct conn_patternconn_pattern_from_string (const char *pattern, enum conn_pattern_type prefer, char *error_buf, size_t error_buf_len)
 Creates a new connection pattern from the string. More...
 
bool conn_is_valid (const struct connection *pconn)
 Returns TRUE if the connection is valid, i.e. More...
 

Variables

const char blank_addr_str []
 

Macro Definition Documentation

◆ conn_list_iterate

#define conn_list_iterate (   connlist,
  pconn 
)     TYPED_LIST_ITERATE(struct connection, connlist, pconn)

Definition at line 99 of file connection.h.

◆ conn_list_iterate_end

#define conn_list_iterate_end   LIST_ITERATE_END

Definition at line 101 of file connection.h.

◆ conn_pattern_list_iterate

#define conn_pattern_list_iterate (   plist,
  ppatern 
)     TYPED_LIST_ITERATE(struct conn_pattern, plist, ppatern)

Definition at line 315 of file connection.h.

◆ conn_pattern_list_iterate_end

#define conn_pattern_list_iterate_end   LIST_ITERATE_END

Definition at line 317 of file connection.h.

◆ MAX_LEN_BUFFER

#define MAX_LEN_BUFFER   (MAX_LEN_PACKET * 128)

Definition at line 47 of file connection.h.

◆ MAX_LEN_CAPSTR

#define MAX_LEN_CAPSTR   512

Definition at line 42 of file connection.h.

◆ MAX_LEN_CONTENT

#define MAX_LEN_CONTENT   (MAX_LEN_PACKET - 20)

Definition at line 45 of file connection.h.

◆ MAX_LEN_PACKET

#define MAX_LEN_PACKET   4096

Definition at line 41 of file connection.h.

◆ MAX_LEN_PASSWORD

#define MAX_LEN_PASSWORD
Value:
512 /* do not change this under any circumstances \
*/

Definition at line 43 of file connection.h.

◆ SPECENUM_COUNT

#define SPECENUM_COUNT   CMDLEVEL_COUNT

Definition at line 74 of file connection.h.

◆ SPECENUM_NAME [1/2]

#define SPECENUM_NAME   cmdlevel

Definition at line 319 of file connection.h.

◆ SPECENUM_NAME [2/2]

#define SPECENUM_NAME   conn_pattern_type

Definition at line 319 of file connection.h.

◆ SPECENUM_VALUE0 [1/2]

#define SPECENUM_VALUE0   ALLOW_NONE

Definition at line 320 of file connection.h.

◆ SPECENUM_VALUE0 [2/2]

#define SPECENUM_VALUE0   CPT_USER

Definition at line 320 of file connection.h.

◆ SPECENUM_VALUE0NAME [1/2]

#define SPECENUM_VALUE0NAME   "none"

Definition at line 321 of file connection.h.

◆ SPECENUM_VALUE0NAME [2/2]

#define SPECENUM_VALUE0NAME   "user"

Definition at line 321 of file connection.h.

◆ SPECENUM_VALUE1 [1/2]

#define SPECENUM_VALUE1   ALLOW_INFO

Definition at line 322 of file connection.h.

◆ SPECENUM_VALUE1 [2/2]

#define SPECENUM_VALUE1   CPT_HOST

Definition at line 322 of file connection.h.

◆ SPECENUM_VALUE1NAME [1/2]

#define SPECENUM_VALUE1NAME   "info"

Definition at line 323 of file connection.h.

◆ SPECENUM_VALUE1NAME [2/2]

#define SPECENUM_VALUE1NAME   "host"

Definition at line 323 of file connection.h.

◆ SPECENUM_VALUE2 [1/2]

#define SPECENUM_VALUE2   ALLOW_BASIC

Definition at line 324 of file connection.h.

◆ SPECENUM_VALUE2 [2/2]

#define SPECENUM_VALUE2   CPT_IP

Definition at line 324 of file connection.h.

◆ SPECENUM_VALUE2NAME [1/2]

#define SPECENUM_VALUE2NAME   "basic"

Definition at line 325 of file connection.h.

◆ SPECENUM_VALUE2NAME [2/2]

#define SPECENUM_VALUE2NAME   "ip"

Definition at line 325 of file connection.h.

◆ SPECENUM_VALUE3

#define SPECENUM_VALUE3   ALLOW_CTRL

Definition at line 66 of file connection.h.

◆ SPECENUM_VALUE3NAME

#define SPECENUM_VALUE3NAME   "ctrl"

Definition at line 67 of file connection.h.

◆ SPECENUM_VALUE4

#define SPECENUM_VALUE4   ALLOW_ADMIN

Definition at line 69 of file connection.h.

◆ SPECENUM_VALUE4NAME

#define SPECENUM_VALUE4NAME   "admin"

Definition at line 70 of file connection.h.

◆ SPECENUM_VALUE5

#define SPECENUM_VALUE5   ALLOW_HACK

Definition at line 72 of file connection.h.

◆ SPECENUM_VALUE5NAME

#define SPECENUM_VALUE5NAME   "hack"

Definition at line 73 of file connection.h.

◆ SPECLIST_TAG [1/2]

#define SPECLIST_TAG   conn

Definition at line 312 of file connection.h.

◆ SPECLIST_TAG [2/2]

#define SPECLIST_TAG   conn_pattern

Definition at line 312 of file connection.h.

◆ SPECLIST_TYPE [1/2]

#define SPECLIST_TYPE   struct connection

Definition at line 313 of file connection.h.

◆ SPECLIST_TYPE [2/2]

#define SPECLIST_TYPE   struct conn_pattern

Definition at line 313 of file connection.h.

◆ SPECVEC_TAG

#define SPECVEC_TAG   byte

Definition at line 119 of file connection.h.

◆ SPECVEC_TYPE

#define SPECVEC_TYPE   unsigned char

Definition at line 120 of file connection.h.

Typedef Documentation

◆ conn_close_fn_t

typedef void(* conn_close_fn_t) (struct connection *pconn)

Definition at line 260 of file connection.h.

Enumeration Type Documentation

◆ auth_status

Enumerator
AS_NOT_ESTABLISHED 
AS_FAILED 
AS_REQUESTING_NEW_PASS 
AS_REQUESTING_OLD_PASS 
AS_ESTABLISHED 

Definition at line 83 of file connection.h.

Function Documentation

◆ can_conn_edit()

bool can_conn_edit ( const struct connection pconn)

◆ can_conn_enable_editing()

bool can_conn_enable_editing ( const struct connection pconn)

Return TRUE iff the connection is allowed to start editing.

Definition at line 481 of file connection.cpp.

Referenced by can_conn_edit(), and handle_edit_mode().

◆ conn_by_number()

struct connection* conn_by_number ( int  id)

Find connection by id, from game.all_connections.

Returns nullptr if not found. Number of connections will always be relatively small given current implementation, so linear search should be fine.

Definition at line 376 of file connection.cpp.

Referenced by check_vote(), handle_conn_info(), lsend_vote_new(), lsend_vote_update(), makeup_connection_name(), and vote_get_caller().

◆ conn_by_user()

struct connection* conn_by_user ( const char *  user_name)

Find connection by exact user name, from game.all_connections, case-insensitve.

Returns nullptr if not found.

Definition at line 329 of file connection.cpp.

Referenced by delegate_command(), establish_new_connection(), get_unique_guest_name(), is_allowed_city_name(), makeup_connection_name(), and send_to_metaserver().

◆ conn_by_user_prefix()

struct connection* conn_by_user_prefix ( const char *  user_name,
enum m_pre_result result 
)

◆ conn_compression_freeze()

void conn_compression_freeze ( struct connection pconn)

Freeze the connection.

Then the packets sent to it won't be sent immediatly, but later, using a compression method. See futher details in common/packets.[ch].

Definition at line 636 of file connection.cpp.

Referenced by conn_list_compression_freeze(), connection_attach_real(), establish_new_connection(), and start_processing_request().

◆ conn_compression_frozen()

bool conn_compression_frozen ( const struct connection pconn)

Returns TRUE if the connection is frozen.

See also conn_compression_freeze().

Definition at line 648 of file connection.cpp.

Referenced by send_packet_data().

◆ conn_compression_thaw()

bool conn_compression_thaw ( struct connection pconn)

Thaw the connection.

Then maybe compress the data waiting to send them to the connection. Returns TRUE on success. See also conn_compression_freeze().

Definition at line 160 of file packets.cpp.

Referenced by conn_list_compression_thaw(), connection_attach_real(), establish_new_connection(), and finish_processing_request().

◆ conn_controls_player()

bool conn_controls_player ( const struct connection pconn)

Returns TRUE if the given connection is attached to a player which it also controls (i.e.

not a player observer).

Definition at line 675 of file connection.cpp.

Referenced by away_command(), conn_can_vote(), connection_delegate_restore(), connection_delegate_take(), cut_client_connection(), delegate_command(), establish_new_connection(), kick_command(), lost_connection_to_client(), send_all_info(), and surrender_command().

◆ conn_description()

const char* conn_description ( const struct connection pconn,
bool  is_private 
)

° Return pointer to static string containing a description for this ° connection, based on pconn->name, pconn->addr, and (if applicable) ° pconn->playing->name.

(Also pconn->established and pconn->observer.) ° ° Note that when pconn is client.conn (connection to server), ° pconn->name and pconn->addr contain empty string, and pconn->playing ° is nullptr: in this case return string "server".

If is_private is true, show the actual hostname, otherwise mask it.

Definition at line 431 of file connection.cpp.

Referenced by conn_compression_thaw(), connection_ping(), connection_send_data(), default_conn_close_callback(), flush_packets(), handle_conn_pong(), handle_edit_mode(), handle_login_request(), handle_vote_submit(), lost_connection_to_client(), packet_check(), reject_new_connection(), freeciv::server::send_pings(), send_remove_team_votes(), send_running_votes(), server_packet_input(), and show_connections().

◆ conn_get_access()

enum cmdlevel conn_get_access ( const struct connection pconn)

Returns the current access level of the given connection.

NB: If 'pconn' is nullptr, this function will return ALLOW_NONE.

Definition at line 693 of file connection.cpp.

Referenced by cancelvote_command(), cmdlevel_command(), conn_can_vote(), conn_set_access(), delegate_command(), handle_stdin_input_real(), kick_command(), and may_use_nothing().

◆ conn_get_player()

struct player* conn_get_player ( const struct connection pconn)

◆ conn_is_global_observer()

bool conn_is_global_observer ( const struct connection pconn)

Returns TRUE if the given connection is a global observer.

Definition at line 683 of file connection.cpp.

Referenced by broadcast_city_info(), chat_msg_to_global_observers(), conn_can_see_vote(), send_city_info_at_tile(), send_pending_events(), and server_remove_unit_full().

◆ conn_is_valid()

bool conn_is_valid ( const struct connection pconn)

Returns TRUE if the connection is valid, i.e.

not nullptr, not closed, not closing, etc.

Definition at line 864 of file connection.cpp.

Referenced by auth_get_ipaddr(), and auth_get_username().

◆ conn_list_compression_freeze()

void conn_list_compression_freeze ( const struct conn_list *  pconn_list)

Freeze a connection list.

Definition at line 656 of file connection.cpp.

Referenced by buffer_shared_vision(), load_command(), send_rulesets(), and srv_ready().

◆ conn_list_compression_thaw()

void conn_list_compression_thaw ( const struct conn_list *  pconn_list)

Thaw a connection list.

Definition at line 665 of file connection.cpp.

Referenced by load_command(), send_rulesets(), srv_ready(), and unbuffer_shared_vision().

◆ conn_list_do_buffer()

◆ conn_list_do_unbuffer()

◆ conn_pattern_destroy()

void conn_pattern_destroy ( struct conn_pattern ppattern)

Free a connection pattern.

Definition at line 738 of file connection.cpp.

Referenced by ignore_command(), and server_make_connection().

◆ conn_pattern_from_string()

struct conn_pattern* conn_pattern_from_string ( const char *  pattern,
enum conn_pattern_type  prefer,
char *  error_buf,
size_t  error_buf_len 
)

Creates a new connection pattern from the string.

If the type is not specified in 'pattern', then 'prefer' type will be used. If the type is needed, then pass conn_pattern_type_invalid() for 'prefer'.

Definition at line 809 of file connection.cpp.

Referenced by ignore_command().

◆ conn_pattern_list_match()

bool conn_pattern_list_match ( const struct conn_pattern_list *  plist,
const struct connection pconn 
)

Returns TRUE whether the connection fits one of the connection patterns.

Definition at line 779 of file connection.cpp.

Referenced by conn_is_ignored().

◆ conn_pattern_match()

bool conn_pattern_match ( const struct conn_pattern ppattern,
const struct connection pconn 
)

Returns TRUE whether the connection fits the connection pattern.

Definition at line 748 of file connection.cpp.

Referenced by conn_pattern_list_match().

◆ conn_pattern_new()

struct conn_pattern* conn_pattern_new ( enum conn_pattern_type  type,
const char *  wildcard 
)

Creates a new connection pattern.

Definition at line 724 of file connection.cpp.

Referenced by conn_pattern_from_string().

◆ conn_pattern_to_string()

size_t conn_pattern_to_string ( const struct conn_pattern ppattern,
char *  buf,
size_t  buf_len 
)

Put a string reprentation of the pattern in 'buf'.

Definition at line 796 of file connection.cpp.

Referenced by ignore_command(), show_ignore(), and unignore_command().

◆ conn_reset_delta_state()

void conn_reset_delta_state ( struct connection pc)

Remove all is-game-info cached packets from the connection.

This resets the delta-state partially.

Definition at line 615 of file connection.cpp.

Referenced by client_state(), and connection_attach_real().

◆ conn_set_capability()

void conn_set_capability ( struct connection pconn,
const char *  capability 
)

Set the network capability string for 'pconn'.

Definition at line 603 of file connection.cpp.

Referenced by handle_login_request(), and handle_server_join_reply().

◆ connection_close()

void connection_close ( struct connection pconn,
const QString &  reason 
)

Call the conn_close_callback.

Definition at line 69 of file connection.cpp.

Referenced by add_connection_data(), connection_close_server(), get_packet_from_connection_raw(), input_from_server(), and write_socket_data().

◆ connection_common_close()

void connection_common_close ( struct connection pconn)

Connection closing part common to server and client.

Definition at line 574 of file connection.cpp.

Referenced by close_connection(), and close_socket_nomessage().

◆ connection_common_init()

void connection_common_init ( struct connection pconn)

Initialize common part of connection structure.

This is used by both server and client.

Definition at line 555 of file connection.cpp.

Referenced by make_connection(), manual_command(), and server_make_connection().

◆ connection_do_buffer()

void connection_do_buffer ( struct connection pc)

◆ connection_do_unbuffer()

void connection_do_unbuffer ( struct connection pc)

Turn off buffering if internal counter of number of times buffering was turned on falls to zero, to handle nested buffer/unbuffer pairs.

When counter is zero, flush any pending data.

Definition at line 290 of file connection.cpp.

Referenced by cma_yoloswag::apply_result_on_server(), conn_list_do_unbuffer(), edit_buffer_paste(), editor_apply_tool_to_selection(), incoming_client_packets(), send_attribute_block(), send_remove_team_votes(), and send_running_votes().

◆ connection_send_data()

bool connection_send_data ( struct connection pconn,
const unsigned char *  data,
int  len 
)

Write data to socket.

Return TRUE on success.

Definition at line 245 of file connection.cpp.

Referenced by conn_compression_flush(), send_packet_data(), and server_packet_input().

◆ connections_set_close_callback()

void connections_set_close_callback ( conn_close_fn_t  func)

Register the close_callback.

Definition at line 61 of file connection.cpp.

Referenced by server_open_socket(), and try_to_connect().

◆ flush_connection_send_buffer_all()

void flush_connection_send_buffer_all ( struct connection pc)

◆ free_compression_queue()

void free_compression_queue ( struct connection pconn)

Free compression queue for given connection.

Definition at line 508 of file connection.cpp.

Referenced by connection_common_close().

◆ get_next_request_id()

int get_next_request_id ( int  old_request_id)

Get next request id.

Takes wrapping of the 16 bit wide unsigned int into account.

Definition at line 490 of file connection.cpp.

Referenced by handle_processing_started(), incoming_client_packets(), and send_packet_data().

◆ new_socket_packet_buffer()

struct socket_packet_buffer* new_socket_packet_buffer ( )

Return malloced struct, appropriately initialized.

Definition at line 395 of file connection.cpp.

Referenced by connection_common_init().

◆ read_socket_data()

int read_socket_data ( QIODevice *  sock,
struct socket_packet_buffer buffer 
)

Read data from socket, and check if a packet is ready.

Returns: -1 : an error occurred - you should close the socket -2 : the connection was closed >0 : number of bytes read =0 : non-blocking sockets only; no data read, would block

Definition at line 110 of file connection.cpp.

Referenced by freeciv::server::input_on_socket(), and read_from_connection().

Variable Documentation

◆ blank_addr_str

const char blank_addr_str[]
extern

Definition at line 35 of file connection.cpp.