fixbuf - API Documentation
Documentation | Downloads

fbInfoElement_st Struct Reference

A single IPFIX Information Element definition. More...

#include <public.h>


Data Fields

union {
   struct fbInfoElement_st *   canon
 Pointer to canonical copy of IE.
   char *   name
 Information element name.
ref
uint32_t midx
 Multiple IE index.
uint32_t ent
 Private Enterprise Number.
uint16_t num
 Information Element number.
uint16_t len
 Information element length in octets.
uint32_t flags
 Flags.

Detailed Description

A single IPFIX Information Element definition.

An Information Element defines the type of data in each field of a record. This structure may be contained in an fbInfoModel_t, in which case the name field contians the information element name, or an an fbTemplate_t, in which case the canon field references the fbInfoElement_t contained within the Information Model.


Field Documentation

Pointer to canonical copy of IE.

Set by fbInfoElementCopyToTemplate(), and valid only for template IEs.

Information element name.

Storage for this is managed by fbInfoModel. Valid only for model IEs.

Multiple IE index.

Must be 0 for model IEs. Defines the ordering of identical IEs in templates. Set and managed automatically by the fbTemplate_t routines.

Private Enterprise Number.

Set to 0 for IETF-defined IEs.

Information Element number.

Does not include the on-wire enterprise bit; i.e. num & 0x8000 == 0 even if ent > 0.

Information element length in octets.

Flags.

Bitwise OR of FB_IE_F_* constants.


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