include/listener.h

   1 /* - Internet Relay Chat, include/listener.h
   2  *   Copyright (C) 1999 Thomas Helvey <tomh@inxpress.net>
   3  *
   4  *   This program is free software; you can redistribute it and/or modify
   5  *   it under the terms of the GNU General Public License as published by
   6  *   the Free Software Foundation; either version 1, or (at your option)
   7  *   any later version.
   8  *
   9  *   This program is distributed in the hope that it will be useful,
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  *   GNU General Public License for more details.
  13  *
  14  *   You should have received a copy of the GNU General Public License
  15  *   along with this program; if not, write to the Free Software
  16  *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17  */
  18 /** @file
  19  * @brief Interface and declarations for handling listening sockets.
  20  * @version $Id$
  21  */
  22 #ifndef INCLUDED_listener_h
  23 #define INCLUDED_listener_h
  24 #ifndef INCLUDED_ircd_defs_h
  25 #include "ircd_defs.h"       /* HOSTLEN */
  26 #endif
  27 #ifndef INCLUDED_ircd_events_h
  28 #include "ircd_events.h"
  29 #endif
  30 #ifndef INCLUDED_res_h
  31 #include "res.h"
  32 #endif
  33 #ifndef INCLUDED_client_h
  34 #include "client.h" /* flagset stuff.  oh well. */
  35 #endif
  36 #ifndef INCLUDED_sys_types_h
  37 #include <sys/types.h>       /* size_t, broken BSD system headers */
  38 #define INCLUDED_sys_types_h
  39 #endif
  40
  41 struct Client;
  42 struct StatDesc;
  43 struct SSLListener;
  44
  45 enum ListenerFlag {
  46   /** Port is currently accepting connections. */
  47   LISTEN_ACTIVE,
  48   /** Port is hidden from /STATS P output. */
  49   LISTEN_HIDDEN,
  50   /** Port accepts only server connections. */
  51   LISTEN_SERVER,
  52   /** Port listens for IPv4 connections. */
  53   LISTEN_IPV4,
  54   /** Port listens for IPv6 connections. */
  55   LISTEN_IPV6,
  56   /** Port listens for SSL connections. */
  57   LISTEN_SSL,
  58   /** Sentinel for counting listener flags. */
  59   LISTEN_LAST_FLAG
  60 };
  61
  62 DECLARE_FLAGSET(ListenerFlags, LISTEN_LAST_FLAG);
  63
  64 /** Describes a single listening port. */
  65 struct Listener {
  66   struct Listener* next;               /**< list node pointer */
  67   struct ListenerFlags flags;          /**< on-off flags for listener */
  68   int              fd_v4;              /**< file descriptor for IPv4 */
  69   int              fd_v6;              /**< file descriptor for IPv6 */
  70   int              ref_count;          /**< number of connection references */
  71   unsigned char    mask_bits;          /**< number of bits in mask address */
  72   int              index;              /**< index into poll array */
  73   time_t           last_accept;        /**< last time listener accepted */
  74   struct irc_sockaddr addr;            /**< virtual address and port */
  75   struct irc_in_addr mask;             /**< listener hostmask */
  76   struct Socket    socket_v4;          /**< describe IPv4 socket to event system */
  77   struct Socket    socket_v6;          /**< describe IPv6 socket to event system */
  78   struct SSLListener* ssl_listener;    /**< ssl listener if listening for ssl connections */
  79 };
  80
  81 #define listener_server(LISTENER) FlagHas(&(LISTENER)->flags, LISTEN_SERVER)
  82 #define listener_active(LISTENER) FlagHas(&(LISTENER)->flags, LISTEN_ACTIVE)
  83 #define listener_ssl(LISTENER) FlagHas(&(LISTENER)->flags, LISTEN_SSL)
  84
  85 extern void        add_listener(int port, const char* vaddr_ip,
  86                                 const char* mask,
  87                                 const struct ListenerFlags *flags);
  88 extern void        close_listener(struct Listener* listener);
  89 extern void        close_listeners(void);
  90 extern void        count_listener_memory(int* count_out, size_t* size_out);
  91 extern const char* get_listener_name(const struct Listener* listener);
  92 extern void        mark_listeners_closing(void);
  93 extern void show_ports(struct Client* client, const struct StatDesc* sd,
  94                        char* param);
  95 extern void        release_listener(struct Listener* listener);
  96
  97 #endif /* INCLUDED_listener_h */
  98