ggep.h

Go to the documentation of this file.

/*
 * $Id: ggep.h,v 1.10 2005/08/16 04:15:22 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_ggep_h_
#define _core_ggep_h_

#include "extensions.h"
#include "lib/cobs.h"
#include "lib/zlib_util.h"

#include <glib.h>

#define GGEP_MAGIC      '\xc3'      
/*
 * GGEP Extension Header Flags.
 */

#define GGEP_F_LAST     0x80U       
#define GGEP_F_COBS     0x40U       
#define GGEP_F_DEFLATE  0x20U       
#define GGEP_F_MBZ      0x10U       
#define GGEP_F_IDLEN    0x0fU       
/*
 * GGEP Length Encoding.
 */

#define GGEP_L_CONT     '\x80'      
#define GGEP_L_LAST     '\x40'      
#define GGEP_L_VALUE    '\x3f'      
#define GGEP_L_VSHIFT   6

#define GGEP_L_XFLAGS   (GGEP_L_CONT | GGEP_L_LAST)

/*
 * The "H" extension
 */

#define GGEP_H_SHA1     0x01        
#define GGEP_H_BITPRINT 0x02        
#define GGEP_H_MD5      0x03        
#define GGEP_H_UUID     0x04        
#define GGEP_H_MD4      0x05        
/*
 * Flags for ggep_ext_write() and friends.
 */

#define GGEP_W_LAST     0x00000001  
#define GGEP_W_COBS     0x00000002  
#define GGEP_W_DEFLATE  0x00000004  
#define GGEP_W_FIRST    0x00000008  
enum ggep_magic { GGEP_MAGIC_ID = 0x62961da4U };

typedef struct ggep_stream {
    enum ggep_magic magic;
    gchar *outbuf;          
    gchar *end;             
    gchar *o;               
    gchar *fp;              
    gchar *lp;              
    gchar *last_fp;         
    size_t size;            
    guint8 flags;           
    gboolean magic_emitted; 
    gboolean begun;         
    cobs_stream_t cs;       
    zlib_deflater_t *zd;    
} ggep_stream_t;

/*
 * Public interface.
 */

struct iovec;

gint ggep_decode_into(extvec_t *exv, gchar *buf, size_t len);

void ggep_stream_init(ggep_stream_t *gs, gpointer data, size_t len);
gboolean ggep_stream_begin(ggep_stream_t *gs, const char *id, guint32 wflags);
gboolean ggep_stream_writev(ggep_stream_t *gs,
    const struct iovec *iov, gint iovcnt);
gboolean ggep_stream_write(ggep_stream_t *gs, gconstpointer data, size_t len);
gboolean ggep_stream_end(ggep_stream_t *gs);
size_t ggep_stream_close(ggep_stream_t *gs);
gboolean ggep_stream_packv(ggep_stream_t *gs,
    const gchar *id, const struct iovec *iov, gint iovcnt, guint32 wflags);
gboolean ggep_stream_pack(ggep_stream_t *gs,
    const gchar *id, gconstpointer payload, size_t plen, guint32 wflags);

gboolean ggep_stream_is_valid(ggep_stream_t *gs);

#endif  /* _core_ggep_h_ */

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

---