fileinfo.h

Go to the documentation of this file.

/*
 * $Id: fileinfo.h,v 1.19 2005/11/21 21:13:47 rmanfredi Exp $
 *
 * Copyright (c) 2001-2003, Raphael Manfredi, Richard Eckart
 *
 *----------------------------------------------------------------------
 * 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 _if_core_fileinfo_h_
#define _if_core_fileinfo_h_

#include "common.h"

#include "if/core/downloads.h"  /* For gnet_srt_t */

struct shared_file;
struct download;

enum dl_chunk_status {
    DL_CHUNK_EMPTY = 0,         
    DL_CHUNK_BUSY  = 1,         
    DL_CHUNK_DONE  = 2,         
};

typedef guint32 gnet_fi_t;

typedef struct gnet_fi_info {
    gnet_fi_t fi_handle;
    gchar *path;                
    gchar *file_name;           
    gchar *sha1;                
    GSList *aliases;            
} gnet_fi_info_t;

typedef struct gnet_fi_status {
    guint32     recvcount;
    guint32     refcount;
    guint32     lifecount;
    filesize_t  size;
    filesize_t  done;
    guint32     recv_last_rate;
    guint32     aqueued_count;
    guint32     pqueued_count;

    /*
     * The following are set only when file has been completely downloaded.
     */

    gboolean    has_sha1;
    gboolean    sha1_matched;
    filesize_t  sha1_hashed;
    filesize_t  copied;
} gnet_fi_status_t;

typedef struct gnet_fi_chunks {
    filesize_t  from;
    filesize_t  to;
    enum dl_chunk_status status;
    gboolean old;
} gnet_fi_chunks_t;

typedef struct dl_file_info {
    gnet_fi_t fi_handle;    
    gchar *guid;            
    guint32 flags;          
    gchar *file_name;       
    gchar *path;            
    GSList *alias;          
    filesize_t size;        
    guint64 *size_atom;     
    gchar *sha1;            
    gchar *cha1;            
    gint32 refcount;        
    GSList *sources;        
    gint32 lifecount;       
    time_t stamp;           
    time_t ctime;           
    time_t ntime;           
    time_t last_flush;      
    time_t last_dmesh;      
    filesize_t done;        
    GSList *chunklist;      
    GSList *seen_on_network;  
    guint32 generation;     
    struct shared_file *sf; 
    gboolean file_size_known; 
    gboolean use_swarming;  
    gboolean dirty;         
    gboolean dirty_status;  
    gboolean hashed;        
    guint32  aqueued_count; 
    guint32  pqueued_count; 
    /*
     * The following group is used to compute the aggregated reception rate.
     */

    gint32 recvcount;       
    guint32 recv_last_rate; 
    guint32 recv_amount;    
    time_t recv_last_time;  
    /*
     * This group of fields is used by the background SHA1 and moving daemons.
     */

    guint cha1_elapsed;     
    filesize_t cha1_hashed; 
    guint copy_elapsed;     
    filesize_t copied;      
} fileinfo_t;

#define FILE_INFO_COMPLETE(x)   ((x)->done == (x)->size && (x)->file_size_known)

#define FILE_INFO_COMPLETE_AFTER(x,z)   \
    ((x)->done + (z) >= (x)->size && (x)->file_size_known)

typedef void (*fi_listener_t) (gnet_fi_t);
typedef void (*fi_src_listener_t) (gnet_fi_t, gnet_src_t);

typedef enum {
    EV_FI_ADDED = 0,       
    EV_FI_REMOVED,         
    EV_FI_INFO_CHANGED,    
    EV_FI_STATUS_CHANGED,  
    EV_FI_STATUS_CHANGED_TRANSIENT, 
    EV_FI_SRC_ADDED,       
    EV_FI_SRC_REMOVED,     
    EV_FI_RANGES_CHANGED,  
    EV_FI_EVENTS           
} gnet_fi_ev_t;

/*
 * Public interface, visible only from the bridge.
 */

#ifdef CORE_SOURCES

void fi_add_listener(fi_listener_t, gnet_fi_ev_t, frequency_t, guint32);
void fi_remove_listener(fi_listener_t, gnet_fi_ev_t);

gnet_fi_info_t *fi_get_info(gnet_fi_t);
void fi_free_info(gnet_fi_info_t *);
void fi_get_status(gnet_fi_t, gnet_fi_status_t *);
GSList *fi_get_chunks(gnet_fi_t);
void fi_free_chunks(GSList *chunks);
GSList *fi_get_ranges(gnet_fi_t);
void fi_free_ranges(GSList *ranges);
gchar **fi_get_aliases(gnet_fi_t fih);

void fi_purge_by_handle_list(const GSList *list);

const gchar *file_info_readable_filename(const struct dl_file_info *fi);

#endif /* CORE_SOURCES */
#endif /* _if_core_fileinfo_h_ */

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

---