capture_opts.h File Reference

#include <sys/types.h>
#include <capture/capture_ifinfo.h>
#include "ringbuffer.h"
#include <wsutil/wslog.h>
#include <wsutil/filter_files.h>

Go to the source code of this file.

Classes
struct	interface_tag
struct	link_row_tag
struct	interface_options_tag
struct	capture_options_tag

Macros
#define	LONGOPT_LIST_TSTAMP_TYPES   LONGOPT_BASE_CAPTURE+1
#define	LONGOPT_SET_TSTAMP_TYPE   LONGOPT_BASE_CAPTURE+2
#define	LONGOPT_COMPRESS_TYPE   LONGOPT_BASE_CAPTURE+3
#define	LONGOPT_CAPTURE_TMPDIR   LONGOPT_BASE_CAPTURE+4
#define	LONGOPT_UPDATE_INTERVAL   LONGOPT_BASE_CAPTURE+5
#define	OPTSTRING_A
#define	LONGOPT_BUFFER_SIZE
#define	OPTSTRING_B
#define	LONGOPT_MONITOR_MODE
#define	OPTSTRING_I
#define	LONGOPT_CAPTURE_COMMON
#define	OPTSTRING_CAPTURE_COMMON    "a:" OPTSTRING_A "b:" OPTSTRING_B "c:Df:F:i:" OPTSTRING_I "Lps:y:"
#define	DEFAULT_CAPTURE_BUFFER_SIZE   2
#define	DEFAULT_UPDATE_INTERVAL   100

Typedefs
typedef struct interface_tag	interface_t
typedef struct link_row_tag	link_row
typedef struct interface_options_tag	interface_options
typedef struct capture_options_tag	capture_options

Enumerations
enum	caps_query { CAPS_QUERY_LINK_TYPES = 0x1 , CAPS_QUERY_TIMESTAMP_TYPES = 0x2 }

Functions
void	capture_opts_init (capture_options *capture_opts, GList *(*get_iface_list)(int *, char **))
void	capture_opts_cleanup (capture_options *capture_opts)
int	capture_opts_add_opt (capture_options *capture_opts, int opt, const char *ws_optarg)
void	capture_opts_log (const char *domain, enum ws_log_level level, capture_options *capture_opts)
void	capture_opts_list_file_types (void)
int	capture_opts_print_if_capabilities (if_capabilities_t *caps, const interface_options *interface_opts, int queries)
void	capture_opts_print_interfaces (GList *if_list)
void	capture_opts_trim_snaplen (capture_options *capture_opts, int snaplen_min)
void	capture_opts_trim_ring_num_files (capture_options *capture_opts)
int	capture_opts_default_iface_if_necessary (capture_options *capture_opts, const char *capture_device)
void	capture_opts_del_iface (capture_options *capture_opts, unsigned if_index)
void	interface_opts_free (interface_options *interface_opts)
interface_options *	interface_opts_from_if_info (capture_options *capture_opts, const if_info_t *if_info)
void	collect_ifaces (capture_options *capture_opts)
void	capture_opts_free_link_row (void *elem)
void	capture_opts_free_interface_t (interface_t *device)

Detailed Description

Capture options (all parameters needed to do the actual capture)

Macro Definition Documentation

LONGOPT_CAPTURE_COMMON

#define LONGOPT_CAPTURE_COMMON

Value:

    {"autostop",              ws_required_argument, NULL, 'a'}, \
    {"ring-buffer",           ws_required_argument, NULL, 'b'}, \
    LONGOPT_BUFFER_SIZE \
    {"list-interfaces",       ws_no_argument,       NULL, 'D'}, \
    {"interface",             ws_required_argument, NULL, 'i'}, \
    LONGOPT_MONITOR_MODE \
    {"list-data-link-types",  ws_no_argument,       NULL, 'L'}, \
    {"no-promiscuous-mode",   ws_no_argument,       NULL, 'p'}, \
    {"snapshot-length",       ws_required_argument, NULL, 's'}, \
    {"linktype",              ws_required_argument, NULL, 'y'}, \
    {"list-time-stamp-types", ws_no_argument,       NULL, LONGOPT_LIST_TSTAMP_TYPES}, \
    {"time-stamp-type",       ws_required_argument, NULL, LONGOPT_SET_TSTAMP_TYPE}, \
    {"compress-type",         ws_required_argument, NULL, LONGOPT_COMPRESS_TYPE}, \
    {"temp-dir",              ws_required_argument, NULL, LONGOPT_CAPTURE_TMPDIR},\
    {"update-interval",       ws_required_argument, NULL, LONGOPT_UPDATE_INTERVAL},

Typedef Documentation

capture_options

typedef struct capture_options_tag capture_options

Capture options coming from user interface