nmsg  1.0.0
Macros
constants.h File Reference

Nmsg constants. More...

Go to the source code of this file.

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. More...
 
#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. More...
 
#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_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_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.