#include "ws_symbol_export.h"
#include <wsutil/inet_addr.h>

Classes
struct	wtapng_section_mandatory_s

struct	wtapng_iface_descriptions_s

struct	wtapng_if_descr_mandatory_s

struct	wtapng_nrb_mandatory_s

struct	wtapng_if_stats_mandatory_s

struct	wtapng_dsb_mandatory_s

struct	wtapng_meta_event_mandatory_s

struct	wtapng_ft_specific_mandatory_s

struct	custom_opt_s

struct	nflx_custom_opt_s

struct	wtap_bpf_insn_s

struct	if_filter_opt_s

struct	packet_verdict_opt_s

struct	packet_hash_opt_s

union	wtap_optval_t

struct	wtap_option_t

struct	nflx_dumpinfo

struct	nflx_tcpinfo

Macros
#define	OPT_EOFOPT 0

#define	OPT_COMMENT 1

#define	OPT_CUSTOM_STR_COPY 2988

#define	OPT_CUSTOM_BIN_COPY 2989

#define	OPT_CUSTOM_STR_NO_COPY 19372

#define	OPT_CUSTOM_BIN_NO_COPY 19373

#define	OPT_SHB_HARDWARE 2

#define	OPT_SHB_OS 3

#define	OPT_SHB_USERAPPL 4

#define	OPT_IDB_NAME 2

#define	OPT_IDB_DESCRIPTION 3

#define	OPT_IDB_IP4ADDR 4

#define	OPT_IDB_IP6ADDR 5

#define	OPT_IDB_MACADDR 6

#define	OPT_IDB_EUIADDR 7

#define	OPT_IDB_SPEED 8

#define	OPT_IDB_TSRESOL 9

#define	OPT_IDB_TZONE 10

#define	OPT_IDB_FILTER 11

#define	OPT_IDB_OS 12

#define	OPT_IDB_FCSLEN 13

#define	OPT_IDB_TSOFFSET 14

#define	OPT_IDB_HARDWARE 15

#define	OPT_PKT_FLAGS 2

#define	OPT_PKT_HASH 3

#define	OPT_PKT_DROPCOUNT 4

#define	OPT_PKT_PACKETID 5

#define	OPT_PKT_QUEUE 6

#define	OPT_PKT_VERDICT 7

#define	OPT_NS_DNSNAME 2

#define	OPT_NS_DNSIP4ADDR 3

#define	OPT_NS_DNSIP6ADDR 4

#define	OPT_ISB_STARTTIME 2

#define	OPT_ISB_ENDTIME 3

#define	OPT_ISB_IFRECV 4

#define	OPT_ISB_IFDROP 5

#define	OPT_ISB_FILTERACCEPT 6

#define	OPT_ISB_OSDROP 7

#define	OPT_ISB_USRDELIV 8

#define	PEN_NFLX 10949

#define	PEN_VCTR 46254

#define	NFLX_OPT_TYPE_VERSION 1

#define	NFLX_OPT_TYPE_TCPINFO 2

#define	NFLX_OPT_TYPE_DUMPINFO 4

#define	NFLX_OPT_TYPE_DUMPTIME 5

#define	NFLX_OPT_TYPE_STACKNAME 6

#define	NFLX_TLB_FLAG_RXBUF 0x0001 /* Includes receive buffer info */

#define	NFLX_TLB_FLAG_TXBUF 0x0002 /* Includes send buffer info */

#define	NFLX_TLB_FLAG_HDR 0x0004 /* Includes a TCP header */

#define	NFLX_TLB_FLAG_VERBOSE 0x0008 /* Includes function/line numbers */

#define	NFLX_TLB_FLAG_STACKINFO 0x0010 /* Includes stack-specific info */

#define	NFLX_TLB_TF_REQ_SCALE 0x00000020 /* Sent WS option */

#define	NFLX_TLB_TF_RCVD_SCALE 0x00000040 /* Received WS option */

#define	NFLX_TLB_TCPS_ESTABLISHED 4

#define	NFLX_TLB_IS_SYNCHRONIZED(state) (state >= NFLX_TLB_TCPS_ESTABLISHED)

Typedefs
typedef struct wtap_block *	wtap_block_t

typedef struct wtapng_section_mandatory_s	wtapng_section_mandatory_t

typedef struct wtapng_iface_descriptions_s	wtapng_iface_descriptions_t

typedef struct wtapng_if_descr_mandatory_s	wtapng_if_descr_mandatory_t

typedef struct wtapng_nrb_mandatory_s	wtapng_nrb_mandatory_t

typedef struct wtapng_if_stats_mandatory_s	wtapng_if_stats_mandatory_t

typedef struct wtapng_dsb_mandatory_s	wtapng_dsb_mandatory_t

typedef struct wtapng_meta_event_mandatory_s	wtapng_meta_event_mandatory_t

typedef struct wtapng_ft_specific_mandatory_s	wtapng_ft_specific_mandatory_t

typedef struct custom_opt_s	custom_opt_t

typedef struct nflx_custom_opt_s	nflx_custom_opt_t

typedef struct wtap_bpf_insn_s	wtap_bpf_insn_t

typedef struct if_filter_opt_s	if_filter_opt_t

typedef struct packet_verdict_opt_s	packet_verdict_opt_t

typedef struct packet_hash_opt_s	packet_hash_opt_t

typedef void(*	wtap_block_create_func) (wtap_block_t block)

typedef void(*	wtap_mand_free_func) (wtap_block_t block)

typedef void(*	wtap_mand_copy_func) (wtap_block_t dest_block, wtap_block_t src_block)

typedef bool(*	wtap_block_foreach_func) (wtap_block_t block, unsigned option_id, wtap_opttype_e option_type, wtap_optval_t option, void user_data)

