pmsg.h

Go to the documentation of this file.

/*
 * $Id: pmsg.h,v 1.9 2005/10/20 07:53:42 cbiere 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_pmsg_h_
#define _core_pmsg_h_

#include <glib.h>

typedef void (*pdata_free_t)(gpointer p, gpointer arg);

typedef struct pdata {
    pdata_free_t d_free;            
    gpointer d_arg;                 
    gint d_refcnt;                  
    gchar *d_arena;                 
    gchar *d_end;                   
    gchar d_embedded[1];            
} pdata_t;

#define pdata_start(x)      ((x)->d_arena)
#define pdata_len(x)        ((size_t) ((x)->d_end - (x)->d_arena))
#define pdata_addref(x)     do { (x)->d_refcnt++; } while (0)

/*
 * A message block
 */

struct mqueue;

typedef struct pmsg pmsg_t;
typedef gboolean (*pmsg_check_t)(pmsg_t *mb, const struct mqueue *q);

struct pmsg {
    gchar *m_rptr;                  
    gchar *m_wptr;                  
    pdata_t *m_data;                
    guint m_prio;                   
    pmsg_check_t m_check;           
};

typedef void (*pmsg_free_t)(pmsg_t *mb, gpointer arg);

#define PMSG_PRIO_MASK      0x00ffffff  
#define pmsg_start(x)       ((x)->m_data->d_arena)
#define pmsg_phys_len(x)    pdata_len((x)->m_data)
#define pmsg_is_writable(x) ((x)->m_data->d_refcnt == 1)
#define pmsg_prio(x)        ((x)->m_prio & PMSG_PRIO_MASK)

#define pmsg_is_unread(x)   ((x)->m_rptr == (x)->m_data->d_arena)
#define pmsg_read_base(x)   ((x)->m_rptr)

#define pmsg_check(x,y)     ((x)->m_check ? (x)->m_check((x), (y)) : TRUE)

/*
 * Message priorities.
 */

#define PMSG_P_DATA     0           
#define PMSG_P_CONTROL  1           
#define PMSG_P_URGENT   2           
#define PMSG_P_HIGHEST  3           
/*
 * Flags defined in highest bits of `m_prio'.
 */

#define PMSG_PF_EXT     0x80000000  
#define PMSG_PF_SENT    0x40000000  
#define pmsg_is_extended(x) ((x)->m_prio & PMSG_PF_EXT)
#define pmsg_was_sent(x)    ((x)->m_prio & PMSG_PF_SENT)
#define pmsg_mark_sent(x)   do { (x)->m_prio |= PMSG_PF_SENT; } while (0)

/*
 * Public interface
 */

void pmsg_init(void);
void pmsg_close(void);

gint pmsg_size(pmsg_t *mb);
pmsg_t *pmsg_new(gint prio, gconstpointer buf, gint len);
pmsg_t * pmsg_new_extend(
    gint prio, gconstpointer buf, gint len,
    pmsg_free_t free_cb, gpointer arg);
pmsg_t *pmsg_alloc(gint prio, pdata_t *db, gint roff, gint woff);
pmsg_t *pmsg_clone(pmsg_t *mb);
pmsg_t *pmsg_clone_extend(pmsg_t *mb, pmsg_free_t free_cb, gpointer arg);
pmsg_free_t pmsg_replace_ext(
    pmsg_t *mb, pmsg_free_t nfree, gpointer narg, gpointer *oarg);
gpointer pmsg_get_metadata(pmsg_t *mb);
pmsg_check_t pmsg_set_check(pmsg_t *mb, pmsg_check_t check);
void pmsg_free(pmsg_t *mb);
gint pmsg_write(pmsg_t *mb, gconstpointer data, gint len);
gint pmsg_read(pmsg_t *mb, gpointer data, gint len);

pdata_t *pdata_new(gint len);
pdata_t *pdata_allocb(void *buf, gint len,
    pdata_free_t freecb, gpointer freearg);
pdata_t *pdata_allocb_ext(void *buf, gint len,
    pdata_free_t freecb, gpointer freearg);
void pdata_free_nop(gpointer p, gpointer arg);
void pdata_unref(pdata_t *db);

#endif  /* _core_pmsg_h_ */

/* vi: set ts=4 sw=4 cindent: */

---