nodes.h

Go to the documentation of this file.

/*
 * $Id: nodes.h,v 1.20 2005/11/26 22:19:12 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_nodes_h_
#define _if_core_nodes_h_

#include "common.h"

#include "if/core/hosts.h"
#include "lib/vendors.h"

typedef guint32 gnet_node_t;

/*
 * XXX this structure should really be inlined in a node,
 * XXX to avoid definition duplication --RAM, 2004-08-21
 */

typedef struct gnet_node_status {
    guchar status;              
    /* FIXME: the variables below should go to gnet_node_info since they
     *        only change very seldom
     */
    time_t connect_date;    
    time_t up_date;         
    guint32 gnet_files_count;   
    guint32 gnet_kbytes_count;  
    gboolean gnet_info_known;   
    guint32  sent;              
    guint32  received;          
    guint32  tx_dropped;        
    guint32  rx_dropped;        
    guint32  n_bad;             
    guint16  n_dups;            
    guint16  n_hard_ttl;        
    guint32  n_weird;           
    guint32  n_hostile;         
    gint     squeue_sent;
    gint     squeue_count;
    gint     mqueue_count;
    gint     mqueue_percent_used;
    gboolean in_tx_flow_control;
    gboolean in_tx_swift_control;

    /*
     * Traffic statistics -- RAM, 13/05/2002.
     */

    gint32   tx_given;          
    gint32   tx_deflated;       
    gint32   tx_written;        
    gboolean tx_compressed;     
    gfloat   tx_compression_ratio; 
    guint32  tx_bps;            
    gint32   rx_given;          
    gint32   rx_inflated;       
    gint32   rx_read;           
    gboolean rx_compressed;     
    gfloat   rx_compression_ratio;
    gfloat   rx_bps;            
    /*
     * Gnutella statistics -- RAM, 10/12/2003.
     */

    gboolean has_qrp;       
    gfloat qrp_efficiency;  
    guint32 rx_queries;     
    guint32 tx_queries;     
    guint32 rx_qhits;       
    guint32 tx_qhits;       
    gint qrt_slots;         
    gint qrt_generation;    
    gint qrt_fill_ratio;    
    gint qrt_pass_throw;    
    guint32  rt_avg;            
    guint32  rt_last;           
    guint32 tcp_rtt;            
    guint32 udp_rtt;            
    gint     shutdown_remain;   
    gchar    message[128];      
} gnet_node_status_t;

typedef struct gnet_node_info {
    gnet_node_t node_handle;    
    gchar *error_str;       
    gint proto_major;       
    gint proto_minor;       
    gchar *vendor;          
    gint country;           
    union vendor_code vcode;
    host_addr_t addr;       
    guint16 port;           
    gboolean is_pseudo;     
    host_addr_t gnet_addr;  
    guint16 gnet_port;      
    gchar gnet_guid[GUID_RAW_SIZE];     
} gnet_node_info_t;

/*
 * Peer modes.
 */

typedef enum {
    NODE_P_LEAF = 0,            
    NODE_P_AUTO,                
    NODE_P_ULTRA,               
    NODE_P_NORMAL,              
    NODE_P_CRAWLER,             
    NODE_P_UDP,                 
    NODE_P_UNKNOWN              
} node_peer_t;

/*
 * QRT state.
 */

typedef enum {
    QRT_S_NONE = 0,             
    QRT_S_SENDING,              
    QRT_S_SENT,                 
    QRT_S_RECEIVING,            
    QRT_S_PATCHING,             
    QRT_S_RECEIVED              
} qrt_state_t;

typedef struct gnet_node_flags {
    node_peer_t peermode;
    qrt_state_t qrt_state;
    qrt_state_t uqrt_state;
    guint8 hops_flow;
    gboolean incoming;
    gboolean writable;
    gboolean readable;
    gboolean tx_compressed;
    gboolean rx_compressed;
    gboolean mqueue_empty;
    gboolean mqueue_above_lowat;
    gboolean in_tx_flow_control;
    gboolean in_tx_swift_control;
    gboolean is_push_proxied;
    gboolean is_proxying;
    gboolean tls;
} gnet_node_flags_t;

/*
 * Node states.
 */
typedef enum {
    GTA_NODE_CONNECTING         = 1,    
    GTA_NODE_HELLO_SENT         = 2,    
    GTA_NODE_WELCOME_SENT       = 3,    
    GTA_NODE_CONNECTED          = 4,    
    GTA_NODE_REMOVING           = 5,    
    GTA_NODE_RECEIVING_HELLO    = 6,    
    GTA_NODE_SHUTDOWN           = 7     
} gnet_node_state_t;

#define GTA_NORMAL_TTL              4   
/*
 * Nodes callback definitions
 */
typedef void (*node_added_listener_t) (gnet_node_t);
typedef void (*node_removed_listener_t) (gnet_node_t);
typedef void (*node_info_changed_listener_t) (gnet_node_t);
typedef void (*node_flags_changed_listener_t) (gnet_node_t);

#define node_add_listener(signal, callback) \
    CAT3(node_add_,signal,_listener)(callback);

#define node_remove_listener(signal, callback) \
    CAT3(node_remove_,signal,_listener)(callback);

#ifdef CORE_SOURCES

/***
 *** Gnet nodes
 ***/

void node_add_node_added_listener(node_added_listener_t);
void node_remove_node_added_listener(node_added_listener_t);
void node_add_node_removed_listener(node_removed_listener_t);
void node_remove_node_removed_listener(node_removed_listener_t);
void node_add_node_info_changed_listener(node_info_changed_listener_t);
void node_remove_node_info_changed_listener(node_info_changed_listener_t);
void node_add_node_flags_changed_listener(node_flags_changed_listener_t);
void node_remove_node_flags_changed_listener(node_flags_changed_listener_t);

/*
 * Nodes public interface
 */
void node_add(const host_addr_t addr, guint16, guint32 flags);
void node_remove_by_handle(gnet_node_t n);
void node_remove_nodes_by_handle(GSList *node_list);
void node_get_status(const gnet_node_t n, gnet_node_status_t *s);
gnet_node_info_t *node_get_info(const gnet_node_t n);
void node_clear_info(gnet_node_info_t *info);
void node_free_info(gnet_node_info_t *info);
void node_fill_flags(gnet_node_t n, gnet_node_flags_t *flags);
void node_fill_info(const gnet_node_t n, gnet_node_info_t *info);

void node_udp_gui_show(void);
void node_udp_gui_remove(void);

#endif /* CORE_SOURCES */

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

---