src/network.h

   1 /*
   2         ctrlproxy: A modular IRC proxy
   3         (c) 2002-2005 Jelmer Vernooij <jelmer@nl.linux.org>
   4
   5         This program is free software; you can redistribute it and/or modify
   6         it under the terms of the GNU General Public License as published by
   7         the Free Software Foundation; either version 2 of the License, or
   8         (at your option) any later version.
   9
  10         This program is distributed in the hope that it will be useful,
  11         but WITHOUT ANY WARRANTY; without even the implied warranty of
  12         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13         GNU General Public License for more details.
  14
  15         You should have received a copy of the GNU General Public License
  16         along with this program; if not, write to the Free Software
  17         Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18 */
  19
  20 #ifndef __CTRLPROXY_NETWORK_H__
  21 #define __CTRLPROXY_NETWORK_H__
  22
  23 /**
  24  * @file
  25  * @brief Network functions
  26  */
  27
  28 #ifndef G_MODULE_EXPORT
  29 #define G_MODULE_EXPORT
  30 #endif
  31
  32 #include "state.h"
  33
  34 struct global;
  35 struct network;
  36 struct client;
  37 struct line;
  38 struct linestack_context;
  39
  40 enum network_connection_state {
  41                 NETWORK_CONNECTION_STATE_NOT_CONNECTED = 0,
  42                 NETWORK_CONNECTION_STATE_RECONNECT_PENDING,
  43                 NETWORK_CONNECTION_STATE_LOGIN_SENT,
  44                 NETWORK_CONNECTION_STATE_MOTD_RECVD,
  45 };
  46
  47 /**
  48  * Information about the connection to a network.
  49  */
  50 struct network_connection {
  51         enum network_connection_state state;
  52
  53         time_t last_line_sent;
  54         GQueue *pending_lines;
  55
  56         GIOChannel *outgoing;
  57         gint outgoing_id;
  58         gint incoming_id;
  59         GIConv outgoing_iconv;
  60         GIConv incoming_iconv;
  61
  62         union {
  63                 struct {
  64                         struct tcp_server_config *current_server;
  65                         struct sockaddr *remote_name;
  66                         struct sockaddr *local_name;
  67                         size_t namelen;
  68                 } tcp;
  69
  70                 struct {
  71                         void *private_data;
  72                         struct virtual_network_ops {
  73                                 char *name;
  74                                 gboolean (*init) (struct network *);
  75                                 gboolean (*to_server) (struct network *, struct client *c, const struct line *);
  76                                 gboolean (*fini) (struct network *);
  77                         } *ops;
  78                 } virtual;
  79         } data;
  80 };
  81
  82 /**
  83  * An IRC network
  84  */
  85 struct network {
  86         char *name;
  87         struct global *global;
  88         struct network_config *config;
  89
  90         GList *clients;
  91         guint reconnect_id;
  92
  93         gpointer ssl_credentials;
  94
  95         struct network_state *state;
  96         struct network_info info;
  97         struct network_connection connection;
  98         struct linestack_context *linestack;
  99 };
 100
 101 /* server.c */
 102 G_MODULE_EXPORT gboolean network_set_charset(struct network *n, const char *name);
 103 G_MODULE_EXPORT struct network *find_network_by_hostname(struct global *global, const char *host, guint16 port, gboolean create);
 104 G_MODULE_EXPORT gboolean load_networks(struct global *, struct ctrlproxy_config *cfg);
 105 G_MODULE_EXPORT gboolean autoconnect_networks(struct global *);
 106 G_MODULE_EXPORT struct network *load_network(struct global *, struct network_config *);
 107 G_MODULE_EXPORT void unload_network(struct network *);
 108 G_MODULE_EXPORT gboolean connect_network(struct network *);
 109 G_MODULE_EXPORT void network_select_next_server(struct network *n);
 110 G_MODULE_EXPORT gboolean disconnect_network(struct network *s);
 111 G_MODULE_EXPORT void clients_send(struct network *, struct line *, const struct client *exception);
 112 G_MODULE_EXPORT gboolean network_send_line(struct network *s, struct client *c, const struct line *);
 113 G_MODULE_EXPORT gboolean network_send_args(struct network *s, ...);
 114 G_MODULE_EXPORT void register_virtual_network(struct virtual_network_ops *);
 115 G_MODULE_EXPORT struct network *find_network(struct global *, const char *);
 116 G_MODULE_EXPORT gboolean virtual_network_recv_line(struct network *l, struct line *);
 117 G_MODULE_EXPORT gboolean virtual_network_recv_args(struct network *l, const char *origin, ...);
 118 typedef void (*new_network_notify_fn) (struct network *, void *);
 119 G_MODULE_EXPORT void register_new_network_notify(struct global *, new_network_notify_fn, void *userdata);
 120 G_MODULE_EXPORT struct linestack_context *new_linestack(struct network *network);
 121
 122 #endif /* __CTRLPROXY_NETWORK_H__ */