apps/irssi/src/core/servers.h

   1 #ifndef __SERVERS_H
   2 #define __SERVERS_H
   3
   4 #include "modules.h"
   5
   6 /* Returns SERVER_REC if it's server, NULL if it isn't. */
   7 #define SERVER(server) \
   8         MODULE_CHECK_CAST(server, SERVER_REC, type, "SERVER")
   9
  10 /* Returns SERVER_CONNECT_REC if it's server connection, NULL if it isn't. */
  11 #define SERVER_CONNECT(conn) \
  12         MODULE_CHECK_CAST(conn, SERVER_CONNECT_REC, type, "SERVER CONNECT")
  13
  14 #define IS_SERVER(server) \
  15         (SERVER(server) ? TRUE : FALSE)
  16
  17 #define IS_SERVER_CONNECT(conn) \
  18         (SERVER_CONNECT(conn) ? TRUE : FALSE)
  19
  20 #define server_ischannel(server, channel) \
  21         (server)->ischannel(server, channel)
  22
  23 /* all strings should be either NULL or dynamically allocated */
  24 /* address and nick are mandatory, rest are optional */
  25 struct _SERVER_CONNECT_REC {
  26 #include "server-connect-rec.h"
  27 };
  28
  29 #define STRUCT_SERVER_CONNECT_REC SERVER_CONNECT_REC
  30 struct _SERVER_REC {
  31 #include "server-rec.h"
  32 };
  33
  34 #define SEND_TARGET_CHANNEL     0
  35 #define SEND_TARGET_NICK        1
  36
  37 extern GSList *servers, *lookup_servers;
  38
  39 void servers_init(void);
  40 void servers_deinit(void);
  41
  42 /* Disconnect from server */
  43 void server_disconnect(SERVER_REC *server);
  44
  45 void server_ref(SERVER_REC *server);
  46 int server_unref(SERVER_REC *server);
  47
  48 SERVER_REC *server_find_tag(const char *tag);
  49 SERVER_REC *server_find_lookup_tag(const char *tag);
  50 SERVER_REC *server_find_chatnet(const char *chatnet);
  51
  52 /* starts connecting to server */
  53 int server_start_connect(SERVER_REC *server);
  54 void server_connect_ref(SERVER_CONNECT_REC *conn);
  55 void server_connect_unref(SERVER_CONNECT_REC *conn);
  56
  57 SERVER_REC *server_connect(SERVER_CONNECT_REC *conn);
  58
  59 /* initializes server record but doesn't start connecting */
  60 void server_connect_init(SERVER_REC *server);
  61 /* Connection to server finished, fill the rest of the fields */
  62 void server_connect_finished(SERVER_REC *server);
  63 /* connection to server failed */
  64 void server_connect_failed(SERVER_REC *server, const char *msg);
  65
  66 /* Change your nick */
  67 void server_change_nick(SERVER_REC *server, const char *nick);
  68
  69 /* Update own IPv4 and IPv6 records */
  70 void server_connect_own_ip_save(SERVER_CONNECT_REC *conn,
  71                                 IPADDR *ip4, IPADDR *ip6);
  72
  73 /* `optlist' should contain only one unknown key - the server tag.
  74    returns NULL if there was unknown -option */
  75 SERVER_REC *cmd_options_get_server(const char *cmd,
  76                                    GHashTable *optlist,
  77                                    SERVER_REC *defserver);
  78
  79 #endif