mq.h

Go to the documentation of this file.

/*
 * $Id: mq.h,v 1.8 2005/08/02 10:29:50 rmanfredi Exp $
 *
 * Copyright (c) 2002-2003, Raphael Manfredi
 *
 *----------------------------------------------------------------------
 * This file is part of gtk-gnutella.
 *
 *  gtk-gnutella 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.
 *
 *  gtk-gnutella 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 gtk-gnutella; if not, write to the Free Software
 *  Foundation, Inc.:
 *      59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *----------------------------------------------------------------------
 */

#ifndef _core_mq_h_
#define _core_mq_h_

#include <glib.h>

#include "gnutella.h"
#include "pmsg.h"
#include "tx.h"

typedef struct mqueue mqueue_t;

struct mq_ops {
    void (*putq)(mqueue_t *q, pmsg_t *mb);
};

struct mq_cops {
    void (*puthere)(mqueue_t *q, pmsg_t *mb, gint msize);
    void (*qlink_remove)(mqueue_t *q, GList *l);
    GList *(*rmlink_prev)(mqueue_t *q, GList *l, gint size);
    void (*update_flowc)(mqueue_t *q);
};

struct mqueue {
    struct gnutella_header header;  
    struct gnutella_node *node;     
    const struct mq_ops *ops;       
    const struct mq_cops *cops;     
    txdrv_t *tx_drv;                
    GList *qhead;           
    GList *qtail;           
    GList **qlink;          
    gpointer swift_ev;      
    gint swift_elapsed;     
    gint qlink_count;       
    gint maxsize;           
    gint count;             
    gint hiwat;             
    gint lowat;             
    gint size;              
    gint flags;             
    gint last_written;      
    gint flowc_written;     
    gint last_size;         
};

/*
 * Queue flags.
 */

#define MQ_FLOWC        0x00000001  
#define MQ_DISCARD      0x00000002  
#define MQ_SWIFT        0x00000004  
#define MQ_WARNZONE     0x00000008  
#define mq_is_flow_controlled(q)    ((q)->flags & MQ_FLOWC)
#define mq_is_swift_controlled(q)   ((q)->flags & MQ_SWIFT)
#define mq_maxsize(q)               ((q)->maxsize)
#define mq_size(q)                  ((q)->size)
#define mq_lowat(q)                 ((q)->lowat)
#define mq_hiwat(q)                 ((q)->hiwat)
#define mq_count(q)                 ((q)->count)
#define mq_pending(q)               ((q)->size + tx_pending((q)->tx_drv))
#define mq_bio(q)                   (tx_bio_source((q)->tx_drv))
#define mq_node(q)                  ((q)->node)

/*
 * Public interface
 */

void mq_putq(mqueue_t *q, pmsg_t *mb);
void mq_free(mqueue_t *q);
void mq_clear(mqueue_t *q);
void mq_discard(mqueue_t *q);
void mq_shutdown(mqueue_t *q);
void mq_fill_ops(struct mq_ops *ops);

const struct mq_cops *mq_get_cops(void);

#endif  /* _core_mq_h_ */

/* vi: set ts=4: */

---