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   guint32         packet_num;   /* current packet number */
  48   gint64          size;         /* file size */
  49 } merge_in_file_t;
  50
  51 /** Open a number of input files to merge.
  52  *
  53  * @param in_file_count number of entries in in_file_names and in_files
  54  * @param in_file_names filenames of the input files
  55  * @param in_files input file array to be filled (>= sizeof(merge_in_file_t) * in_file_count)
  56  * @param err wiretap error, if failed
  57  * @param err_info wiretap error string, if failed
  58  * @param err_fileno file on which open failed, if failed
  59  * @return TRUE if all files could be opened, FALSE otherwise
  60  */
  61 extern gboolean
  62 merge_open_in_files(int in_file_count, char *const *in_file_names,
  63                     merge_in_file_t **in_files, int *err, gchar **err_info,
  64                     int *err_fileno);
  65
  66 /** Close the input files again.
  67  *
  68  * @param in_file_count number of entries in in_files
  69  * @param in_files input file array to be closed
  70  */
  71 extern void
  72 merge_close_in_files(int in_file_count, merge_in_file_t in_files[]);
  73
  74 /** Try to get the frame type from the input files.
  75  *
  76  * @param in_file_count number of entries in in_files
  77  * @param in_files input file array
  78  * @return the frame type
  79  */
  80 extern int
  81 merge_select_frame_type(int in_file_count, merge_in_file_t in_files[]);
  82
  83 /** Try to get the snapshot length from the input files.
  84  *
  85  * @param in_file_count number of entries in in_files
  86  * @param in_files input file array
  87  * @return the snapshot length
  88  */
  89 extern int
  90 merge_max_snapshot_length(int in_file_count, merge_in_file_t in_files[]);
  91
  92 /** Read the next packet, in chronological order, from the set of files to
  93  * be merged.
  94  *
  95  * @param in_file_count number of entries in in_files
  96  * @param in_files input file array
  97  * @param err wiretap error, if failed
  98  * @param err_info wiretap error string, if failed
  99  * @return pointer to merge_in_file_t for file from which that packet
 100  * came, or NULL on error or EOF
 101  */
 102 extern merge_in_file_t *
 103 merge_read_packet(int in_file_count, merge_in_file_t in_files[], int *err,
 104                   gchar **err_info);
 105
 106
 107 /** Read the next packet, in file sequence order, from the set of files
 108  * to be merged.
 109  *
 110  * @param in_file_count number of entries in in_files
 111  * @param in_files input file array
 112  * @param err wiretap error, if failed
 113  * @param err_info wiretap error string, if failed
 114  * @return pointer to merge_in_file_t for file from which that packet
 115  * came, or NULL on error or EOF
 116  */
 117 extern merge_in_file_t *
 118 merge_append_read_packet(int in_file_count, merge_in_file_t in_files[],
 119                          int *err, gchar **err_info);
 120
 121 #ifdef __cplusplus
 122 }
 123 #endif /* __cplusplus */
 124
 125 #endif /* __MERGE_H__ */
 126