ui2c.h

Go to the documentation of this file.

/*
 * $Id: ui2c.h 13925 2007-06-22 05:24:10Z cbiere $
 *
 * Copyright (c) 2004, Emile Roberts
 *
 *----------------------------------------------------------------------
 * 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_bridge_ui2c_h_
#define _if_bridge_ui2c_h_

#include "common.h"

/*
 *  SECTION 1 - Interface includes
 */

#include "lib/adns.h"

#include "if/core/downloads.h"
#include "if/core/fileinfo.h"
#include "if/core/net_stats.h"
#include "if/core/hcache.h"
#include "if/core/hsep.h"
#include "if/core/search.h"
#include "if/core/share.h"
#include "if/core/uploads.h"
#include "if/core/bitzi.h"

/* Property table includes */
#include "if/gnet_property.h"

/* adns interface functions */
gboolean guc_adns_resolve(const gchar *hostname,
            adns_callback_t user_callback, gpointer user_data);

/* download and src interface functions */
gboolean
guc_download_new(const gchar *filename,
    const gchar *uri,
    filesize_t size,
    const host_addr_t addr,
    guint16 port,
    const gchar *guid,
    const gchar *hostname,
    const struct sha1 *sha1,
    time_t stamp,
    fileinfo_t *fi,
    gnet_host_vec_t *proxies,
    guint32 flags,
    const gchar *parq_id);

void
guc_download_auto_new(const gchar *filename,
    filesize_t size,
    const host_addr_t addr,
    guint16 port,
    const gchar *guid,
    const gchar *hostname,
    const struct sha1 *sha1,
    time_t stamp,
    fileinfo_t *fi,
    gnet_host_vec_t *proxies,
    guint32 flags);

gchar *guc_download_build_url(const struct download *d);
gchar *guc_file_info_build_magnet(gnet_fi_t handle);
gchar *guc_file_info_get_file_url(gnet_fi_t handle);
const gchar *guc_file_info_status_to_string(const gnet_fi_status_t *status);
gint guc_download_get_http_req_percent(const struct download *d);
void guc_download_fallback_to_push(struct download *d, gboolean on_timeout,
        gboolean user_request);
gint guc_download_remove_all_from_peer(const gchar *guid,
        const host_addr_t addr, guint16 port, gboolean unavailable);
gint guc_download_remove_all_named(const gchar *name);
gint guc_download_remove_all_with_sha1(const struct sha1 *sha1);
void guc_download_remove_file(struct download *d, gboolean reset);
gboolean guc_download_file_exists(const struct download *d);
void guc_download_requeue(struct download *d);
void guc_download_start(struct download *d, gboolean check_allowed);
void guc_download_pause(struct download *d);
gboolean guc_download_remove(struct download *d);
void guc_download_abort(struct download *d);
void guc_download_resume(struct download *d);
void guc_download_freeze_queue(void);
void guc_download_thaw_queue(void);
gboolean guc_download_queue_is_frozen(void);
void guc_download_clear_stopped(gboolean complete,
    gboolean failed, gboolean unavailable, gboolean now);
guint guc_download_handle_magnet(const gchar *url);
const gchar *guc_download_get_hostname(const struct download *d);
const gchar *guc_download_get_country(const struct download *d);
gdouble guc_download_source_progress(const struct download *d);
gdouble guc_download_total_progress(const struct download *d);
gboolean guc_download_something_to_clear(void);
void guc_download_index_changed(const host_addr_t addr, guint16 port,
    const gchar *guid, filesize_t from, filesize_t to);
struct download *guc_src_get_download(gnet_src_t src_handle);
void guc_src_add_listener(src_listener_t cb, gnet_src_ev_t ev,
    frequency_t t, guint32 interval);
void guc_src_remove_listener(src_listener_t cb,
    gnet_src_ev_t ev);

/* fileinfo interface functions */
const gchar *guc_file_info_readable_filename(fileinfo_t *fi);
gnet_fi_info_t *guc_fi_get_info(gnet_fi_t fih);
void guc_fi_free_info(gnet_fi_info_t *info);
void guc_fi_get_status(gnet_fi_t fih, gnet_fi_status_t *s);
gchar **guc_fi_get_aliases(gnet_fi_t fih);
void guc_fi_purge_by_handle_list(const GSList *list);
void guc_fi_add_listener(fi_listener_t cb, gnet_fi_ev_t ev,
    frequency_t t, guint32 interval);
void guc_fi_remove_listener(fi_listener_t cb, gnet_fi_ev_t ev);
GSList *guc_fi_get_chunks(gnet_fi_t fih);
void guc_fi_free_chunks(GSList *chunks);
GSList *guc_fi_get_ranges(gnet_fi_t fih);
void guc_fi_free_ranges(GSList *ranges);
void guc_fi_add_listener(fi_listener_t cb, gnet_fi_ev_t ev,
    frequency_t t, guint32 interval);
void guc_fi_remove_listener(fi_listener_t cb, gnet_fi_ev_t ev);

/* gnet_stats interface functions */
void guc_gnet_stats_get(gnet_stats_t *stats);
void guc_gnet_stats_tcp_get(gnet_stats_t *stats);
void guc_gnet_stats_udp_get(gnet_stats_t *stats);
void guc_gnet_get_bw_stats(gnet_bw_source type, gnet_bw_stats_t *stats);
const gchar *guc_gnet_stats_drop_reason_to_string(msg_drop_reason_t reason);

/* hcache interface functions */
void guc_hcache_clear_host_type(host_type_t type);
void guc_hcache_clear(hcache_type_t type);
void guc_hcache_get_stats(hcache_stats_t *stats);

