Xcode 4 isn't available on DVD, but is available for download from
[obnox/wireshark/wip.git] / merge.h
1 /* merge.h
2  * Definitions for routines for merging files.
3  *
4  * $Id$
5  *
6  * Wireshark - Network traffic analyzer
7  * By Gerald Combs <gerald@wireshark.org>
8  * Copyright 1998 Gerald Combs
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License
12  * as published by the Free Software Foundation; either version 2
13  * of the License, or (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
23  */
24
25 #ifndef __MERGE_H__
26 #define __MERGE_H__
27
28 #ifdef __cplusplus
29 extern "C" {
30 #endif /* __cplusplus */
31
32 typedef enum {
33   PACKET_PRESENT,
34   PACKET_NOT_PRESENT,
35   AT_EOF,
36   GOT_ERROR
37 } in_file_state_e;
38
39 /**
40  * Structures to manage our input files.
41  */
42 typedef struct merge_in_file_s {
43   const char     *filename;
44   wtap           *wth;
45   gint64          data_offset;
46   in_file_state_e state;
47   gint64          size;         /* file size */
48 } merge_in_file_t;
49
50 /** Open a number of input files to merge.
51  * 
52  * @param in_file_count number of entries in in_file_names and in_files
53  * @param in_file_names filenames of the input files
54  * @param in_files input file array to be filled (>= sizeof(merge_in_file_t) * in_file_count)
55  * @param err wiretap error, if failed
56  * @param err_info wiretap error string, if failed
57  * @param err_fileno file on which open failed, if failed
58  * @return TRUE if all files could be opened, FALSE otherwise
59  */
60 extern gboolean
61 merge_open_in_files(int in_file_count, char *const *in_file_names,
62                     merge_in_file_t **in_files, int *err, gchar **err_info,
63                     int *err_fileno);
64
65 /** Close the input files again.
66  * 
67  * @param in_file_count number of entries in in_files
68  * @param in_files input file array to be closed
69  */
70 extern void
71 merge_close_in_files(int in_file_count, merge_in_file_t in_files[]);
72
73 /** Try to get the frame type from the input files.
74  * 
75  * @param in_file_count number of entries in in_files
76  * @param in_files input file array
77  * @return the frame type
78  */
79 extern int
80 merge_select_frame_type(int in_file_count, merge_in_file_t in_files[]);
81
82 /** Try to get the snapshot length from the input files.
83  * 
84  * @param in_file_count number of entries in in_files
85  * @param in_files input file array
86  * @return the snapshot length
87  */
88 extern int
89 merge_max_snapshot_length(int in_file_count, merge_in_file_t in_files[]);
90
91 /** Read the next packet, in chronological order, from the set of files to
92  * be merged.
93  * 
94  * @param in_file_count number of entries in in_files
95  * @param in_files input file array
96  * @param err wiretap error, if failed
97  * @param err_info wiretap error string, if failed
98  * @return pointer to wtap for file from which that packet came, or NULL on
99  * error or EOF
100  */
101 extern wtap *
102 merge_read_packet(int in_file_count, merge_in_file_t in_files[], int *err,
103                   gchar **err_info);
104
105
106 /** Read the next packet, in file sequence order, from the set of files
107  * to be merged.
108  * 
109  * @param in_file_count number of entries in in_files
110  * @param in_files input file array
111  * @param err wiretap error, if failed
112  * @param err_info wiretap error string, if failed
113  * @return pointer to wtap for file from which that packet came, or NULL on
114  * error or EOF
115  */
116 extern wtap *
117 merge_append_read_packet(int in_file_count, merge_in_file_t in_files[],
118                          int *err, gchar **err_info);
119
120 #ifdef __cplusplus
121 }
122 #endif /* __cplusplus */
123
124 #endif /* __MERGE_H__ */
125