uploads.h

Go to the documentation of this file.

/*
 * $Id: uploads.h,v 1.17 2005/12/11 13:52:51 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_uploads_h_
#define _if_core_uploads_h_

#include "common.h"
#include "lib/host_addr.h"

typedef guint32 gnet_upload_t;

typedef enum {
    GTA_UL_PUSH_RECEIVED    = 1,    
    GTA_UL_COMPLETE         = 2,    
    GTA_UL_SENDING          = 3,    
    GTA_UL_HEADERS          = 4,    
    GTA_UL_WAITING          = 5,    
    GTA_UL_ABORTED          = 6,    
    GTA_UL_CLOSED           = 7,    
    GTA_UL_QUEUED           = 8,    
    GTA_UL_QUEUE            = 9,    
    GTA_UL_QUEUE_WAITING    = 10,   
    GTA_UL_PFSP_WAITING     = 11    
} upload_stage_t;

typedef struct gnet_upload_status {
    upload_stage_t status;
    filesize_t  pos;     
    guint32 bps;         
    guint32 avg_bps;     
    time_t  last_update;

    gboolean parq_quick;
    guint   parq_position;
    guint   parq_size;
    guint32 parq_lifetime;
    guint32 parq_retry;
    guint   parq_queue_no;
} gnet_upload_status_t;

typedef struct gnet_upload_info {
    gnet_upload_t upload_handle;

    gchar  *name;        
    host_addr_t addr;       
    filesize_t file_size;   
    filesize_t range_start; 
    filesize_t range_end;   
    time_t  start_date;

    gchar  *user_agent; 
    gint   country;     
    gboolean push;      
    gboolean partial;   
    gboolean encrypted; 
} gnet_upload_info_t;

/*
 * State inspection macros.
 */

#define UPLOAD_IS_CONNECTING(u)                     \
    (   (u)->status == GTA_UL_HEADERS               \
    ||  (u)->status == GTA_UL_PUSH_RECEIVED         \
    ||  (u)->status == GTA_UL_QUEUE                 \
    ||  (u)->status == GTA_UL_QUEUE_WAITING         \
    ||  (u)->status == GTA_UL_PFSP_WAITING          \
    ||  (u)->status == GTA_UL_WAITING   )

#define UPLOAD_IS_COMPLETE(u)   \
    ((u)->status == GTA_UL_COMPLETE)

#define UPLOAD_IS_SENDING(u)    \
    ((u)->status == GTA_UL_SENDING)


struct ul_stats {
    gchar  *filename;
    filesize_t size;
    guint32 attempts;
    guint32 complete;
    guint64 bytes_sent;
    gfloat  norm;       
};

/*
 * Uploads callback definitions
 */
typedef void (*upload_added_listener_t) (
    gnet_upload_t, guint32, guint32);
typedef void (*upload_removed_listener_t) (
    gnet_upload_t, const gchar *, guint32, guint32);
typedef void (*upload_info_changed_listener_t) (
    gnet_upload_t, guint32, guint32);

#define upload_add_listener(signal, callback) \
    CAT3(upload_add_,signal,_listener)(callback);

#define upload_remove_listener(signal, callback) \
    CAT3(upload_remove_,signal,_listener)(callback);

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

#ifdef CORE_SOURCES

gnet_upload_info_t *upload_get_info(gnet_upload_t uh);
void upload_free_info(gnet_upload_info_t *info);
void upload_get_status(gnet_upload_t uh, gnet_upload_status_t *si);
void upload_kill_addr(const host_addr_t addr);
void upload_add_upload_added_listener(upload_added_listener_t l);
void upload_remove_upload_added_listener(upload_added_listener_t l);
void upload_add_upload_removed_listener(upload_removed_listener_t l);
void upload_remove_upload_removed_listener(upload_removed_listener_t l);
void upload_add_upload_info_changed_listener(
    upload_info_changed_listener_t l);
void upload_remove_upload_info_changed_listener(
    upload_info_changed_listener_t l);
void upload_kill(gnet_upload_t upload);
void upload_stats_prune_nonexistent(void);

#endif /* CORE_SOURCES */
#endif /* _if_core_uploads_h_ */

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

---