Enumerations
enum	wtap_block_type_t { WTAP_BLOCK_SECTION = 0 , WTAP_BLOCK_IF_ID_AND_INFO , WTAP_BLOCK_NAME_RESOLUTION , WTAP_BLOCK_IF_STATISTICS , WTAP_BLOCK_DECRYPTION_SECRETS , WTAP_BLOCK_PACKET , WTAP_BLOCK_FT_SPECIFIC_REPORT , WTAP_BLOCK_FT_SPECIFIC_EVENT , WTAP_BLOCK_SYSDIG_EVENT , WTAP_BLOCK_META_EVENT , WTAP_BLOCK_SYSTEMD_JOURNAL_EXPORT , WTAP_BLOCK_CUSTOM , MAX_WTAP_BLOCK_TYPE_VALUE }

enum	wtap_opttype_e { WTAP_OPTTYPE_UINT8 , WTAP_OPTTYPE_UINT32 , WTAP_OPTTYPE_UINT64 , WTAP_OPTTYPE_STRING , WTAP_OPTTYPE_BYTES , WTAP_OPTTYPE_IPv4 , WTAP_OPTTYPE_IPv6 , WTAP_OPTTYPE_CUSTOM , WTAP_OPTTYPE_IF_FILTER , WTAP_OPTTYPE_PACKET_VERDICT , WTAP_OPTTYPE_PACKET_HASH , WTAP_OPTTYPE_INT8 , WTAP_OPTTYPE_INT32 , WTAP_OPTTYPE_INT64 }

enum	wtap_opttype_return_val { WTAP_OPTTYPE_SUCCESS = 0 , WTAP_OPTTYPE_NO_SUCH_OPTION = -1 , WTAP_OPTTYPE_NOT_FOUND = -2 , WTAP_OPTTYPE_TYPE_MISMATCH = -3 , WTAP_OPTTYPE_NUMBER_MISMATCH = -4 , WTAP_OPTTYPE_ALREADY_EXISTS = -5 , WTAP_OPTTYPE_BAD_BLOCK = -6 }

enum	if_filter_type_e { if_filter_pcap = 0 , if_filter_bpf = 1 }

enum	packet_verdict_type_e { packet_verdict_hardware = 0 , packet_verdict_linux_ebpf_tc = 1 , packet_verdict_linux_ebpf_xdp = 2 }

Functions
WS_DLL_PUBLIC void	wtap_opttypes_initialize (void)

WS_DLL_PUBLIC wtap_block_t	wtap_block_create (wtap_block_type_t block_type)

WS_DLL_PUBLIC wtap_block_t	wtap_block_ref (wtap_block_t block)

WS_DLL_PUBLIC void	wtap_block_unref (wtap_block_t block)

WS_DLL_PUBLIC void	wtap_block_array_free (GArray *block_array)

WS_DLL_PUBLIC void	wtap_block_array_unref (GArray *block_array)

WS_DLL_PUBLIC void	wtap_block_array_ref (GArray *block_array)

WS_DLL_PUBLIC wtap_block_type_t	wtap_block_get_type (wtap_block_t block)

WS_DLL_PUBLIC void *	wtap_block_get_mandatory_data (wtap_block_t block)

