include/msgq.h

   1 #ifndef INCLUDED_msgq_h
   2 #define INCLUDED_msgq_h
   3 /*
   4  * IRC - Internet Relay Chat, include/msgq.h
   5  * Copyright (C) 2000 Kevin L. Mitchell <klmitch@mit.edu>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2, or (at your option)
  10  * any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20  *
  21  * $Id$
  22  */
  23 #ifndef INCLUDED_ircd_defs_h
  24 #include "ircd_defs.h"  /* BUFSIZE */
  25 #endif
  26 #ifndef INCLUDED_sys_types_h
  27 #include <sys/types.h>
  28 #define INCLUDED_sys_types_h
  29 #endif
  30 #ifndef INCLUDED_stdarg_h
  31 #include <stdarg.h>
  32 #define INCLUDED_stdarg_h
  33 #endif
  34
  35 struct iovec;
  36
  37 struct Client;
  38 struct StatDesc;
  39
  40 struct Msg;
  41 struct MsgBuf;
  42
  43 /** Queue of individual messages. */
  44 struct MsgQList {
  45   struct Msg *head;             /**< First Msg in queue list */
  46   struct Msg *tail;             /**< Last Msg in queue list */
  47 };
  48
  49 /** Entire two-priority message queue for a destination. */
  50 struct MsgQ {
  51   unsigned int length;          /**< Current number of bytes stored */
  52   unsigned int count;           /**< Current number of messages stored */
  53   struct MsgQList queue;        /**< Normal Msg queue */
  54   struct MsgQList prio;         /**< Priority Msg queue */
  55 };
  56
  57 /** Returns the current number of bytes stored in \a mq. */
  58 #define MsgQLength(mq) ((mq)->length)
  59
  60 /** Returns the current number of messages stored in \a mq. */
  61 #define MsgQCount(mq) ((mq)->count)
  62
  63 /** Scratch the current content of the buffer.
  64  * Release all allocated buffers and make it empty.
  65  */
  66 #define MsgQClear(mq) msgq_delete((mq), MsgQLength(mq))
  67
  68 /*
  69  * Prototypes
  70  */
  71 extern void msgq_init(struct MsgQ *mq);
  72 extern void msgq_delete(struct MsgQ *mq, unsigned int length);
  73 extern int msgq_mapiov(const struct MsgQ *mq, struct iovec *iov, int count,
  74                        unsigned int *len);
  75 extern struct MsgBuf *msgq_make(struct Client *dest, const char *format, ...);
  76 extern struct MsgBuf *msgq_vmake(struct Client *dest, const char *format,
  77                                  va_list args);
  78 extern void msgq_append(struct Client *dest, struct MsgBuf *mb,
  79                         const char *format, ...);
  80 extern void msgq_clean(struct MsgBuf *mb);
  81 extern void msgq_add(struct MsgQ *mq, struct MsgBuf *mb, int prio);
  82 extern void msgq_count_memory(struct Client *cptr,
  83                               size_t *msg_alloc, size_t *msg_used);
  84 extern void msgq_histogram(struct Client *cptr, const struct StatDesc *sd,
  85                            char *param);
  86 extern unsigned int msgq_bufleft(struct MsgBuf *mb);
  87
  88 #endif /* INCLUDED_msgq_h */