extcap-base.h

Go to the documentation of this file.

#ifndef __EXTCAP_BASE_H__
#define __EXTCAP_BASE_H__
 
#include <glib.h>
#include <glib/gprintf.h>
#include <stdlib.h>
#include <stdint.h>
#include <stdbool.h>
 
#include <wsutil/ws_getopt.h>
 
#ifdef _WIN32
#include <io.h>
#endif
 
#include <wsutil/socket.h>
 
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
 
#define EXTCAP_BASE_OPTIONS_ENUM \
    EXTCAP_OPT_LIST_INTERFACES, \
    EXTCAP_OPT_VERSION, \
    EXTCAP_OPT_LIST_DLTS, \
    EXTCAP_OPT_INTERFACE, \
    EXTCAP_OPT_CONFIG, \
    EXTCAP_OPT_CONFIG_OPTION_NAME, \
    EXTCAP_OPT_CONFIG_OPTION_VALUE, \
    EXTCAP_OPT_CLEANUP_POSTKILL, \
    EXTCAP_OPT_CAPTURE, \
    EXTCAP_OPT_CAPTURE_FILTER, \
    EXTCAP_OPT_FIFO, \
    EXTCAP_OPT_CONTROL_OUT, \
    EXTCAP_OPT_CONTROL_IN, \
    EXTCAP_OPT_LOG_LEVEL, \
    EXTCAP_OPT_LOG_FILE
 
/* These should match what is defined in extcap.h in root.
 * XXX - Restructure the code so that they *are* the same. */
 
#define EXTCAP_BASE_OPTIONS \
    { "extcap-interfaces", ws_no_argument, NULL, EXTCAP_OPT_LIST_INTERFACES}, \
    { "extcap-version", ws_optional_argument, NULL, EXTCAP_OPT_VERSION}, \
    { "extcap-dlts", ws_no_argument, NULL, EXTCAP_OPT_LIST_DLTS}, \
    { "extcap-interface", ws_required_argument, NULL, EXTCAP_OPT_INTERFACE}, \
    { "extcap-config", ws_no_argument, NULL, EXTCAP_OPT_CONFIG}, \
    { "extcap-config-option-name", ws_required_argument, NULL, EXTCAP_OPT_CONFIG_OPTION_NAME}, \
    { "extcap-config-option-value", ws_required_argument, NULL, EXTCAP_OPT_CONFIG_OPTION_VALUE }, \
    { "extcap-cleanup-postkill", ws_no_argument, NULL, EXTCAP_OPT_CLEANUP_POSTKILL }, \
    { "capture", ws_no_argument, NULL, EXTCAP_OPT_CAPTURE}, \
    { "extcap-capture-filter", ws_required_argument,    NULL, EXTCAP_OPT_CAPTURE_FILTER}, \
    { "fifo", ws_required_argument, NULL, EXTCAP_OPT_FIFO}, \
    { "extcap-control-out", ws_required_argument, NULL, EXTCAP_OPT_CONTROL_OUT}, \
    { "extcap-control-in", ws_required_argument, NULL, EXTCAP_OPT_CONTROL_IN}, \
    { "log-level", ws_required_argument, NULL, EXTCAP_OPT_LOG_LEVEL}, \
    { "log-file", ws_required_argument, NULL, EXTCAP_OPT_LOG_FILE}
 
/* Extcap control pipe messages supported.
 * TOOLBAR messages are bidirectional,
 * QUIT messages are unidirectional (from the main application).
 */
#define EXTCAP_CONTROL_NONE 0
#define EXTCAP_CONTROL_TOOLBAR 1
#define EXTCAP_CONTROL_QUIT 2
 
typedef void (*extcap_toolbar_control_cb_t)(int, int, GBytes*);

typedef struct _extcap_parameters
{
    char*    exename;              
    char*    fifo;                 
    char*    control_in;           
    char*    control_out;          
    char*    interface;            
    char*    capture_filter;       
 
    char*    version;              
    char*    compiled_with;        
    char*    running_with;         
    char*    helppage;             
    uint8_t  capture;              
    uint8_t  show_config;          
    uint8_t  show_config_option;   
    char*    config_option_name;   
    char*    config_option_value;  
 
    char*    ws_version;           
 
    /* private content */
    GList*   interfaces;           
    uint8_t  do_version;           
    uint8_t  do_list_dlts;         
    uint8_t  do_list_interfaces;   
    uint8_t  do_cleanup_postkill;  
 
    int      control_in_fd;        
    int      control_out_fd;       
 
    char*    help_header;          
    GList*   help_options;         
 
    enum ws_log_level debug;       
 
    void (*cleanup_postkill_cb)(void); 
} extcap_parameters;

extern bool extcap_end_application;

void extcap_base_register_interface(extcap_parameters * extcap, const char * interface, const char * ifdescription, uint16_t dlt, const char * dltdescription );

void extcap_base_register_interface_ext(extcap_parameters * extcap, const char * interface, const char * ifdescription, uint16_t dlt, const char * dltname, const char * dltdescription, unsigned control);

bool extcap_base_register_graceful_shutdown_cb(extcap_parameters * extcap, void (*callback)(void));

bool extcap_base_register_cleanup_postkill_cb(extcap_parameters* extcap, void (*callback)(void));

bool extcap_base_register_toolbar_control_cb(extcap_parameters * extcap, extcap_toolbar_control_cb_t callback);

void extcap_base_set_util_info(extcap_parameters * extcap, const char * exename, const char * major, const char * minor, const char * release, const char * helppage);

void extcap_base_set_compiled_with(extcap_parameters * extcap, const char *fmt, ...);

void extcap_base_set_running_with(extcap_parameters * extcap, const char *fmt, ...);

uint8_t extcap_base_parse_options(extcap_parameters * extcap, int result, char * optargument);

uint8_t extcap_base_handle_interface(extcap_parameters * extcap);

void extcap_base_cleanup(extcap_parameters ** extcap);

void extcap_help_add_header(extcap_parameters * extcap, char * help_header);

void extcap_help_add_option(extcap_parameters * extcap, const char * help_option_name, const char * help_option_desc);

void extcap_version_print(extcap_parameters * extcap);

void extcap_help_print(extcap_parameters * extcap);

void extcap_cmdline_debug(char** ar, const unsigned n);

void extcap_config_debug(unsigned* count);

void extcap_base_help(void);

void extcap_log_init(extcap_parameters *extcap_conf);

void extcap_log_cmdarg_err(const char *msg_format, va_list ap);
 
#ifdef __cplusplus
}
#endif // __cplusplus
 
#endif // __EXTCAP_BASE_H__
 
/*
 * Editor modelines  -  https://www.wireshark.org/tools/modelines.html
 *
 * Local variables:
 * c-basic-offset: 4
 * tab-width: 8
 * indent-tabs-mode: nil
 * End:
 *
 * vi: set shiftwidth=4 tabstop=8 expandtab:
 * :indentSize=4:tabSize=8:noTabs=true:
 */