search.h

Go to the documentation of this file.

/*
 * $Id: search.h,v 1.20 2006/02/01 23:13:21 cbiere 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_search_h_
#define _if_core_search_h_

#include "common.h"

#include "lib/misc.h"
#include "lib/vendors.h"
#include "if/core/nodes.h"

/***
 *** Searches
 ***/
typedef guint32 gnet_search_t;

/*
 * Flags for search_new()
 */
enum {
    SEARCH_F_PASSIVE    = 1 << 0,   
    SEARCH_F_ENABLED    = 1 << 1,   
    SEARCH_F_BROWSE     = 1 << 2    
};

/*
 * Host vectors held in query hits.
 */
typedef struct gnet_host_vec {
    gnet_host_t *hvec;      
    gint hvcnt;             
} gnet_host_vec_t;

/*
 * Result sets `status' flags.
 */
#define ST_TLS              (1 << 10)   
#define ST_BH               (1 << 9)    
#define ST_KNOWN_VENDOR     (1 << 8)    
#define ST_PARSED_TRAILER   (1 << 7)    
#define ST_UDP              (1 << 6)    
#define ST_BOGUS            (1 << 5)    
#define ST_PUSH_PROXY       (1 << 4)    
#define ST_GGEP             (1 << 3)    
#define ST_UPLOADED         (1 << 2)    
#define ST_BUSY             (1 << 1)    
#define ST_FIREWALL         (1 << 0)    
/*
 * Processing of ignored files.
 */
#define SEARCH_IGN_DISPLAY_AS_IS    0   
#define SEARCH_IGN_DISPLAY_MARKED   1   
#define SEARCH_IGN_NO_DISPLAY       2   
typedef struct gnet_results_set {
    gchar *guid;                
    host_addr_t addr;
    guint16 port;
    guint16 status;             
    guint32 speed;
    time_t  stamp;              
    union vendor_code vcode;    
    gchar *version;             
    gint country;               
    flag_t  flags;
    gnet_host_vec_t *proxies;   
    gchar *hostname;            
    host_addr_t udp_addr;       
    host_addr_t last_hop;       
    GSList *records;
    guint32 num_recs;
} gnet_results_set_t;

/*
 * Result record flags
 */
#define SR_DOWNLOADED   0x0001
#define SR_IGNORED      0x0002
#define SR_DONT_SHOW    0x0004

typedef struct gnet_record {
    gchar  *name;               
    filesize_t size;            
    guint32 index;              
    gchar  *sha1;               
    gchar  *tag;                
    gchar  *xml;                
    gnet_host_vec_t *alt_locs;  
    flag_t  flags;
} gnet_record_t;


typedef void (*search_got_results_listener_t)
    (GSList *, const gnet_results_set_t *);

/*
 * Search public interface, visible only from the bridge.
 */

#ifdef CORE_SOURCES

gnet_search_t search_new(const gchar *, time_t create_time, guint lifetime,
        guint32 timeout, flag_t flags);
void search_close(gnet_search_t sh);

void search_start(gnet_search_t sh);
void search_stop(gnet_search_t sh);

/*  search_is_stopped doesn't exist yet!
gboolean search_is_stopped(gnet_search_t sh);
*/

void search_reissue(gnet_search_t sh);
void search_add_kept(gnet_search_t sh, guint32 kept);

gboolean search_is_passive(gnet_search_t sh);
gboolean search_is_active(gnet_search_t sh);
gboolean search_is_frozen(gnet_search_t sh);
gboolean search_is_expired(gnet_search_t sh);

void search_set_reissue_timeout(gnet_search_t sh, guint32 timeout);
guint32 search_get_reissue_timeout(gnet_search_t sh);
guint search_get_lifetime(gnet_search_t sh);
time_t search_get_create_time(gnet_search_t sh);
void search_set_create_time(gnet_search_t sh, time_t t);

void search_free_alt_locs(gnet_record_t *rc);
void search_free_proxies(gnet_results_set_t *rs);

void search_update_items(gnet_search_t sh, guint32 items);

gboolean search_browse(gnet_search_t sh,
    const gchar *hostname, host_addr_t addr, guint16 port,
    const gchar *guid, gboolean push, const gnet_host_vec_t *proxies);

#endif /* CORE_SOURCES */
#endif /* _if_core_search_h_ */

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

---