209 lines
5.1 KiB
C
209 lines
5.1 KiB
C
/*
|
|
* ircd-ratbox: A slightly useful ircd.
|
|
* commio.h: A header for the network subsystem.
|
|
*
|
|
* Copyright (C) 1990 Jarkko Oikarinen and University of Oulu, Co Center
|
|
* Copyright (C) 1996-2002 Hybrid Development Team
|
|
* Copyright (C) 2002-2004 ircd-ratbox development team
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307
|
|
* USA
|
|
*
|
|
* $Id: commio.h 3354 2007-04-03 09:21:31Z nenolod $
|
|
*/
|
|
|
|
#ifndef INCLUDED_commio_h
|
|
#define INCLUDED_commio_h
|
|
|
|
#include "setup.h"
|
|
#include "config.h"
|
|
#include "ircd_defs.h"
|
|
#include "tools.h"
|
|
|
|
typedef struct _fde fde_t;
|
|
|
|
/* Callback for completed IO events */
|
|
typedef void PF(int fd, void *);
|
|
|
|
/* virtual function types for I/O --nenolod */
|
|
typedef int IOFuncRead(fde_t *, void *buf, size_t count);
|
|
typedef int IOFuncWrite(fde_t *, const void *buf, size_t count);
|
|
|
|
/* Callback for completed connections */
|
|
/* int fd, int status, void * */
|
|
typedef void CNCB(int fd, int, void *);
|
|
|
|
#define FD_DESC_SZ 128 /* hostlen + comment */
|
|
|
|
|
|
/* FD type values */
|
|
enum
|
|
{
|
|
FD_NONE,
|
|
FD_LOG,
|
|
FD_FILE,
|
|
FD_FILECLOSE,
|
|
FD_SOCKET,
|
|
FD_PIPE,
|
|
FD_UNKNOWN
|
|
};
|
|
|
|
enum
|
|
{
|
|
COMM_OK,
|
|
COMM_ERR_BIND,
|
|
COMM_ERR_DNS,
|
|
COMM_ERR_TIMEOUT,
|
|
COMM_ERR_CONNECT,
|
|
COMM_ERROR,
|
|
COMM_ERR_MAX
|
|
};
|
|
|
|
typedef enum fdlist_t
|
|
{
|
|
FDLIST_NONE,
|
|
FDLIST_SERVICE,
|
|
FDLIST_SERVER,
|
|
FDLIST_IDLECLIENT,
|
|
FDLIST_BUSYCLIENT,
|
|
FDLIST_MAX
|
|
}
|
|
fdlist_t;
|
|
|
|
|
|
extern int highest_fd;
|
|
extern int number_fd;
|
|
|
|
struct Client;
|
|
|
|
struct _fde
|
|
{
|
|
/* New-school stuff, again pretty much ripped from squid */
|
|
/*
|
|
* Yes, this gives us only one pending read and one pending write per
|
|
* filedescriptor. Think though: when do you think we'll need more?
|
|
*/
|
|
int fd; /* So we can use the fde_t as a callback ptr */
|
|
int type;
|
|
fdlist_t list; /* Which list this FD should sit on */
|
|
int comm_index; /* where in the poll list we live */
|
|
char desc[FD_DESC_SZ];
|
|
|
|
PF *read_handler;
|
|
void *read_data;
|
|
|
|
PF *write_handler;
|
|
void *write_data;
|
|
|
|
PF *timeout_handler;
|
|
void *timeout_data;
|
|
time_t timeout;
|
|
|
|
PF *flush_handler;
|
|
void *flush_data;
|
|
time_t flush_timeout;
|
|
|
|
IOFuncRead *read_impl;
|
|
IOFuncWrite *write_impl;
|
|
|
|
struct DNSQuery *dns_query;
|
|
struct
|
|
{
|
|
unsigned int open:1;
|
|
unsigned int close_request:1;
|
|
unsigned int write_daemon:1;
|
|
unsigned int closing:1;
|
|
unsigned int socket_eof:1;
|
|
unsigned int nolinger:1;
|
|
unsigned int nonblocking:1;
|
|
unsigned int ipc:1;
|
|
unsigned int called_connect:1;
|
|
}
|
|
flags;
|
|
struct
|
|
{
|
|
struct irc_sockaddr_storage hostaddr;
|
|
CNCB *callback;
|
|
void *data;
|
|
/* We'd also add the retry count here when we get to that -- adrian */
|
|
}
|
|
connect;
|
|
int pflags;
|
|
dlink_node node;
|
|
};
|
|
|
|
|
|
void fdlist_init(void);
|
|
|
|
extern void comm_open(int, unsigned int, const char *);
|
|
extern void comm_close(int);
|
|
extern void comm_dump(struct Client *source_p);
|
|
#ifndef __GNUC__
|
|
extern void comm_note(int fd, const char *format, ...);
|
|
#else
|
|
extern void comm_note(int fd, const char *format, ...) __attribute__ ((format(printf, 2, 3)));
|
|
#endif
|
|
|
|
#define FB_EOF 0x01
|
|
#define FB_FAIL 0x02
|
|
|
|
|
|
/* Size of a read buffer */
|
|
#define READBUF_SIZE 16384 /* used by src/packet.c and src/s_serv.c */
|
|
|
|
/* Type of IO */
|
|
#define COMM_SELECT_READ 0x1
|
|
#define COMM_SELECT_WRITE 0x2
|
|
#define COMM_SELECT_RETRY 0x4
|
|
extern int readcalls;
|
|
extern const char *const NONB_ERROR_MSG;
|
|
extern const char *const SETBUF_ERROR_MSG;
|
|
|
|
extern void comm_close_all(void);
|
|
extern int comm_set_nb(int);
|
|
extern int comm_set_buffers(int, int);
|
|
|
|
extern int comm_get_sockerr(int);
|
|
extern int ignoreErrno(int ierrno);
|
|
|
|
extern void comm_settimeout(int fd, time_t, PF *, void *);
|
|
extern void comm_setflush(int fd, time_t, PF *, void *);
|
|
extern void comm_checktimeouts(void *);
|
|
extern void comm_connect_tcp(int fd, const char *, u_short,
|
|
struct sockaddr *, int, CNCB *, void *, int, int);
|
|
extern const char *comm_errstr(int status);
|
|
extern int comm_socket(int family, int sock_type, int proto, const char *note);
|
|
extern int comm_accept(int fd, struct sockaddr *pn, socklen_t *addrlen);
|
|
|
|
/* These must be defined in the network IO loop code of your choice */
|
|
extern void comm_setselect(int fd, fdlist_t list, unsigned int type,
|
|
PF * handler, void *client_data, time_t timeout);
|
|
extern void init_netio(void);
|
|
extern int read_message(time_t, unsigned char);
|
|
extern int comm_select(unsigned long);
|
|
extern int disable_sock_options(int);
|
|
#ifdef IPV6
|
|
extern void mangle_mapped_sockaddr(struct sockaddr *in);
|
|
#else
|
|
#define mangle_mapped_sockaddr(x)
|
|
#endif
|
|
|
|
extern int comm_get_maxconnections(void);
|
|
|
|
extern fde_t *comm_locate_fd(int fd);
|
|
extern fde_t *comm_add_fd(int fd);
|
|
|
|
#endif /* INCLUDED_commio_h */
|