*
* $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_started,
+ cf_cb_file_read_finished,
+ cf_cb_packet_selected,
+ cf_cb_packet_unselected,
+ cf_cb_field_unselected,
+ cf_cb_file_save_started,
+ cf_cb_file_save_finished,
+ cf_cb_file_save_reload_finished,
+ cf_cb_file_save_failed
+} cf_cbs;
+
+typedef void (*cf_callback_t) (gint event, gpointer data, gpointer user_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.
*
/**
* Read all packets of a capture file into the internal structures.
- *
+ *
* @param cf the capture file to be read
+ * @param from_save reread asked from cf_save
* @return one of cf_read_status_t
*/
-cf_read_status_t cf_read(capture_file *cf);
+cf_read_status_t cf_read(capture_file *cf, gboolean from_save);
+
+gboolean cf_read_frame_r(capture_file *cf, frame_data *fdata,
+ union wtap_pseudo_header *pseudo_header, guint8 *pd,
+ int *err, gchar **err_info);
+
+gboolean cf_read_frame(capture_file *cf, frame_data *fdata,
+ int *err, gchar **err_info);
/**
* Start reading from the end of a capture file.
* This is used in "Update list of packets in Real-Time".
- *
+ *
* @param cf the capture file to be read from
* @param fname the filename to be read from
* @param is_tempfile is this a temporary file?
/**
* 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_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);
+
+/**
+ * Fake reading packets from the "end" of a capture file.
+ *
+ * @param cf the capture file to be read from
+ */
+void cf_fake_continue_tail(capture_file *cf);
/**
* 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_read_status_t
*/
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 cf the capture file to save to
* @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 whether 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 displayable name (don't have to be g_free'd)
*/
const gchar *cf_get_display_name(capture_file *cf);
+/**
+ * Set the source of the capture data for temporary files, e.g.
+ * "Interface eth0" or "Pipe from Pong"
+ *
+ * @param cf the capture file
+ * @param source the source description. this will be copied internally.
+ */
+void cf_set_tempfile_source(capture_file *cf, gchar *source);
+
+/**
+ * Get the source of the capture data for temporary files. Guaranteed to
+ * return a non-null value. The returned value should not be freed.
+ *
+ * @param cf the capture file
+ * @param source the source description. this will be copied internally.
+ */
+const gchar *cf_get_tempfile_source(capture_file *cf);
+
/**
* Get the number of packets in 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);
/**
- * Is this capture file a temporary file?
- *
+ * Set the number of packets in the capture file.
+ *
* @param cf the capture file
- * @return TRUE if it's a temporary file, FALSE otherwise
+ * @param the number of packets in the capture file
*/
-gboolean cf_is_tempfile(capture_file *cf);
+void cf_set_packet_count(capture_file *cf, int packet_count);
/**
- * Get the interface name to capture from.
- *
+ * Is this capture file a temporary file?
+ *
* @param cf the capture file
- * @return the interface name (don't have to be g_free'd)
+ * @return TRUE if it's a temporary file, FALSE otherwise
*/
-gchar *cf_get_iface(capture_file *cf);
+gboolean cf_is_tempfile(capture_file *cf);
/**
- * Get the capture filter of this capture file.
- *
- * @param cf the capture file
- * @return the capture filter (don't have to be g_free'd)
+ * Set flag, that this file is a tempfile.
*/
-gchar *cf_get_cfilter(capture_file *cf);
+void cf_set_tempfile(capture_file *cf, gboolean is_tempfile);
/**
* Set flag, 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
*/
/**
* Set the number of packet drops while capturing.
- *
+ *
* @param cf the capture file
* @param drops the number of packet drops occured while capturing
*/
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
- *
+ *
* @param cf the capture file
* @param rfcode the readfilter
*/
/**
* "Display Filter" packets in the capture file.
- *
+ *
* @param cf the capture file
* @param dfilter the display filter
* @param force TRUE if do in any case, FALSE only if dfilter changed
/**
* At least one "Refence Time" flag has changed, rescan all packets.
- *
+ *
* @param cf the capture file
*/
void cf_reftime_packets(capture_file *cf);
/**
- * At least one "Refence Time" flag has changed, rescan all packets.
- *
+ * Return the time it took to load the file
+ */
+gulong cf_get_computed_elapsed(void);
+
+/**
+ * The coloring rules have changed, redo coloring
+ *
* @param cf the capture file
*/
void cf_colorize_packets(capture_file *cf);
/**
* "Something" has changed, rescan all packets.
- *
+ *
* @param cf the capture file
*/
void cf_redissect_packets(capture_file *cf);
/**
* Rescan all packets and just run taps - don't reconstruct the display.
- *
+ *
* @param cf the capture file
* @return one of cf_read_status_t
*/
/**
* The time format has changed, rescan all packets.
- *
+ *
* @param cf the capture file
*/
void cf_change_time_formats(capture_file *cf);
+/**
+ * Adjust timestamp precision if auto is selected.
+ *
+ * @param cf the capture file
+ */
+void cf_timestamp_auto_precision(capture_file *cf);
+
/**
* Print the capture file.
- *
+ *
* @param cf the capture file
* @param print_args the arguments what and how to print
* @return one of cf_print_status_t
/**
* 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_print_status_t
/**
* 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_print_status_t
*/
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);
+
+/**
+ * Print (export) the capture file into C Arrays 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_carrays_packets(capture_file *cf, print_args_t *print_args);
+
/**
* Find Packet in protocol tree.
- *
+ *
* @param cf the capture file
* @param string the string to find
* @return TRUE if a packet was found, FALSE otherwise
/**
* Find Packet in summary line.
- *
+ *
* @param cf the capture file
* @param string the string to find
* @return TRUE if a packet was found, FALSE otherwise
/**
* Find Packet in packet data.
- *
+ *
* @param cf the capture file
* @param string the string to find
* @param string_size the size of the string to find
/**
* Find Packet by display filter.
- *
+ *
* @param cf the capture file
* @param sfcode the display filter to find a packet for
* @return TRUE if a packet was found, FALSE otherwise
/**
* GoTo Packet in first row.
- *
+ *
* @param cf the capture file
* @return TRUE if the first row exists, FALSE otherwise
*/
/**
* GoTo Packet in last row.
- *
+ *
* @param cf the capture file
* @return TRUE if last row exists, FALSE otherwise
*/
/**
* GoTo Packet with the given row.
- *
+ *
* @param cf the capture file
* @param row the row to go to
* @return TRUE if this row exists, FALSE otherwise
*/
void cf_unmark_frame(capture_file *cf, frame_data *frame);
+/**
+ * Ignore a particular frame in a particular capture.
+ *
+ * @param cf the capture file
+ * @param frame the frame to be ignored
+ */
+void cf_ignore_frame(capture_file *cf, frame_data *frame);
+
+/**
+ * Unignore a particular frame in a particular capture.
+ *
+ * @param cf the capture file
+ * @param frame the frame to be unignored
+ */
+void cf_unignore_frame(capture_file *cf, frame_data *frame);
+
/**
* Convert error number and info to a complete message.
*
* @param err the error number
- * @param err_info the additional info about this error (e.g. filename)
+ * @param err_info a string with additional details about this error
* @return statically allocated error message
*/
-char *cf_read_error_message(int err, const gchar *err_info);
+char *cf_read_error_message(int err, 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
*/
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);
+#if defined(HAVE_HEIMDAL_KERBEROS) || defined(HAVE_MIT_KERBEROS)
+void read_keytab_file(const char *);
+#endif
#endif /* file.h */
git.samba.org / obnox / wireshark / wip.git / blobdiff