_stat_tap_table_ui Struct Reference

Registration descriptor and runtime state for a table-based tap statistics UI. More...

#include <stat_tap_ui.h>

Public Attributes
register_stat_group_t	group
const char *	title
const char *	tap_name
const char *	cli_string
void(*	stat_tap_init_cb )(struct _stat_tap_table_ui *new_stat)
	Callback invoked once to allocate and initialize the statistic's tables.
tap_packet_cb	packet_func
void(*	stat_tap_reset_table_cb )(stat_tap_table *table)
	Callback invoked to reset (clear) all rows in a table without freeing its schema.
void(*	stat_tap_free_table_item_cb )(stat_tap_table *table, unsigned row, unsigned column, stat_tap_table_item_type *field_data)
	Callback invoked to release resources held by a single table cell.
void(*	stat_filter_check_cb )(const char *opt_arg, const char **filter, char **err)
	Callback giving the dissector a chance to validate or transform the filter string.
size_t	nfields
stat_tap_table_item *	fields
size_t	nparams
tap_param *	params
GArray *	tables
unsigned	refcount

Detailed Description

Registration descriptor and runtime state for a table-based tap statistics UI.

Member Data Documentation

cli_string

const char* _stat_tap_table_ui::cli_string

Leading token of the "-z" CLI argument used to invoke this statistic

fields

stat_tap_table_item* _stat_tap_table_ui::fields

Array of column schema descriptors

group

register_stat_group_t _stat_tap_table_ui::group

Statistics menu group this tap belongs to

nfields

size_t _stat_tap_table_ui::nfields

Number of column schema entries in fields

nparams

size_t _stat_tap_table_ui::nparams

Number of entries in params

packet_func

tap_packet_cb _stat_tap_table_ui::packet_func

Callback invoked for each packet delivered to the tap

params

tap_param* _stat_tap_table_ui::params

Array of configurable parameter descriptors

refcount

unsigned _stat_tap_table_ui::refcount

Reference count used to manage deallocation of shared instances

stat_filter_check_cb

void(* _stat_tap_table_ui::stat_filter_check_cb) (const char *opt_arg, const char **filter, char **err)

Callback giving the dissector a chance to validate or transform the filter string.

Parameters

opt_arg	The raw "-z" option argument string.
filter	Output: pointer to the accepted display filter string, or NULL.
err	Output: pointer to an error message string if the filter is rejected, or NULL.

stat_tap_free_table_item_cb

void(* _stat_tap_table_ui::stat_tap_free_table_item_cb) (stat_tap_table *table, unsigned row, unsigned column, stat_tap_table_item_type *field_data)

Callback invoked to release resources held by a single table cell.

Parameters

table	The table containing the cell.
row	Zero-based row index of the cell.
column	Zero-based column index of the cell.
field_data	Pointer to the cell's stat_tap_table_item_type value to free.

stat_tap_init_cb

void(* _stat_tap_table_ui::stat_tap_init_cb) (struct _stat_tap_table_ui *new_stat)

Callback invoked once to allocate and initialize the statistic's tables.

Parameters

new_stat

Pointer to this stat_tap_table_ui being initialized.

stat_tap_reset_table_cb

void(* _stat_tap_table_ui::stat_tap_reset_table_cb) (stat_tap_table *table)

Callback invoked to reset (clear) all rows in a table without freeing its schema.

Parameters

table

The table to reset.

tables

GArray* _stat_tap_table_ui::tables

Dynamic array of stat_tap_table* instances created by this statistic

tap_name

const char* _stat_tap_table_ui::tap_name

Internal tap name used to register the tap listener

title

const char* _stat_tap_table_ui::title

Human-readable title of the statistic

---

The documentation for this struct was generated from the following file:

• /builds/wireshark/wireshark/epan/stat_tap_ui.h