annotate src/transfer/source.h @ 0:d39e1d0d75b6

initial add
author paulo@hit-nxdomain.opendns.com
date Sat, 20 Feb 2010 21:18:28 -0800
parents
children
rev   line source
paulo@0 1 /*
paulo@0 2 * $Id: source.h,v 1.4 2003/12/22 02:46:34 hipnod Exp $
paulo@0 3 *
paulo@0 4 * Copyright (C) 2002-2003 giFT project (gift.sourceforge.net)
paulo@0 5 *
paulo@0 6 * This program is free software; you can redistribute it and/or modify it
paulo@0 7 * under the terms of the GNU General Public License as published by the
paulo@0 8 * Free Software Foundation; either version 2, or (at your option) any
paulo@0 9 * later version.
paulo@0 10 *
paulo@0 11 * This program is distributed in the hope that it will be useful, but
paulo@0 12 * WITHOUT ANY WARRANTY; without even the implied warranty of
paulo@0 13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
paulo@0 14 * General Public License for more details.
paulo@0 15 */
paulo@0 16
paulo@0 17 #ifndef GIFT_GT_TRANSFER_SOURCE_H_
paulo@0 18 #define GIFT_GT_TRANSFER_SOURCE_H_
paulo@0 19
paulo@0 20 /*****************************************************************************/
paulo@0 21
paulo@0 22 struct transfer;
paulo@0 23 struct source;
paulo@0 24
paulo@0 25 typedef struct gt_source
paulo@0 26 {
paulo@0 27 uint32_t user_ip;
paulo@0 28 uint16_t user_port;
paulo@0 29 uint32_t server_ip;
paulo@0 30 uint16_t server_port;
paulo@0 31 BOOL firewalled;
paulo@0 32 gt_guid_t *guid;
paulo@0 33 uint32_t index;
paulo@0 34 char *filename;
paulo@0 35
paulo@0 36 /*
paulo@0 37 * Parameters we don't understand, but were in the source URL.
paulo@0 38 * Parsed for forwards compatibility reasons, so newer versions
paulo@0 39 * can play with the same state files as older versions).
paulo@0 40 */
paulo@0 41 Dataset *extra;
paulo@0 42
paulo@0 43 /*
paulo@0 44 * Fields that get set depending on what happens to this source.
paulo@0 45 * This should be in a shared per-server structure, actually.
paulo@0 46 */
paulo@0 47 time_t retry_time; /* used for Retry-After; pollMin */
paulo@0 48 char *status_txt; /* previous status text message */
paulo@0 49 BOOL uri_res_failed; /* uri-res request failed */
paulo@0 50 BOOL connect_failed; /* last connection attempt failed */
paulo@0 51 } GtSource;
paulo@0 52
paulo@0 53 /*****************************************************************************/
paulo@0 54
paulo@0 55 GtSource *gt_source_new (void);
paulo@0 56 void gt_source_free (GtSource *gt);
paulo@0 57
paulo@0 58 char *gt_source_serialize (GtSource *src);
paulo@0 59 GtSource *gt_source_unserialize (const char *url);
paulo@0 60
paulo@0 61 void gt_source_set_ip (GtSource *src, in_addr_t port);
paulo@0 62 void gt_source_set_port (GtSource *src, in_port_t port);
paulo@0 63 void gt_source_set_index (GtSource *src, uint32_t index);
paulo@0 64 void gt_source_set_server_ip (GtSource *src, in_addr_t server_ip);
paulo@0 65 void gt_source_set_server_port (GtSource *src, in_port_t server_port);
paulo@0 66 void gt_source_set_firewalled (GtSource *src, BOOL fw);
paulo@0 67
paulo@0 68 BOOL gt_source_set_filename (GtSource *src, const char *filename);
paulo@0 69 BOOL gt_source_set_guid (GtSource *src, const gt_guid_t *guid);
paulo@0 70
paulo@0 71 /*****************************************************************************/
paulo@0 72
paulo@0 73 /* deprecated */
paulo@0 74 char *gt_source_url_new (const char *filename, uint32_t index,
paulo@0 75 in_addr_t user_ip, uint16_t user_port,
paulo@0 76 in_addr_t server_ip, uint16_t server_port,
paulo@0 77 BOOL firewalled,
paulo@0 78 const gt_guid_t *client_id);
paulo@0 79
paulo@0 80 /*****************************************************************************/
paulo@0 81
paulo@0 82 int gnutella_source_cmp (Protocol *p, struct source *a, struct source *b);
paulo@0 83 BOOL gnutella_source_add (Protocol *p, struct transfer *transfer,
paulo@0 84 struct source *source);
paulo@0 85 void gnutella_source_remove (Protocol *p, struct transfer *transfer,
paulo@0 86 struct source *source);
paulo@0 87
paulo@0 88 /*****************************************************************************/
paulo@0 89
paulo@0 90 #endif /* GIFT_GT_TRANSFER_SOURCE_H_ */