libethereal -> libwireshark. idl2eth -> idl2wrs. There are a _lot_ of
[obnox/wireshark/wip.git] / file.h
diff --git a/file.h b/file.h
index ee47fee173d4a86f24a1f126d8e5d082a71bd152..716ea5da99e5c45ae6f3e4f51d67f94a968d0284 100644 (file)
--- a/file.h
+++ b/file.h
@@ -3,8 +3,8 @@
  *
  * $Id$
  *
- * Ethereal - Network traffic analyzer
- * By Gerald Combs <gerald@ethereal.com>
+ * Wireshark - Network traffic analyzer
+ * By Gerald Combs <gerald@wireshark.org>
  * Copyright 1998 Gerald Combs
  *
  * This program is free software; you can redistribute it and/or
@@ -55,6 +55,41 @@ typedef enum {
        CF_PRINT_WRITE_ERROR    /**< print operation failed while writing to the printer */
 } cf_print_status_t;
 
+typedef enum {
+    cf_cb_file_closing,
+    cf_cb_file_closed,
+    cf_cb_file_read_start,
+    cf_cb_file_read_finished,
+#ifdef HAVE_LIBPCAP
+    cf_cb_live_capture_prepared,
+    cf_cb_live_capture_update_started,
+    cf_cb_live_capture_update_continue,
+    cf_cb_live_capture_update_finished,
+    cf_cb_live_capture_fixed_started,
+    cf_cb_live_capture_fixed_continue,
+    cf_cb_live_capture_fixed_finished,
+       cf_cb_live_capture_stopping,
+#endif
+    cf_cb_packet_selected,
+    cf_cb_packet_unselected,
+    cf_cb_field_unselected,
+    cf_cb_file_safe_started,
+    cf_cb_file_safe_finished,
+    cf_cb_file_safe_reload_finished,
+    cf_cb_file_safe_failed
+} cf_cbs;
+
+typedef void (*cf_callback_t) (gint event, gpointer data, gpointer user_data);
+
+extern void
+cf_callback_invoke(int event, gpointer data);
+
+extern void
+cf_callback_add(cf_callback_t func, gpointer user_data);
+
+extern void
+cf_callback_remove(cf_callback_t func);
+
 /**
  * Open a capture file.
  *
@@ -97,7 +132,7 @@ cf_read_status_t cf_read(capture_file *cf);
  * @param err the error code, if an error had occured
  * @return one of cf_status_t
  */
-cf_status_t cf_start_tail(capture_file *cf, const char *fname, const char *iface, gboolean is_tempfile, int *err);
+cf_status_t cf_start_tail(capture_file *cf, const char *fname, gboolean is_tempfile, int *err);
 
 /**
  * Read packets from the "end" of a capture file.
@@ -125,9 +160,10 @@ cf_read_status_t cf_finish_tail(capture_file *cf, int *err);
  * @param fname the filename to save to
  * @param range the range of packets to save
  * @param save_format the format of the file to save (libpcap, ...)
+ * @param compressed wether to gzip compress the file
  * @return one of cf_status_t
  */
-cf_status_t cf_save(capture_file * cf, const char *fname, packet_range_t *range, guint save_format);
+cf_status_t cf_save(capture_file * cf, const char *fname, packet_range_t *range, guint save_format, gboolean compressed);
 
 /**
  * Get a displayable name of the capture file.
@@ -143,7 +179,15 @@ const gchar *cf_get_display_name(capture_file *cf);
  * @param cf the capture file
  * @return the number of packets in the capture file
  */
-int cf_packet_count(capture_file *cf);
+int cf_get_packet_count(capture_file *cf);
+
+/**
+ * Set the number of packets in the capture file.
+ * 
+ * @param cf the capture file
+ * @param the number of packets in the capture file
+ */
+void cf_set_packet_count(capture_file *cf, int packet_count);
 
 /**
  * Is this capture file a temporary file?
@@ -153,6 +197,11 @@ int cf_packet_count(capture_file *cf);
  */
 gboolean cf_is_tempfile(capture_file *cf);
 
+/**
+ * Set flag, that this file is a tempfile.
+ */
+void cf_set_tempfile(capture_file *cf, gboolean is_tempfile);
+
 /**
  * Set flag, if the number of packet drops while capturing are known or not.
  * 
@@ -169,6 +218,22 @@ void cf_set_drops_known(capture_file *cf, gboolean drops_known);
  */
 void cf_set_drops(capture_file *cf, guint32 drops);
 
+/**
+ * Get flag state, if the number of packet drops while capturing are known or not.
+ * 
+ * @param cf the capture file
+ * @return TRUE if the number of packet drops are known, FALSE otherwise
+ */
+gboolean cf_get_drops_known(capture_file *cf);
+
+/**
+ * Get the number of packet drops while capturing.
+ * 
+ * @param cf the capture file
+ * @return the number of packet drops occured while capturing
+ */
+guint32 cf_get_drops(capture_file *cf);
+
 /**
  * Set the read filter.
  * @todo this shouldn't be required, remove it somehow
@@ -213,9 +278,10 @@ void cf_redissect_packets(capture_file *cf);
  * Rescan all packets and just run taps - don't reconstruct the display.
  * 
  * @param cf the capture file
+ * @param do_columns TRUE if columns are to be generated, FALSE otherwise
  * @return one of cf_read_status_t
  */
-cf_read_status_t cf_retap_packets(capture_file *cf);
+cf_read_status_t cf_retap_packets(capture_file *cf, gboolean do_columns);
 
 /**
  * The time format has changed, rescan all packets.
@@ -251,6 +317,15 @@ cf_print_status_t cf_write_pdml_packets(capture_file *cf, print_args_t *print_ar
  */
 cf_print_status_t cf_write_psml_packets(capture_file *cf, print_args_t *print_args);
 
+/**
+ * Print (export) the capture file into CSV format.
+ *
+ * @param cf the capture file
+ * @param print_args the arguments what and how to export
+ * @return one of cf_print_status_t
+ */
+cf_print_status_t cf_write_csv_packets(capture_file *cf, print_args_t *print_args);
+
 /**
  * Find Packet in protocol tree.
  * 
@@ -377,8 +452,9 @@ char *cf_read_error_message(int err, const gchar *err_info);
  * Merge two (or more) capture files into one.
  * @todo is this the right place for this function? It doesn't have to do a lot with capture_file.
  *
- * @param out_filename output filename
- * @param out_fd output file descriptor
+ * @param out_filename pointer to output filename; if output filename is
+ * NULL, a temporary file name is generated and *out_filename is set
+ * to point to the generated file name
  * @param in_file_count the number of input files to merge
  * @param in_filnames array of input filenames
  * @param file_type the output filetype
@@ -386,8 +462,7 @@ char *cf_read_error_message(int err, const gchar *err_info);
  * @return one of cf_status_t
  */
 cf_status_t
-cf_merge_files(const char *out_filename, int out_fd, int in_file_count,
+cf_merge_files(char **out_filename, int in_file_count,
                char *const *in_filenames, int file_type, gboolean do_append);
 
-
 #endif /* file.h */