capture_session.h

Go to the documentation of this file.

 
#ifndef __CAPCHILD_CAPTURE_SESSION_H__
#define __CAPCHILD_CAPTURE_SESSION_H__
 
#ifndef _WIN32
#include <sys/types.h>
#include <stdint.h>
#endif
 
#include "capture_opts.h"
 
#include <epan/fifo_string_cache.h>
#include <wsutil/processes.h>
 
#include "cfile.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#ifdef HAVE_LIBPCAP
/* Current state of capture engine. XXX - differentiate states */
typedef enum {
    CAPTURE_STOPPED,        
    CAPTURE_PREPARING,      
    CAPTURE_RUNNING         
} capture_state;
 
struct _info_data;
 
/*
 * State of a capture session.
 */
typedef struct _capture_session capture_session;
 
/*
 * Types of callbacks.
 */
 
typedef bool (*new_file_fn)(capture_session *cap_session, char *new_file);
 
typedef void (*new_packets_fn)(capture_session *cap_session, int to_read);
 
typedef void (*drops_fn)(capture_session *cap_session, uint32_t dropped,
                         const char *interface_name);
 
typedef void (*error_fn)(capture_session *cap_session, char *error_msg,
                         char *secondary_error_msg);
 
typedef void (*cfilter_error_fn)(capture_session *cap_session, unsigned i,
                                 const char *error_message);
 
typedef void (*closed_fn)(capture_session *cap_session, char *msg);
 
/*
 * The structure for the session.
 */
struct _capture_session {
    ws_process_id fork_child;             
    int       fork_child_status;          
    int       pipe_input_id;              
#ifdef _WIN32
    int       signal_pipe_write_fd;       
#endif
    capture_state state;                  
#ifndef _WIN32
    uid_t     owner;                      
    gid_t     group;                      
#endif
    bool  session_will_restart;       
    uint32_t   count;                      
    uint32_t   count_pending;              
    capture_options *capture_opts;        
    capture_file *cf;                     
    wtap_rec rec;                         
    Buffer buf;                           
    struct wtap *wtap;                    
    struct _info_data *cap_data_info;     
    // If the user wants to ignore duplicate frames, we need these.
    fifo_string_cache_t frame_dup_cache;
    GChecksum           *frame_cksum;
 
    /*
     * Routines supplied by our caller; we call them back to notify them
     * of various events.
     */
    new_file_fn new_file;
    new_packets_fn new_packets;
    drops_fn drops;
    error_fn error;
    cfilter_error_fn cfilter_error;
    closed_fn closed;
};
 
extern void
capture_session_init(capture_session *cap_session, capture_file *cf,
                     new_file_fn new_file, new_packets_fn new_packets,
                     drops_fn drops, error_fn error,
                     cfilter_error_fn cfilter_error, closed_fn closed);
 
void capture_process_finished(capture_session *cap_session);
#else
 
/* dummy is needed because clang throws the error: empty struct has size 0 in C, size 1 in C++ */
typedef struct _capture_session {int dummy;} capture_session;
 
#endif /* HAVE_LIBPCAP */
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* __CAPCHILD_CAPTURE_SESSION_H__ */