Frame Data

Classes
struct	_frame_data
	Frame data structure. More...

Typedefs
typedef DIAG_OFF_PEDANTIC struct _frame_data	frame_data
	Frame data structure.

Enumerations
enum	packet_char_enc { PACKET_CHAR_ENC_CHAR_ASCII = 0 , PACKET_CHAR_ENC_CHAR_EBCDIC = 1 }
	Types of character encodings. More...

Functions
DIAG_ON_PEDANTIC WS_DLL_PUBLIC int	frame_data_compare (const struct epan_session *epan, const frame_data *fdata1, const frame_data *fdata2, int field)
	Compare two frame_data structs by a given field.
WS_DLL_PUBLIC void	frame_data_reset (frame_data *fdata)
	Reset a frame_data struct to its initial state without freeing it.
WS_DLL_PUBLIC void	frame_data_destroy (frame_data *fdata)
	Free all resources owned by a frame_data struct.
WS_DLL_PUBLIC void	frame_data_aggregation_free (frame_data *fdata)
	Free the aggregation data associated with a frame_data struct.
WS_DLL_PUBLIC void	frame_data_init (frame_data *fdata, uint32_t num, const wtap_rec *rec, int64_t offset, uint32_t cum_bytes)
	Initialize a frame_data struct for a newly read frame.
bool	frame_rel_first_frame_time (const struct epan_session *epan, const frame_data *fdata, nstime_t *delta)
	Compute the time delta from the first frame to this frame.
bool	frame_rel_time (const struct epan_session *epan, const frame_data *fdata, nstime_t *delta)
	Compute the time delta from the capture start to this frame.
bool	frame_rel_start_time (const struct epan_session *epan, const frame_data *fdata, nstime_t *delta)
	Compute the time delta from the first displayed frame to this frame.
bool	frame_delta_time_prev_captured (const struct epan_session *epan, const frame_data *fdata, nstime_t *delta)
	Compute the time delta from the previous captured frame to this frame.
bool	frame_delta_time_prev_displayed (const struct epan_session *epan, const frame_data *fdata, nstime_t *delta)
	Compute the time delta from the previous displayed frame to this frame.
WS_DLL_PUBLIC void	frame_data_set_before_dissect (frame_data *fdata, nstime_t *elapsed_time, const frame_data **frame_ref, const frame_data *prev_dis)
	Set frame_data fields before dissection.
WS_DLL_PUBLIC void	frame_data_set_after_dissect (frame_data *fdata, uint32_t *cum_bytes)
	Set frame_data fields after dissection.

Detailed Description

Enumeration Type Documentation

packet_char_enc

enum packet_char_enc

Types of character encodings.

Todo:

XXX - some of this stuff is used only while a packet is being dissected; should we keep that stuff in the "packet_info" structure, instead, to save memory?

Enumerator
PACKET_CHAR_ENC_CHAR_ASCII	ASCII
PACKET_CHAR_ENC_CHAR_EBCDIC	EBCDIC

Function Documentation

frame_data_aggregation_free()

WS_DLL_PUBLIC void frame_data_aggregation_free

(

frame_data *

fdata

)

Free the aggregation data associated with a frame_data struct.

Parameters

fdata

The frame_data whose aggregation data to free.

frame_data_compare()

DIAG_ON_PEDANTIC WS_DLL_PUBLIC int frame_data_compare	(	const struct epan_session *	epan,
		const frame_data *	fdata1,
		const frame_data *	fdata2,
		int	field
	)

Compare two frame_data structs by a given field.

Parameters

epan	The epan session context.
fdata1	The first frame_data to compare.
fdata2	The second frame_data to compare.
field	The field ID to compare on.

Returns

Negative if fdata1 < fdata2, 0 if equal, positive if fdata1 > fdata2.

frame_data_destroy()

WS_DLL_PUBLIC void frame_data_destroy

(

frame_data *

fdata

)

Free all resources owned by a frame_data struct.

Parameters

fdata

The frame_data to destroy.

frame_data_init()

WS_DLL_PUBLIC void frame_data_init	(	frame_data *	fdata,
		uint32_t	num,
		const wtap_rec *	rec,
		int64_t	offset,
		uint32_t	cum_bytes
	)

Initialize a frame_data struct for a newly read frame.

Parameters

fdata	The frame_data to initialize.
num	The frame number.
rec	The wtap record for this frame.
offset	The file offset of this frame.
cum_bytes	The cumulative byte count before this frame.

frame_data_reset()

WS_DLL_PUBLIC void frame_data_reset

(

frame_data *

fdata

)

Reset a frame_data struct to its initial state without freeing it.

Parameters

fdata

The frame_data to reset.

frame_data_set_after_dissect()

WS_DLL_PUBLIC void frame_data_set_after_dissect	(	frame_data *	fdata,
		uint32_t *	cum_bytes
	)

Set frame_data fields after dissection.

Parameters

fdata	The frame_data to update.
cum_bytes	The running cumulative byte count; updated to include this frame.

frame_data_set_before_dissect()

WS_DLL_PUBLIC void frame_data_set_before_dissect	(	frame_data *	fdata,
		nstime_t *	elapsed_time,
		const frame_data **	frame_ref,
		const frame_data *	prev_dis
	)

Set frame_data fields before dissection.

Parameters

fdata	The frame_data to update.
elapsed_time	The elapsed capture time; updated with this frame's timestamp.
frame_ref	Pointer to the reference frame pointer; updated if this frame becomes the new reference.
prev_dis	The most recently displayed frame, or NULL if none.

frame_delta_time_prev_captured()

bool frame_delta_time_prev_captured ( const struct epan_session *  epan, const frame_data *  fdata, nstime_t *  delta  )

extern

Compute the time delta from the previous captured frame to this frame.

Parameters

epan	The epan session context.
fdata	The frame_data for the current frame.
delta	Output pointer for the computed time delta.

Returns

true if the delta was computed successfully, false otherwise.

frame_delta_time_prev_displayed()

bool frame_delta_time_prev_displayed ( const struct epan_session *  epan, const frame_data *  fdata, nstime_t *  delta  )

extern

Compute the time delta from the previous displayed frame to this frame.

Parameters

epan	The epan session context.
fdata	The frame_data for the current frame.
delta	Output pointer for the computed time delta.

Returns

true if the delta was computed successfully, false otherwise.

frame_rel_first_frame_time()

bool frame_rel_first_frame_time ( const struct epan_session *  epan, const frame_data *  fdata, nstime_t *  delta  )

extern

Compute the time delta from the first frame to this frame.

Parameters

epan	The epan session context.
fdata	The frame_data for the current frame.
delta	Output pointer for the computed time delta.

Returns

true if the delta was computed successfully, false otherwise.

frame_rel_start_time()

bool frame_rel_start_time ( const struct epan_session *  epan, const frame_data *  fdata, nstime_t *  delta  )

extern

Compute the time delta from the first displayed frame to this frame.

Parameters

epan	The epan session context.
fdata	The frame_data for the current frame.
delta	Output pointer for the computed time delta.

Returns

true if the delta was computed successfully, false otherwise.

frame_rel_time()

bool frame_rel_time ( const struct epan_session *  epan, const frame_data *  fdata, nstime_t *  delta  )

extern

Compute the time delta from the capture start to this frame.

Parameters

epan	The epan session context.
fdata	The frame_data for the current frame.
delta	Output pointer for the computed time delta.

Returns

true if the delta was computed successfully, false otherwise.