Nmsg constants. More...

Macros
#define	NMSG_MAGIC {'N', 'M', 'S', 'G'}
	Four-octet magic sequence seen at the beginning of a serialized NMSG.

#define	NMSG_VERSION 2U
	Current version number of the NMSG serialization format.

#define	NMSG_PROTOCOL_VERSION NMSG_VERSION

#define	NMSG_HDRSZ 6
	Number of octets in an NMSG header (magic + version).

#define	NMSG_HDRLSZ_V2 10
	Number of octets in an NMSG header (magic + version + length).

#define	NMSG_LENHDRSZ_V1 2
	Number of octets in the NMSG v1 header length field.

#define	NMSG_LENHDRSZ_V2 4
	Number of octets in the NMSG v2 header length field.

#define	NMSG_PAYHDRSZ 64
	Maximum number of octets in an NMSG payload header.

#define	NMSG_WBUFSZ_MIN 512
	Minimum number of octets that an nmsg wbuf must hold.

#define	NMSG_WBUFSZ_MAX 1048576
	Maximum number of octets that an nmsg wbuf can hold.

#define	NMSG_WBUFSZ_JUMBO 8192
	Number of octets that an nmsg wbuf destined for transport over a jumbo frame Ethernet should hold.

#define	NMSG_WBUFSZ_ETHER 1280
	Number of octets that an nmsg wbuf destined for transport over an Ethernet should hold.

#define	NMSG_RBUFSZ (2 * NMSG_WBUFSZ_MAX)
	Number of octets than an nmsg rbuf must hold.

#define	NMSG_RBUF_TIMEOUT 500
	Number of milliseconds to wait for data on an nmsg socket before returning nmsg_res_again.

#define	NMSG_DEFAULT_SNAPLEN 1522
	Default libpcap snap length when reading from a live interface.

#define	NMSG_IPSZ_MAX 65536
	Maximize size of an IP datagram.

#define	NMSG_FLAG_ZLIB 0x01
	NMSG container is zlib compressed.

#define	NMSG_FLAG_FRAGMENT 0x02
	NMSG container is fragmented.

Detailed Description

Nmsg constants.

Definition in file constants.h.

Macro Definition Documentation

◆ NMSG_MAGIC

#define NMSG_MAGIC {'N', 'M', 'S', 'G'}

Four-octet magic sequence seen at the beginning of a serialized NMSG.

Definition at line 27 of file constants.h.

◆ NMSG_VERSION

#define NMSG_VERSION 2U

Current version number of the NMSG serialization format.

With the introduction of NMSG_LIBRARY_VERSION, NMSG_PROTOCOL_VERSION was introduced to disambiguate version constants. It is assumed NMSG_VERSION will be deprecated and removed in a future release.

Definition at line 35 of file constants.h.

◆ NMSG_PROTOCOL_VERSION

#define NMSG_PROTOCOL_VERSION NMSG_VERSION

Definition at line 36 of file constants.h.

◆ NMSG_HDRSZ

#define NMSG_HDRSZ 6

Number of octets in an NMSG header (magic + version).

Definition at line 41 of file constants.h.

◆ NMSG_HDRLSZ_V2

#define NMSG_HDRLSZ_V2 10

Number of octets in an NMSG header (magic + version + length).

Definition at line 46 of file constants.h.

◆ NMSG_LENHDRSZ_V1

#define NMSG_LENHDRSZ_V1 2

Number of octets in the NMSG v1 header length field.

Definition at line 51 of file constants.h.

◆ NMSG_LENHDRSZ_V2

#define NMSG_LENHDRSZ_V2 4

Number of octets in the NMSG v2 header length field.

Definition at line 56 of file constants.h.

◆ NMSG_PAYHDRSZ

#define NMSG_PAYHDRSZ 64

Maximum number of octets in an NMSG payload header.

Definition at line 61 of file constants.h.

◆ NMSG_WBUFSZ_MIN

#define NMSG_WBUFSZ_MIN 512

Minimum number of octets that an nmsg wbuf must hold.

Definition at line 66 of file constants.h.

◆ NMSG_WBUFSZ_MAX

#define NMSG_WBUFSZ_MAX 1048576

Maximum number of octets that an nmsg wbuf can hold.

Definition at line 71 of file constants.h.

◆ NMSG_WBUFSZ_JUMBO

#define NMSG_WBUFSZ_JUMBO 8192

Number of octets that an nmsg wbuf destined for transport over a jumbo frame Ethernet should hold.

Definition at line 77 of file constants.h.

◆ NMSG_WBUFSZ_ETHER

#define NMSG_WBUFSZ_ETHER 1280

Number of octets that an nmsg wbuf destined for transport over an Ethernet should hold.

Definition at line 83 of file constants.h.

◆ NMSG_RBUFSZ

#define NMSG_RBUFSZ (2 * NMSG_WBUFSZ_MAX)

Number of octets than an nmsg rbuf must hold.

Since an nmsg stream is delimited by length fields, the worst case amount of storage needed is twice the maximum length of an nmsg container.

Definition at line 90 of file constants.h.

◆ NMSG_RBUF_TIMEOUT

#define NMSG_RBUF_TIMEOUT 500

Number of milliseconds to wait for data on an nmsg socket before returning nmsg_res_again.

Definition at line 96 of file constants.h.

◆ NMSG_DEFAULT_SNAPLEN

#define NMSG_DEFAULT_SNAPLEN 1522

Default libpcap snap length when reading from a live interface.

Definition at line 101 of file constants.h.

◆ NMSG_IPSZ_MAX

#define NMSG_IPSZ_MAX 65536

Maximize size of an IP datagram.

Definition at line 106 of file constants.h.

◆ NMSG_FLAG_ZLIB

#define NMSG_FLAG_ZLIB 0x01

NMSG container is zlib compressed.

Definition at line 113 of file constants.h.

◆ NMSG_FLAG_FRAGMENT

#define NMSG_FLAG_FRAGMENT 0x02

NMSG container is fragmented.

Definition at line 118 of file constants.h.

Macros