*
* $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
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.
*
* @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.
* @param err the error code, if an error had occured
* @return one of cf_read_status_t
*/
-cf_read_status_t cf_continue_tail(capture_file *cf, int to_read, int *err);
+cf_read_status_t cf_continue_tail(capture_file *cf, volatile int to_read, int *err);
/**
* Finish reading from "end" of a capture file.
*/
cf_read_status_t cf_finish_tail(capture_file *cf, int *err);
+/**
+ * Determine whether this capture file (or a range of it) can be saved
+ * (except by copying the raw file data).
+ *
+ * @param cf the capture file to check
+ * @return TRUE if it can be saved, FALSE if it can't
+ */
+gboolean cf_can_save_as(capture_file *cf);
+
/**
* Save a capture file (or a range of it).
*
* @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.
* @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?
*/
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.
*
*/
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
* 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.
*/
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.
*
* 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
* @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 */