WS_DLL_PUBLIC unsigned	wtap_block_count_option (wtap_block_t block, unsigned option_id)

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_add_uint8_option (wtap_block_t block, unsigned option_id, uint8_t value)

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_set_uint8_option_value (wtap_block_t block, unsigned option_id, uint8_t value)

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_get_uint8_option_value (wtap_block_t block, unsigned option_id, uint8_t *value) G_GNUC_WARN_UNUSED_RESULT

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_add_uint32_option (wtap_block_t block, unsigned option_id, uint32_t value)

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_set_uint32_option_value (wtap_block_t block, unsigned option_id, uint32_t value)

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_get_uint32_option_value (wtap_block_t block, unsigned option_id, uint32_t *value) G_GNUC_WARN_UNUSED_RESULT

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_add_uint64_option (wtap_block_t block, unsigned option_id, uint64_t value)

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_set_uint64_option_value (wtap_block_t block, unsigned option_id, uint64_t value)

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_get_uint64_option_value (wtap_block_t block, unsigned option_id, uint64_t *value) G_GNUC_WARN_UNUSED_RESULT

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_add_int8_option (wtap_block_t block, unsigned option_id, int8_t value)

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_set_int8_option_value (wtap_block_t block, unsigned option_id, int8_t value)

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_get_int8_option_value (wtap_block_t block, unsigned option_id, int8_t *value) G_GNUC_WARN_UNUSED_RESULT

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_add_int32_option (wtap_block_t block, unsigned option_id, int32_t value)

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_set_int32_option_value (wtap_block_t block, unsigned option_id, int32_t value)

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_get_int32_option_value (wtap_block_t block, unsigned option_id, int32_t *value) G_GNUC_WARN_UNUSED_RESULT

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_add_int64_option (wtap_block_t block, unsigned option_id, int64_t value)

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_set_int64_option_value (wtap_block_t block, unsigned option_id, int64_t value)

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_get_int64_option_value (wtap_block_t block, unsigned option_id, int64_t *value) G_GNUC_WARN_UNUSED_RESULT

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_add_ipv4_option (wtap_block_t block, unsigned option_id, uint32_t value)

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_set_ipv4_option_value (wtap_block_t block, unsigned option_id, uint32_t value)

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_get_ipv4_option_value (wtap_block_t block, unsigned option_id, uint32_t *value) G_GNUC_WARN_UNUSED_RESULT

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_add_ipv6_option (wtap_block_t block, unsigned option_id, ws_in6_addr *value)

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_set_ipv6_option_value (wtap_block_t block, unsigned option_id, ws_in6_addr *value)

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_get_ipv6_option_value (wtap_block_t block, unsigned option_id, ws_in6_addr *value) G_GNUC_WARN_UNUSED_RESULT

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_add_string_option (wtap_block_t block, unsigned option_id, const char *value, size_t value_length)

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_add_string_option_owned (wtap_block_t block, unsigned option_id, char *value)

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_add_string_option_format (wtap_block_t block, unsigned option_id, const char *format,...) G_GNUC_PRINTF(3

WS_DLL_PUBLIC wtap_opttype_return_val WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_set_string_option_value (wtap_block_t block, unsigned option_id, const char *value, size_t value_length)

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_set_nth_string_option_value (wtap_block_t block, unsigned option_id, unsigned idx, const char *value, size_t value_length)

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_set_string_option_value_format (wtap_block_t block, unsigned option_id, const char *format,...) G_GNUC_PRINTF(3

WS_DLL_PUBLIC wtap_opttype_return_val WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_set_nth_string_option_value_format (wtap_block_t block, unsigned option_id, unsigned idx, const char *format,...) G_GNUC_PRINTF(4

WS_DLL_PUBLIC wtap_opttype_return_val WS_DLL_PUBLIC wtap_opttype_return_val WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_get_string_option_value (wtap_block_t block, unsigned option_id, char **value) G_GNUC_WARN_UNUSED_RESULT

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_get_nth_string_option_value (wtap_block_t block, unsigned option_id, unsigned idx, char **value) G_GNUC_WARN_UNUSED_RESULT

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_add_bytes_option (wtap_block_t block, unsigned option_id, const uint8_t *value, size_t value_length)

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_add_bytes_option_borrow (wtap_block_t block, unsigned option_id, GBytes *value)

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_set_bytes_option_value (wtap_block_t block, unsigned option_id, const uint8_t *value, size_t value_length)

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_set_nth_bytes_option_value (wtap_block_t block, unsigned option_id, unsigned idx, GBytes *value)

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_get_bytes_option_value (wtap_block_t block, unsigned option_id, GBytes **value) G_GNUC_WARN_UNUSED_RESULT

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_get_nth_bytes_option_value (wtap_block_t block, unsigned option_id, unsigned idx, GBytes **value) G_GNUC_WARN_UNUSED_RESULT

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_add_nflx_custom_option (wtap_block_t block, uint32_t nflx_type, const char *nflx_custom_data, size_t nflx_custom_data_len)

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_get_nflx_custom_option (wtap_block_t block, uint32_t nflx_type, char *nflx_custom_data, size_t nflx_custom_data_len)

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_add_custom_option (wtap_block_t block, unsigned option_id, uint32_t pen, const char *custom_data, size_t custom_data_len)

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_add_if_filter_option (wtap_block_t block, unsigned option_id, if_filter_opt_t *value)

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_set_if_filter_option_value (wtap_block_t block, unsigned option_id, if_filter_opt_t *value)

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_get_if_filter_option_value (wtap_block_t block, unsigned option_id, if_filter_opt_t *value) G_GNUC_WARN_UNUSED_RESULT

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_add_packet_verdict_option (wtap_block_t block, unsigned option_id, packet_verdict_opt_t *value)

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_set_nth_packet_verdict_option_value (wtap_block_t block, unsigned option_id, unsigned idx, packet_verdict_opt_t *value)

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_get_nth_packet_verdict_option_value (wtap_block_t block, unsigned option_id, unsigned idx, packet_verdict_opt_t *value) G_GNUC_WARN_UNUSED_RESULT

WS_DLL_PUBLIC void	wtap_packet_verdict_free (packet_verdict_opt_t *verdict)

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_add_packet_hash_option (wtap_block_t block, unsigned option_id, packet_hash_opt_t *value)

WS_DLL_PUBLIC void	wtap_packet_hash_free (packet_hash_opt_t *hash)

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_remove_option (wtap_block_t block, unsigned option_id)

WS_DLL_PUBLIC wtap_opttype_return_val	wtap_block_remove_nth_option_instance (wtap_block_t block, unsigned option_id, unsigned idx)

WS_DLL_PUBLIC void	wtap_block_copy (wtap_block_t dest_block, wtap_block_t src_block)

WS_DLL_PUBLIC wtap_block_t	wtap_block_make_copy (wtap_block_t block)

WS_DLL_PUBLIC bool	wtap_block_foreach_option (wtap_block_t block, wtap_block_foreach_func func, void *user_data)

WS_DLL_PUBLIC void	wtap_opttypes_cleanup (void)

Detailed Description

SPDX-License-Identifier: GPL-2.0-or-later

Macro Definition Documentation

◆ OPT_COMMENT

#define OPT_COMMENT 1

A UTF-8 string containing a human-readable comment.

◆ OPT_CUSTOM_BIN_COPY

#define OPT_CUSTOM_BIN_COPY 2989

A custom option containing binary data, copying allowed.

◆ OPT_CUSTOM_BIN_NO_COPY

#define OPT_CUSTOM_BIN_NO_COPY 19373

A custom option containing binary data, copying not allowed.

◆ OPT_CUSTOM_STR_COPY

#define OPT_CUSTOM_STR_COPY 2988

A custom option containing a UTF-8 string, copying allowed.

◆ OPT_CUSTOM_STR_NO_COPY

#define OPT_CUSTOM_STR_NO_COPY 19372

A custom option containing a UTF-8 string, copying not allowed.

◆ OPT_EOFOPT

#define OPT_EOFOPT 0

Appears in pcapng files, but not in blocks.

◆ OPT_IDB_DESCRIPTION

#define OPT_IDB_DESCRIPTION 3

A UTF-8 string containing the description of the device used to capture data. "Wi-Fi" / "Local Area Connection" / "Wireless Network Connection" / "First Ethernet Interface"

◆ OPT_IDB_EUIADDR

#define OPT_IDB_EUIADDR 7

XXX: if_EUIaddr Interface Hardware EUI address (64 bits)

◆ OPT_IDB_FCSLEN

#define OPT_IDB_FCSLEN 13

An integer value that specified the length of the Frame Check Sequence (in bits) for this interface. For link layers whose FCS length can change during time, the Packet Block Flags Word can be used (see Appendix A (Packet Block Flags Word))

◆ OPT_IDB_FILTER

#define OPT_IDB_FILTER 11

The filter (e.g. "capture only TCP traffic") used to capture traffic. The first byte of the Option Data keeps a code of the filter used (e.g. if this is a libpcap string, or BPF bytecode, and more). More details about this format will be presented in Appendix XXX (TODO). (TODO: better use different options for different fields? e.g. if_filter_pcap, if_filter_bpf, ...) 00 "tcp port 23 and host 10.0.0.5"

◆ OPT_IDB_HARDWARE

#define OPT_IDB_HARDWARE 15

A UTF-8 string containing the description of the hardware of the device used to capture data. "Broadcom NetXtreme" / "Intel(R) PRO/1000 MT Network Connection" / "NETGEAR WNA1000Mv2 N150 Wireless USB Micro Adapter"

◆ OPT_IDB_IP4ADDR

#define OPT_IDB_IP4ADDR 4

XXX: if_IPv4addr Interface network address and netmask. This option can be repeated multiple times within the same Interface Description Block when multiple IPv4 addresses are assigned to the interface. 192 168 1 1 255 255 255 0

◆ OPT_IDB_IP6ADDR

#define OPT_IDB_IP6ADDR 5

XXX: if_IPv6addr Interface network address and prefix length (stored in the last byte). This option can be repeated multiple times within the same Interface Description Block when multiple IPv6 addresses are assigned to the interface. 2001:0db8:85a3:08d3:1319:8a2e:0370:7344/64 is written (in hex) as "20 01 0d b8 85 a3 08 d3 13 19 8a 2e 03 70 73 44 40"

◆ OPT_IDB_MACADDR

#define OPT_IDB_MACADDR 6

XXX: if_MACaddr Interface Hardware MAC address (48 bits).

◆ OPT_IDB_NAME

#define OPT_IDB_NAME 2

A UTF-8 string containing the name of the device used to capture data. "eth0" / "\Device\NPF_{AD1CE675-96D0-47C5-ADD0-2504B9126B68}"

◆ OPT_IDB_OS

#define OPT_IDB_OS 12

A UTF-8 string containing the name of the operating system of the machine in which this interface is installed. This can be different from the same information that can be contained by the Section Header Block (Section 3.1 (Section Header Block (mandatory))) because the capture can have been done on a remote machine. "Windows XP SP2" / "openSUSE 10.2"

◆ OPT_IDB_SPEED

#define OPT_IDB_SPEED 8

Interface speed (in bps). 100000000 for 100Mbps

◆ OPT_IDB_TSOFFSET

#define OPT_IDB_TSOFFSET 14

A 64-bit signed integer value that specifies an offset (in seconds) that must be added to the timestamp of each packet to obtain the absolute timestamp of a packet. If the option is not present, an offst of 0 is assumed (i.e., timestamps in blocks are absolute timestamps).

This offset is not intended to be used as an offset between local time and UTC; for this purpose, the if_iana_tzname option SHOULD be used to specify a timezone.

◆ OPT_IDB_TSRESOL

#define OPT_IDB_TSRESOL 9

Resolution of timestamps. If the Most Significant Bit is equal to zero, the remaining bits indicates the resolution of the timestamp as a negative power of 10 (e.g. 6 means microsecond resolution, timestamps are the number of microseconds since 1/1/1970). If the Most Significant Bit is equal to one, the remaining bits indicates the resolution has a negative power of 2 (e.g. 10 means 1/1024 of second). If this option is not present, a resolution of 10^-6 is assumed (i.e. timestamps have the same resolution of the standard 'libpcap' timestamps).

◆ OPT_IDB_TZONE

#define OPT_IDB_TZONE 10

Time zone for GMT support. This option has neer been specified in greater detail and, unless it were to identify something such as an IANA time zone database timezone, would be insufficient for converting between UTC and local time. Therefore, it SHOULD NOT be used; instead, the if_iana_tzname option SHOULD be used if time zone information is to be specified.

◆ OPT_SHB_HARDWARE

#define OPT_SHB_HARDWARE 2

A UTF-8 string containing the description of the hardware used to create this section.

◆ OPT_SHB_OS

#define OPT_SHB_OS 3

A UTF-8 string containing the name of the operating system used to create this section.

◆ OPT_SHB_USERAPPL

#define OPT_SHB_USERAPPL 4

A UTF-8 string containing the name of the application used to create this section.

Typedef Documentation

◆ wtapng_dsb_mandatory_t

typedef struct wtapng_dsb_mandatory_s wtapng_dsb_mandatory_t

Holds the required data from a WTAP_BLOCK_DECRYPTION_SECRETS.

◆ wtapng_ft_specific_mandatory_t

typedef struct wtapng_ft_specific_mandatory_s wtapng_ft_specific_mandatory_t

Holds the required data from a WTAP_BLOCK_PACKET. This includes Enhanced Packet Block, Simple Packet Block, and the deprecated Packet Block. NB. I'm not including the packet data here since Wireshark handles it in other ways. If we were to add it we'd need to implement copy and free routines in wtap_opttypes.c Holds the required data from a WTAP_BLOCK_FT_SPECIFIC_REPORT.

◆ wtapng_if_descr_mandatory_t

typedef struct wtapng_if_descr_mandatory_s wtapng_if_descr_mandatory_t

Holds the required data from a WTAP_BLOCK_IF_ID_AND_INFO.

◆ wtapng_if_stats_mandatory_t

typedef struct wtapng_if_stats_mandatory_s wtapng_if_stats_mandatory_t

Holds the required data from a WTAP_BLOCK_IF_STATISTICS.

◆ wtapng_iface_descriptions_t

typedef struct wtapng_iface_descriptions_s wtapng_iface_descriptions_t

struct holding the information to build a WTAP_BLOCK_IF_ID_AND_INFO. the interface_data array holds an array of wtap_block_t representing interfacs, one per interface.

◆ wtapng_meta_event_mandatory_t

typedef struct wtapng_meta_event_mandatory_s wtapng_meta_event_mandatory_t

Holds the required data from a WTAP_BLOCK_META_EVENT.

◆ wtapng_nrb_mandatory_t

typedef struct wtapng_nrb_mandatory_s wtapng_nrb_mandatory_t

Holds the required data from a WTAP_BLOCK_NAME_RESOLUTION.

◆ wtapng_section_mandatory_t

typedef struct wtapng_section_mandatory_s wtapng_section_mandatory_t

Holds the required data from a WTAP_BLOCK_SECTION.

Function Documentation

◆ wtap_block_add_bytes_option()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_add_bytes_option	(	wtap_block_t	block,
		unsigned	option_id,
		const uint8_t *	value,
		size_t	value_length
	)

Add a bytes option to a block

Parameters

[in]	block	Block to which to add the option
[in]	option_id	Identifier value for option
[in]	value	Value of option to copy
[in]	value_length	Number of bytes to copy

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_add_bytes_option_borrow()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_add_bytes_option_borrow	(	wtap_block_t	block,
		unsigned	option_id,
		GBytes *	value
	)

Add a bytes option to a block, borrowing the value from a GBytes

Parameters

[in]	block	Block to which to add the option
[in]	option_id	Identifier value for option
[in]	value	Value of option as a GBytes

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_add_custom_option()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_add_custom_option	(	wtap_block_t	block,
		unsigned	option_id,
		uint32_t	pen,
		const char *	custom_data,
		size_t	custom_data_len
	)

Add a custom option to a block

Parameters

[in]	block	Block to which to add the option
[in]	option_id	Identifier value for option
[in]	pen	PEN
[in]	custom_data	pointer to the data
[in]	custom_data_len	length of custom_data

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_add_if_filter_option()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_add_if_filter_option	(	wtap_block_t	block,
		unsigned	option_id,
		if_filter_opt_t *	value
	)

Add an if_filter option value to a block

Parameters

[in]	block	Block to which to add the option
[in]	option_id	Identifier value for option
[in]	value	Value of option

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_add_int32_option()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_add_int32_option	(	wtap_block_t	block,
		unsigned	option_id,
		int32_t	value
	)

Add INT32 option value to a block

Parameters

[in]	block	Block to which to add the option
[in]	option_id	Identifier value for option
[in]	value	Value of option

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_add_int64_option()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_add_int64_option	(	wtap_block_t	block,
		unsigned	option_id,
		int64_t	value
	)

Add INT64 option value to a block

Parameters

[in]	block	Block to which to add the option
[in]	option_id	Identifier value for option
[in]	value	Value of option

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_add_int8_option()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_add_int8_option	(	wtap_block_t	block,
		unsigned	option_id,
		int8_t	value
	)

Add INT8 option value to a block

Parameters

[in]	block	Block to which to add the option
[in]	option_id	Identifier value for option
[in]	value	Value of option

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_add_ipv4_option()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_add_ipv4_option	(	wtap_block_t	block,
		unsigned	option_id,
		uint32_t	value
	)

Add IPv4 address option value to a block

Parameters

[in]	block	Block to which to add the option
[in]	option_id	Identifier value for option
[in]	value	Value of option

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_add_ipv6_option()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_add_ipv6_option	(	wtap_block_t	block,
		unsigned	option_id,
		ws_in6_addr *	value
	)

Add IPv6 address option value to a block

Parameters

[in]	block	Block to which to add the option
[in]	option_id	Identifier value for option
[in]	value	Value of option

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_add_nflx_custom_option()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_add_nflx_custom_option	(	wtap_block_t	block,
		uint32_t	nflx_type,
		const char *	nflx_custom_data,
		size_t	nflx_custom_data_len
	)

Add an NFLX custom option to a block

Parameters

[in]	block	Block to which to add the option
[in]	nflx_type	NFLX option type
[in]	nflx_custom_data	pointer to the data
[in]	nflx_custom_data_len	length of custom_data

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_add_packet_hash_option()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_add_packet_hash_option	(	wtap_block_t	block,
		unsigned	option_id,
		packet_hash_opt_t *	value
	)

Add a packet_hash option value to a block

Parameters

[in]	block	Block to which to add the option
[in]	option_id	Identifier value for option
[in]	value	Value of option

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_add_packet_verdict_option()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_add_packet_verdict_option	(	wtap_block_t	block,
		unsigned	option_id,
		packet_verdict_opt_t *	value
	)

Add a packet_verdict option value to a block

Parameters

[in]	block	Block to which to add the option
[in]	option_id	Identifier value for option
[in]	value	Value of option

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_add_string_option()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_add_string_option	(	wtap_block_t	block,
		unsigned	option_id,
		const char *	value,
		size_t	value_length
	)

Add a string option to a block

Parameters

[in]	block	Block to which to add the option
[in]	option_id	Identifier value for option
[in]	value	Value of option
[in]	value_length	Maximum length of string to copy.

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_add_string_option_format()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_add_string_option_format	(	wtap_block_t	block,
		unsigned	option_id,
		const char *	format,
			...
	)

Add a string option to a block with a printf-formatted string as its value

Parameters

[in]	block	Block to which to add the option
[in]	option_id	Identifier value for option
[in]	format	printf-like format string

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_add_string_option_owned()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_add_string_option_owned	(	wtap_block_t	block,
		unsigned	option_id,
		char *	value
	)

Add a string option to a block taking ownership of the null-terminated string.

Parameters

[in]	block	Block to which to add the option
[in]	option_id	Identifier value for option
[in]	value	Value of option

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_add_uint32_option()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_add_uint32_option	(	wtap_block_t	block,
		unsigned	option_id,
		uint32_t	value
	)

Add UINT32 option value to a block

Parameters

[in]	block	Block to which to add the option
[in]	option_id	Identifier value for option
[in]	value	Value of option

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_add_uint64_option()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_add_uint64_option	(	wtap_block_t	block,
		unsigned	option_id,
		uint64_t	value
	)

Add UINT64 option value to a block

Parameters

[in]	block	Block to which to add the option
[in]	option_id	Identifier value for option
[in]	value	Value of option

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_add_uint8_option()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_add_uint8_option	(	wtap_block_t	block,
		unsigned	option_id,
		uint8_t	value
	)

Add UINT8 option value to a block

Parameters

[in]	block	Block to which to add the option
[in]	option_id	Identifier value for option
[in]	value	Value of option

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_array_free()

WS_DLL_PUBLIC void wtap_block_array_free ( GArray * block_array )

Free an array of blocks

Needs to be called to clean up blocks allocated through GArray (for multiple blocks of same type) Includes freeing the GArray

Parameters

[in] block_array Array of blocks to be freed

◆ wtap_block_array_ref()

WS_DLL_PUBLIC void wtap_block_array_ref ( GArray * block_array )

Increment the reference count of an array of blocks

Increment the reference count of each block in the array and the GArray itself.

Parameters

[in] block_array Array of blocks to be referenced

◆ wtap_block_array_unref()

WS_DLL_PUBLIC void wtap_block_array_unref ( GArray * block_array )

Decrement the reference count of an array of blocks

Decrement the reference count of each block in the array and the GArray itself. Any element whose reference count drops to 0 will be freed. If the GArray and every block has a reference count of 1, this is the same as wtap_block_array_free().

Parameters

[in] block_array Array of blocks to be dereferenced

◆ wtap_block_copy()

WS_DLL_PUBLIC void wtap_block_copy	(	wtap_block_t	dest_block,
		wtap_block_t	src_block
	)

Copy a block to another.

Any options that are in the destination but not the source are not removed. Options that are just in source will be added to destination

Parameters

[in]	dest_block	Block to be copied to
[in]	src_block	Block to be copied from

◆ wtap_block_count_option()

WS_DLL_PUBLIC unsigned wtap_block_count_option	(	wtap_block_t	block,
		unsigned	option_id
	)

Count the number of times the given option appears in the block

Parameters

[in]	block	Block to which to add the option
[in]	option_id	Identifier value for option

Returns: unsigned - the number of times the option was found

◆ wtap_block_create()

WS_DLL_PUBLIC wtap_block_t wtap_block_create ( wtap_block_type_t block_type )

Create a block by type

Return a newly allocated block with default options provided

Parameters

[in] block_type Block type to be created

Returns: Newly allocated block

◆ wtap_block_get_bytes_option_value()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_get_bytes_option_value	(	wtap_block_t	block,
		unsigned	option_id,
		GBytes **	value
	)

Get bytes option value from a block

Parameters

[in]	block	Block from which to get the option value
[in]	option_id	Identifier value for option
[out]	value	Returned value of option

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

Note: You should call g_bytes_ref() on value if you plan to keep it around (and then g_bytes_unref() when you're done with it).

◆ wtap_block_get_if_filter_option_value()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_get_if_filter_option_value	(	wtap_block_t	block,
		unsigned	option_id,
		if_filter_opt_t *	value
	)

Get an if_filter option value from a block

Parameters

[in]	block	Block from which to get the option value
[in]	option_id	Identifier value for option
[out]	value	Returned value of option value

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_get_int32_option_value()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_get_int32_option_value	(	wtap_block_t	block,
		unsigned	option_id,
		int32_t *	value
	)

Get INT32 option value from a block

Parameters

[in]	block	Block from which to get the option value
[in]	option_id	Identifier value for option
[out]	value	Returned value of option

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_get_int64_option_value()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_get_int64_option_value	(	wtap_block_t	block,
		unsigned	option_id,
		int64_t *	value
	)

Get INT64 option value from a block

Parameters

[in]	block	Block from which to get the option value
[in]	option_id	Identifier value for option
[out]	value	Returned value of option

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_get_int8_option_value()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_get_int8_option_value	(	wtap_block_t	block,
		unsigned	option_id,
		int8_t *	value
	)

Get INT8 option value from a block

Parameters

[in]	block	Block from which to get the option value
[in]	option_id	Identifier value for option
[out]	value	Returned value of option

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_get_ipv4_option_value()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_get_ipv4_option_value	(	wtap_block_t	block,
		unsigned	option_id,
		uint32_t *	value
	)

Get IPv4 option value from a block

Parameters

[in]	block	Block from which to get the option value
[in]	option_id	Identifier value for option
[out]	value	Returned value of option

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_get_ipv6_option_value()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_get_ipv6_option_value	(	wtap_block_t	block,
		unsigned	option_id,
		ws_in6_addr *	value
	)

Get IPv6 option value from a block

Parameters

[in]	block	Block from which to get the option value
[in]	option_id	Identifier value for option
[out]	value	Returned value of option

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_get_mandatory_data()

WS_DLL_PUBLIC void * wtap_block_get_mandatory_data ( wtap_block_t block )

Provide mandatory data of a block

Parameters

[in] block Block from which to retrieve mandatory data

Returns: Block mandatory data. Structure varies based on block type

◆ wtap_block_get_nflx_custom_option()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_get_nflx_custom_option	(	wtap_block_t	block,
		uint32_t	nflx_type,
		char *	nflx_custom_data,
		size_t	nflx_custom_data_len
	)

Get an NFLX custom option value from a block

Parameters

[in]	block	Block from which to get the option value
[in]	nflx_type	type of the option
[out]	nflx_custom_data	Returned value of NFLX custom option value
[in]	nflx_custom_data_len	size of buffer provided in nflx_custom_data

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_get_nth_bytes_option_value()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_get_nth_bytes_option_value	(	wtap_block_t	block,
		unsigned	option_id,
		unsigned	idx,
		GBytes **	value
	)

Get bytes option value for nth instance of a particular option in a block

Parameters

[in]	block	Block from which to get the option value
[in]	option_id	Identifier value for option
[in]	idx	Instance number of option with that ID
[out]	value	Returned value of option

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

Note: You should call g_bytes_ref() on value if you plan to keep it around (and then g_bytes_unref() when you're done with it).

◆ wtap_block_get_nth_packet_verdict_option_value()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_get_nth_packet_verdict_option_value	(	wtap_block_t	block,
		unsigned	option_id,
		unsigned	idx,
		packet_verdict_opt_t *	value
	)

Get packet_verdict option value for the nth instance of a particular option in a block

Parameters

[in]	block	Block from which to get the option value
[in]	option_id	Identifier value for option
[in]	idx	Instance number of option with that ID
[out]	value	Returned value of option value

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_get_nth_string_option_value()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_get_nth_string_option_value	(	wtap_block_t	block,
		unsigned	option_id,
		unsigned	idx,
		char **	value
	)

Get string option value for the nth instance of a particular option in a block

Parameters

[in]	block	Block from which to get the option value
[in]	option_id	Identifier value for option
[in]	idx	Instance number of option with that ID
[out]	value	Returned value of option

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_get_string_option_value()

WS_DLL_PUBLIC wtap_opttype_return_val WS_DLL_PUBLIC wtap_opttype_return_val WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_get_string_option_value	(	wtap_block_t	block,
		unsigned	option_id,
		char **	value
	)

Get string option value from a block

Parameters

[in]	block	Block from which to get the option value
[in]	option_id	Identifier value for option
[out]	value	Returned value of option

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_get_type()

WS_DLL_PUBLIC wtap_block_type_t wtap_block_get_type ( wtap_block_t block )

Provide type of a block

Parameters

[in] block Block from which to retrieve mandatory data

Returns: Block type.

◆ wtap_block_get_uint32_option_value()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_get_uint32_option_value	(	wtap_block_t	block,
		unsigned	option_id,
		uint32_t *	value
	)

Get UINT32 option value from a block

Parameters

[in]	block	Block from which to get the option value
[in]	option_id	Identifier value for option
[out]	value	Returned value of option

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_get_uint64_option_value()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_get_uint64_option_value	(	wtap_block_t	block,
		unsigned	option_id,
		uint64_t *	value
	)

Get UINT64 option value from a block

Parameters

[in]	block	Block from which to get the option value
[in]	option_id	Identifier value for option
[out]	value	Returned value of option

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_get_uint8_option_value()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_get_uint8_option_value	(	wtap_block_t	block,
		unsigned	option_id,
		uint8_t *	value
	)

Get UINT8 option value from a block

Parameters

[in]	block	Block from which to get the option value
[in]	option_id	Identifier value for option
[out]	value	Returned value of option

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_make_copy()

WS_DLL_PUBLIC wtap_block_t wtap_block_make_copy ( wtap_block_t block )

Make a copy of a block.

Parameters

[in] block Block to be copied from

Returns: Newly allocated copy of that block

◆ wtap_block_ref()

WS_DLL_PUBLIC wtap_block_t wtap_block_ref ( wtap_block_t block )

Increase reference count of a block

Call when taking a copy of a block

Parameters

[in] block Block add ref to

Returns: The block

◆ wtap_block_remove_nth_option_instance()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_remove_nth_option_instance	(	wtap_block_t	block,
		unsigned	option_id,
		unsigned	idx
	)

Remove the nth instance of an option from a block

Parameters

[in]	block	Block from which to remove the option instance
[in]	option_id	Identifier value for option
[in]	idx	Instance number of option with that ID

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_remove_option()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_remove_option	(	wtap_block_t	block,
		unsigned	option_id
	)

Remove an option from a block

Parameters

[in]	block	Block from which to remove the option
[in]	option_id	Identifier value for option

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_set_bytes_option_value()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_set_bytes_option_value	(	wtap_block_t	block,
		unsigned	option_id,
		const uint8_t *	value,
		size_t	value_length
	)

Set bytes option value in a block

Parameters

[in]	block	Block in which to set the option value
[in]	option_id	Identifier value for option
[in]	value	New value of option
[in]	value_length	Number of bytes to copy.

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_set_if_filter_option_value()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_set_if_filter_option_value	(	wtap_block_t	block,
		unsigned	option_id,
		if_filter_opt_t *	value
	)

Set an if_filter option value in a block

Parameters

[in]	block	Block in which to set the option value
[in]	option_id	Identifier value for option
[in]	value	New value of option

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_set_int32_option_value()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_set_int32_option_value	(	wtap_block_t	block,
		unsigned	option_id,
		int32_t	value
	)

Set INT32 option value in a block

Parameters

[in]	block	Block in which to set the option value
[in]	option_id	Identifier value for option
[in]	value	New value of option

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_set_int64_option_value()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_set_int64_option_value	(	wtap_block_t	block,
		unsigned	option_id,
		int64_t	value
	)

Set INT64 option value in a block

Parameters

[in]	block	Block in which to set the option value
[in]	option_id	Identifier value for option
[in]	value	New value of option

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_set_int8_option_value()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_set_int8_option_value	(	wtap_block_t	block,
		unsigned	option_id,
		int8_t	value
	)

Set INT8 option value in a block

Parameters

[in]	block	Block in which to set the option value
[in]	option_id	Identifier value for option
[in]	value	New value of option

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_set_ipv4_option_value()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_set_ipv4_option_value	(	wtap_block_t	block,
		unsigned	option_id,
		uint32_t	value
	)

Set IPv4 option value in a block

Parameters

[in]	block	Block in which to set the option value
[in]	option_id	Identifier value for option
[in]	value	New value of option

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_set_ipv6_option_value()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_set_ipv6_option_value	(	wtap_block_t	block,
		unsigned	option_id,
		ws_in6_addr *	value
	)

Set IPv6 option value in a block

Parameters

[in]	block	Block in which to set the option value
[in]	option_id	Identifier value for option
[in]	value	New value of option

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_set_nth_bytes_option_value()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_set_nth_bytes_option_value	(	wtap_block_t	block,
		unsigned	option_id,
		unsigned	idx,
		GBytes *	value
	)

Set bytes option value for nth instance of a particular option in a block

Parameters

[in]	block	Block in which to set the option value
[in]	option_id	Identifier value for option
[in]	idx	Instance number of option with that ID
[in]	value	New value of option

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_set_nth_packet_verdict_option_value()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_set_nth_packet_verdict_option_value	(	wtap_block_t	block,
		unsigned	option_id,
		unsigned	idx,
		packet_verdict_opt_t *	value
	)

Set packet_verdict option value for the nth instsance of a particular option in a block

Parameters

[in]	block	Block in which to set the option value
[in]	option_id	Identifier value for option
[in]	idx	Instance number of option with that ID
[in]	value	New value of option

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_set_nth_string_option_value()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_set_nth_string_option_value	(	wtap_block_t	block,
		unsigned	option_id,
		unsigned	idx,
		const char *	value,
		size_t	value_length
	)

Set string option value for the nth instance of a particular option in a block

Parameters

[in]	block	Block in which to set the option value
[in]	option_id	Identifier value for option
[in]	idx	Instance number of option with that ID
[in]	value	New value of option
[in]	value_length	Maximum length of string to copy.

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_set_nth_string_option_value_format()

WS_DLL_PUBLIC wtap_opttype_return_val WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_set_nth_string_option_value_format	(	wtap_block_t	block,
		unsigned	option_id,
		unsigned	idx,
		const char *	format,
			...
	)

Set string option value for the nth instance of a particular option in a block to a printf-formatted string

Parameters

[in]	block	Block in which to set the option value
[in]	option_id	Identifier value for option
[in]	idx	Instance number of option with that ID
[in]	format	printf-like format string

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_set_string_option_value()

WS_DLL_PUBLIC wtap_opttype_return_val WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_set_string_option_value	(	wtap_block_t	block,
		unsigned	option_id,
		const char *	value,
		size_t	value_length
	)

Set string option value in a block

Parameters

[in]	block	Block in which to set the option value
[in]	option_id	Identifier value for option
[in]	value	New value of option
[in]	value_length	Maximum length of string to copy.

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_set_string_option_value_format()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_set_string_option_value_format	(	wtap_block_t	block,
		unsigned	option_id,
		const char *	format,
			...
	)

Set string option value in a block to a printf-formatted string

Parameters

[in]	block	Block in which to set the option value
[in]	option_id	Identifier value for option
[in]	format	printf-like format string

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_set_uint32_option_value()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_set_uint32_option_value	(	wtap_block_t	block,
		unsigned	option_id,
		uint32_t	value
	)

Set UINT32 option value in a block

Parameters

[in]	block	Block in which to set the option value
[in]	option_id	Identifier value for option
[in]	value	New value of option

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_set_uint64_option_value()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_set_uint64_option_value	(	wtap_block_t	block,
		unsigned	option_id,
		uint64_t	value
	)

Set UINT64 option value in a block

Parameters

[in]	block	Block in which to set the option value
[in]	option_id	Identifier value for option
[in]	value	New value of option

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_set_uint8_option_value()

WS_DLL_PUBLIC wtap_opttype_return_val wtap_block_set_uint8_option_value	(	wtap_block_t	block,
		unsigned	option_id,
		uint8_t	value
	)

Set UINT8 option value in a block

Parameters

[in]	block	Block in which to set the option value
[in]	option_id	Identifier value for option
[in]	value	New value of option

Returns: wtap_opttype_return_val - WTAP_OPTTYPE_SUCCESS if successful, error code otherwise

◆ wtap_block_unref()

WS_DLL_PUBLIC void wtap_block_unref ( wtap_block_t block )

Decrease reference count of a block

Needs to be called on any block once you're done with it

Parameters

[in] block Block to be deref'd

◆ wtap_opttypes_cleanup()

WS_DLL_PUBLIC void wtap_opttypes_cleanup ( void )

Cleanup the internal structures

◆ wtap_opttypes_initialize()

WS_DLL_PUBLIC void wtap_opttypes_initialize ( void )

Initialize block types.

This is currently just a placeholder as nothing needs to be initialized yet. Should handle "registration" when code is refactored to do so.

Classes

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ OPT_COMMENT

◆ OPT_CUSTOM_BIN_COPY

◆ OPT_CUSTOM_BIN_NO_COPY

◆ OPT_CUSTOM_STR_COPY

◆ OPT_CUSTOM_STR_NO_COPY

◆ OPT_EOFOPT

◆ OPT_IDB_DESCRIPTION

◆ OPT_IDB_EUIADDR

◆ OPT_IDB_FCSLEN

◆ OPT_IDB_FILTER

◆ OPT_IDB_HARDWARE

◆ OPT_IDB_IP4ADDR

◆ OPT_IDB_IP6ADDR

◆ OPT_IDB_MACADDR

◆ OPT_IDB_NAME

◆ OPT_IDB_OS

◆ OPT_IDB_SPEED

◆ OPT_IDB_TSOFFSET

◆ OPT_IDB_TSRESOL

◆ OPT_IDB_TZONE

◆ OPT_SHB_HARDWARE

◆ OPT_SHB_OS

◆ OPT_SHB_USERAPPL

Typedef Documentation

◆ wtapng_dsb_mandatory_t

◆ wtapng_ft_specific_mandatory_t

◆ wtapng_if_descr_mandatory_t

◆ wtapng_if_stats_mandatory_t

◆ wtapng_iface_descriptions_t

◆ wtapng_meta_event_mandatory_t

◆ wtapng_nrb_mandatory_t

◆ wtapng_section_mandatory_t

Function Documentation

◆ wtap_block_add_bytes_option()

◆ wtap_block_add_bytes_option_borrow()

◆ wtap_block_add_custom_option()

◆ wtap_block_add_if_filter_option()

◆ wtap_block_add_int32_option()

◆ wtap_block_add_int64_option()

◆ wtap_block_add_int8_option()

◆ wtap_block_add_ipv4_option()

◆ wtap_block_add_ipv6_option()

◆ wtap_block_add_nflx_custom_option()

◆ wtap_block_add_packet_hash_option()

◆ wtap_block_add_packet_verdict_option()

◆ wtap_block_add_string_option()

◆ wtap_block_add_string_option_format()

◆ wtap_block_add_string_option_owned()

◆ wtap_block_add_uint32_option()

◆ wtap_block_add_uint64_option()

◆ wtap_block_add_uint8_option()

◆ wtap_block_array_free()

◆ wtap_block_array_ref()

◆ wtap_block_array_unref()

◆ wtap_block_copy()

◆ wtap_block_count_option()

◆ wtap_block_create()

◆ wtap_block_get_bytes_option_value()

◆ wtap_block_get_if_filter_option_value()

◆ wtap_block_get_int32_option_value()

◆ wtap_block_get_int64_option_value()

◆ wtap_block_get_int8_option_value()

◆ wtap_block_get_ipv4_option_value()

◆ wtap_block_get_ipv6_option_value()

◆ wtap_block_get_mandatory_data()

◆ wtap_block_get_nflx_custom_option()

◆ wtap_block_get_nth_bytes_option_value()

◆ wtap_block_get_nth_packet_verdict_option_value()

◆ wtap_block_get_nth_string_option_value()

◆ wtap_block_get_string_option_value()

◆ wtap_block_get_type()

◆ wtap_block_get_uint32_option_value()

◆ wtap_block_get_uint64_option_value()