wtap_dump_params Struct Reference

#include <wtap.h>

Public Attributes
int	encap
int	snaplen
int	tsprec
GArray *	shb_hdrs
const GArray *	shb_iface_to_global
wtapng_iface_descriptions_t *	idb_inf
const GArray *	nrbs_growing
GArray *	dsbs_initial
const GArray *	dsbs_growing
const GArray *	mevs_growing
bool	dont_copy_idbs

Detailed Description

Parameters for various wtap_dump_* functions, specifying per-file information. The structure itself is no longer used after returning from wtap_dump_*, but its pointer fields must remain valid until wtap_dump_close is called.

Note

The shb_hdr and idb_inf arguments will be used until wtap_dump_close() is called, but will not be free'd by the dumper. If you created them, you must free them yourself after wtap_dump_close(). dsbs_initial will be unreferenced by wtap_dump_close(), so to reuse them for another dump file, call wtap_block_array_ref() before closing. dsbs_growing typically refers to another wth->dsbs. nrbs_growing typically refers to another wth->nrbs.

See also

wtap_dump_params_init, wtap_dump_params_cleanup.

Member Data Documentation

dont_copy_idbs

bool wtap_dump_params::dont_copy_idbs

XXX - don't copy IDBs; this should eventually always be the case.

dsbs_growing

const GArray* wtap_dump_params::dsbs_growing

DSBs that will be written while writing packets, or NULL. This array may grow since the dumper was opened and will subsequently be written before newer packets are written in wtap_dump.

dsbs_initial

GArray* wtap_dump_params::dsbs_initial

The initial Decryption Secrets Block(s) to be written, or NULL.

encap

int wtap_dump_params::encap

Per-file packet encapsulation, or WTAP_ENCAP_PER_PACKET

idb_inf

wtapng_iface_descriptions_t* wtap_dump_params::idb_inf

The interface description information, or NULL.

mevs_growing

const GArray* wtap_dump_params::mevs_growing

Meta events that will be written while writing packets, or NULL. This array may grow since the dumper was opened and will subsequently be written before newer packets are written in wtap_dump.

nrbs_growing

const GArray* wtap_dump_params::nrbs_growing

NRBs that will be written while writing packets, or NULL. This array may grow since the dumper was opened and will subsequently be written before newer packets are written in wtap_dump.

shb_hdrs

GArray* wtap_dump_params::shb_hdrs

The section header block(s) information, or NULL.

shb_iface_to_global

const GArray* wtap_dump_params::shb_iface_to_global

An array mapping the per-section interface numbers to global IDs This array may grow after the dumper is opened if a new section header is read.

snaplen

int wtap_dump_params::snaplen

Per-file snapshot length (what if it's per-interface?)

tsprec

int wtap_dump_params::tsprec

Per-file time stamp precision

---

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

• /builds/wireshark/wireshark/wiretap/wtap.h