* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- *
- * $Id$
+ */
+/** @file
+ * @brief Interface and declarations for handling listening sockets.
+ * @version $Id$
*/
#ifndef INCLUDED_listener_h
#define INCLUDED_listener_h
struct Client;
struct StatDesc;
+/** Describes a single listening port. */
struct Listener {
- struct Listener* next; /* list node pointer */
- int fd; /* file descriptor */
- int ref_count; /* number of connection references */
- unsigned char active; /* current state of listener */
- unsigned char hidden; /* hidden in stats output for clients */
- unsigned char server; /* 1 if port is a server listener */
- unsigned char mask_bits; /* number of bits in mask address */
- int index; /* index into poll array */
- time_t last_accept; /* last time listener accepted */
- struct irc_sockaddr addr; /* virtual address and port */
- struct irc_in_addr mask; /* listener hostmask */
- struct Socket socket; /* describe socket to event system */
+ struct Listener* next; /**< list node pointer */
+ int fd; /**< file descriptor */
+ int ref_count; /**< number of connection references */
+ unsigned char active; /**< current state of listener */
+ unsigned char hidden; /**< hidden in stats output for clients */
+ unsigned char server; /**< 1 if port is a server listener */
+ unsigned char mask_bits; /**< number of bits in mask address */
+ int index; /**< index into poll array */
+ time_t last_accept; /**< last time listener accepted */
+ struct irc_sockaddr addr; /**< virtual address and port */
+ struct irc_in_addr mask; /**< listener hostmask */
+ struct Socket socket; /**< describe socket to event system */
};
-extern struct Listener* ListenerPollList; /* GLOBAL - listener list */
-
extern void add_listener(int port, const char* vaddr_ip,
const char* mask, int is_server,
int is_hidden);