/* hsep interface functions */
gint guc_hsep_get_table_size(void);
void guc_hsep_get_non_hsep_triple(hsep_triple *tripledest);
const gchar *guc_hsep_get_static_str(gint row, gint column);
void guc_hsep_add_global_table_listener(GCallback cb,
    frequency_t t, guint32 interval);
void guc_hsep_remove_global_table_listener(GCallback cb);

/* http interface functions */
const gchar *guc_http_range_to_string(const GSList *list);
GSList * guc_http_range_merge(GSList *old_list, GSList *new_list);

/* node interface functions */
void guc_node_add_node_added_listener(node_added_listener_t l);
void guc_node_add_node_removed_listener(node_removed_listener_t l);
void guc_node_add_node_info_changed_listener(node_info_changed_listener_t l);
void guc_node_add_node_flags_changed_listener(node_flags_changed_listener_t l);
void guc_node_remove_node_added_listener(node_added_listener_t l);
void guc_node_remove_node_removed_listener(node_removed_listener_t l);
void guc_node_remove_node_info_changed_listener(node_info_changed_listener_t l);
void guc_node_remove_node_flags_changed_listener(node_flags_changed_listener_t l);
void guc_node_add(const host_addr_t addr, guint16 port, guint32 flags);
void guc_node_remove_by_id(const node_id_t node_id);
void guc_node_remove_nodes_by_id(const GSList *node_list);
gboolean guc_node_get_status(const node_id_t node_id, gnet_node_status_t *s);
gnet_node_info_t *guc_node_get_info(const node_id_t node_id);
void guc_node_clear_info(gnet_node_info_t *info);
void guc_node_free_info(gnet_node_info_t *info);
gboolean guc_node_fill_flags(const node_id_t node_id, gnet_node_flags_t *flags);
gboolean guc_node_fill_info(const node_id_t node_id, gnet_node_info_t *info);
const gchar *guc_node_flags_to_string(const gnet_node_flags_t *flags);
const gchar *guc_node_peermode_to_string(node_peer_t m);

/* parq interface functions */
gint guc_get_parq_dl_position(const struct download *d);
gint guc_get_parq_dl_queue_length(const struct download *d);
gint guc_get_parq_dl_eta(const struct download *d);
gint guc_get_parq_dl_retry_delay(const struct download *d);

/* search interface functions */
guint guc_search_handle_magnet(const gchar *url);
void guc_search_update_items(gnet_search_t sh, guint32 items);
guint guc_search_get_lifetime(gnet_search_t sh);
time_t guc_search_get_create_time(gnet_search_t sh);
void guc_search_set_create_time(gnet_search_t sh, time_t t);
guint32 guc_search_get_reissue_timeout(gnet_search_t sh);
void guc_search_set_reissue_timeout(gnet_search_t sh, guint32 timeout);

const gchar *guc_search_query(gnet_search_t sh);

gboolean guc_search_is_active(gnet_search_t sh);
gboolean guc_search_is_browse(gnet_search_t sh);
gboolean guc_search_is_expired(gnet_search_t sh);
gboolean guc_search_is_frozen(gnet_search_t sh);
gboolean guc_search_is_local(gnet_search_t sh);
gboolean guc_search_is_passive(gnet_search_t sh);

gnet_search_t guc_search_new(const gchar *query,
    time_t create_time, guint lifetime,
    guint32 reissue_timeout, flag_t flags);
gboolean guc_search_browse(gnet_search_t sh,
    const gchar *hostname, host_addr_t addr, guint16 port,
    const gchar *guid, const gnet_host_vec_t *proxies, guint32 flags);
gboolean guc_search_locally(gnet_search_t sh, const gchar *query);
void guc_search_reissue(gnet_search_t sh);
void guc_search_close(gnet_search_t sh);
void guc_search_start(gnet_search_t sh);
void guc_search_stop(gnet_search_t sh);
void guc_search_add_kept(gnet_search_t sh, guint32 kept);

/* settings interface functions */
guint16 guc_listen_port(void);
host_addr_t guc_listen_addr(enum net_type net);
const gchar *guc_settings_home_dir(void);
const gchar *guc_settings_config_dir(void);

/* share interface functions */
void guc_shared_dir_add(const gchar * path);
void guc_share_scan(void);
guint64 guc_shared_files_scanned(void);
guint64 guc_shared_kbytes_scanned(void);
void guc_share_add_search_request_listener
    (search_request_listener_t l);
void guc_share_remove_search_request_listener
    (search_request_listener_t l);

/* upload interface functions */
gnet_upload_info_t *guc_upload_get_info(gnet_upload_t uh);
void guc_upload_free_info(gnet_upload_info_t *info);
void guc_upload_get_status
    (gnet_upload_t uh, gnet_upload_status_t *si);
void guc_upload_kill(gnet_upload_t upload);
void guc_upload_add_upload_added_listener
    (upload_added_listener_t l);
void guc_upload_remove_upload_added_listener
    (upload_added_listener_t l);
void guc_upload_add_upload_removed_listener
    (upload_removed_listener_t l);
void guc_upload_remove_upload_removed_listener
    (upload_removed_listener_t l);
void guc_upload_add_upload_info_changed_listener
    (upload_info_changed_listener_t l);
void guc_upload_remove_upload_info_changed_listener
    (upload_info_changed_listener_t l);

/* upload stats interface functions */
void guc_upload_stats_prune_nonexistent(void);
void guc_upload_stats_clear_all(void);

const gchar *guc_version_get_version_string(void);

/* bitzi interface functions*/
gboolean guc_bitzi_has_cached_ticket(const struct sha1 *sha1);
void guc_query_bitzi_by_sha1(const struct sha1 *sha1, filesize_t filesize);

void guc_gtk_gnutella_exit(gint code);

#endif /* _if_bridge_ui2c_h_ */
/* vi: set ts=4 sw=4 cindent: */

---