add more details for doxygen
[obnox/wireshark/wip.git] / gtk / hostlist_table.h
1 /* hostlist_table.h   2004 Ian Schorr
2  * modified from endpoint_talkers_table   2003 Ronnie Sahlberg
3  * Helper routines common to all host talkers taps.
4  *
5  * $Id: hostlist_table.h,v 1.8 2004/06/05 13:28:13 ulfl Exp $
6  *
7  * Ethereal - Network traffic analyzer
8  * By Gerald Combs <gerald@ethereal.com>
9  * Copyright 1998 Gerald Combs
10  * 
11  * This program is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU General Public License
13  * as published by the Free Software Foundation; either version 2
14  * of the License, or (at your option) any later version.
15  * 
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  * 
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
24  */
25
26 #include "sat.h"
27
28 /** @file
29  *  Hostlist definitions.
30  */
31
32 /** Hostlist information */
33 typedef struct _hostlist_talker_t {
34         address address;        /**< address */
35         SAT_E   sat;            /**< address type */
36         guint32 port_type;      /**< port_type (e.g. PT_TCP) */
37         guint32 port;           /**< port */
38
39         guint32 rx_frames;      /**< number of received packets */
40         guint32 tx_frames;      /**< number of transmitted packets */
41         guint32 rx_bytes;       /**< number of received bytes */
42         guint32 tx_bytes;       /**< number of transmitted bytes */
43 } hostlist_talker_t;
44
45 /** Hostlist widget */
46 typedef struct _hostlist_table {
47         char                *name;              /**< the name of the table */
48         GtkWidget           *win;               /**< GTK window */
49         GtkWidget           *page_lb;           /**< label */
50         GtkWidget           *scrolled_window;   /**< the scrolled window */
51         GtkCList            *table;             /**< the GTK table */
52         GtkWidget           *menu;              /**< context menu */
53         gboolean            has_ports;          /**< table has ports */
54         guint32             num_hosts;          /**< number of hosts (0 or 1) */
55         hostlist_talker_t   *hosts;             /**< array of host values */
56         gboolean            resolve_names;      /**< resolve address names? */
57 } hostlist_table;
58
59 /** Register the hostlist table for the multiple hostlist window.
60  *
61  * @param hide_ports hide the port columns
62  * @param table_name the table name to be displayed
63  * @param tap_name the registered tap name
64  * @param filter the optional filter name or NULL
65  * @param packet_func the function to be called for each incoming packet
66  */
67 extern void register_hostlist_table(gboolean hide_ports, char *table_name, char *tap_name, char *filter, void *packet_func);
68
69 /** Init the hostlist table for the single hostlist window.
70  *
71  * @param hide_ports hide the port columns
72  * @param table_name the table name to be displayed
73  * @param tap_name the registered tap name
74  * @param filter the optional filter name or NULL
75  * @param packet_func the function to be called for each incoming packet
76  */
77 extern void init_hostlist_table(gboolean hide_ports, char *table_name, char *tap_name, char *filter, void *packet_func);
78
79 /** Callback for "Endpoints" statistics item.
80  *
81  * @param w unused
82  * @param d unused
83  */
84 extern void init_hostlist_notebook_cb(GtkWidget *w, gpointer d);
85
86 /** Add some data to the table.
87  *
88  * @param hl the table to add the data to
89  * @param addr address
90  * @param port port
91  * @param sender TRUE, if this is a sender
92  * @param num_frames number of packets
93  * @param num_bytes number of bytes
94  * @param sat address type
95  * @param port_type the port type (e.g. PT_TCP)
96  */
97 void add_hostlist_table_data(hostlist_table *hl, address *addr,
98                              guint32 port, gboolean sender, int num_frames, int num_bytes, SAT_E sat, int port_type);