4f2ce4cc2e
The following parameters of capture_start(capture_options *capture_opts, capture_session *cap_session, info_data_t *cap_data, void(*update_cb)(void)) are not documented: parameter 'cap_data' Change-Id: I5953b35155de49ead64be263b32da2aa671f2206 Reviewed-on: https://code.wireshark.org/review/13546 Petri-Dish: Alexis La Goutte <alexis.lagoutte@gmail.com> Reviewed-by: Anders Broman <a.broman58@gmail.com>
124 lines
3.5 KiB
C
124 lines
3.5 KiB
C
/* capture.h
|
|
* Definitions for packet capture windows
|
|
*
|
|
* 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
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
*/
|
|
|
|
/* This file should only be included if libpcap is present */
|
|
|
|
#ifndef __CAPTURE_H__
|
|
#define __CAPTURE_H__
|
|
|
|
/** @file
|
|
* Capture related things.
|
|
*/
|
|
|
|
#include "capture_opts.h"
|
|
#include "capture_info.h"
|
|
#include "capchild/capture_session.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif /* __cplusplus */
|
|
|
|
typedef enum {
|
|
capture_cb_capture_prepared,
|
|
capture_cb_capture_update_started,
|
|
capture_cb_capture_update_continue,
|
|
capture_cb_capture_update_finished,
|
|
capture_cb_capture_fixed_started,
|
|
capture_cb_capture_fixed_continue,
|
|
capture_cb_capture_fixed_finished,
|
|
capture_cb_capture_stopping,
|
|
capture_cb_capture_failed
|
|
} capture_cbs;
|
|
|
|
typedef void (*capture_callback_t) (gint event, capture_session *cap_session,
|
|
gpointer user_data);
|
|
|
|
extern void
|
|
capture_callback_add(capture_callback_t func, gpointer user_data);
|
|
|
|
extern void
|
|
capture_callback_remove(capture_callback_t func, gpointer user_data);
|
|
|
|
/**
|
|
* Start a capture session.
|
|
*
|
|
* @param capture_opts the numerous capture options
|
|
* @param cap_session a handle for the capture session
|
|
* @param cap_data a struct with capture info data
|
|
* @param update_cb update screen
|
|
* @return TRUE if the capture starts successfully, FALSE otherwise.
|
|
*/
|
|
extern gboolean
|
|
capture_start(capture_options *capture_opts, capture_session *cap_session, info_data_t* cap_data, void(*update_cb)(void));
|
|
|
|
/** Stop a capture session (usually from a menu item). */
|
|
extern void
|
|
capture_stop(capture_session *cap_session);
|
|
|
|
/** Restart the current captured packets and start again. */
|
|
extern void
|
|
capture_restart(capture_session *cap_session);
|
|
|
|
/** Terminate the capture child cleanly when exiting. */
|
|
extern void
|
|
capture_kill_child(capture_session *cap_session);
|
|
|
|
struct if_stat_cache_s;
|
|
typedef struct if_stat_cache_s if_stat_cache_t;
|
|
|
|
/**
|
|
* Start gathering capture statistics for the interfaces specified.
|
|
* @param capture_opts A structure containing options for the capture.
|
|
* @return A pointer to the statistics state data.
|
|
*/
|
|
extern if_stat_cache_t * capture_stat_start(capture_options *capture_opts);
|
|
|
|
/**
|
|
* Fetch capture statistics, similar to pcap_stats().
|
|
*/
|
|
struct pcap_stat; /* Stub in case we don't or haven't yet included pcap.h */
|
|
extern gboolean capture_stats(if_stat_cache_t *sc, char *ifname, struct pcap_stat *ps);
|
|
|
|
/**
|
|
* Stop gathering capture statistics.
|
|
*/
|
|
void capture_stat_stop(if_stat_cache_t *sc);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif /* __cplusplus */
|
|
|
|
#endif /* capture.h */
|
|
|
|
/*
|
|
* Editor modelines - http://www.wireshark.org/tools/modelines.html
|
|
*
|
|
* Local Variables:
|
|
* c-basic-offset: 2
|
|
* tab-width: 8
|
|
* indent-tabs-mode: nil
|
|
* End:
|
|
*
|
|
* vi: set shiftwidth=2 tabstop=8 expandtab:
|
|
* :indentSize=2:tabSize=8:noTabs=true:
|
|
*/
|