1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
/* capture_dissectors.h
* Routines for handling capture dissectors
*
* 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.
*/
#ifndef __CAPTURE_DISSECTORS_H__
#define __CAPTURE_DISSECTORS_H__
#include "ws_symbol_export.h"
#include <wiretap/wtap.h>
#include <capture_info.h>
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/** @file
*/
typedef struct capture_dissector_handle* capture_dissector_handle_t;
/** callback function definition for capture dissectors */
typedef gboolean (*capture_dissector_t)(const guchar *pd, int offset, int len, capture_packet_info_t *cpinfo, const union wtap_pseudo_header *pseudo_header);
/* a protocol uses the function to register a capture sub-dissector table
* @param[in] name Name of capture sub-dissector table.
* @param[in] ui_name Name string used when referring to capture sub-dissector table in UI.
*/
WS_DLL_PUBLIC void register_capture_dissector_table(const char *name, const char *ui_name);
/* Create an anonymous handle for a capture dissector
* @param[in] dissector capture dissector function.
* @param[in] proto Protocol associated with capture dissector function.
* @return Handle created for capture dissector
*/
WS_DLL_PUBLIC capture_dissector_handle_t create_capture_dissector_handle(capture_dissector_t dissector, const int proto);
/* Find a dissector by name
* @param[in] name Name of capture dissector
* @return Handle for capture dissector if found, NULL otherwise
*/
WS_DLL_PUBLIC capture_dissector_handle_t find_capture_dissector(const char *name);
/* Register a new capture dissector
* @param[in] name Name of capture dissector function.
* @param[in] dissector capture dissector function.
* @param[in] proto Protocol associated with capture dissector function.
* @return Handle created for capture dissector
*/
WS_DLL_PUBLIC capture_dissector_handle_t register_capture_dissector(const char *name, capture_dissector_t dissector, int proto);
/* Add an entry to a uint capture dissector table
* @param[in] name Name of capture dissector table
* @param[in] pattern Numerical value associated with capture dissector
* @param[in] handle Handle to capture dissector
*/
WS_DLL_PUBLIC void capture_dissector_add_uint(const char *name, const guint32 pattern, capture_dissector_handle_t handle);
/* Look for a given value in a given uint capture dissector table and, if found,
* call the dissector with the arguments supplied, and return TRUE,
* otherwise return FALSE
* @param[in] name Name of capture dissector table
* @param[in] pattern Numerical value associated with capture dissector
* @param[in] pd Data buffer of captured bytes
* @param[in] offset Current offset into pd
* @param[in] len Length of pd
* @param[in] cpinfo Capture statistics
* @param[in] pseudo_header Wiretap pseudo header information
*/
WS_DLL_PUBLIC gboolean try_capture_dissector(const char* name, const guint32 pattern, const guchar *pd, int offset, int len, capture_packet_info_t *cpinfo, const union wtap_pseudo_header *pseudo_header);
/* Call a capture dissector through a handle. If handle is value return TRUE,
* otherwise return FALSE
* @param[in] handle Capture dissector handle
* @param[in] pd Data buffer of captured bytes
* @param[in] offset Current offset into pd
* @param[in] len Length of pd
* @param[in] cpinfo Capture statistics
* @param[in] pseudo_header Wiretap pseudo header information
*/
WS_DLL_PUBLIC gboolean call_capture_dissector(capture_dissector_handle_t handle, const guchar *pd, int offset, int len, capture_packet_info_t *cpinfo, const union wtap_pseudo_header *pseudo_header);
/* Get current capture packet count for a particular protocol
* @param[in] counts Packet count structure
* @param[in] proto Protocol to retrieve packet count from
* @return Number of packets captured for a particular protocol
*/
WS_DLL_PUBLIC guint32 capture_dissector_get_count(packet_counts* counts, const int proto);
/* Increment packet capture count by 1 for a particular protocol.
* @param[in] cpinfo Capture statistics
* @param[in] proto Protocol to increment packet count
*/
WS_DLL_PUBLIC void capture_dissector_increment_count(capture_packet_info_t *cpinfo, const int proto);
extern void capture_dissector_init(void);
extern void capture_dissector_cleanup(void);
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* capture_dissectors.h */
|
