#include "cfile.h"
-/** Return values from various cf_xxx functions. */
+
+/** Return values from functions that only can succeed or fail. */
+typedef enum {
+ CF_OK, /**< operation succeeded */
+ CF_ERROR /**< operation got an error (function may provide err with details) */
+} cf_status_t;
+
+/** Return values from functions that read capture files. */
typedef enum {
- CF_OK, /**< operation succeeded */
- CF_ERROR, /**< operation got an error (function may provide err with details) */
- CF_ABORTED, /**< operation aborted by user */
+ CF_READ_OK, /**< operation succeeded */
+ CF_READ_ERROR, /**< operation got an error (function may provide err with details) */
+ CF_READ_ABORTED /**< operation aborted by user */
+} cf_read_status_t;
+
+/** Return values from functions that print sets of packets. */
+typedef enum {
+ CF_PRINT_OK, /**< print operation succeeded */
CF_PRINT_OPEN_ERROR, /**< print operation failed while opening printer */
CF_PRINT_WRITE_ERROR /**< print operation failed while writing to the printer */
-} cf_status_t;
+} cf_print_status_t;
+
+typedef enum {
+ cf_cb_file_closed,
+ cf_cb_file_read_start,
+ cf_cb_file_read_finished,
+#ifdef HAVE_LIBPCAP
+ cf_cb_live_capture_prepare,
+ cf_cb_live_capture_started,
+ cf_cb_live_capture_finished,
+#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 is_tempfile is this a temporary file?
* @return one of cf_status_t
*/
-cf_status_t cf_open(capture_file *cf, char *fname, gboolean is_tempfile, int *err);
+cf_status_t cf_open(capture_file *cf, const char *fname, gboolean is_tempfile, int *err);
/**
* Close a capture file.
* Read all packets of a capture file into the internal structures.
*
* @param cf the capture file to be read
- * @return one of cf_status_t
+ * @return one of cf_read_status_t
*/
-cf_status_t cf_read(capture_file *cf);
+cf_read_status_t cf_read(capture_file *cf);
/**
* Start reading from the end of 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, char *fname, 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 cf the capture file to be read from
* @param to_read the number of packets to read
* @param err the error code, if an error had occured
- * @return one of cf_status_t
+ * @return one of cf_read_status_t
*/
-cf_status_t cf_continue_tail(capture_file *cf, int to_read, int *err);
+cf_read_status_t cf_continue_tail(capture_file *cf, int to_read, int *err);
/**
* Finish reading from "end" of a capture file.
*
* @param cf the capture file to be read from
* @param err the error code, if an error had occured
- * @return one of cf_status_t
+ * @return one of cf_read_status_t
*/
-cf_status_t cf_finish_tail(capture_file *cf, int *err);
+cf_read_status_t cf_finish_tail(capture_file *cf, int *err);
/**
* Save a capture file (or a range of it).
* @param save_format the format of the file to save (libpcap, ...)
* @return one of cf_status_t
*/
-cf_status_t cf_save(capture_file * cf, 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);
/**
* Get a displayable name of the capture file.
gboolean cf_is_tempfile(capture_file *cf);
/**
- * Get the interface name to capture from.
+ * Set flag, if the number of packet drops while capturing are known or not.
*
* @param cf the capture file
- * @return the interface name (don't have to be g_free'd)
+ * @param drops_known TRUE if the number of packet drops are known, FALSE otherwise
*/
-gchar *cf_get_iface(capture_file *cf);
+void cf_set_drops_known(capture_file *cf, gboolean drops_known);
/**
- * Get the capture filter of this capture file.
+ * Set the number of packet drops while capturing.
*
* @param cf the capture file
- * @return the capture filter (don't have to be g_free'd)
+ * @param drops the number of packet drops occured while capturing
*/
-gchar *cf_get_cfilter(capture_file *cf);
+void cf_set_drops(capture_file *cf, guint32 drops);
/**
- * Set flag, if the number of packet drops while capturing are known or not.
+ * Get flag state, if the number of packet drops while capturing are known or not.
*
* @param cf the capture file
- * @param drops_known TRUE if the number of packet drops are known, FALSE otherwise
+ * @return TRUE if the number of packet drops are known, FALSE otherwise
*/
-void cf_set_drops_known(capture_file *cf, gboolean drops_known);
+gboolean cf_get_drops_known(capture_file *cf);
/**
- * Set the number of packet drops while capturing.
+ * Get the number of packet drops while capturing.
*
* @param cf the capture file
- * @param drops the number of packet drops occured while capturing
+ * @return the number of packet drops occured while capturing
*/
-void cf_set_drops(capture_file *cf, guint32 drops);
+guint32 cf_get_drops(capture_file *cf);
/**
* Set the read filter.
void cf_redissect_packets(capture_file *cf);
/**
- * A tap listener want's to rescan all packets.
+ * Rescan all packets and just run taps - don't reconstruct the display.
*
* @param cf the capture file
- * @return one of cf_status_t
+ * @return one of cf_read_status_t
*/
-cf_status_t cf_retap_packets(capture_file *cf);
+cf_read_status_t cf_retap_packets(capture_file *cf);
/**
* The time format has changed, rescan all packets.
*
* @param cf the capture file
* @param print_args the arguments what and how to print
- * @return one of cf_status_t
+ * @return one of cf_print_status_t
*/
-cf_status_t cf_print_packets(capture_file *cf, print_args_t *print_args);
+cf_print_status_t cf_print_packets(capture_file *cf, print_args_t *print_args);
/**
* Print (export) the capture file into PDML format.
*
* @param cf the capture file
* @param print_args the arguments what and how to export
- * @return one of cf_status_t
+ * @return one of cf_print_status_t
*/
-cf_status_t cf_write_pdml_packets(capture_file *cf, print_args_t *print_args);
+cf_print_status_t cf_write_pdml_packets(capture_file *cf, print_args_t *print_args);
/**
* Print (export) the capture file into PSML format.
*
* @param cf the capture file
* @param print_args the arguments what and how to export
- * @return one of cf_status_t
+ * @return one of cf_print_status_t
*/
-cf_status_t cf_write_psml_packets(capture_file *cf, print_args_t *print_args);
+cf_print_status_t cf_write_psml_packets(capture_file *cf, print_args_t *print_args);
/**
* Find Packet in protocol tree.
* @param err_info the additional info about this error (e.g. filename)
* @return statically allocated error message
*/
-char *cf_read_error_message(int err, gchar *err_info);
+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
* @param do_append FALSE to merge chronologically, TRUE simply append
- * @return TRUE if merging suceeded, FALSE otherwise
+ * @return one of cf_status_t
*/
-gboolean
-cf_merge_files(const char *out_filename, int out_fd, int in_file_count,
+cf_status_t
+cf_merge_files(char **out_filename, int in_file_count,
char *const *in_filenames, int file_type, gboolean do_append);
-
#endif /* file.h */
git.samba.org / obnox / wireshark / wip.git / blobdiff