public.h File Reference
#include <fixbuf/autoinc.h>
#include <fixbuf/version.h>

Go to the source code of this file.

Typedefs

typedef struct fbBasicList_st fbBasicList_t
 
typedef struct fbBasicListInfo_st fbBasicListInfo_t
 
typedef struct fbCollector_st fbCollector_t
 
typedef struct fbConnSpec_st fbConnSpec_t
 
typedef struct fbExporter_st fbExporter_t
 
typedef struct fbInfoElement_st fbInfoElement_t
 
typedef enum fbInfoElementDataType_en fbInfoElementDataType_t
 
typedef struct fbInfoElementOptRec_st fbInfoElementOptRec_t
 
typedef enum fbInfoElementSemantics_en fbInfoElementSemantics_t
 
typedef struct fbInfoElementSpec_st fbInfoElementSpec_t
 
typedef struct fbInfoElementSpecId_st fbInfoElementSpecId_t
 
typedef enum fbInfoElementUnits_en fbInfoElementUnits_t
 
typedef struct fbInfoModel_st fbInfoModel_t
 
typedef GHashTableIter fbInfoModelIter_t
 
typedef struct fbListener_st fbListener_t
 
typedef void(* fbListenerAppFree_fn) (void *ctx)
 
typedef gboolean(* fbListenerAppInit_fn) (fbListener_t *listener, void **ctx, int fd, struct sockaddr *peer, size_t peerlen, GError **err)
 
typedef struct fbListenerEntry_st fbListenerEntry_t
 
typedef struct fbListenerGroup_st fbListenerGroup_t
 
typedef struct fbListenerGroupResult_st fbListenerGroupResult_t
 
typedef enum fbListSemantics_en fbListSemantics_t
 
typedef void(* fbNewTemplateCallback_fn) (fbSession_t *session, uint16_t tid, fbTemplate_t *tmpl, void *app_ctx, void **tmpl_ctx, fbTemplateCtxFree_fn *tmpl_ctx_free_fn)
 
typedef struct fbRecord_st fbRecord_t
 
typedef int(* fbRecordSubRecordCallback_fn) (const fbRecord_t *record, void *ctx)
 
typedef struct fbRecordValue_st fbRecordValue_t
 
typedef int(* fbRecordValueCallback_fn) (const fbRecord_t *parent_record, const fbBasicList_t *parent_bl, const fbInfoElement_t *field, const fbRecordValue_t *value, void *ctx)
 
typedef struct fbSession_st fbSession_t
 
typedef struct fbSubTemplateList_st fbSubTemplateList_t
 
typedef struct fbSubTemplateMultiList_st fbSubTemplateMultiList_t
 
typedef struct fbSubTemplateMultiListEntry_st fbSubTemplateMultiListEntry_t
 
typedef struct fbTemplate_st fbTemplate_t
 
typedef void(* fbTemplateCtxFree_fn) (void *tmpl_ctx, void *app_ctx)
 
typedef struct fbTemplateField_st fbTemplateField_t
 
typedef struct fbTemplateInfo_st fbTemplateInfo_t
 
typedef struct fbTemplateIter_st fbTemplateIter_t
 
typedef enum fbTemplateSetCompareStatus_en fbTemplatesSetCompareStatus_t
 
typedef enum fbTransport_en fbTransport_t
 
typedef struct fBuf_st fBuf_t
 
typedef struct fbVarfield_st fbVarfield_t
 

Macros

#define FB_CISCO_ASA_EVENT_ID   9998
 
#define FB_CISCO_ASA_EVENT_XTRA   9997
 
#define FB_CISCO_GENERIC   9999
 
#define FB_CONNSPEC_INIT    { FB_SCTP, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL }
 
#define FB_ERROR_BUFSZ   5
 
#define FB_ERROR_CONN   11
 
#define FB_ERROR_DOMAIN   g_quark_from_string("fixbufError")
 
#define FB_ERROR_EOF   3
 
#define FB_ERROR_EOM   2
 
#define FB_ERROR_IMPL   6
 
#define FB_ERROR_IO   7
 
#define FB_ERROR_IPFIX   4
 
#define FB_ERROR_LAXSIZE   16
 
#define FB_ERROR_NETFLOWV9   12
 
#define FB_ERROR_NLREAD   8
 
#define FB_ERROR_NLWRITE   9
 
#define FB_ERROR_NOELEMENT   10
 
#define FB_ERROR_SETUP   15
 
#define FB_ERROR_SFLOW   14
 
#define FB_ERROR_TMPL   1
 
#define FB_ERROR_TRANSMISC   13
 
#define FB_IE_DEFAULT   0x00000000
 
#define FB_IE_DELTACOUNTER   0x00000300
 
#define FB_IE_F_ALIEN   0x00000080
 
#define FB_IE_F_ENDIAN   0x00000001
 
#define FB_IE_F_NONE   0x00000000
 
#define FB_IE_F_REVERSIBLE   0x00000040
 
#define FB_IE_FLAGS   0x00000500
 
#define FB_IE_IDENTIFIER   0x00000400
 
#define FB_IE_INIT(_name_, _ent_, _num_, _len_, _flags_)    FB_IE_INIT_FULL(_name_, _ent_, _num_, _len_, _flags_, 0, 0, 0, (char *)NULL)
 
#define FB_IE_INIT_FULL(_name_, _ent_, _num_, _len_, _flags_, _min_, _max_, _type_, _desc_)    { _ent_, _num_, _len_, _flags_, _type_, _min_, _max_, _name_, _desc_ }
 
#define FB_IE_INIT_FULL_SPLIT(_name_, _ent_, _num_, _len_, _rev_, _endian_, _semantics_, _units_, _min_, _max_, _type_, _desc_)
 
#define FB_IE_LIST   0x00000600
 
#define FB_IE_NULL   FB_IE_INIT(NULL, 0, 0, 0, 0)
 
#define FB_IE_PEN_REVERSE   29305
 
#define FB_IE_QUANTITY   0x00000100
 
#define FB_IE_REVERSE_STR   "reverse"
 
#define FB_IE_REVERSE_STRLEN   7
 
#define FB_IE_SEMANTIC(flags)   ((flags & 0x0000ff00) >> 8)
 
#define FB_IE_SNMPCOUNTER   0x00000700
 
#define FB_IE_SNMPGAUGE   0x00000800
 
#define FB_IE_TOTALCOUNTER   0x00000200
 
#define FB_IE_UNITS(flags)   ((flags & 0xFFFF0000) >> 16)
 
#define FB_IE_VARLEN   65535
 
#define FB_IE_VENDOR_BIT_REVERSE   0x4000
 
#define FB_IESPEC_NULL   { NULL, 0, 0 }
 
#define FB_IESPECID_NULL   { {0, 0}, 0, 0 }
 
#define FB_RECORD_INIT   {NULL, NULL, 0, 0, 0}
 
#define FB_RECORD_VALUE_INIT    { NULL, NULL, { {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0} } }
 
#define FB_TEMPLATE_ITER_NULL   {NULL, UINT16_MAX}
 
#define FB_TEMPLATEFIELD_INIT   {NULL, 0, 0, 0, NULL}
 
#define FB_TID_AUTO   0
 
#define FB_TID_MIN_DATA   256
 
#define FB_TID_OTS   3
 
#define FB_TID_TS   2
 
#define FB_TMPL_CMP_IGNORE_LENGTHS   0x02u
 
#define FB_TMPL_CMP_IGNORE_PADDING   0x01u
 
#define FB_TMPL_CMP_IGNORE_SCOPE   0x04u
 
#define FB_TMPL_COPY_IGNORE_SCOPE   0x04u
 
#define FB_TMPL_COPY_REMOVE_PADDING   0x01u
 
#define FB_TMPL_IS_META_ANY
 
#define FB_TMPL_IS_META_BASICLIST   (1u << 4)
 
#define FB_TMPL_IS_META_ELEMENT   (1u << 1)
 
#define FB_TMPL_IS_META_TEMPLATE_V1   (1u << 2)
 
#define FB_TMPL_IS_META_TEMPLATE_V3   (1u << 3)
 
#define FB_TMPL_IS_META_TMPL_ANY
 
#define FB_TMPL_IS_OPTIONS   (1u << 0)
 
#define FB_TMPL_MD_LEVEL_0   0
 
#define FB_TMPL_MD_LEVEL_1   1
 
#define FB_TMPL_MD_LEVEL_NA   0xFF
 
#define FB_UNITS_BITS   0x00010000
 
#define FB_UNITS_ENTRIES   0x000C0000
 
#define FB_UNITS_FLOWS   0x00040000
 
#define FB_UNITS_FRAMES   0x000D0000
 
#define FB_UNITS_HOPS   0x000B0000
 
#define FB_UNITS_INFERRED   0x000F0000
 
#define FB_UNITS_MESSAGES   0x000A0000
 
#define FB_UNITS_MICROSECONDS   0x00070000
 
#define FB_UNITS_MILLISECONDS   0x00060000
 
#define FB_UNITS_NANOSECONDS   0x00080000
 
#define FB_UNITS_OCTETS   0x00020000
 
#define FB_UNITS_PACKETS   0x00030000
 
#define FB_UNITS_PORTS   0x000E0000
 
#define FB_UNITS_SECONDS   0x00050000
 
#define FB_UNITS_WORDS   0x00090000
 
#define fbBLNext(type, basicList, current)    ((type *)(fbBasicListGetNextPtr((basicList), (current))))
 
#define fbInfoElementCheckIdent(_ie, _enterpriseNumber, _elementId)    ((_elementId) == (_ie)->num && (_enterpriseNumber) == (_ie)->ent)
 
#define fbInfoElementGetDescription(_ie)   ((_ie)->description)
 
#define fbInfoElementGetId(_ie)   ((_ie)->num)
 
#define fbInfoElementGetLen(_ie)   ((_ie)->len)
 
#define fbInfoElementGetMax(_ie)   ((_ie)->max)
 
#define fbInfoElementGetMin(_ie)   ((_ie)->min)
 
#define fbInfoElementGetName(_ie)   ((_ie)->name)
 
#define fbInfoElementGetPEN(_ie)   ((_ie)->ent)
 
#define fbInfoElementGetSemantics(_ie)   FB_IE_SEMANTIC((_ie)->flags)
 
#define fbInfoElementGetType(_ie)   ((_ie)->type)
 
#define fbInfoElementGetUnits(_ie)   FB_IE_UNITS((_ie)->units)
 
#define fbInfoElementIsAlien(_ie)   (!!((_ie)->flags & FB_IE_F_ALIEN))
 
#define fbInfoElementIsDatetime(_ie)    ((_ie)->type >= FB_DT_SEC && (_ie)->type <= FB_DT_NANOSEC)
 
#define fbInfoElementIsEndian(_ie)   (!!((_ie)->flags & FB_IE_F_ENDIAN))
 
#define fbInfoElementIsFloat(_ie)    ((_ie)->type >= FB_FLOAT_32 && (_ie)->type <= FB_FLOAT_64)
 
#define fbInfoElementIsInteger(_ie)    ((_ie)->type >= FB_UINT_8 && (_ie)->type <= FB_INT_64)
 
#define fbInfoElementIsIPAddress(_ie)    ((_ie)->type >= FB_IP4_ADDR && (_ie)->type <= FB_IP6_ADDR)
 
#define fbInfoElementIsList(_ie)    ((_ie)->type >= FB_BASIC_LIST && (_ie)->type <= FB_SUB_TMPL_MULTI_LIST)
 
#define fbInfoElementIsNumber(_ie)    ((_ie)->type >= FB_UINT_8 && (_ie)->type <= FB_FLOAT_64)
 
#define fbInfoElementIsPadding(_ie)   (210 == (_ie)->num && 0 == (_ie)->ent)
 
#define fbInfoElementIsReversible(_ie)   (!!((_ie)->flags & FB_IE_F_REVERSIBLE))
 
#define fbInfoElementIsSigned(_ie)    ((_ie)->type >= FB_INT_8 && (_ie)->type <= FB_INT_64)
 
#define fbInfoElementIsUnsigned(_ie)    ((_ie)->type >= FB_UINT_8 && (_ie)->type <= FB_UINT_64)
 
#define fbSTLNext(type, subTemplateList, current)    ((type *)(fbSubTemplateListGetNextPtr((subTemplateList), (current))))
 
#define fbSTMLEntryNext(type, subTemplateMultiListEntry, current)
 
#define fbSTMLNext(subTemplateMultiList, current)    fbSubTemplateMultiListGetNextEntry((subTemplateMultiList), (current))
 
#define fbTemplateFieldCheckIdent(_field, _enterpriseNumber, _elementId)
 
#define fbTemplateFieldGetId(_field)   ((_field)->canon->num)
 
#define fbTemplateFieldGetIE(_field)   ((_field)->canon)
 
#define fbTemplateFieldGetLen(_field)   ((_field)->len)
 
#define fbTemplateFieldGetMemsize(_field)
 
#define fbTemplateFieldGetName(_field)   ((_field)->canon->name)
 
#define fbTemplateFieldGetOffset(_field)   ((_field)->offset)
 
#define fbTemplateFieldGetPEN(_field)   ((_field)->canon->ent)
 
#define fbTemplateFieldGetRepeat(_field)   ((_field)->midx)
 
#define fbTemplateFieldGetType(_field)   ((_field)->canon->type)
 
#define FIXBUF_CHECK_VERSION(major, minor, release)
 

Enumerations

enum  fbInfoElementDataType_en {
  FB_OCTET_ARRAY, FB_UINT_8, FB_UINT_16, FB_UINT_32,
  FB_UINT_64, FB_INT_8, FB_INT_16, FB_INT_32,
  FB_INT_64, FB_FLOAT_32, FB_FLOAT_64, FB_BOOL,
  FB_MAC_ADDR, FB_STRING, FB_DT_SEC, FB_DT_MILSEC,
  FB_DT_MICROSEC, FB_DT_NANOSEC, FB_IP4_ADDR, FB_IP6_ADDR,
  FB_BASIC_LIST, FB_SUB_TMPL_LIST, FB_SUB_TMPL_MULTI_LIST
}
 
enum  fbInfoElementSemantics_en {
  FB_IE_SEM_DEFAULT = 0, FB_IE_SEM_QUANTITY = 1, FB_IE_SEM_TOTALCOUNTER = 2, FB_IE_SEM_DELTACOUNTER = 3,
  FB_IE_SEM_IDENTIFIER = 4, FB_IE_SEM_FLAGS = 5, FB_IE_SEM_LIST = 6, FB_IE_SEM_SNMPCOUNTER = 7,
  FB_IE_SEM_SNMPGAUGE = 8
}
 
enum  fbInfoElementUnits_en {
  FB_IE_UNITS_NONE = 0, FB_IE_UNITS_BITS = 1, FB_IE_UNITS_OCTETS = 2, FB_IE_UNITS_PACKETS = 3,
  FB_IE_UNITS_FLOWS = 4, FB_IE_UNITS_SECONDS = 5, FB_IE_UNITS_MILLISECONDS = 6, FB_IE_UNITS_MICROSECONDS = 7,
  FB_IE_UNITS_NANOSECONDS = 8, FB_IE_UNITS_WORDS = 9, FB_IE_UNITS_MESSAGES = 10, FB_IE_UNITS_HOPS = 11,
  FB_IE_UNITS_ENTRIES = 12, FB_IE_UNITS_FRAMES = 13, FB_IE_UNITS_PORTS = 14, FB_IE_UNITS_INFERRED = 15
}
 
enum  fbListSemantics_en {
  FB_LIST_SEM_UNDEFINED = 0xFF, FB_LIST_SEM_NONE_OF = 0, FB_LIST_SEM_EXACTLY_ONE_OF = 1, FB_LIST_SEM_ONE_OR_MORE_OF = 2,
  FB_LIST_SEM_ALL_OF = 3, FB_LIST_SEM_ORDERED = 4
}
 
enum  fbTemplateSetCompareStatus_en {
  FB_TMPL_SETCMP_SUBSET = 1, FB_TMPL_SETCMP_EQUAL = 2, FB_TMPL_SETCMP_SUPERSET = 3, FB_TMPL_SETCMP_COMMON = 4,
  FB_TMPL_SETCMP_DISJOINT = 8
}
 
enum  fbTransport_en {
  FB_SCTP, FB_TCP, FB_UDP, FB_DTLS_SCTP,
  FB_TLS_TCP, FB_DTLS_UDP
}
 

Functions

void * fbBasicListAddNewElements (fbBasicList_t *basicList, uint16_t additional)
 
fbBasicList_tfbBasicListAlloc (void)
 
void fbBasicListClear (fbBasicList_t *basicList)
 
void fbBasicListClearWithoutFree (fbBasicList_t *basicList)
 
void fbBasicListCollectorInit (fbBasicList_t *basicList)
 
uint16_t fbBasicListCountElements (const fbBasicList_t *basicList)
 
void fbBasicListFree (fbBasicList_t *basicList)
 
void * fbBasicListGetDataPtr (const fbBasicList_t *basicList)
 
uint16_t fbBasicListGetElementIdent (const fbBasicList_t *basicList, uint32_t *pen)
 
uint16_t fbBasicListGetElementLength (const fbBasicList_t *basicList)
 
void * fbBasicListGetIndexedDataPtr (const fbBasicList_t *basicList, uint16_t index)
 
gboolean fbBasicListGetIndexedRecordValue (const fbBasicList_t *basicList, uint16_t index, fbRecordValue_t *value)
 
const fbInfoElement_tfbBasicListGetInfoElement (const fbBasicList_t *basicList)
 
void * fbBasicListGetNextPtr (const fbBasicList_t *basicList, const void *currentPtr)
 
uint8_t fbBasicListGetSemantic (const fbBasicList_t *basicList)
 
const fbTemplateField_tfbBasicListGetTemplateField (const fbBasicList_t *basicList)
 
uint16_t fbBasicListInfoGetContentIdent (const fbBasicListInfo_t *blInfo, uint32_t *pen)
 
uint16_t fbBasicListInfoGetListIdent (const fbBasicListInfo_t *blInfo, uint32_t *pen)
 
void * fbBasicListInit (fbBasicList_t *basicList, uint8_t semantic, const fbInfoElement_t *infoElement, uint16_t numElements)
 
void * fbBasicListInitWithLength (fbBasicList_t *basicList, uint8_t semantic, const fbInfoElement_t *infoElement, uint16_t elementLength, uint16_t numElements)
 
void * fbBasicListResize (fbBasicList_t *basicList, uint16_t newCount)
 
void fbBasicListSetSemantic (fbBasicList_t *basicList, uint8_t semantic)
 
fbCollector_tfbCollectorAllocFile (void *ctx, const char *path, GError **err)
 
fbCollector_tfbCollectorAllocFP (void *ctx, FILE *fp)
 
gboolean fbCollectorClearTranslator (fbCollector_t *collector, GError **err)
 
void fbCollectorClose (fbCollector_t *collector)
 
void * fbCollectorGetContext (const fbCollector_t *collector)
 
uint32_t fbCollectorGetNetflowMissed (const fbCollector_t *collector, const struct sockaddr *peer, size_t peerlen, uint32_t obdomain)
 
uint32_t fbCollectorGetObservationDomain (const fbCollector_t *collector)
 
const struct sockaddr * fbCollectorGetPeer (const fbCollector_t *collector)
 
uint32_t fbCollectorGetSFlowMissed (const fbCollector_t *collector, const struct sockaddr *peer, size_t peerlen, uint32_t obdomain)
 
void fbCollectorSetAcceptOnly (fbCollector_t *collector, struct sockaddr *address, size_t address_length)
 
gboolean fbCollectorSetNetflowV9Translator (fbCollector_t *collector, GError **err)
 
gboolean fbCollectorSetSFlowTranslator (fbCollector_t *collector, GError **err)
 
void fbCollectorSetUDPMultiSession (fbCollector_t *collector, gboolean multi_session)
 
fbExporter_tfbExporterAllocBuffer (uint8_t *buf, uint16_t bufsize)
 
fbExporter_tfbExporterAllocFile (const char *path)
 
fbExporter_tfbExporterAllocFP (FILE *fp)
 
fbExporter_tfbExporterAllocNet (const fbConnSpec_t *spec)
 
void fbExporterAutoStream (fbExporter_t *exporter)
 
void fbExporterClose (fbExporter_t *exporter)
 
size_t fbExporterGetMsgLen (const fbExporter_t *exporter)
 
size_t fbExporterGetOctetCount (const fbExporter_t *exporter)
 
size_t fbExporterGetOctetCountAndReset (fbExporter_t *exporter)
 
void fbExporterResetOctetCount (fbExporter_t *exporter)
 
void fbExporterSetStream (fbExporter_t *exporter, int sctp_stream)
 
gboolean fbInfoElementAddOptRecElement (fbInfoModel_t *model, const fbInfoElementOptRec_t *rec)
 
fbTemplate_tfbInfoElementAllocTypeTemplate (fbInfoModel_t *model, GError **err)
 
gboolean fbInfoElementWriteOptionsRecord (fBuf_t *fbuf, const fbInfoElement_t *model_ie, uint16_t itid, uint16_t etid, GError **err)
 
void fbInfoModelAddElement (fbInfoModel_t *model, const fbInfoElement_t *ie)
 
void fbInfoModelAddElementArray (fbInfoModel_t *model, const fbInfoElement_t *ie)
 
fbInfoModel_tfbInfoModelAlloc (void)
 
gboolean fbInfoModelContainsElement (const fbInfoModel_t *model, const fbInfoElement_t *element)
 
guint fbInfoModelCountElements (const fbInfoModel_t *model)
 
void fbInfoModelFree (fbInfoModel_t *model)
 
const fbInfoElement_tfbInfoModelGetElementByID (const fbInfoModel_t *model, uint16_t id, uint32_t ent)
 
const fbInfoElement_tfbInfoModelGetElementByName (const fbInfoModel_t *model, const char *name)
 
void fbInfoModelIterInit (fbInfoModelIter_t *iter, const fbInfoModel_t *model)
 
const fbInfoElement_tfbInfoModelIterNext (fbInfoModelIter_t *iter)
 
gboolean fbInfoModelReadXMLData (fbInfoModel_t *model, const gchar *xml_data, gssize xml_data_len, GError **err)
 
gboolean fbInfoModelReadXMLFile (fbInfoModel_t *model, const gchar *filename, GError **err)
 
fbListener_tfbListenerAlloc (const fbConnSpec_t *spec, fbSession_t *session, fbListenerAppInit_fn appinit, fbListenerAppFree_fn appfree, GError **err)
 
void fbListenerFree (fbListener_t *listener)
 
void fbListenerFreeGroupResult (fbListenerGroupResult_t *result)
 
gboolean fbListenerGetCollector (const fbListener_t *listener, fbCollector_t **collector, GError **err)
 
int fbListenerGroupAddListener (fbListenerGroup_t *group, const fbListener_t *listener)
 
fbListenerGroup_tfbListenerGroupAlloc (void)
 
int fbListenerGroupDeleteListener (fbListenerGroup_t *group, const fbListener_t *listener)
 
void fbListenerGroupFree (fbListenerGroup_t *group)
 
fbListenerGroupResult_tfbListenerGroupWait (fbListenerGroup_t *group, GError **err)
 
void fbListenerInterrupt (fbListener_t *listener)
 
fBuf_tfbListenerOwnSocketCollectorTCP (fbListener_t *listener, int sock, GError **err)
 
fBuf_tfbListenerOwnSocketCollectorTLS (fbListener_t *listener, int sock, GError **err)
 
fBuf_tfbListenerWait (fbListener_t *listener, GError **err)
 
fBuf_tfbListenerWaitNoCollectors (fbListener_t *listener, GError **err)
 
gboolean fbListSemanticsIsValid (uint8_t semantic)
 
gboolean fbRecordCopyFieldValue (const fbRecord_t *record, const fbTemplateField_t *field, void *dest, size_t destlen)
 
gboolean fbRecordCopyToTemplate (const fbRecord_t *srcRec, fbRecord_t *dstRec, const fbTemplate_t *tmpl, uint16_t tid, GError **err)
 
int fbRecordFindAllElementValues (const fbRecord_t *record, const fbInfoElement_t *ie, unsigned int flags, fbRecordValueCallback_fn callback, void *ctx)
 
int fbRecordFindAllSubRecords (const fbRecord_t *record, uint16_t tid, unsigned int flags, fbRecordSubRecordCallback_fn callback, void *ctx)
 
const fbBasicList_tfbRecordFindBasicListOfIE (const fbRecord_t *record, const fbInfoElement_t *contentsElement, uint16_t *position, uint16_t skip)
 
const fbSubTemplateList_tfbRecordFindStlOfTemplate (const fbRecord_t *record, const fbTemplate_t *tmpl, uint16_t *position, uint16_t skip)
 
gboolean fbRecordFindValueForInfoElement (const fbRecord_t *record, const fbInfoElement_t *ie, fbRecordValue_t *value, uint16_t *position, uint16_t skip)
 
void fbRecordFreeLists (fbRecord_t *record)
 
uint16_t fbRecordGetFieldCount (const fbRecord_t *record)
 
gboolean fbRecordGetValueForField (const fbRecord_t *record, const fbTemplateField_t *field, fbRecordValue_t *value)
 
void fbRecordValueClear (fbRecordValue_t *value)
 
fbRecordValue_tfbRecordValueCopy (fbRecordValue_t *dstValue, const fbRecordValue_t *srcValue)
 
gchar * fbRecordValueTakeVarfieldBuf (fbRecordValue_t *value)
 
void fbSessionAddNewTemplateCallback (fbSession_t *session, fbNewTemplateCallback_fn callback, void *app_ctx)
 
uint16_t fbSessionAddTemplate (fbSession_t *session, gboolean internal, uint16_t tid, fbTemplate_t *tmpl, fbTemplateInfo_t *tmplInfo, GError **err)
 
void fbSessionAddTemplatePair (fbSession_t *session, uint16_t ext_tid, uint16_t int_tid)
 
uint16_t fbSessionAddTemplatesForExport (fbSession_t *session, uint16_t tid, fbTemplate_t *tmpl, fbTemplateInfo_t *tmplInfo, GError **err)
 
fbSession_tfbSessionAlloc (fbInfoModel_t *model)
 
void fbSessionCopyIncomingTemplatesCallback (fbSession_t *incomingSession, uint16_t tid, fbTemplate_t *tmpl, void *exportSession, void **tmpl_ctx, fbTemplateCtxFree_fn *tmpl_ctx_free_fn)
 
gboolean fbSessionExportTemplate (fbSession_t *session, uint16_t tid, GError **err)
 
gboolean fbSessionExportTemplates (fbSession_t *session, GError **err)
 
void fbSessionFree (fbSession_t *session)
 
fbCollector_tfbSessionGetCollector (const fbSession_t *session)
 
uint32_t fbSessionGetDomain (const fbSession_t *session)
 
fbInfoModel_tfbSessionGetInfoModel (const fbSession_t *session)
 
uint16_t fbSessionGetLargestInternalTemplateSize (fbSession_t *session)
 
fbTemplate_tfbSessionGetTemplate (const fbSession_t *session, gboolean internal, uint16_t tid, GError **err)
 
const fbTemplateInfo_tfbSessionGetTemplateInfo (const fbSession_t *session, uint16_t tid)
 
uint16_t fbSessionGetTemplatePath (const fbSession_t *session, const fbTemplateInfo_t *tmplInfo, uint16_t path[], uint16_t path_size, GError **err)
 
uint16_t fbSessionLookupTemplatePair (const fbSession_t *session, uint16_t ext_tid)
 
gboolean fbSessionRemoveTemplate (fbSession_t *session, gboolean internal, uint16_t tid, GError **err)
 
void fbSessionRemoveTemplatePair (fbSession_t *session, uint16_t ext_tid)
 
void fbSessionResetExternal (fbSession_t *session)
 
void fbSessionSetCallbackCopyTemplates (fbSession_t *incomingSession, fbSession_t *exportSession)
 
void fbSessionSetDomain (fbSession_t *session, uint32_t domain)
 
uint16_t fbSessionSetMetadataExportElements (fbSession_t *session, gboolean enabled, uint16_t tid, GError **err)
 
uint16_t fbSessionSetMetadataExportTemplates (fbSession_t *session, gboolean enabled, uint16_t tmplInfoTid, uint16_t blInfoTid, GError **err)
 
void * fbSubTemplateListAddNewElements (fbSubTemplateList_t *subTemplateList, uint16_t additional)
 
fbSubTemplateList_tfbSubTemplateListAlloc (void)
 
void fbSubTemplateListClear (fbSubTemplateList_t *subTemplateList)
 
void fbSubTemplateListClearWithoutFree (fbSubTemplateList_t *subTemplateList)
 
void fbSubTemplateListCollectorInit (fbSubTemplateList_t *subTemplateList)
 
uint16_t fbSubTemplateListCountElements (const fbSubTemplateList_t *subTemplateList)
 
void fbSubTemplateListFree (fbSubTemplateList_t *subTemplateList)
 
void * fbSubTemplateListGetDataPtr (const fbSubTemplateList_t *subTemplateList)
 
void * fbSubTemplateListGetIndexedDataPtr (const fbSubTemplateList_t *subTemplateList, uint16_t index)
 
void * fbSubTemplateListGetNextPtr (const fbSubTemplateList_t *subTemplateList, const void *currentPtr)
 
uint8_t fbSubTemplateListGetSemantic (const fbSubTemplateList_t *subTemplateList)
 
const fbTemplate_tfbSubTemplateListGetTemplate (const fbSubTemplateList_t *subTemplateList)
 
uint16_t fbSubTemplateListGetTemplateID (const fbSubTemplateList_t *subTemplateList)
 
void * fbSubTemplateListInit (fbSubTemplateList_t *sTL, uint8_t semantic, uint16_t tmplID, const fbTemplate_t *tmpl, uint16_t numElements)
 
void * fbSubTemplateListResize (fbSubTemplateList_t *subTemplateList, uint16_t newCount)
 
void fbSubTemplateListSetSemantic (fbSubTemplateList_t *subTemplateList, uint8_t semantic)
 
fbSubTemplateMultiListEntry_tfbSubTemplateMultiListAddNewEntries (fbSubTemplateMultiList_t *STML, uint16_t additional)
 
fbSubTemplateMultiList_tfbSubTemplateMultiListAlloc (void)
 
void fbSubTemplateMultiListClear (fbSubTemplateMultiList_t *STML)
 
void fbSubTemplateMultiListClearEntries (fbSubTemplateMultiList_t *STML)
 
uint16_t fbSubTemplateMultiListCountElements (const fbSubTemplateMultiList_t *STML)
 
void * fbSubTemplateMultiListEntryAddNewElements (fbSubTemplateMultiListEntry_t *entry, uint16_t additional)
 
void fbSubTemplateMultiListEntryClear (fbSubTemplateMultiListEntry_t *entry)
 
uint16_t fbSubTemplateMultiListEntryCountElements (const fbSubTemplateMultiListEntry_t *entry)
 
void * fbSubTemplateMultiListEntryGetDataPtr (const fbSubTemplateMultiListEntry_t *entry)
 
void * fbSubTemplateMultiListEntryGetIndexedPtr (const fbSubTemplateMultiListEntry_t *entry, uint16_t index)
 
const fbTemplate_tfbSubTemplateMultiListEntryGetTemplate (const fbSubTemplateMultiListEntry_t *entry)
 
uint16_t fbSubTemplateMultiListEntryGetTemplateID (const fbSubTemplateMultiListEntry_t *entry)
 
void * fbSubTemplateMultiListEntryInit (fbSubTemplateMultiListEntry_t *entry, uint16_t tmplID, const fbTemplate_t *tmpl, uint16_t numElements)
 
void * fbSubTemplateMultiListEntryNextDataPtr (const fbSubTemplateMultiListEntry_t *entry, const void *currentPtr)
 
void * fbSubTemplateMultiListEntryResize (fbSubTemplateMultiListEntry_t *entry, uint16_t newCount)
 
void fbSubTemplateMultiListFree (fbSubTemplateMultiList_t *STML)
 
fbSubTemplateMultiListEntry_tfbSubTemplateMultiListGetFirstEntry (const fbSubTemplateMultiList_t *STML)
 
fbSubTemplateMultiListEntry_tfbSubTemplateMultiListGetIndexedEntry (const fbSubTemplateMultiList_t *STML, uint16_t index)
 
fbSubTemplateMultiListEntry_tfbSubTemplateMultiListGetNextEntry (const fbSubTemplateMultiList_t *STML, const fbSubTemplateMultiListEntry_t *currentEntry)
 
uint8_t fbSubTemplateMultiListGetSemantic (const fbSubTemplateMultiList_t *STML)
 
fbSubTemplateMultiListEntry_tfbSubTemplateMultiListInit (fbSubTemplateMultiList_t *STML, uint8_t semantic, uint16_t numElements)
 
fbSubTemplateMultiListEntry_tfbSubTemplateMultiListResize (fbSubTemplateMultiList_t *STML, uint16_t newCount)
 
void fbSubTemplateMultiListSetSemantic (fbSubTemplateMultiList_t *STML, uint8_t semantic)
 
fbTemplate_tfbTemplateAlloc (fbInfoModel_t *model)
 
gboolean fbTemplateAppend (fbTemplate_t *tmpl, const fbInfoElement_t *ex_ie, GError **err)
 
gboolean fbTemplateAppendArraySpecId (fbTemplate_t *tmpl, const fbInfoElementSpecId_t *spec, uint32_t wantedFlags, GError **err)
 
gboolean fbTemplateAppendSpec (fbTemplate_t *tmpl, const fbInfoElementSpec_t *spec, uint32_t wantedFlags, GError **err)
 
gboolean fbTemplateAppendSpecArray (fbTemplate_t *tmpl, const fbInfoElementSpec_t *spec, uint32_t wantedFlags, GError **err)
 
gboolean fbTemplateAppendSpecId (fbTemplate_t *tmpl, const fbInfoElementSpecId_t *spec, uint32_t wantedFlags, GError **err)
 
gboolean fbTemplateContainsAllArraySpecId (const fbTemplate_t *tmpl, const fbInfoElementSpecId_t *spec)
 
gboolean fbTemplateContainsAllElementsByName (const fbTemplate_t *tmpl, const fbInfoElementSpec_t *spec)
 
gboolean fbTemplateContainsAllFlaggedArraySpecId (const fbTemplate_t *tmpl, const fbInfoElementSpecId_t *spec, uint32_t wantedFlags)
 
gboolean fbTemplateContainsAllFlaggedElementsByName (const fbTemplate_t *tmpl, const fbInfoElementSpec_t *spec, uint32_t wantedFlags)
 
gboolean fbTemplateContainsElement (const fbTemplate_t *tmpl, const fbInfoElement_t *element)
 
gboolean fbTemplateContainsElementByName (const fbTemplate_t *tmpl, const fbInfoElementSpec_t *spec)
 
gboolean fbTemplateContainsSpecId (const fbTemplate_t *tmpl, const fbInfoElementSpecId_t *spec)
 
fbTemplate_tfbTemplateCopy (const fbTemplate_t *tmpl, uint32_t flags)
 
uint16_t fbTemplateCountElements (const fbTemplate_t *tmpl)
 
const fbTemplateField_tfbTemplateFindFieldByDataType (const fbTemplate_t *tmpl, fbInfoElementDataType_t datatype, uint16_t *position, uint16_t skip)
 
const fbTemplateField_tfbTemplateFindFieldByElement (const fbTemplate_t *tmpl, const fbInfoElement_t *ie, uint16_t *position, uint16_t skip)
 
const fbTemplateField_tfbTemplateFindFieldByIdent (const fbTemplate_t *tmpl, uint32_t ent, uint16_t num, uint16_t *position, uint16_t skip)
 
void fbTemplateFreeUnused (fbTemplate_t *tmpl)
 
void * fbTemplateGetContext (const fbTemplate_t *tmpl)
 
const fbTemplateField_tfbTemplateGetFieldByPosition (const fbTemplate_t *tmpl, uint16_t position)
 
uint16_t fbTemplateGetIELenOfMemBuffer (const fbTemplate_t *tmpl)
 
const fbTemplateField_tfbTemplateGetIndexedIE (const fbTemplate_t *tmpl, uint16_t position) __attribute__((__deprecated__))
 
fbInfoModel_tfbTemplateGetInfoModel (const fbTemplate_t *tmpl)
 
uint16_t fbTemplateGetOptionsScope (const fbTemplate_t *tmpl)
 
void fbTemplateInfoAddBasicList (fbTemplateInfo_t *tmplInfo, uint32_t blEnt, uint16_t blNum, uint32_t contentEnt, uint16_t contentNum)
 
fbTemplateInfo_tfbTemplateInfoAlloc (void)
 
fbTemplateInfo_tfbTemplateInfoCopy (const fbTemplateInfo_t *tmplInfo)
 
void fbTemplateInfoFree (fbTemplateInfo_t *tmplInfo)
 
uint16_t fbTemplateInfoGetApplabel (const fbTemplateInfo_t *tmplInfo)
 
const char * fbTemplateInfoGetDescription (const fbTemplateInfo_t *tmplInfo)
 
const char * fbTemplateInfoGetName (const fbTemplateInfo_t *tmplInfo)
 
const fbBasicListInfo_tfbTemplateInfoGetNextBasicList (const fbTemplateInfo_t *tmplInfo, const fbBasicListInfo_t *blInfo)
 
uint16_t fbTemplateInfoGetParentTid (const fbTemplateInfo_t *tmplInfo)
 
uint16_t fbTemplateInfoGetTemplateId (const fbTemplateInfo_t *tmplInfo)
 
gboolean fbTemplateInfoInit (fbTemplateInfo_t *tmplInfo, const char *name, const char *description, uint16_t appLabel, uint16_t parentTid)
 
gboolean fbTemplateIsMetadata (const fbTemplate_t *tmpl, uint32_t tests)
 
const fbTemplateField_tfbTemplateIterGetField (const fbTemplateIter_t *iter)
 
uint16_t fbTemplateIterGetPosition (const fbTemplateIter_t *iter)
 
const fbTemplate_tfbTemplateIterGetTemplate (const fbTemplateIter_t *iter)
 
void fbTemplateIterInit (fbTemplateIter_t *iter, const fbTemplate_t *tmpl)
 
const fbTemplateField_tfbTemplateIterNext (fbTemplateIter_t *iter)
 
gboolean fbTemplatesAreEqual (const fbTemplate_t *tmpl1, const fbTemplate_t *tmpl2)
 
int fbTemplatesCompare (const fbTemplate_t *tmpl1, const fbTemplate_t *tmpl2, unsigned int flags)
 
void fbTemplateSetContext (fbTemplate_t *tmpl, void *tmpl_ctx, void *app_ctx, fbTemplateCtxFree_fn ctx_free)
 
gboolean fbTemplateSetOptionsScope (fbTemplate_t *tmpl, uint16_t scope_count)
 
fbTemplatesSetCompareStatus_t fbTemplatesSetCompare (const fbTemplate_t *tmpl1, const fbTemplate_t *tmpl2, uint16_t *matching_fields, unsigned int flags)
 
fBuf_tfBufAllocForCollection (fbSession_t *session, fbCollector_t *collector)
 
fBuf_tfBufAllocForExport (fbSession_t *session, fbExporter_t *exporter)
 
gboolean fBufAppend (fBuf_t *fbuf, uint8_t *recbase, size_t recsize, GError **err)
 
gboolean fBufEmit (fBuf_t *fbuf, GError **err)
 
void fBufFree (fBuf_t *fbuf)
 
fbTemplate_tfBufGetCollectionTemplate (const fBuf_t *fbuf, uint16_t *ext_tid)
 
fbCollector_tfBufGetCollector (const fBuf_t *fbuf)
 
fbExporter_tfBufGetExporter (const fBuf_t *fbuf)
 
uint32_t fBufGetExportTime (const fBuf_t *fbuf)
 
fbSession_tfBufGetSession (const fBuf_t *fbuf)
 
void fBufInterruptSocket (fBuf_t *fbuf)
 
void fBufListFree (const fbTemplate_t *tmpl, uint8_t *record)
 
gboolean fBufNext (fBuf_t *fbuf, uint8_t *recbase, size_t *recsize, GError **err)
 
fbTemplate_tfBufNextCollectionTemplate (fBuf_t *fbuf, uint16_t *ext_tid, GError **err)
 
gboolean fBufNextMessage (fBuf_t *fbuf, GError **err)
 
gboolean fBufNextRecord (fBuf_t *fbuf, fbRecord_t *record, GError **err)
 
size_t fBufRemaining (fBuf_t *fbuf)
 
gboolean fBufSetAutomaticElementInsert (fBuf_t *fbuf, GError **err)
 
gboolean fBufSetAutomaticInsert (fBuf_t *fbuf, GError **err)
 
gboolean fBufSetAutomaticMetadataAttach (fBuf_t *fbuf, GError **err)
 
void fBufSetAutomaticMode (fBuf_t *fbuf, gboolean automatic)
 
void fBufSetAutomaticNextMessage (fBuf_t *fbuf, gboolean automatic)
 
void fBufSetBuffer (fBuf_t *fbuf, uint8_t *buf, size_t buflen)
 
void fBufSetCollector (fBuf_t *fbuf, fbCollector_t *collector)
 
void fBufSetExporter (fBuf_t *fbuf, fbExporter_t *exporter)
 
gboolean fBufSetExportTemplate (fBuf_t *fbuf, uint16_t ext_tid, GError **err)
 
void fBufSetExportTime (fBuf_t *fbuf, uint32_t extime)
 
gboolean fBufSetInternalTemplate (fBuf_t *fbuf, uint16_t int_tid, GError **err)
 
gboolean fBufSetTemplatesForExport (fBuf_t *fbuf, uint16_t tid, GError **err)
 

Data Structures

struct  fbBasicList_st
 
struct  fbConnSpec_st
 
struct  fbInfoElement_st
 
struct  fbInfoElementOptRec_st
 
struct  fbInfoElementSpec_st
 
struct  fbInfoElementSpecId_st
 
struct  fbInfoElementSpecId_st::fbInfoElementSpecIdIdent_st
 
struct  fbListenerEntry_st
 
struct  fbListenerGroupResult_st
 
struct  fbRecord_st
 
struct  fbRecordValue_st
 
struct  fbSubTemplateList_st
 
struct  fbSubTemplateMultiList_st
 
struct  fbSubTemplateMultiListEntry_st
 
struct  fbTemplateField_st
 
struct  fbTemplateIter_st
 
struct  fbVarfield_st
 
union  fbRecordValue_st::v_un
 

Detailed Description

Fixbuf IPFIX protocol library public interface.

Typedef Documentation

◆ fBuf_t

typedef struct fBuf_st fBuf_t

An IPFIX message buffer.

Used to encode and decode records from IPFIX Messages. The internals of this structure are private to libfixbuf.

◆ fbVarfield_t

typedef struct fbVarfield_st fbVarfield_t

A variable-length field value.

Variable-length information element content is represented by an fbVarfield_t on the internal side of the transcoder; that is, variable length fields in an IPFIX Message must be represented by this structure within the application record.

◆ fbInfoModel_t

typedef struct fbInfoModel_st fbInfoModel_t

An IPFIX information model.

Contains information element definitions. The internals of this structure are private to libfixbuf.

◆ fbInfoModelIter_t

typedef GHashTableIter fbInfoModelIter_t

An iterator over the information elements in an information model.

◆ fbInfoElementSemantics_t

◆ fbInfoElementUnits_t

◆ fbInfoElementDataType_t

From RFC 5610: A description of the abstract data type of an IPFIX information element as registered in the IANA IPFIX IE Data Type subregistry.

See also
fbInfoElementGetType(), fbTemplateFieldGetType() https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-information-element-data-types

◆ fbTemplate_t

typedef struct fbTemplate_st fbTemplate_t

An IPFIX Template or Options Template.

Templates define the structure of data records and options records within an IPFIX Message.

The internals of this structure are private to libfixbuf.

◆ fbInfoElement_t

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.

◆ fbTemplateField_t

fbTemplateField_t represents an fbInfoElement_t that has been added to an fbTemplate_t.

Since
libfixbuf 3.0.0

◆ fbTemplateIter_t

fbTemplateIter_t iterates over the fbTemplateField_t objects in an fbTemplate_t.

To use, define the fbTemplateIter_t on the stack, using FB_TEMPLATE_ITER_NULL to zero it if desired. Bind it to a Template with fbTemplateIterInit(), iterate over the TemplateFields with fbTemplateIterNext() until that function returns NULL.

Since
libfixbuf 3.0.0

◆ fbBasicList_t

typedef struct fbBasicList_st fbBasicList_t

A data type to represent an fbInfoElement_t of type basicList (FB_BASIC_LIST).

A BasicList contains zero or more instances of a single Information Element.

When reading from a fbCollector_t, you should first initialize the BasicList (fbBasicListCollectorInit() or memset() the list to 0). After calling fBufNext(), you may query the BasicList for its element (fbBasicListGetInfoElement()), get the number of elements (fbBasicListCountElements()), get the element at a specific position (fbBasicListGetIndexedDataPtr()), and iterate over the elements (fbBasicListGetNextPtr() or fbBLNext()).

When building a BasicList for an fbExporter_t, use fbBasicListInitWithLength() to initialize the BasicList, then fill in the value for each element in the list. To add entries to the BasicList while building it, use fbBasicListAddNewElements().

In either case, the data buffer of the BasicList should be freed when it no longer needed (fbBasicListClear()).

◆ fbSubTemplateList_t

A data type to represent an fbInfoElement_t of type subTemplateList (FB_SUB_TMPL_LIST).

A SubTemplateList contains zero or more instances of structured a data type, where the data type is described by a single fbTemplate_t.

When reading from a fbCollector_t, you should first initialize the SubTemplateList (fbSubTemplateListCollectorInit() or memset() the list to 0). After calling fBufNext(), you may query the SubTemplateList for its Template (fbSubTemplateListGetTemplate() and fbSubTemplateListGetTemplateID()), get the number of elements (fbSubTemplateListCountElements()), get the element at a specific position (fbSubTemplateListGetIndexedDataPtr()), and iterate over the elements (fbSubTemplateListGetNextPtr() or fbSTLNext()).

When building a SubTemplateList for an fbExporter_t, use fbSubTemplateListInit() to initialize the SubTemplateList, then fill in the value for each element in the list. To add entries to the SubTemplateList while building it, use fbSubTemplateListAddNewElements().

In either case, the data buffer of the SubTemplateList should be freed when it no longer needed (fbSubTemplateListClear()).

◆ fbSubTemplateMultiList_t

A data type to represent an fbInfoElement_t of type subTemplateMultiList (FB_SUB_TMPL_MULTI_LIST).

A SubTemplateMultiList contains zero or more instances of structured data, where different elements may be described by different fbTemplate_t definitions.

In libfixbuf, groups of consecutive data instances that share the same Template are represented by an fbSubTemplateMultiListEntry_t. The SubTemplateMultiList contains only the list semantic, an array of SubTemplateMultiListEntries, and the length of the array.

A SubTemplateMultiList may be thought of as a list of SubTemplateLists (where SubTemplateMultiListEntry is equivalent to SubTemplateList).

When reading from a fbCollector_t, you call fBufNext() to fill the SubTemplateMultiList. You may then query the SubTemplateMultiList for the number of entries (fbSubTemplateMultiListCountElements()), get the entry at a specific position (fbSubTemplateMultiListGetIndexedEntry()), and iterate over the entries (fbSubTemplateMultiListGetNextEntry() or fbSTMLNext()). For each entry, you will need to iterate over its contents (details in the description of fbSubTemplateMultiListEntry_t).

When building a SubTemplateMultiList for an fbExporter_t, use fbSubTemplateMultiListInit() to initialize the SubTemplateMultiList, then fill in the value for each fbSubTemplateMultiListEntry_t in the list. To add entries to the SubTemplateMultiList while building it, use fbSubTemplateMultiListAddNewEntries().

In either case, the data buffer of the SubTemplateMultiList should be freed (fbSubTemplateMultiListClear()) before collecting or exporting another record.

◆ fbRecord_t

typedef struct fbRecord_st fbRecord_t

fbRecord_t maintains a buffer holding an IPFIX record's data, the fbTemplate_t that describes that data and the template's ID.

The caller should initialize rec with an data buffer and store the length of that buffer in reccapacity. All fixbuf functions treat reccapacity as constant. FIXME—We could allow the fbRecord_t to maintain this buffer itself.

Before each call to fBufNextRecord(), the caller sets tid to the template to use to read the record. fBufNextRecord() updates tmpl and recsize reads the data into rec.

The caller is responsible for calling fbRecordFreeLists() before reusing the record. FIXME—We should probably change this.

Since
libfixbuf 3.0.0

◆ fbRecordValue_t

fbRecordValue_t is used to access the value of a single Element (or Field) in an fbRecord_t.

When an fbRecordValue_t is created on the stack, it should be initialized with FB_RECORD_VALUE_INIT.

If you use it to access FB_STRING or FB_OCTET_ARRAY data, call either fbRecordValueClear() to ensure its internal string buffer is freed or fbRecordValueTakeVarfieldBuf() to take ownship of the internal string buffer before the RecordValue leaves scope.

Since
libfixbuf 3.0.0

◆ fbInfoElementOptRec_t

The corresponding C struct for a record whose template is the RFC 5610 Information Element Type Options Template.

If collecting this record, use the function fbInfoElementAddOptRecElement() to add the fbInfoElement_t it describes to the fbInfoModel_t.

To export RFC5610 elements, use fbSessionSetMetadataExportElements().

fbInfoElementSpec_t rfc5610_spec[] = {
{"privateEnterpriseNumber", 4, 0 },
{"informationElementId", 2, 0 },
{"informationElementDataType", 1, 0 },
{"informationElementSemantics", 1, 0 },
{"informationElementUnits", 2, 0 },
{"paddingOctets", 6, 0 },
{"informationElementRangeBegin", 8, 0 },
{"informationElementRangeEnd", 8, 0 },
{"informationElementName", FB_IE_VARLEN, 0 },
{"informationElementDescription", FB_IE_VARLEN, 0 },
};

◆ fbInfoElementSpec_t

A single IPFIX Information Element specification.

Used to name an information element (fbInfoElement_t) for inclusion in an fbTemplate_t by fbTemplateAppendSpecArray() and for querying whether a template contains an element via fbTemplateContainsElementByName().

See also
fbInfoElementSpecId_t

◆ fbInfoElementSpecId_t

A single IPFIX Information Element specification using the element's numeric identifier and private enterprise number.

Used to name an information element (fbInfoElement_t) for inclusion in an fbTemplate_t by fbTemplateAppendArraySpecId().

See also
fbInfoElementSpec_t
Since
libfixbuf 3.0.0

◆ fbSession_t

typedef struct fbSession_st fbSession_t

An IPFIX Transport Session state container.

Though Session creation and lifetime are managed by the fbCollector_t and fbExporter_t types, each fBuf_t buffer uses this type to store session state, including internal and external Templates and Message Sequence Number information.

◆ fbTransport_t

Transport protocol for connection specifier.

◆ fbConnSpec_t

typedef struct fbConnSpec_st fbConnSpec_t

Connection specifier.

Used to define a peer address for fbExporter_t, or a passive address for fbListener_t.

◆ fbTemplateInfo_t

typedef struct fbTemplateInfo_st fbTemplateInfo_t

fbTemplateInfo_t describes an fbTemplate_t.

This information is encoded and sent between IPFIX senders and receives to provide enhanced description of the structure of the templates.

Since
libfixbuf 3.0.0

◆ fbBasicListInfo_t

typedef struct fbBasicListInfo_st fbBasicListInfo_t

fbBasicListInfo_t describes a basicList and is used by fbTemplateInfo_t.

fbBasicListInfo_t contains the enterprise and element numbers of the fbInfoElement_t the list contains and the numbers for the basicList itself.

Since
libfixbuf 3.0.0

◆ fbExporter_t

typedef struct fbExporter_st fbExporter_t

IPFIX Exporting Process endpoint.

Used to export messages from an associated IPFIX Message Buffer to a remote Collecting Process, or to an IPFIX File. The internals of this structure are private to libfixbuf.

◆ fbCollector_t

typedef struct fbCollector_st fbCollector_t

IPFIX Collecting Process endpoint.

Used to collect messages into an associated IPFIX Message Buffer from a remote Exporting Process, or from an IPFIX File. Use this with the fbListener_t structure to implement a full Collecting Process, including Transport Session setup. The internals of this structure are private to libfixbuf.

◆ fbListener_t

typedef struct fbListener_st fbListener_t

IPFIX Collecting Process session listener.

Used to wait for connections from IPFIX Exporting Processes, and to manage open connections via a select(2)-based mechanism. The internals of this structure are private to libfixbuf.

◆ fbListenerGroup_t

typedef struct fbListenerGroup_st fbListenerGroup_t

Structure that represents a group of listeners.

◆ fbListenerEntry_t

ListenerEntry's make up an fbListenerGroup_t as a linked list.

◆ fbListenerGroupResult_t

A ListenerGroupResult contains the fbListener whose listening socket got a new connection (cf.

fbListenerGroupWait()). It is tied to the fBuf_t that is produced for the connection. These comprise a linked list.

◆ fbTemplateCtxFree_fn

typedef void(* fbTemplateCtxFree_fn) (void *tmpl_ctx, void *app_ctx)

A callback function that is called when a template is freed.

This function should be set during the fbNewTemplateCallback_fn.

Parameters
tmpl_ctxa pointer to the ctx that is stored within the fbTemplate. This is the context to be cleaned up.
app_ctxthe app_ctx pointer that was passed to the fbSessionAddNewTemplateCallback() call. This is for context only and should not be cleaned up.

◆ fbNewTemplateCallback_fn

typedef void(* fbNewTemplateCallback_fn) (fbSession_t *session, uint16_t tid, fbTemplate_t *tmpl, void *app_ctx, void **tmpl_ctx, fbTemplateCtxFree_fn *tmpl_ctx_free_fn)

A callback function that will be called when the session receives a new external template.

This callback can be used to assign an internal template to an incoming external template for nested template records using fbSessionAddTemplatePair() or to apply some context variable to a template.

The callback should be set using fbSessionAddNewTemplateCallback(), and that function should be called after fbSessionAlloc(). Libfixbuf often clones session upon receiving a connection (particularly in the UDP case since a collector and fbuf can have multiple sessions), and this callback is carried over to cloned sessions.

Parameters
sessiona pointer to the session that received the template
tidthe template ID for the template that was received
tmplpointer to the template information of the received template
app_ctxthe app_ctx pointer that was passed to the fbSessionAddNewTemplateCallback() call
tmpl_ctxpointer that is stored in the fbTemplate structure.
tmpl_ctx_free_fna callback function that should be called to free the tmpl_ctx when the template is freed/replaced.

◆ fbListSemantics_t

fbListSemantics_t defines the possible values for the semantics of the structured Data Types: basicLists, subTemplateLists, and subTemplateMultiLists.

See RFC 6313.

https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-structured-data-types-semantics

Since
libfixbuf 3.0.0
See also
fbBasicListGetSemantic(), fbSubTemplateListGetSemantic(), fbSubTemplateMultiListGetSemantic()

◆ fbSubTemplateMultiListEntry_t

A data type used in a fbSubTemplateMultiList_t to represent structured data instances that share the same fbTemplate_t.

The SubTemplateMultiList contains an array of these objects.

When reading from a fbCollector_t, use the methods on the SubTemplateMultiList to get each SubTemplateMultiListEntry. For each entry, you may get its Template (fbSubTemplateMultiListEntryGetTemplate() and fbSubTemplateMultiListEntryGetTemplateID()), get its number of elements (fbSubTemplateMultiListEntryCountElements()), get the element at a specific position (fbSubTemplateMultiListEntryGetIndexedPtr()), and iterate over the elements (fbSubTemplateMultiListEntryNextDataPtr() or fbSTMLEntryNext()).

When writing to an fbExporter_t, first initialize the fbSubTemplateMultiList_t and then get a reference to a SubTemplateMultiListEntry. For the entry, initialize it (fbSubTemplateMultiListEntryInit()) and then fill in the value for each element in the list. To add entries to the SubTemplateMultiListEntry while building it, use fbSubTemplateMultiListEntryAddNewElements().

◆ fbListenerAppInit_fn

typedef gboolean(* fbListenerAppInit_fn) (fbListener_t *listener, void **ctx, int fd, struct sockaddr *peer, size_t peerlen, GError **err)

Application context initialization function type for fbListener_t.

Pass this function as the appinit parameter when creating the fbListener_t with fbListenerAlloc().

Fixbuf calls this function after accept(2) for TCP or SCTP with the peer address in the peer argument. For UDP, it is called during fbListener_t initialization and the peer address is NULL. If the Collector is in UDP multi-session mode, the function is called again when a new UDP connection occurs with the peer address, similiar to the TCP case. Use fbCollectorSetUDPMultiSession() to turn on multi-session mode (off by default).

The application may veto fbCollector_t creation by having this function return FALSE. In multi-session mode, if the connection is to be ignored, the application should set error code FB_ERROR_NLREAD on the err and return FALSE. If the function returns FALSE, fixbuf will maintain information about that peer, and will reject connections from that peer until shutdown or until that session times out. Fixbuf will return FB_ERROR_NLREAD for previously rejected sessions.

The context (returned via out-parameter ctx) is stored in the fbCollector_t, and it is retrievable via fbCollectorGetContext(). If not in multi-session mode and using the appinit fn, the ctx will be associated with all UDP sessions.

See also
fbListenerAppFree_fn

◆ fbListenerAppFree_fn

typedef void(* fbListenerAppFree_fn) (void *ctx)

Application context free function type for fbListener_t.

Pass this function as the appfree parameter when creating the fbListener_t with fbListenerAlloc().

For TCP and SCTP collectors, this is called when the connection is closed. If a UDP Collector is in multi-session mode (see fbListenerAppInit_fn), this function is called if a session is timed out (does not receive a UDP message for more than 30 minutes.) Called during fbCollector_t cleanup.

◆ fbTemplatesSetCompareStatus_t

Defines the values returned by fbTemplatesSetCompare() when checking whether one fbTemplate_t is a subset of another.

Since
libfixbuf 3.0.0

◆ fbRecordValueCallback_fn

typedef int(* fbRecordValueCallback_fn) (const fbRecord_t *parent_record, const fbBasicList_t *parent_bl, const fbInfoElement_t *field, const fbRecordValue_t *value, void *ctx)

Signature of the callback function required by fbRecordFindAllElementValues().

The function is called with parent_record being the Record that holds the field, parent_bl is either NULL or the basicList that holds items matching the desired fbInfoElement_t, field is the InfoElement searched for, value is the value for the desired InfoElement, and ctx is the user-supplied context. The function should return 0 success, and non-zero on failure.

Since
libfixbuf 3.0.0

◆ fbRecordSubRecordCallback_fn

typedef int(* fbRecordSubRecordCallback_fn) (const fbRecord_t *record, void *ctx)

Signature of the callback function required by fbRecordFindAllSubRecords().

The function is called with record being a Record whose fbTemplate_t matches the desired Template ID and ctx holding the user-supplied context. The function should return 0 success, and non-zero on failure.

Since
libfixbuf 3.0.0

Macro Definition Documentation

◆ FIXBUF_CHECK_VERSION

#define FIXBUF_CHECK_VERSION (   major,
  minor,
  release 
)
Value:
(FIXBUF_VERSION_MAJOR > (major) || \
(FIXBUF_VERSION_MAJOR == (major) && FIXBUF_VERSION_MINOR > (minor)) || \
(FIXBUF_VERSION_MAJOR == (major) && FIXBUF_VERSION_MINOR == (minor) && \
FIXBUF_VERSION_RELEASE >= (release)))

Evaluates to a non-zero value if the version number of libfixbuf is at least major.minor.release.

◆ FB_ERROR_DOMAIN

#define FB_ERROR_DOMAIN   g_quark_from_string("fixbufError")

All fixbuf errors are returned within the FB_ERROR_DOMAIN domain.

◆ FB_ERROR_TMPL

#define FB_ERROR_TMPL   1

No template was available for the given template ID, the session's template table is full, an attempt was made to modify a template that was previously added to a session, or the template is at its maximum size.

◆ FB_ERROR_EOM

#define FB_ERROR_EOM   2

End of IPFIX message.

Either there are no more records present in the message on read, or the message MTU has been reached on write.

◆ FB_ERROR_EOF

#define FB_ERROR_EOF   3

End of IPFIX Message stream.

No more messages are available from the transport layer on read, either because the session has closed, or the file has been processed.

◆ FB_ERROR_IPFIX

#define FB_ERROR_IPFIX   4

Illegal IPFIX message content on read.

The input stream is malformed, or is not an IPFIX Message after all.

◆ FB_ERROR_BUFSZ

#define FB_ERROR_BUFSZ   5

A message was received larger than the collector buffer size.

Should never occur. This condition is checked at the transport layer in case future versions of fixbuf support dynamic buffer sizing.

◆ FB_ERROR_IMPL

#define FB_ERROR_IMPL   6

The requested feature is not yet implemented.

◆ FB_ERROR_IO

#define FB_ERROR_IO   7

An unspecified I/O error occured.

◆ FB_ERROR_NLREAD

#define FB_ERROR_NLREAD   8

No data is available for reading from the transport layer.

Either a transport layer read was interrupted, or timed out.

◆ FB_ERROR_NLWRITE

#define FB_ERROR_NLWRITE   9

An attempt to write data to the transport layer failed due to closure of the remote end of the connection.

Currently only occurs with the TCP transport layer.

◆ FB_ERROR_NOELEMENT

#define FB_ERROR_NOELEMENT   10

The specified Information Element does not exist in the Information Model.

◆ FB_ERROR_CONN

#define FB_ERROR_CONN   11

A connection or association could not be established or maintained.

◆ FB_ERROR_NETFLOWV9

#define FB_ERROR_NETFLOWV9   12

Illegal NetflowV9 content on a read.

Can't parse the Netflow header or the stream is not a NetflowV9 stream

◆ FB_ERROR_TRANSMISC

#define FB_ERROR_TRANSMISC   13

Miscellaneous error occured during translator operation.

◆ FB_ERROR_SFLOW

#define FB_ERROR_SFLOW   14

Illegal sFlow content on a read.

◆ FB_ERROR_SETUP

#define FB_ERROR_SETUP   15

Setup error.

◆ FB_ERROR_LAXSIZE

#define FB_ERROR_LAXSIZE   16

Internal template with defaulted element sizes.

◆ FB_IE_INIT_FULL

#define FB_IE_INIT_FULL (   _name_,
  _ent_,
  _num_,
  _len_,
  _flags_,
  _min_,
  _max_,
  _type_,
  _desc_ 
)     { _ent_, _num_, _len_, _flags_, _type_, _min_, _max_, _name_, _desc_ }

Convenience macro for creating full fbInfoElement_t static initializer.

Used for creating information element arrays suitable for passing to fbInfoModelAddElementArray().

◆ FB_IE_INIT_FULL_SPLIT

#define FB_IE_INIT_FULL_SPLIT (   _name_,
  _ent_,
  _num_,
  _len_,
  _rev_,
  _endian_,
  _semantics_,
  _units_,
  _min_,
  _max_,
  _type_,
  _desc_ 
)
Value:
FB_IE_INIT_FULL(_name_, _ent_, _num_, _len_, \
(((_rev_) ? FB_IE_F_REVERSIBLE : 0) | \
((_endian_) ? FB_IE_F_ENDIAN : 0) | \
(((_semantic) & 0xFF) << 8) | \
(((_units_) & 0xFFFF) << 16)), \
_min_, _max_, _type_, _desc_)

Convenience macro for creating full fbInfoElement_t static initializers.

Used for creating information element arrays suitable for passing to fbInfoModelAddElementArray().

rev and endian are booleans, semantics is a fbInfoElementSemantics_t units is a fbInfoElementUnits_t

Since
libfixbuf 3.0.0

◆ FB_IE_INIT

#define FB_IE_INIT (   _name_,
  _ent_,
  _num_,
  _len_,
  _flags_ 
)     FB_IE_INIT_FULL(_name_, _ent_, _num_, _len_, _flags_, 0, 0, 0, (char *)NULL)

Convenience macro for creating default fbInfoElement_t static initializers.

Used for creating information element arrays suitable for passing to fbInfoModelAddElementArray().

◆ FB_IE_NULL

#define FB_IE_NULL   FB_IE_INIT(NULL, 0, 0, 0, 0)

Convenience macro defining a null fbInfoElement_t initializer to terminate a constant information element array for passing to fbInfoModelAddElementArray().

◆ FB_IE_SEMANTIC

#define FB_IE_SEMANTIC (   flags)    ((flags & 0x0000ff00) >> 8)

Convenience macro for extracting the information element semantic value (fbInfoElementSemantics_t) from the flags member of the fbInfoElement_t struct.

See also
fbInfoElementGetSemantics() https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-information-element-semantics

◆ FB_IE_UNITS

#define FB_IE_UNITS (   flags)    ((flags & 0xFFFF0000) >> 16)

Convenience macro for extracting the information element units value (fbInfoElementUnits_t) from the flags member of the fbInfoElement_t struct.

See also
fbInfoElementGetUnits() https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-information-element-units.

◆ FB_IE_F_NONE

#define FB_IE_F_NONE   0x00000000

Default treatment of flags member in an fbInfoElement_t.

Provided for initializer convenience. Corresponds to octet-array semantics for a non-reversible, non-alien IE.

◆ FB_IE_F_ENDIAN

#define FB_IE_F_ENDIAN   0x00000001

Information element endian conversion bit in the flags member of fbInfoElement_t.

If set, IE is an integer and will be endian-converted on transcode.

See also
fbInfoElementIsEndian()

◆ FB_IE_F_REVERSIBLE

#define FB_IE_F_REVERSIBLE   0x00000040

Information element reversible bit in the flags member of fbInfoElement_t.

Adding the information element via fbInfoModelAddElement() or fbInfoModelAddElementArray() will cause a second, reverse information element to be added to the model following the conventions in IETF RFC 5103. This means that, if there is no enterprise number, the reverse element will get an enterprise number of FB_IE_PEN_REVERSE, and if there is an enterprise number, the reverse element's numeric identifier will have its FB_IE_VENDOR_BIT_REVERSE bit set.

See also
fbInfoElementIsReversible()

◆ FB_IE_F_ALIEN

#define FB_IE_F_ALIEN   0x00000080

Information element alien bit in the flags member of fbInfoElement_t.

If set, IE is enterprise-specific and was recieved via an external template at a Collecting Process. It is therefore subject to semantic typing via options (not yet implemented). Do not set this flag on information elements added programmatically to an information model via fbInfoModelAddElement() or fbInfoModelAddElementArray().

See also
fbInfoElementIsAlien()

◆ FB_IE_QUANTITY

#define FB_IE_QUANTITY   0x00000100

Information Element Semantics - See RFC 5610

https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-information-element-semantics The Information Element Semantics bits within the flags member of an fbInfoElement_t that denote the information element as a quantity.

fbInfoElementGetSemantics() and fbInfoElementSemantics_t provide an alternate interface.

◆ FB_IE_TOTALCOUNTER

#define FB_IE_TOTALCOUNTER   0x00000200

The Information Element Semantics bits within the flags member of an fbInfoElement_t that denote the information element as a totalCounter.

fbInfoElementGetSemantics() and fbInfoElementSemantics_t provide an alternate interface.

◆ FB_IE_DELTACOUNTER

#define FB_IE_DELTACOUNTER   0x00000300

The Information Element Semantics bits within the flags member of an fbInfoElement_t that denote the information element as a deltaCounter.

fbInfoElementGetSemantics() and fbInfoElementSemantics_t provide an alternate interface.

◆ FB_IE_IDENTIFIER

#define FB_IE_IDENTIFIER   0x00000400

The Information Element Semantics bits within the flags member of an fbInfoElement_t that denote the information element as an identifier.

fbInfoElementGetSemantics() and fbInfoElementSemantics_t provide an alternate interface.

◆ FB_IE_FLAGS

#define FB_IE_FLAGS   0x00000500

The Information Element Semantics bits within the flags member of an fbInfoElement_t that denote the information element as a flags element.

fbInfoElementGetSemantics() and fbInfoElementSemantics_t provide an alternate interface.

◆ FB_IE_LIST

#define FB_IE_LIST   0x00000600

The Information Element Semantics bits within the flags member of an fbInfoElement_t that denote the information element as a list element.

fbInfoElementGetSemantics() and fbInfoElementSemantics_t provide an alternate interface.

◆ FB_IE_SNMPCOUNTER

#define FB_IE_SNMPCOUNTER   0x00000700

The Information Element Semantics bits within the flags member of an fbInfoElement_t that denote the information element as an SNMP counter.

fbInfoElementGetSemantics() and fbInfoElementSemantics_t provide an alternate interface.

◆ FB_IE_SNMPGAUGE

#define FB_IE_SNMPGAUGE   0x00000800

The Information Element Semantics bits within the flags member of an fbInfoElement_t that denote the information element as a SNMP gauge.

fbInfoElementGetSemantics() and fbInfoElementSemantics_t provide an alternate interface.

◆ FB_IE_DEFAULT

#define FB_IE_DEFAULT   0x00000000

The Information Element Semantics bits within the flags member of an fbInfoElement_t that denote the information element as having no specific semantics.

fbInfoElementGetSemantics() and fbInfoElementSemantics_t provide an alternate interface.

◆ FB_UNITS_BITS

#define FB_UNITS_BITS   0x00010000

Information Element Units - See RFC 5610.

https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-information-element-units The Information Element Units bits within the flags member of an fbInfoElement_t that denote the information element as counting bits.

fbInfoElementGetUnits() and fbInfoElementUnits_t provide an alternate interface.

◆ FB_UNITS_OCTETS

#define FB_UNITS_OCTETS   0x00020000

The Information Element Units bits within the flags member of an fbInfoElement_t that denote the information element as counting octets.

fbInfoElementGetUnits() and fbInfoElementUnits_t provide an alternate interface.

◆ FB_UNITS_PACKETS

#define FB_UNITS_PACKETS   0x00030000

The Information Element Units bits within the flags member of an fbInfoElement_t that denote the information element as counting packets.

fbInfoElementGetUnits() and fbInfoElementUnits_t provide an alternate interface.

◆ FB_UNITS_FLOWS

#define FB_UNITS_FLOWS   0x00040000

The Information Element Units bits within the flags member of an fbInfoElement_t that denote the information element as counting flows.

fbInfoElementGetUnits() and fbInfoElementUnits_t provide an alternate interface.

◆ FB_UNITS_SECONDS

#define FB_UNITS_SECONDS   0x00050000

The Information Element Units bits within the flags member of an fbInfoElement_t that denote the information element as counting seconds.

fbInfoElementGetUnits() and fbInfoElementUnits_t provide an alternate interface.

◆ FB_UNITS_MILLISECONDS

#define FB_UNITS_MILLISECONDS   0x00060000

The Information Element Units bits within the flags member of an fbInfoElement_t that denote the information element as counting milliseconds.

fbInfoElementGetUnits() and fbInfoElementUnits_t provide an alternate interface.

◆ FB_UNITS_MICROSECONDS

#define FB_UNITS_MICROSECONDS   0x00070000

The Information Element Units bits within the flags member of an fbInfoElement_t that denote the information element as counting microseconds.

fbInfoElementGetUnits() and fbInfoElementUnits_t provide an alternate interface.

◆ FB_UNITS_NANOSECONDS

#define FB_UNITS_NANOSECONDS   0x00080000

The Information Element Units bits within the flags member of an fbInfoElement_t that denote the information element as counting nanoseconds.

fbInfoElementGetUnits() and fbInfoElementUnits_t provide an alternate interface.

◆ FB_UNITS_WORDS

#define FB_UNITS_WORDS   0x00090000

The Information Element Units bits within the flags member of an fbInfoElement_t that denote the information element as counting 4-octet words.

fbInfoElementGetUnits() and fbInfoElementUnits_t provide an alternate interface.

◆ FB_UNITS_MESSAGES

#define FB_UNITS_MESSAGES   0x000A0000

The Information Element Units bits within the flags member of an fbInfoElement_t that denote the information element as counting messages.

fbInfoElementGetUnits() and fbInfoElementUnits_t provide an alternate interface.

◆ FB_UNITS_HOPS

#define FB_UNITS_HOPS   0x000B0000

The Information Element Units bits within the flags member of an fbInfoElement_t that denote the information element as counting hops.

fbInfoElementGetUnits() and fbInfoElementUnits_t provide an alternate interface.

◆ FB_UNITS_ENTRIES

#define FB_UNITS_ENTRIES   0x000C0000

The Information Element Units bits within the flags member of an fbInfoElement_t that denote the information element as counting entries.

fbInfoElementGetUnits() and fbInfoElementUnits_t provide an alternate interface.

◆ FB_UNITS_FRAMES

#define FB_UNITS_FRAMES   0x000D0000

The Information Element Units bits within the flags member of an fbInfoElement_t that denote the information element as counting frames.

fbInfoElementGetUnits() and fbInfoElementUnits_t provide an alternate interface.

◆ FB_UNITS_PORTS

#define FB_UNITS_PORTS   0x000E0000

The Information Element Units bits within the flags member of an fbInfoElement_t that denote the information element as counting ports.

fbInfoElementGetUnits() and fbInfoElementUnits_t provide an alternate interface.

◆ FB_UNITS_INFERRED

#define FB_UNITS_INFERRED   0x000F0000

The Information Element Units bits within the flags member of an fbInfoElement_t that denote the information element as having units inferred from some other element.

fbInfoElementGetUnits() and fbInfoElementUnits_t provide an alternate interface.

◆ FB_IE_VARLEN

#define FB_IE_VARLEN   65535

Information element length constant for variable-length IE.

◆ FB_IE_PEN_REVERSE

#define FB_IE_PEN_REVERSE   29305

The Reverse Information Element Private Enterprise Number as defined by RFC 5103 section 6.1.

When an information element having the FB_IE_F_REVERSIBLE flag bit set and a zero enterprise number (i.e., an IANA-assigned information element) is added to a model, the reverse IE is generated by setting the enterprise number to this constant.

◆ FB_IE_VENDOR_BIT_REVERSE

#define FB_IE_VENDOR_BIT_REVERSE   0x4000

Reverse information element bit for vendor-specific information elements (see RFC 5103 section 6.2).

If an information element with FB_IE_F_REVERSIBLE and a non-zero enterprise number (i.e., a vendor-specific information element) is added to a model, the reverse IE number will be generated by ORing this bit with the given forward information element number.

◆ FB_IE_REVERSE_STR

#define FB_IE_REVERSE_STR   "reverse"

Reverse information element name prefix.

This string is prepended to an information element name, and the first character after this string is capitalized, when generating a reverse information element.

◆ FB_IE_REVERSE_STRLEN

#define FB_IE_REVERSE_STRLEN   7

Length of reverse information element name prefix.

◆ FB_CISCO_GENERIC

#define FB_CISCO_GENERIC   9999

Generic Information Element ID for undefined Cisco NetFlow v9 Elements.

◆ FB_CISCO_ASA_EVENT_ID

#define FB_CISCO_ASA_EVENT_ID   9998

Information Element ID for Cisco NSEL Element NF_F_FW_EVENT often exported by Cisco's ASA Device.

This must be converted to a different Information Element ID due to the reverse IE bit in IPFIX. Cisco uses IE ID 40005. http://www.cisco.com/en/US/docs/security/asa/asa82/netflow/netflow.html

◆ FB_CISCO_ASA_EVENT_XTRA

#define FB_CISCO_ASA_EVENT_XTRA   9997

Information Element ID for Cisco NSEL Element NF_F_FW_EXT_EVENT often exported by Cisco's ASA Device.

This must be converted to a different Information Element ID due to the reverse IE bit in IPFIX. Cisco uses IE ID 33002 http://www.cisco.com/en/US/docs/security/asa/asa82/netflow/netflow.html More Information about event codes can be found here: http://www.cisco.com/en/US/docs/security/asa/asa84/system/netflow/netflow.pdf

◆ fbInfoElementCheckIdent

#define fbInfoElementCheckIdent (   _ie,
  _enterpriseNumber,
  _elementId 
)     ((_elementId) == (_ie)->num && (_enterpriseNumber) == (_ie)->ent)

Returns TRUE if the private enterprise number and element id of fbInfoElement_t match the given values.

Since
libfixbuf 3.0.0

◆ fbInfoElementGetDescription

#define fbInfoElementGetDescription (   _ie)    ((_ie)->description)

Returns the description of an fbInfoElement_t, a C-string.

Since
libfixbuf 3.0.0

◆ fbInfoElementGetId

#define fbInfoElementGetId (   _ie)    ((_ie)->num)

Returns the element id of an fbInfoElement_t, a uint16_t.

This value does not include the on-wire enterprise bit. That is, the high-order bit is always 0.

Since
libfixbuf 3.0.0

◆ fbInfoElementGetLen

#define fbInfoElementGetLen (   _ie)    ((_ie)->len)

Returns the length of an fbInfoElement_t, a uint16_t.

Since
libfixbuf 3.0.0

◆ fbInfoElementGetMax

#define fbInfoElementGetMax (   _ie)    ((_ie)->max)

Returns the maximum value of an fbInfoElement_t, a uint64_t.

Returns 0 if no range values have been specified for the element.

Since
libfixbuf 3.0.0

◆ fbInfoElementGetMin

#define fbInfoElementGetMin (   _ie)    ((_ie)->min)

Returns the minimum value of an fbInfoElement_t, a uint64_t.

Since
libfixbuf 3.0.0

◆ fbInfoElementGetName

#define fbInfoElementGetName (   _ie)    ((_ie)->name)

Returns the name of an fbInfoElement_t.

Since
libfixbuf 3.0.0

◆ fbInfoElementGetPEN

#define fbInfoElementGetPEN (   _ie)    ((_ie)->ent)

Returns the private enterprise number (PEN) of an fbInfoElement_t, a uint32_t.

Since
libfixbuf 3.0.0

◆ fbInfoElementGetSemantics

#define fbInfoElementGetSemantics (   _ie)    FB_IE_SEMANTIC((_ie)->flags)

Returns the semantics of an fbInfoElement_t, an fbInfoElementSemantics_t.

Since
libfixbuf 3.0.0

◆ fbInfoElementGetType

#define fbInfoElementGetType (   _ie)    ((_ie)->type)

Returns the data type of an fbInfoElement_t, a fbInfoElementDataType_t.

Since
libfixbuf 3.0.0

◆ fbInfoElementGetUnits

#define fbInfoElementGetUnits (   _ie)    FB_IE_UNITS((_ie)->units)

Returns the units of an fbInfoElement_t, an fbInfoElementUnits_t.

Since
libfixbuf 3.0.0

◆ fbInfoElementIsAlien

#define fbInfoElementIsAlien (   _ie)    (!!((_ie)->flags & FB_IE_F_ALIEN))

Returns TRUE if the fbInfoElement_t is unknown and was received via an external template from a collecting process and FALSE if not.

Since
libfixbuf 3.0.0

◆ fbInfoElementIsEndian

#define fbInfoElementIsEndian (   _ie)    (!!((_ie)->flags & FB_IE_F_ENDIAN))

Returns TRUE if the fbInfoElement_t should be endian-converted on transcode and FALSE if not.

Since
libfixbuf 3.0.0

◆ fbInfoElementIsReversible

#define fbInfoElementIsReversible (   _ie)    (!!((_ie)->flags & FB_IE_F_REVERSIBLE))

Returns TRUE if the fbInfoElement_t should be considered reversible and FALSE if not.

Since
libfixbuf 3.0.0

◆ fbInfoElementIsUnsigned

#define fbInfoElementIsUnsigned (   _ie)     ((_ie)->type >= FB_UINT_8 && (_ie)->type <= FB_UINT_64)

Returns TRUE if the fbInfoElement_t is a unsigned integer type and FALSE if not.

The values of fbInfoElementDataType_t that are unsigned integers are FB_UINT_8, FB_UINT_16, FB_UINT_32, and FB_UINT_64.

Since
libfixbuf 3.0.0

◆ fbInfoElementIsSigned

#define fbInfoElementIsSigned (   _ie)     ((_ie)->type >= FB_INT_8 && (_ie)->type <= FB_INT_64)

Returns TRUE if the fbInfoElement_t is a signed integer type and FALSE if not.

The values of fbInfoElementDataType_t that are signed integers are FB_INT_8, FB_INT_16, FB_INT_32, and FB_INT_64.

Since
libfixbuf 3.0.0

◆ fbInfoElementIsInteger

#define fbInfoElementIsInteger (   _ie)     ((_ie)->type >= FB_UINT_8 && (_ie)->type <= FB_INT_64)

Returns TRUE if the fbInfoElement_t is an integer type and FALSE if not.

The values of fbInfoElementDataType_t that are integer types are FB_UINT_8, FB_UINT_16, FB_UINT_32, and FB_UINT_64, FB_INT_8, FB_INT_16, FB_INT_32, and FB_INT_64.

Since
libfixbuf 3.0.0

◆ fbInfoElementIsFloat

#define fbInfoElementIsFloat (   _ie)     ((_ie)->type >= FB_FLOAT_32 && (_ie)->type <= FB_FLOAT_64)

Returns TRUE if the fbInfoElement_t is a floating point type and FALSE if not.

The values of fbInfoElementDataType_t that are floats are FB_FLOAT_32 and FB_FLOAT_64.

Since
libfixbuf 3.0.0

◆ fbInfoElementIsNumber

#define fbInfoElementIsNumber (   _ie)     ((_ie)->type >= FB_UINT_8 && (_ie)->type <= FB_FLOAT_64)

Returns TRUE if the fbInfoElement_t is an unsigned integer type, a signed integer type, or a float type, and FALSE if not.

The values of fbInfoElementDataType_t that are numbers are FB_UINT_8, FB_UINT_16, FB_UINT_32, and FB_UINT_64, FB_INT_8, FB_INT_16, FB_INT_32, FB_INT_64, FB_FLOAT_32, and FB_FLOAT_64.

Since
libfixbuf 3.0.0

◆ fbInfoElementIsIPAddress

#define fbInfoElementIsIPAddress (   _ie)     ((_ie)->type >= FB_IP4_ADDR && (_ie)->type <= FB_IP6_ADDR)

Returns TRUE if the fbInfoElement_t is an IP Address type, and FALSE if not.

The values of fbInfoElementDataType_t that are numbers are FB_IP4_ADDR and FB_IP6_ADDR.

Since
libfixbuf 3.0.0

◆ fbInfoElementIsDatetime

#define fbInfoElementIsDatetime (   _ie)     ((_ie)->type >= FB_DT_SEC && (_ie)->type <= FB_DT_NANOSEC)

Returns TRUE if the fbInfoElement_t is a date-time type, and FALSE if not.

The values of fbInfoElementDataType_t that are date-times are FB_DT_SEC, FB_DT_MILSEC, FB_DT_MICROSEC, and FB_DT_NANOSEC.

Since
libfixbuf 3.0.0

◆ fbInfoElementIsList

#define fbInfoElementIsList (   _ie)     ((_ie)->type >= FB_BASIC_LIST && (_ie)->type <= FB_SUB_TMPL_MULTI_LIST)

Returns TRUE if the type of the fbInfoElement_t is a structured data element (a list) and FALSE if not.

The values of fbInfoElementDataType_t that are structured data are FB_BASIC_LIST, FB_SUB_TMPL_LIST, and FB_SUB_TMPL_MULTI_LIST.

Since
libfixbuf 3.0.0

◆ fbInfoElementIsPadding

#define fbInfoElementIsPadding (   _ie)    (210 == (_ie)->num && 0 == (_ie)->ent)

Returns TRUE if the fbInfoElement_t is paddingOctets (IANA defined element 210) and FALSE if not.

Since
libfixbuf 3.0.0

◆ FB_TEMPLATEFIELD_INIT

#define FB_TEMPLATEFIELD_INIT   {NULL, 0, 0, 0, NULL}

A static initializer for an fbTemplateField_t.

Since
libfixbuf 3.0.0

◆ fbTemplateFieldCheckIdent

#define fbTemplateFieldCheckIdent (   _field,
  _enterpriseNumber,
  _elementId 
)
Value:
((_elementId) == (_field)->canon->num && \
(_enterpriseNumber) == (_field)->canon->ent)

Returns TRUE if the private enterprise number and element id of fbInfoElement_t used by the fbTemplateField_t match the given values.

Since
libfixbuf 3.0.0

◆ fbTemplateFieldGetIE

#define fbTemplateFieldGetIE (   _field)    ((_field)->canon)

Returns the fbInfoElement_t used by an fbTemplateField_t.

Since
libfixbuf 3.0.0

◆ fbTemplateFieldGetId

#define fbTemplateFieldGetId (   _field)    ((_field)->canon->num)

Returns the element ID of the fbInfoElement_t used by an fbTemplateField_t, a uint16_t.

Since
libfixbuf 3.0.0

◆ fbTemplateFieldGetLen

#define fbTemplateFieldGetLen (   _field)    ((_field)->len)

Returns the octet length of an fbTemplateField_t, a uint16_t, as specified when the fbTemplate_t was created.

That is, this is the length specified by the fbInfoElementSpec_t or fbInfoElementSpecId_t for Templates created by the user, or the length read from a Collector.

Since
libfixbuf 3.0.0

◆ fbTemplateFieldGetMemsize

#define fbTemplateFieldGetMemsize (   _field)
Value:
((FB_IE_VARLEN != (_field)->len) \
? (_field)->len \
: ((FB_BASIC_LIST == (_field)->canon->type) \
? sizeof(fbBasicList_t) \
: ((FB_SUB_TMPL_LIST == (_field)->canon->type) \
? sizeof(fbSubTemplateList_t) \
: ((FB_SUB_TMPL_MULTI_LIST == (_field)->canon->type) \
: sizeof(fbVarfield_t)))))

Returns the octet length in memory of an fbTemplate_t, a unit16_t.

For fixed length elements, this is same as fbTemplateFieldGetLen(). For variable-fixed fields, this is the size of the data structure used by libfixbuf to represent the element.

Since
libfixbuf 3.0.0

◆ fbTemplateFieldGetName

#define fbTemplateFieldGetName (   _field)    ((_field)->canon->name)

Returns the name of the fbInfoElement_t used by an fbTemplateField_t, a const char *.

Since
libfixbuf 3.0.0

◆ fbTemplateFieldGetOffset

#define fbTemplateFieldGetOffset (   _field)    ((_field)->offset)

Returns the offset of the fbTemplateField_t from the start of an (in meory) record, a uint16_t.

This is the offset of this field in an array of uint8_t's representing a data record.

Since
libfixbuf 3.0.0

◆ fbTemplateFieldGetPEN

#define fbTemplateFieldGetPEN (   _field)    ((_field)->canon->ent)

Returns the private enterprise number (PEN) of the fbInfoElement_t used by an fbTemplateField_t, a uint32_t.

Since
libfixbuf 3.0.0

◆ fbTemplateFieldGetType

#define fbTemplateFieldGetType (   _field)    ((_field)->canon->type)

Returns the data type of the fbInfoElement_t used by an fbTemplateField_t, a fbInfoElementDataType_t.

Since
libfixbuf 3.0.0

◆ fbTemplateFieldGetRepeat

#define fbTemplateFieldGetRepeat (   _field)    ((_field)->midx)

Returns the repeat index for the fbInfoElement_t used by this fbTemplateField_t in the containing fbTemplate_t.

When an InfoElement is repeated within a Template, the repeat index, also called the multi-use index, is used to distinguish them. The InfoElement with the lowest offset has repeat index 0, the next lowest has index 1, et cetera.

The value can also be considered as the number of times this TemplateField's InfoElement is used in the Template prior to this occurrence.

Since
libfixbuf 3.0.0

◆ FB_TEMPLATE_ITER_NULL

#define FB_TEMPLATE_ITER_NULL   {NULL, UINT16_MAX}

A static initializer for an fbTemplateIter_t.

Since
libfixbuf 3.0.0

◆ FB_RECORD_INIT

#define FB_RECORD_INIT   {NULL, NULL, 0, 0, 0}

A static initializer for an fbRecord_t.

Since
libfixbuf 3.0.0

◆ FB_RECORD_VALUE_INIT

#define FB_RECORD_VALUE_INIT    { NULL, NULL, { {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0} } }

A static initializer for an fbRecordValue_t.

Since
libfixbuf 3.0.0

◆ FB_TID_AUTO

#define FB_TID_AUTO   0

Template ID argument used when adding an fbTemplate_t to an fbSession_t that automatically assigns a template ID.

Functions that accept this value include fbSessionAddTemplate(), fbSessionAddTemplatesMulticast(), and others.

For internal templates, FB_TID_AUTO starts from 65535 and decrements. For external templates, FB_TID_AUTO starts from 256 and increments. This is to avoid inadvertant unrelated external and internal templates having the same ID.

◆ FB_TID_TS

#define FB_TID_TS   2

Reserved set ID for template sets, per RFC 7011.

◆ FB_TID_OTS

#define FB_TID_OTS   3

Reserved set ID for options template sets, per RFC 7011.

◆ FB_TID_MIN_DATA

#define FB_TID_MIN_DATA   256

Minimum non-reserved template ID available for data sets, per RFC 7011.

◆ FB_IESPEC_NULL

#define FB_IESPEC_NULL   { NULL, 0, 0 }

Convenience macro defining a null information element specification initializer (fbInfoElementSpec_t) to terminate a constant information element specifier array for passing to fbTemplateAppendSpecArray().

◆ FB_IESPECID_NULL

#define FB_IESPECID_NULL   { {0, 0}, 0, 0 }

Convenience macro defining a null information element specification initializer (fbInfoElementSpecId_t) to terminate a constant information element specifier array for passing to fbTemplateAppendArraySpecId().

Since
libfixbuf 3.0.0

◆ FB_TMPL_MD_LEVEL_0

#define FB_TMPL_MD_LEVEL_0   0

Value to use for the parentTid parameter of fbTemplateInfoInit() to indicate the template is not used as a sub-record (that is, that it is not used in a subTemplateList or subTemplateMultiList).

Since
libfixbuf 3.0.0

◆ FB_TMPL_MD_LEVEL_1

#define FB_TMPL_MD_LEVEL_1   1

Value to use for the parentTid parameter of fbTemplateInfoInit() to indicate the template is used as a first level sub-record.

Since
libfixbuf 3.0.0

◆ FB_TMPL_MD_LEVEL_NA

#define FB_TMPL_MD_LEVEL_NA   0xFF

Value set by an fbCollector_t to denote that the version of the received TemplateInfo does not include parent template ID.

Since
libfixbuf 3.0.0

◆ FB_CONNSPEC_INIT

#define FB_CONNSPEC_INIT    { FB_SCTP, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL }

Convenience macro defining a null static fbConnSpec_t.

◆ fbBLNext

#define fbBLNext (   type,
  basicList,
  current 
)     ((type *)(fbBasicListGetNextPtr((basicList), (current))))

Retrieves the next item from an fbBasicList_t.

Returns a pointer to the element in basicList that follows current and casts it to a pointer to type. If current is NULL, gets the first item. Returns NULL when there are no more items.

Since
libfixbuf 3.0.0

◆ fbSTLNext

#define fbSTLNext (   type,
  subTemplateList,
  current 
)     ((type *)(fbSubTemplateListGetNextPtr((subTemplateList), (current))))

Retrieves the next record from an fbSubTemplateList_t.

Returns a pointer to the record in subTemplateList that follows current and casts it to a pointer to type. If current is NULL, gets the first record. Returns NULL when there are no more records.

Since
libfixbuf 3.0.0

◆ fbSTMLNext

#define fbSTMLNext (   subTemplateMultiList,
  current 
)     fbSubTemplateMultiListGetNextEntry((subTemplateMultiList), (current))

Retrieves the next fbSubTemplateMultiListEntry_t from an fbSubTemplateMultiList_t.

Returns a pointer to the entry in subTemplateMultiList that follows current. If current is NULL, gets the first entry. Returns NULL when there are no more entries.

Since
libfixbuf 3.0.0

◆ fbSTMLEntryNext

#define fbSTMLEntryNext (   type,
  subTemplateMultiListEntry,
  current 
)
Value:
(subTemplateMultiListEntry), (current))))

Retrieves the next record from an fbSubTemplateMultiListEntry_t.

Returns a pointer to the record in subTemplateMultiListEntry that follows current and casts it to a pointer to type. If current is NULL, gets the first record. Returns NULL when there are no more records.

Since
libfixbuf 3.0.0

◆ FB_TMPL_IS_OPTIONS

#define FB_TMPL_IS_OPTIONS   (1u << 0)

A tests flag for fbTemplateIsMetadata() to check whether the fbTemplate_t is an options template.

Since
libfixbuf 3.0.0

◆ FB_TMPL_IS_META_ELEMENT

#define FB_TMPL_IS_META_ELEMENT   (1u << 1)

A tests flag for fbTemplateIsMetadata() to check whether the fbTemplate_t is for describing Information Elements (RFC 5610) (element metadata, fbInfoElementOptRec_t).

Since
libfixbuf 3.0.0

◆ FB_TMPL_IS_META_TEMPLATE_V1

#define FB_TMPL_IS_META_TEMPLATE_V1   (1u << 2)

A tests flag for fbTemplateIsMetadata() to check whether the fbTemplate_t is for describing a Template as defined by libfixbuf 1.8.0.

Templates matching this may also match FB_TMPL_IS_META_TEMPLATE_V3.

Since
libfixbuf 3.0.0

◆ FB_TMPL_IS_META_TEMPLATE_V3

#define FB_TMPL_IS_META_TEMPLATE_V3   (1u << 3)

A tests flag for fbTemplateIsMetadata() to check whether the fbTemplate_t is for describing a Template as defined by libfixbuf 3.0.0 (fbTemplateInfo_t).

Since
libfixbuf 3.0.0

◆ FB_TMPL_IS_META_BASICLIST

#define FB_TMPL_IS_META_BASICLIST   (1u << 4)

A tests flag for fbTemplateIsMetadata() to check whether the fbTemplate_t is for describing the relationship between a BasicList and its contents (fbBasicListInfo_t).

Since
libfixbuf 3.0.0

◆ FB_TMPL_IS_META_TMPL_ANY

#define FB_TMPL_IS_META_TMPL_ANY
Value:
FB_TMPL_IS_META_TEMPLATE_V1 | \
FB_TMPL_IS_META_BASICLIST)

A tests flag for fbTemplateIsMetadata() to check whether the fbTemplate_t is related to template metadata (fbTemplateInfo_t or fbBasicListInfo_t).

Since
libfixbuf 3.0.0

◆ FB_TMPL_IS_META_ANY

#define FB_TMPL_IS_META_ANY
Value:
FB_TMPL_IS_META_TMPL_ANY | \
FB_TMPL_IS_META_ELEMENT)

A tests flag for fbTemplateIsMetadata() to check whether the fbTemplate_t is related to template metadata or element metadata.

Since
libfixbuf 3.0.0

◆ FB_TMPL_COPY_REMOVE_PADDING

#define FB_TMPL_COPY_REMOVE_PADDING   0x01u

Causes fbTemplatesCopy() to ignore paddingOctets elements while copying the template.

The resulting template will contain no paddingOctets elements.

Since
libfixbuf 3.0.0

◆ FB_TMPL_COPY_IGNORE_SCOPE

#define FB_TMPL_COPY_IGNORE_SCOPE   0x04u

Prevents fbTemplatesCopy() from setting the options scope of the new template.

This can be used to create a template with a different scope count, since a template's scope may not be modified once set.

Since
libfixbuf 3.0.0

◆ FB_TMPL_CMP_IGNORE_PADDING

#define FB_TMPL_CMP_IGNORE_PADDING   0x01u

Causes fbTemplatesCompare() and fbTemplateSetCompare() to ignore paddingOctets elements when comparing templates.

Since
libfixbuf 3.0.0

◆ FB_TMPL_CMP_IGNORE_LENGTHS

#define FB_TMPL_CMP_IGNORE_LENGTHS   0x02u

Causes fbTemplatesCompare() and fbTemplateSetCompare() to ignore the lengths of the elements when comparing templates.

Since
libfixbuf 3.0.0

◆ FB_TMPL_CMP_IGNORE_SCOPE

#define FB_TMPL_CMP_IGNORE_SCOPE   0x04u

Causes fbTemplatesCompare() to ignore the options scope count when comparing templates.

Since
libfixbuf 3.0.0

Enumeration Type Documentation

◆ fbInfoElementSemantics_en

fbInfoElementSemantics_t defines the possible semantics of an fbInfoElement_t.

See RFC 5610

See also
fbInfoElementGetSemantics()

https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-information-element-semantics

Since
libfixbuf 3.0.0
Enumerator
FB_IE_SEM_DEFAULT 

Describes an information element as having no specific semantics.

FB_IE_SEM_QUANTITY 

Describes an information element as a quantity.

FB_IE_SEM_TOTALCOUNTER 

Describes an information element as a totalCounter.

FB_IE_SEM_DELTACOUNTER 

Describes an information element as a deltaCounter.

FB_IE_SEM_IDENTIFIER 

Describes an information element as an identifier.

FB_IE_SEM_FLAGS 

Describes an information element as a flags element.

FB_IE_SEM_LIST 

Describes an information element as a list element.

FB_IE_SEM_SNMPCOUNTER 

Describes an information element as an SNMP counter.

FB_IE_SEM_SNMPGAUGE 

Describes an information element as a SNMP gauge.

◆ fbInfoElementUnits_en

fbInfoElementUnits_t defines the possible units on an fbInfoElement_t.

See RFC 5610

See also
fbInfoElementGetUnits()

https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-information-element-units

Since
libfixbuf 3.0.0
Enumerator
FB_IE_UNITS_NONE 

Describes an information element as having no units.

FB_IE_UNITS_BITS 

Describes an information element as counting bits.

FB_IE_UNITS_OCTETS 

Describes an information element as counting octets.

FB_IE_UNITS_PACKETS 

Describes an information element as counting packets.

FB_IE_UNITS_FLOWS 

Describes an information element as counting flows.

FB_IE_UNITS_SECONDS 

Describes an information element as counting seconds.

FB_IE_UNITS_MILLISECONDS 

Describes an information element as counting milliseconds.

FB_IE_UNITS_MICROSECONDS 

Describes an information element as counting microseconds.

FB_IE_UNITS_NANOSECONDS 

Describes an information element as counting nanoseconds.

FB_IE_UNITS_WORDS 

Describes an information element as counting 4-octet words, as for IPv4-header length.

FB_IE_UNITS_MESSAGES 

Describes an information element as counting messages.

FB_IE_UNITS_HOPS 

Describes an information element as counting hops, as for TTL.

FB_IE_UNITS_ENTRIES 

Describes an information element as counting entries, as for MPLS label stack.

FB_IE_UNITS_FRAMES 

Describes an information element as counting frames, as for Layer 2 frames.

FB_IE_UNITS_PORTS 

Describes an information element as counting ports.

FB_IE_UNITS_INFERRED 

Describes an information element as having units inferred from some other element.

For example, the units of absoluteError (IANA 320) are inferred from the element that it is the absoluteError of.

◆ fbInfoElementDataType_en

From RFC 5610: A description of the abstract data type of an IPFIX information element as registered in the IANA IPFIX IE Data Type subregistry.

See also
fbInfoElementGetType(), fbTemplateFieldGetType() https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-information-element-data-types
Enumerator
FB_OCTET_ARRAY 

The "octetArray" data type: A finite-length string of octets.

FB_UINT_8 

The "unsigned8" data type: A non-negative integer value in the range of 0 to 255 (0xFF).

FB_UINT_16 

The "unsigned16" data type: A non-negative integer value in the range of 0 to 65535 (0xFFFF).

FB_UINT_32 

The "unsigned32" data type: A non-negative integer value in the range of 0 to 4_294_967_295 (0xFFFFFFFF).

FB_UINT_64 

The "unsigned64" data type: A non-negative integer value in the range of 0 to 18_446_744_073_709_551_615 (0xFFFFFFFFFFFFFFFF).

FB_INT_8 

The "signed8" data type: An integer value in the range of -128 to 127.

FB_INT_16 

The "signed16" data type: An integer value in the range of -32768 to 32767.

FB_INT_32 

The "signed32" data type: An integer value in the range of -2_147_483_648 to 2_147_483_647.

FB_INT_64 

The "signed64" data type: An integer value in the range of -9_223_372_036_854_775_808 to 9_223_372_036_854_775_807.

FB_FLOAT_32 

The "float32" data type: An IEEE single-precision 32-bit floating point type.

FB_FLOAT_64 

The "float64" data type: An IEEE double-precision 64-bit floating point type.

FB_BOOL 

The "boolean" data type: A binary value: "true" or "false".

FB_MAC_ADDR 

The "macAddress" data type: A MAC-48 address as a string of 6 octets.

FB_STRING 

The "string" data type: A finite-length string of valid characters from the Unicode character encoding set.

FB_DT_SEC 

The "dateTimeSeconds" data type: An unsigned 32-bit integer containing the number of seconds since the UNIX epoch, 1970-Jan-01 00:00 UTC.


FB_DT_MILSEC 

The "dateTimeMilliseconds" data type: An unsigned 64-bit integer containing the number of milliseconds since the UNIX epoch, 1970-Jan-01 00:00 UTC.


FB_DT_MICROSEC 

The "dateTimeMicroseconds" data type: Two 32-bit fields where the first is the number seconds since the NTP epoch, 1900-Jan-01 00:00 UTC, and the second is the number of 1/(2^32) fractional seconds.

FB_DT_NANOSEC 

The "dateTimeMicroseconds" data type: Two 32-bit fields where the first is the number seconds since the NTP epoch, 1900-Jan-01 00:00 UTC, and the second is the number of 1/(2^32) fractional seconds.

FB_IP4_ADDR 

The "ipv4Address" data type: A value of an IPv4 address.

FB_IP6_ADDR 

The "ipv6Address" data type: A value of an IPv6 address.

FB_BASIC_LIST 

The "basicList" data type: A structured data element as described in RFC6313, Section 4.5.1.

FB_SUB_TMPL_LIST 

The "subTemplateList" data type: A structured data element as described in RFC6313, Section 4.5.2.

FB_SUB_TMPL_MULTI_LIST 

The "subTemplateMultiList" data type: A structured data element as described in RFC6313, Section 4.5.3.

◆ fbTransport_en

Transport protocol for connection specifier.

Enumerator
FB_SCTP 

Partially reliable datagram transport via SCTP.

Only available if fixbuf was built with SCTP support.

FB_TCP 

Reliable stream transport via TCP.

FB_UDP 

Unreliable datagram transport via UDP.

FB_DTLS_SCTP 

Secure, partially reliable datagram transport via DTLS over SCTP.

Only available if fixbuf was built with OpenSSL support. Requires an OpenSSL implementation of DLTS over SCTP, not yet available.

FB_TLS_TCP 

Secure, reliable stream transport via TLS over TCP.

Only available if fixbuf was built with OpenSSL support.

FB_DTLS_UDP 

Secure, unreliable datagram transport via DTLS over UDP.

Only available if fixbuf was built with OpenSSL support. Requires OpenSSL 0.9.8 or later with DTLS support.

◆ fbListSemantics_en

fbListSemantics_t defines the possible values for the semantics of the structured Data Types: basicLists, subTemplateLists, and subTemplateMultiLists.

See RFC 6313.

https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-structured-data-types-semantics

Since
libfixbuf 3.0.0
See also
fbBasicListGetSemantic(), fbSubTemplateListGetSemantic(), fbSubTemplateMultiListGetSemantic()
Enumerator
FB_LIST_SEM_UNDEFINED 

Semantic field for indicating the value has not been set.

FB_LIST_SEM_NONE_OF 

Semantic field for none-of value defined in RFC 6313.

FB_LIST_SEM_EXACTLY_ONE_OF 

Semantic field for exactly-one-of value defined in RFC 6313.

FB_LIST_SEM_ONE_OR_MORE_OF 

Semantic field for the one-or-more-of value defined in RFC 6313.

FB_LIST_SEM_ALL_OF 

Semantic field for the all-of value defined in RFC 6313.

FB_LIST_SEM_ORDERED 

Semantic field for the ordered value defined in RFC 6313.

◆ fbTemplateSetCompareStatus_en

Defines the values returned by fbTemplatesSetCompare() when checking whether one fbTemplate_t is a subset of another.

Since
libfixbuf 3.0.0
Enumerator
FB_TMPL_SETCMP_SUBSET 

Indicates the first template is a strict subset of the second.

FB_TMPL_SETCMP_EQUAL 

Indicates the two templates contain the same elements.

FB_TMPL_SETCMP_SUPERSET 

Indicates the first template is a strict superset of the second.

FB_TMPL_SETCMP_COMMON 

Indicates the templates contain common elements but each has elements that the other does not.

FB_TMPL_SETCMP_DISJOINT 

Indicates the templates contain no common elements.

Function Documentation

◆ fbTemplateIterInit()

void fbTemplateIterInit ( fbTemplateIter_t iter,
const fbTemplate_t tmpl 
)

Initializes a TemplateIter to visit the fbTemplateField_t objects in a Template.

The TemplateFields are visited in the order they appear. Use fbTemplateIterNext() to visit each TemplateField.

Parameters
iterThe TemplateIter to initialize
tmplThe Template to be iterated over
Since
libfixbuf 3.0.0

◆ fbTemplateIterGetField()

const fbTemplateField_t* fbTemplateIterGetField ( const fbTemplateIter_t iter)

Returns the same TemplateField returned by the most recent call to fbTemplateIterNext().

Does not advance the iterator. Returns NULL if fbTemplateIterNext() has not been called or if the iterator has visited all TemplateFields. Assumes fbTemplateIterInit() has been called on iter.

Parameters
iterA TemplateIter
Returns
The same TemplateField returned by the most recent call to fbTemplateIterNext().
Since
libfixbuf 3.0.0

◆ fbTemplateIterGetPosition()

uint16_t fbTemplateIterGetPosition ( const fbTemplateIter_t iter)

Returns the position of the fbTemplateField_t returned by the most recent call to fbTemplateIterNext().

Does not advance the iterator. Returns fbTemplateCountElements() if the iterator is exhausted. Returns UINT16_MAX if fbTemplateIterNext() has not been called.

Parameters
iterA TemplateIter
Returns
The position of the iterator.
Since
libfixbuf 3.0.0

◆ fbTemplateIterGetTemplate()

const fbTemplate_t* fbTemplateIterGetTemplate ( const fbTemplateIter_t iter)

Returns the Template to which the TemplateIter is bound.

Parameters
iterA TemplateIter
Since
libfixbuf 3.0.0

◆ fbTemplateIterNext()

const fbTemplateField_t* fbTemplateIterNext ( fbTemplateIter_t iter)

Returns the next TemplateField in the fbTemplate_t.

Returns the first TemplateField if this is the first call to fbTemplateIterNext() after calling fbTemplateIterInit(). Returns NULL if the iterator is exhausted. Assumes fbTemplateIterInit() has been called on iter.

To get this same TemplateField, you may call fbTemplateIterGetField().

Parameters
iterA TemplateIter
Returns
The next TemplateField in the iterator.
Since
libfixbuf 3.0.0

◆ fbTemplateInfoAlloc()

fbTemplateInfo_t* fbTemplateInfoAlloc ( void  )

Allocates and returns an empty template metadata information structure.

Exits the application on allocation failure.

Returns
A newly allocated TemplateInfo.
Since
libfixbuf 3.0.0

◆ fbTemplateInfoFree()

void fbTemplateInfoFree ( fbTemplateInfo_t tmplInfo)

Frees a template metadata structure.

Parameters
tmplInfoThe object to be freed.
Since
libfixbuf 3.0.0

◆ fbTemplateInfoCopy()

fbTemplateInfo_t* fbTemplateInfoCopy ( const fbTemplateInfo_t tmplInfo)

Makes a copy of TemplateInfo.

A TemplateInfo is tied to a fbTemplate_t in a specific fbSession_t. To use it in another Session it should be copied.

Parameters
tmplInfoThe object to be copied.
Since
libfixbuf 3.0.0

◆ fbTemplateInfoInit()

gboolean fbTemplateInfoInit ( fbTemplateInfo_t tmplInfo,
const char *  name,
const char *  description,
uint16_t  appLabel,
uint16_t  parentTid 
)

Initializes a template metadata structure.

Parameters
tmplInfothe object to initialize
namethe name of the template, required
descriptiona description of the template
appLabelthe silkAppLabel value this template is associate with
parentTidthe parent template id. use FB_TMPL_MD_LEVEL_0 if this is top-level and FB_TMPL_MD_LEVEL_1 if this is used immediately below top-level.
Returns
TRUE unless name is NULL, then FALSE
Since
libfixbuf 3.0.0

◆ fbTemplateInfoAddBasicList()

void fbTemplateInfoAddBasicList ( fbTemplateInfo_t tmplInfo,
uint32_t  blEnt,
uint16_t  blNum,
uint32_t  contentEnt,
uint16_t  contentNum 
)

Adds a description for an fbBasicList_t that is used by the fbTemplate_t described by tmplInfo.

Parameters
tmplInfothe template info to modify
blEntthe enterprise number of the fbInfoElement_t of the the list itself
blNumthe element number of the fbInfoElement_t of the list itself
contentEntthe enterprise number of the fbInfoElement_t for the contents of the list
contentNumthe element number of the fbInfoElement_t for the contents of the list
Since
libfixbuf 3.0.0

◆ fbTemplateInfoGetApplabel()

uint16_t fbTemplateInfoGetApplabel ( const fbTemplateInfo_t tmplInfo)

Returns the applabel value specified in fbTemplateInfoInit().

Since
libfixbuf 3.0.0

◆ fbTemplateInfoGetParentTid()

uint16_t fbTemplateInfoGetParentTid ( const fbTemplateInfo_t tmplInfo)

Returns the parentTid value specified in fbTemplateInfoInit().

Since
libfixbuf 3.0.0

◆ fbTemplateInfoGetName()

const char* fbTemplateInfoGetName ( const fbTemplateInfo_t tmplInfo)

Returns the name value specified in fbTemplateInfoInit().

Since
libfixbuf 3.0.0

◆ fbTemplateInfoGetDescription()

const char* fbTemplateInfoGetDescription ( const fbTemplateInfo_t tmplInfo)

Returns the description value specified in fbTemplateInfoInit().

Since
libfixbuf 3.0.0

◆ fbTemplateInfoGetTemplateId()

uint16_t fbTemplateInfoGetTemplateId ( const fbTemplateInfo_t tmplInfo)

Returns the Template ID value associated with this TemplateInfo.

Since
libfixbuf 3.0.0

◆ fbTemplateInfoGetNextBasicList()

const fbBasicListInfo_t* fbTemplateInfoGetNextBasicList ( const fbTemplateInfo_t tmplInfo,
const fbBasicListInfo_t blInfo 
)

Returns a description of the next fbBasicList_t that is used by the fbTemplate_t described by tmplInfo.

Returns NULL when there are no more BasicListInfos. When blInfo is NULL, returns the the first BasicListInfo.

Use fbTemplateInfoAddBasicList() to add descriptions of BasicLists to an fbTemplateInfo_t.

Parameters
tmplInfothe template info to be queried
blInfothe value returned on the previous call to this function or NULL for the initial call
Returns
The information for the next basicList, or NULL when no more data.
Since
libfixbuf 3.0.0

◆ fbBasicListInfoGetListIdent()

uint16_t fbBasicListInfoGetListIdent ( const fbBasicListInfo_t blInfo,
uint32_t *  pen 
)

Gets from blInfo the element numbers for the fbInfoElement_t used by the BasicList element itself.

That is, this is the element that a fbTemplate_t which uses this BasicList would contain. Returns the element number and sets the referent of pen to the enterprise number when pen is not NULL.

Parameters
blInfothe BasicListInfo to be queried
penan output parameter filled with the enterprise number if non-NULL
Returns
The element number used by the BasicList itself.
Since
libfixbuf 3.0.0
See also
fbBasicListInfoGetContentIdent() to get information about the element that the BasicList contains.

fbTemplateInfoGetNextBasicList() to get a handle to a BasicListInfo.

◆ fbBasicListInfoGetContentIdent()

uint16_t fbBasicListInfoGetContentIdent ( const fbBasicListInfo_t blInfo,
uint32_t *  pen 
)

Gets from blInfo the element numbers for the fbInfoElement_t that the BasicList contains.

These are the values that would be returned by fbBasicListGetElementIdent(). Returns the element number and sets the referent of pen to the enterprise number when pen is not NULL.

Parameters
blInfothe BasicListInfo to be queried
penan output parameter filled with the enterprise number if non-NULL
Returns
The element number of the InfoElement the BasicList contains.
Since
libfixbuf 3.0.0
See also
fbBasicListInfoGetListIdent() to get information about the element used by a fbTemplate_t that uses this BasicList. fbTemplateInfoGetNextBasicList() to get a handle to a BasicListInfo.

◆ fbSessionGetTemplateInfo()

const fbTemplateInfo_t* fbSessionGetTemplateInfo ( const fbSession_t session,
uint16_t  tid 
)

Returns the metadata for template whose ID is tid in the current domain or NULL if no metadata is available.

Parameters
sessionA session to be queried
tidThe template ID to search for
Returns
The template information if found or NULL otherwise.
Since
libfixbuf 3.0.0

◆ fbSessionGetTemplatePath()

uint16_t fbSessionGetTemplatePath ( const fbSession_t session,
const fbTemplateInfo_t tmplInfo,
uint16_t  path[],
uint16_t  path_size,
GError **  err 
)

Finds the template path of the fbTemplate_t described by tmplInfo.

FIXME: Should the caller supply tmplInfo or TID? If tmplInfo, should we confirm that tmplInfo exists in this session?

The function fills the array path with the Template IDs starting at tmplInfo (at position 0), its parent at position 1, and continuing to the top-level template at position "count-1". The function returns the value of count. The caller must supply the number of IDs path can hold in the path_size parameter.

To get the count of the Template described by tmplInfo without getting the template IDs, pass NULL to path and 0 to path_size.

If tmplInfo is for a top-level template, the path[0] is that ID and the return value is 1.

For a first-level template, its ID is in path[0], 0 is in path[1] (meaning any top-level template), and the return value is 2.

If 'path' is not-null and the depth is larger than path_size, the function sets the err value and returns 0.

If the metadata for a template ID in the path is not known to the session, the function sets an error and returns 0.

If tmplInfo does not contain information other then template ID, name, and description, path[0] is FB_TMPL_MD_LEVEL_NA and the return value is 1.

Parameters
sessionThe Session in which to find the template path
tmplInfoThe metadata to start from when finding the path.
pathAn array to be filled in with the template IDs or NULL
path_sizeThe number of values path is capable of holding
errAn error description, set on failure
Returns
The number of templates IDs added to path or 0 on error
Since
libfixbuf 3.0.0

◆ fbListSemanticsIsValid()

gboolean fbListSemanticsIsValid ( uint8_t  semantic)

Validates the value of a structured data types semantic field, as defined in RFC 6313 and listed at IANA.

Parameters
semanticThe value of the semantic field to be checked
Returns
TRUE if valid (0xFF, 0x00-0x04), FALSE otherwise
Since
libfixbuf 3.0.0; previously called fbListValidSemantic().

◆ fbBasicListAlloc()

fbBasicList_t* fbBasicListAlloc ( void  )

Allocates and returns an empty BasicList.

Exits the application on allocation failure.

Returns
A newly allocated BasicList.

◆ fbBasicListInit()

void* fbBasicListInit ( fbBasicList_t basicList,
uint8_t  semantic,
const fbInfoElement_t infoElement,
uint16_t  numElements 
)

Initializes a BasicList for export.

This function calls fbBasicListInitWithLength() using the default length of infoElement as the value for the elementLength parameter. See that function for more information.

Parameters
basicLista pointer to the basic list structure to fill
semanticthe semantic value to be used in the basic list
infoElementa pointer to the info element to be used in the list
numElementsnumber of elements in the list
Returns
a pointer to the memory where the list data is to be written

◆ fbBasicListInitWithLength()

void* fbBasicListInitWithLength ( fbBasicList_t basicList,
uint8_t  semantic,
const fbInfoElement_t infoElement,
uint16_t  elementLength,
uint16_t  numElements 
)

Initializes a BasicList for export using a user-specified element length.

Sets the semantic of the list, sets the type of element stored by the list, and allocates a data buffer large enough to hold numElements elements, each of size elementLength. Returns a pointer to the data buffer, or returns NULL if infoElement does not support elements of length elementLength.

The function fbBasicListInit() is a convenience function to initalize a BasicList using the default length of infoElement.

If basicList has been used previously, it must be cleared with fbBasicListClear() prior to invoking this function.

Parameters
basicLista pointer to the basic list structure to fill
semanticthe semantic value to be used in the basic list
infoElementa pointer to the info element to be used in the list
elementLengththe length for each element in the list
numElementsnumber of elements in the list
Returns
a pointer to the memory where the list data is to be written
See also
Use fbBasicListCollectorInit() when using a fbCollector_t.

◆ fbBasicListCollectorInit()

void fbBasicListCollectorInit ( fbBasicList_t basicList)

Initializes a BasicList for collection, setting all properties of the list to 0 or NULL.

If basicList has been used previously, it must be cleared with fbBasicListClear() and calling this function is not necessary.

Parameters
basicListpointer to the basic list to be initialized

◆ fbBasicListGetElementLength()

uint16_t fbBasicListGetElementLength ( const fbBasicList_t basicList)

Returns the octet length of an individual element in the BasicList.

That is, returns the value specified when the list was initialized for export (fbBasicListInitWithLength()) or read from the fbCollector_t.

Parameters
basicListpointer to the basic list
Returns
the size of one element
Since
libfixbuf 3.0.0

◆ fbBasicListCountElements()

uint16_t fbBasicListCountElements ( const fbBasicList_t basicList)

Returns the number of elements the basic list is capable of holding.

That is, returns the value specified when the list was initialized for export (fbBasicListInitWithLength()), expanded (fbBasicListAddNewElements()), or read from the fbCollector_t.

Parameters
basicListpointer to the basic list
Returns
the number of elements on the basic list
Since
libfixbuf 2.3.0

◆ fbBasicListGetSemantic()

uint8_t fbBasicListGetSemantic ( const fbBasicList_t basicList)

Returns the list semantics value (fbListSemantics_t) for a BasicList.

Parameters
basicListpointer to the basic list to retrieve the semantic from
Returns
the 8-bit semantic value describing the basic list

◆ fbBasicListSetSemantic()

void fbBasicListSetSemantic ( fbBasicList_t basicList,
uint8_t  semantic 
)

Sets the list semantics value (fbListSemantics_t) for describing a basic list.

Parameters
basicListpointer to the basic list to set the semantic
semanticvalue to set the semantic field to

◆ fbBasicListGetInfoElement()

const fbInfoElement_t* fbBasicListGetInfoElement ( const fbBasicList_t basicList)

Returns a pointer to the information element used in the basic list.

It is mainly used in an fbCollector_t to retrieve information.

Parameters
basicListpointer to the basic list to get the infoElement from
Returns
pointer to the information element from the list

◆ fbBasicListGetElementIdent()

uint16_t fbBasicListGetElementIdent ( const fbBasicList_t basicList,
uint32_t *  pen 
)

Gets the element ID and enterprise number for the fbInfoElement_t used by a BasicList.

Returns the element ID and sets the referent of pen to the enterprise number when pen is not NULL.

Parameters
basicListBasicList from which to get the information
penAn output parameter used to get the enterprise number
Returns
The element ID
Since
libfixbuf 3.0.0

◆ fbBasicListGetTemplateField()

const fbTemplateField_t* fbBasicListGetTemplateField ( const fbBasicList_t basicList)

Returns a simulated TemplateField that describes the data within a basicList.

The TemplateField is not associated with an fbRecord_t, and it must not be used for fbRecordGetValueForField() or similar functions.

Parameters
basicListBasicList from which to get the information
Returns
A TemplateField describing the contents of basicList
Since
libfixbuf 3.0.0

◆ fbBasicListGetDataPtr()

void* fbBasicListGetDataPtr ( const fbBasicList_t basicList)

Gets a pointer to the data buffer for the basic list.

Parameters
basicListpointer to the basic list to get the data pointer from
Returns
the pointer to the data held by the basic list

◆ fbBasicListGetIndexedDataPtr()

void* fbBasicListGetIndexedDataPtr ( const fbBasicList_t basicList,
uint16_t  index 
)

Retrieves the element at position index in the basic list or returns NULL if index is out of range.

The first element is at index 0, and the last at fbBasicListCountElements()-1.

Parameters
basicListpointer to the basic list to retrieve the dataPtr
indexthe index of the element to retrieve (0-based)
Returns
a pointer to the data in the index'th slot in the list, or NULL if the index is outside the bounds of the list
See also
fbBasicListGetIndexedRecordValue()

◆ fbBasicListGetIndexedRecordValue()

gboolean fbBasicListGetIndexedRecordValue ( const fbBasicList_t basicList,
uint16_t  index,
fbRecordValue_t value 
)

Fills a RecordValue from the data for the indexth element in basicList.

Returns FALSE if index is invalid; the valid range for index is 0 to fbBasicListCountElements()-1 inclusive.

Parameters
basicListThe basicList to get the value from.
indexWhich item to get the value of; 0 is first.
valueAn output parameter to fill with the value.
Returns
TRUE unless basicList is NULL or index is out of range.
Since
libfixbuf 3.0.0
See also
fbBasicListGetIndexedDataPtr()

◆ fbBasicListGetNextPtr()

void* fbBasicListGetNextPtr ( const fbBasicList_t basicList,
const void *  currentPtr 
)

Retrieves a pointer to the data element in the basicList that follows the one at currentPtr.

Retrieves the first element if currentPtr is NULL. Returns NULL when there are no more elements or when currentPtr is outside the buffer used by the basic list.

Parameters
basicListpointer to the basic list
currentPtrpointer to the current element being used. Set to NULL to retrieve the first element.
Returns
a pointer to the next data slot, based on the current pointer. NULL if the new pointer is passed the end of the buffer
See also
fbBLNext()

◆ fbBasicListResize()

void* fbBasicListResize ( fbBasicList_t basicList,
uint16_t  newCount 
)

Resizes and zeroes the list's internal buffer for elements.

Returns a handle to the new buffer which is capable of holding newCount total elements. The other properties of the BasicList are unchanged.

May only be called on an initialized BasicList. This function does not free any recursive structured-data records used by the existing buffer before resizing it.

Parameters
basicListthe BasicList to resize
newCounttotal count of elements the resized list can hold
Returns
pointer to the list's data buffer
See also
fbBasicListAddNewElements() to add additional elements to an existing list.
Since
libfixbuf 3.0.0; previously called fbBasicListRealloc().

◆ fbBasicListAddNewElements()

void* fbBasicListAddNewElements ( fbBasicList_t basicList,
uint16_t  additional 
)

Increases the size of the list's internal data buffer to hold additional more elements.

Returns a pointer to the first additional element. Any elements in the buffer prior to this call remain unchanged (though they may be in a new memory location). May only be called on an initialized BasicList.

Parameters
basicListpointer to the basic list to add elements to
additionalnumber of elements to add to the list
Returns
A pointer to the first newly allocated element.

◆ fbBasicListClear()

void fbBasicListClear ( fbBasicList_t basicList)

Clears the parameters of the BasicList and frees the data buffer.

This function leaves the BasicList in the same state as fbBasicListCollectorInit(). To reuse the BasicList for export after this call, re-initialize it with fbBasicListInit().

Parameters
basicListpointer to the basic list to clear
See also
fBufListFree() to recursively free all structured data on a record

◆ fbBasicListClearWithoutFree()

void fbBasicListClearWithoutFree ( fbBasicList_t basicList)

Clears the parameters of the basic list but does not free the buffer.

Parameters
basicListpointer to the basic list to clear without freeing

◆ fbBasicListFree()

void fbBasicListFree ( fbBasicList_t basicList)

Clears the basic list (fbBasicListClear()), then frees the basic list itself.

This is typically paired with fbBasicListAlloc(), and it not normally needed.

Parameters
basicListpointer to the basic list to free

◆ fbSubTemplateListAlloc()

fbSubTemplateList_t* fbSubTemplateListAlloc ( void  )

Allocates and returns an empty subTemplateList structure.

Exits the application on allocation failure.

Based on how subTemplateLists will be used and set up amidst data structures, this function may never be used.

Returns
A newly allocated SubTemplateList.

◆ fbSubTemplateListInit()

void* fbSubTemplateListInit ( fbSubTemplateList_t sTL,
uint8_t  semantic,
uint16_t  tmplID,
const fbTemplate_t tmpl,
uint16_t  numElements 
)

Initializes a subTemplateList structure and allocates the internal buffer to a size capable of holding numElements records matching the template.

This is mainly used when preparing to encode data for output by an fbExporter_t. When reading data, use fbSubTemplateListCollectorInit() to initialize the subTemplateList. The tmpl should exist on the fbSession_t that will be used when exporting the record holding this subTemplateList. Returns a pointer to the allocated buffer; exits the application if the allocation fails. Returns NULL only when tmpl is NULL.

Parameters
sTLpointer to the sub template list to initialize
semanticthe semantic value used to describe the list contents
tmplIDid of the template used for encoding the list data
tmplpointer to the template struct used for encoding the list data
numElementsnumber of elements in the list
Returns
a pointer to the allocated buffer (location of first element)

◆ fbSubTemplateListCollectorInit()

void fbSubTemplateListCollectorInit ( fbSubTemplateList_t subTemplateList)

Initializes a SubTemplateList variable on a fbCollector_t.

If the fbSubTemplateList variable is in a struct, it will likely not be set to 0's If not, the dataPtr will not be NULL, so the transcoder will not allocate the right memory for it, as it will assuming it's set up. This will break. Call this function right after declaring the struct variable that contains the fbSubTemplateList. It only needs to be called once for each STL.

When using an fbExporter_t, use fbSubTemplateListInit() to initialize the subTemplateList.

Parameters
subTemplateListThe SubTemplateList to initialize for collection

◆ fbSubTemplateListGetDataPtr()

void* fbSubTemplateListGetDataPtr ( const fbSubTemplateList_t subTemplateList)

Returns a pointer to the buffer that contains the data for the list.

Parameters
subTemplateListpointer to the STL to get the pointer from
Returns
a pointer to the data buffer used by the sub template list

◆ fbSubTemplateListGetIndexedDataPtr()

void* fbSubTemplateListGetIndexedDataPtr ( const fbSubTemplateList_t subTemplateList,
uint16_t  index 
)

Returns the data for the record at position index in the sub template list, or returns NULL if index is out of range.

The first element is at index 0, the last at fbSubTemplateListCountElements()-1.

Parameters
subTemplateListpointer to the STL
indexThe index of the element to be retrieved (0-based)
Returns
a pointer to the desired element, or NULL when out of range

◆ fbSubTemplateListGetNextPtr()

void* fbSubTemplateListGetNextPtr ( const fbSubTemplateList_t subTemplateList,
const void *  currentPtr 
)

Retrieves a pointer to the data record in the sub template list that follows the one at currentPtr.

Retrieves the first record if currentPtr is NULL. Returns NULL when there are no more records or when currentPtr is outside the buffer used by the sub template list.

Parameters
subTemplateListpointer to the STL to get data from
currentPtrpointer to the last element accessed. NULL causes the pointer to the first element to be returned
Returns
the pointer to the next element in the list. Returns NULL if currentPtr points to the last element in the list.
See also
fbSTLNext()

◆ fbSubTemplateListCountElements()

uint16_t fbSubTemplateListCountElements ( const fbSubTemplateList_t subTemplateList)

Returns the number of elements (sub-records) the sub template list is capable of holding.

Parameters
subTemplateListpointer to the sub template list
Returns
the number of records on the sub template list
Since
libfixbuf 2.3.0

◆ fbSubTemplateListSetSemantic()

void fbSubTemplateListSetSemantic ( fbSubTemplateList_t subTemplateList,
uint8_t  semantic 
)

Sets the list semantics value (fbListSemantics_t) of a SubTemplateList.

Parameters
subTemplateListpointer to the sub template list
semanticSemantic value for the list

◆ fbSubTemplateListGetSemantic()

uint8_t fbSubTemplateListGetSemantic ( const fbSubTemplateList_t subTemplateList)

Gets the list semantics value (fbListSemantics_t) from a SubTemplateList.

Parameters
subTemplateListpointer to the sub template list
Returns
the semantic field from the list

◆ fbSubTemplateListGetTemplate()

const fbTemplate_t* fbSubTemplateListGetTemplate ( const fbSubTemplateList_t subTemplateList)

Gets the template pointer from the list structure.

Parameters
subTemplateListpointer to the sub template list
Returns
a pointer to the template used by the sub template list

◆ fbSubTemplateListGetTemplateID()

uint16_t fbSubTemplateListGetTemplateID ( const fbSubTemplateList_t subTemplateList)

Gets the template ID for the template used by the list.

Parameters
subTemplateListpointer to the sub template list
Returns
the template ID used by the sub template list

◆ fbSubTemplateListResize()

void* fbSubTemplateListResize ( fbSubTemplateList_t subTemplateList,
uint16_t  newCount 
)

Resizes and zeroes the list's internal buffer for elements (sub-records).

Returns a handle to the new buffer which is capable of holding newCount total sub-records. The other properties of the SubTemplateList are unchanged.

This function may only be called on an initialized SubTemplateList. This function does not free any recursive structured-data records used by the existing buffer before resizing it.

Parameters
subTemplateListthe sub template list to resize
newCounttotal count of sub-records the resized list can hold
Returns
pointer to the list's data buffer
See also
fbSubTemplateListAddNewElements() to add additional elements to an existing list.
Since
libfixbuf 3.0.0; previously called fbSubTemplateListRealloc().

◆ fbSubTemplateListAddNewElements()

void* fbSubTemplateListAddNewElements ( fbSubTemplateList_t subTemplateList,
uint16_t  additional 
)

Increases the size of the list's internal buffer to hold additional more elements (sub-records).

Returns a pointer to the first additional sub-record. Any sub-records in the buffer prior to this call remain unchanged (though they may be in a new memory location). May only be called on an initialized SubTemplateList.

Parameters
subTemplateListpointer to the sub template list
additionalnumber of new elements to add to the list
Returns
A pointer to the first newly allocated element.

◆ fbSubTemplateListClear()

void fbSubTemplateListClear ( fbSubTemplateList_t subTemplateList)

Clears a subTemplateList structure, notably freeing the internal buffer and setting it to NULL.

This should be used after each call to fBufNext(): If the dataPtr is not NULL in DecodeSubTemplateList, it will not allocate new memory for the new record, which could cause a buffer overflow if the new record has a longer list than the current one. An alternative is to allocate a large buffer and assign it to dataPtr on your own, then never clear it with this. Be certain this buffer is longer than needed for all possible lists

If any of the sub-records contain another layer of structures, that second layer must be freed by the user, as this function cannot do that. For example, if subTemplateList's Template contains an element of type basicList, the memory used by that basicList is not freed by this function.

Parameters
subTemplateListpointer to the sub template list to clear
See also
fBufListFree() to recursively free all structured data on a record

◆ fbSubTemplateListClearWithoutFree()

void fbSubTemplateListClearWithoutFree ( fbSubTemplateList_t subTemplateList)

Clears the sub template list parameters but does not free the data ptr.

Parameters
subTemplateListpointer to the sub template list to clear

◆ fbSubTemplateListFree()

void fbSubTemplateListFree ( fbSubTemplateList_t subTemplateList)

Clears the sub template list (fbSubTemplateListClear()) then frees the subTemplateList itself.

This is typically paired with subTemplateListAlloc(), and it is unlikely to be used.

Parameters
subTemplateListpointer to the sub template list to free

◆ fbSubTemplateMultiListAlloc()

fbSubTemplateMultiList_t* fbSubTemplateMultiListAlloc ( void  )

Allocates and returns an empty subTemplateMultiList structure.

Exits the application on allocation failure.

Based on how subTemplateMultiLists are used and set up amidst data structures, this function may never be used.

Returns
A newly allocated SubTemplateMultiList.

◆ fbSubTemplateMultiListInit()

fbSubTemplateMultiListEntry_t* fbSubTemplateMultiListInit ( fbSubTemplateMultiList_t STML,
uint8_t  semantic,
uint16_t  numElements 
)

Initializes the multi list with the list semantic and allocates memory to store numElements entries.

Retuns a pointer to the allocated memory; exits the application on allocation failure.

Parameters
STMLpointer to the sub template multi list to initialize
semanticvalue used to describe the entries in the multi list
numElementsnumber of entries in the multi list
Returns
pointer to the first uninitialized entry

◆ fbSubTemplateMultiListCountElements()

uint16_t fbSubTemplateMultiListCountElements ( const fbSubTemplateMultiList_t STML)

Returns the number of entries the sub template multi list is capable of holding.

Parameters
STMLpointer to the sub template multi list
Returns
the number of entries on the sub template multi list
Since
libfixbuf 2.3.0

◆ fbSubTemplateMultiListSetSemantic()

void fbSubTemplateMultiListSetSemantic ( fbSubTemplateMultiList_t STML,
uint8_t  semantic 
)

Sets the list semantics value (fbListSemantics_t) for the multi list.

Parameters
STMLpointer to the sub template multi list
semanticValue for the semantic field of the sub template multi list

◆ fbSubTemplateMultiListGetSemantic()

uint8_t fbSubTemplateMultiListGetSemantic ( const fbSubTemplateMultiList_t STML)

Gets the list semantics value (fbListSemantics_t) from the multi list.

Parameters
STMLpointer to the sub template multi list
Returns
semantic parameter describing the contents of the multi list

◆ fbSubTemplateMultiListClear()

void fbSubTemplateMultiListClear ( fbSubTemplateMultiList_t STML)

Clears all of the fbSubTemplateMultiListEntry_t objects on this STML (see fbSubTemplateMultiListClearEntries()), then frees the buffer containing the entries.

Parameters
STMLpointer to the sub template multi list to clear
See also
fBufListFree() to recursively free all structured data on a record

◆ fbSubTemplateMultiListClearEntries()

void fbSubTemplateMultiListClearEntries ( fbSubTemplateMultiList_t STML)

Clears the memory used by all the entries of a sub template multi list.

That is, it calls fbSubTemplateMultiListEntryClear() for each entry.

Note
If any of the entries contain another layer of structures, that second layer must be freed by the user, as this function does not do that. For example, if an entry's template contains an element of type basicList, the memory used by that basicList is not freed by this function.
Parameters
STMLpointer to the sub template multi list
See also
Use fbSubTemplateMultiListClear() instead of this function to clear and free the memory in the STML that holds the entries.

◆ fbSubTemplateMultiListFree()

void fbSubTemplateMultiListFree ( fbSubTemplateMultiList_t STML)

Clears the multi list (fbSubTemplateMultiListClear()), then frees the STML itself.

This is typically paired with fbSubTemplateMultiListAlloc(), and it not normally needed.

Parameters
STMLpointer to the sub template multi list

◆ fbSubTemplateMultiListResize()

fbSubTemplateMultiListEntry_t* fbSubTemplateMultiListResize ( fbSubTemplateMultiList_t STML,
uint16_t  newCount 
)

Resizes and zeroes the list's internal buffer for entries (fbSubTemplateMultiListEntry_t).

Returns a handle to the new buffer which is capable of holding newCount total entries. The other properties of the SubTemplateMultiList are unchanged.

This function may only be called on an initialized SubTemplateMultiList. This function does not free any recursive structured-data records used by the existing buffer before resizing it.

Parameters
STMLthe sub template multi list to resize
newCounttotal number of entries the resized list can hold
Returns
pointer to the entry's data buffer
See also
fbSubTemplateMultiListAddNewEntries() to add additional entries to an existing STML.
Since
libfixbuf 3.0.0; previously called fbSubTemplateMultiListRealloc().

◆ fbSubTemplateMultiListAddNewEntries()

fbSubTemplateMultiListEntry_t* fbSubTemplateMultiListAddNewEntries ( fbSubTemplateMultiList_t STML,
uint16_t  additional 
)

Increases the size of the list's internal buffer to hold additional more entries.

Returns a pointer to the first additional entry. Any entries in the buffer prior to this call remain unchanged (though they may be in a new memory location). May only be used on an initialized SubTemplateMultiList.

Parameters
STMLpointer to the sub template multi list
additionalnumber of entries to add to the list
Returns
a pointer to the new entry

◆ fbSubTemplateMultiListGetFirstEntry()

fbSubTemplateMultiListEntry_t* fbSubTemplateMultiListGetFirstEntry ( const fbSubTemplateMultiList_t STML)

Retrieves the first entry in the multi list.

Parameters
STMLpointer to the sub template multi list
Returns
pointer to the first entry used by the list

◆ fbSubTemplateMultiListGetIndexedEntry()

fbSubTemplateMultiListEntry_t* fbSubTemplateMultiListGetIndexedEntry ( const fbSubTemplateMultiList_t STML,
uint16_t  index 
)

Retrieves a pointer to the entry at a specific index, or returns NULL if index is out of range.

The first entry is at index 0, the last at fbSubTemplateMultiListCountElements()-1.

Parameters
STMLpointer to the sub template multi list
indexindex of the entry to be returned (0-based)
Returns
the index'th entry used by the list, or NULL if out of range

◆ fbSubTemplateMultiListGetNextEntry()

fbSubTemplateMultiListEntry_t* fbSubTemplateMultiListGetNextEntry ( const fbSubTemplateMultiList_t STML,
const fbSubTemplateMultiListEntry_t currentEntry 
)

Retrieves a pointer to the entry in the multi list that follows the one at currentEntry.

Retrieves the first entry if currentEntry is NULL. Returns NULL when there are no more entries or when currentEntry is outside the buffer used by the multi list.

Parameters
STMLpointer to the sub template multi list to get data from
currentEntrypointer to the last element accessed. NULL means none have been accessed yet
Returns
the pointer to the next element in the list. Returns the NULL if currentEntry points to the last entry.
See also
fbSTMLNext()

◆ fbSubTemplateMultiListEntryInit()

void* fbSubTemplateMultiListEntryInit ( fbSubTemplateMultiListEntry_t entry,
uint16_t  tmplID,
const fbTemplate_t tmpl,
uint16_t  numElements 
)

Initializes the multi list entry with the template values, and allocates the memory used by the entry to hold the data.

This is mainly used when preparing to encode data for output by an fbExporter_t. The tmpl should exist on the fbSession_t that will be used when exporting the record holding the subTemplateMultiList.

Parameters
entrypointer to the entry to initialize
tmplIDID of the template used to structure the data elements
tmplpointer to the template used to structure the data elements
numElementsnumber of data elements in the entry
Returns
pointer to the data buffer to be filled in

◆ fbSubTemplateMultiListEntryResize()

void* fbSubTemplateMultiListEntryResize ( fbSubTemplateMultiListEntry_t entry,
uint16_t  newCount 
)

Resizes and zeroes the entry's internal buffer for elements (sub-records).

Returns a handle to the new buffer which is capable of holding newCount total sub-records. The other properties of the SubTemplateMultiListEntry are unchanged.

This function may only be called on an initialized SubTemplateMultiListEntry. This function does not free any recursive structured-data records used by the existing buffer before resizing it.

Parameters
entrythe STML entry to resize
newCounttotal count of sub-records the resized list can hold
Returns
pointer to buffer to write data to
See also
fbSubTemplateMultiListEntryAddNewElements() to add additional elements to an existing sub template multi list entry.
Since
libfixbuf 3.0.0; previously called fbSubTemplateMultiListEntryRealloc().

◆ fbSubTemplateMultiListEntryAddNewElements()

void* fbSubTemplateMultiListEntryAddNewElements ( fbSubTemplateMultiListEntry_t entry,
uint16_t  additional 
)

Increases the size of the entry's internal buffer to hold additional more elements (sub-records).

Returns a pointer to the first additional sub-record. Any sub-records in the buffer prior to this call remain unchanged (though they may be in a new memory location). May only be called on an initialized SubTemplateMultiListEntry.

Parameters
entrypointer to the STML entry to add additional sub-records to
additionalnumber of sub-records to add to the STML entry
Returns
a pointer to the first newly allocated sub-record

◆ fbSubTemplateMultiListEntryClear()

void fbSubTemplateMultiListEntryClear ( fbSubTemplateMultiListEntry_t entry)

Frees the memory holding the sub-records' data used by this entry.

Use fbSubTemplateMultiListClearEntries() to clear all entries in an fbSubTemplateMultiList_t, and fbSubTemplateMultiListClear() to clear the entire sub template multi list.

This function does not free any recursive structured-data records used by the buffer before freeing it.

Parameters
entrypointer to the entry to be cleared

◆ fbSubTemplateMultiListEntryGetDataPtr()

void* fbSubTemplateMultiListEntryGetDataPtr ( const fbSubTemplateMultiListEntry_t entry)

Retrieves the data pointer for this entry.

Parameters
entrypointer to the entry to get the data pointer from
Returns
pointer to the buffer used to store data for this entry

◆ fbSubTemplateMultiListEntryNextDataPtr()

void* fbSubTemplateMultiListEntryNextDataPtr ( const fbSubTemplateMultiListEntry_t entry,
const void *  currentPtr 
)

Retrieves a pointer to the data record in this entry that follows the one at currentPtr.

Retrieves the first record if currentPtr is NULL. Returns NULL when there are no more records or when currentPtr is outside the buffer used by the multi list entry.

Parameters
entrypointer to the entry to get the next element from
currentPtrpointer to the last element accessed. NULL means return a pointer to the first element.
Returns
the pointer to the next element in the list. Returns NULL if currentPtr points to the last element in the list
See also
fbSTMLEntryNext()

◆ fbSubTemplateMultiListEntryGetIndexedPtr()

void* fbSubTemplateMultiListEntryGetIndexedPtr ( const fbSubTemplateMultiListEntry_t entry,
uint16_t  index 
)

Retrieves a pointer to the data element in the entry at position index, or returns NULL when index is out of range.

The first element is at index 0, the last at fbSubTemplateMultiListEntryCountElements()-1.

Parameters
entrypointer to the entry to get a data pointer from.
indexthe number of the element in the list to return
Returns
the pointer to the index'th element used by the entry, or NULL when out of range

◆ fbSubTemplateMultiListEntryCountElements()

uint16_t fbSubTemplateMultiListEntryCountElements ( const fbSubTemplateMultiListEntry_t entry)

Returns the number of entries the sub template multi list entry is capable of holding.

Parameters
entrypointer to the sub template multi list entry
Returns
the number of records on the sub template multi list entry
Since
libfixbuf 2.3.0

◆ fbSubTemplateMultiListEntryGetTemplate()

const fbTemplate_t* fbSubTemplateMultiListEntryGetTemplate ( const fbSubTemplateMultiListEntry_t entry)

Retrieves the template pointer used to structure the data elements.

Parameters
entrypointer to the entry to get the template from
Returns
the template pointer used to describe the contents of the entry

◆ fbSubTemplateMultiListEntryGetTemplateID()

uint16_t fbSubTemplateMultiListEntryGetTemplateID ( const fbSubTemplateMultiListEntry_t entry)

Retrieves the template ID for the template used to structure the data.

Parameters
entrypointer to the entry to get the template ID from
Returns
the template ID for template that describes the data

◆ fBufListFree()

void fBufListFree ( const fbTemplate_t tmpl,
uint8_t *  record 
)

Clears all of the memory that fixbuf allocated during transcode of this record.

This frees all of the memory allocated for list structures, recursively, when fixbuf was encoding or decoding the record.

The template provided is the internal template that was set on the fBuf before fBufNext() or fBufAppend() was called with the data. The template MUST match the record or bad things WILL happen without indication. This does not free the record itself. It will only free any list information elements and nested list information elements.

Parameters
tmplpointer to the internal template that MUST match the record
recordpointer to the data

◆ fbListenerGroupAlloc()

fbListenerGroup_t* fbListenerGroupAlloc ( void  )

Allocates and returns an empty ListenerGroup.

Use fbListenerGroupAddListener() to populate the ListenerGroup, fbListenerGroupWait() to wait for connections on those listeners, and fbListenerGroupFree() when the ListenerGroup is no longer needed.

Exits the application on allocation failure.

Returns
A newly allocated ListenerGroup.

◆ fbListenerGroupFree()

void fbListenerGroupFree ( fbListenerGroup_t group)

Frees a listener group.

Parameters
groupfbListenerGroup

◆ fbListenerGroupAddListener()

int fbListenerGroupAddListener ( fbListenerGroup_t group,
const fbListener_t listener 
)

Adds a previously allocated listener to the previously allocated group.

The listener is placed at the head of the list

Parameters
grouppointer to the allocated group to add the listener to
listenerpointer to the listener structure to add to the group
Returns
0 upon success. "1" if entry couldn't be allocated "2" if either of the incoming pointers are NULL

◆ fbListenerGroupDeleteListener()

int fbListenerGroupDeleteListener ( fbListenerGroup_t group,
const fbListener_t listener 
)

Removes the listener from the group.

IT DOES NOT FREE THE LISTENER OR THE GROUP

Parameters
grouppointer to the group to remove from the listener from
listenerpointer to the listener to remove from the group
Returns
0 on success, and "1" if the listener is not found "2" if either of the pointers are NULL

◆ fbListenerGroupWait()

fbListenerGroupResult_t* fbListenerGroupWait ( fbListenerGroup_t group,
GError **  err 
)

Accepts connections for multiple listeners.

Works similarly to fbListenerWait(), except that is looks for connections for any listener that is part of a previously allocated and filled listener group. It returns a pointer to the head of a list of listenerGroupResults. The caller is responsible for freeing the listenerGroupResult (fbListenerFreeGroupResult()).

Parameters
grouppointer to the group of listeners to wait on
errerror string structure seen throughout fixbuf
Returns
pointer to the head of the listener group result list NULL on error, and sets the error string

◆ fbListenerFreeGroupResult()

void fbListenerFreeGroupResult ( fbListenerGroupResult_t result)

Frees the listener group result returned from fbListenerGroupWait().

Parameters
resultA listener group result

◆ fbListenerOwnSocketCollectorTCP()

fBuf_t* fbListenerOwnSocketCollectorTCP ( fbListener_t listener,
int  sock,
GError **  err 
)

Returns an fBuf wrapped around an independently managed socket and a properly created listener for TCP connections.

The caller is only responsible for creating the socket. The existing collector code will close the socket and cleanup everything.

Parameters
listenerpointer to the listener to wrap around the socket
sockthe socket descriptor of the independently managed socket
errstandard fixbuf err structure pointer
Returns
pointer to the fbuf for the collector. NULL if sock is 0, 1, or 2 (stdin, stdout, or stderr)

◆ fbListenerOwnSocketCollectorTLS()

fBuf_t* fbListenerOwnSocketCollectorTLS ( fbListener_t listener,
int  sock,
GError **  err 
)

Same as fbListenerOwnSocketCollectorTCP() but for TLS (not tested)

Parameters
listenerpointer to the listener to wait on
sockindependently managed socket descriptor
errstandard fixbuf err structure pointer
Returns
pointer to the fbuf for the collector NULL if sock is 0, 1, or 2 (stdin, stdout, or stderr)

◆ fBufInterruptSocket()

void fBufInterruptSocket ( fBuf_t fbuf)

Interrupts the select call of a specific collector by way of its fBuf.

This is mainly used by fbListenerInterrupt() to interrupt all of the collector sockets well.

◆ fBufSetInternalTemplate()

gboolean fBufSetInternalTemplate ( fBuf_t fbuf,
uint16_t  int_tid,
GError **  err 
)

Sets the internal template on a buffer to the given template ID.

The internal template describes the format of the record pointed to by the recbase parameter to fBufAppend() (for export) and fBufNext() (for collection). The given template ID must identify a current internal template in the buffer's associated session.

An internal template must be set on a buffer before calling fBufAppend() or fBufNext().

Parameters
fbufan IPFIX message buffer
int_tidtemplate ID of the new internal template
errAn error description, set on failure.
Returns
TRUE on success, FALSE on failure.

◆ fBufSetExportTemplate()

gboolean fBufSetExportTemplate ( fBuf_t fbuf,
uint16_t  ext_tid,
GError **  err 
)

Sets the external template for export on a buffer to the given template ID.

The external template describes the record that will be written to the IPFIX message. The buffer must be initialized for export. The given ID is scoped to the observation domain of the associated session (see fbSessionSetDomain()), and must identify a current external template for the current domain in the buffer's associated session.

An export template must be set on a buffer before calling fBufAppend().

Parameters
fbufan IPFIX message buffer
ext_tidtemplate ID of the new external template within the current domain.
errAn error description, set on failure.
Returns
TRUE on success, FALSE on failure.

◆ fBufSetTemplatesForExport()

gboolean fBufSetTemplatesForExport ( fBuf_t fbuf,
uint16_t  tid,
GError **  err 
)

Sets the internal and external templates on a Buffer to the given template ID.

This is a convenience function that invokes fBufSetExportTemplate() and fBufSetInternalTemplate().

Parameters
fbufan IPFIX message buffer
tidtemplate ID used to find the internal and external templates for the buffer
errAn error description, set on failure.
Returns
TRUE on success, FALSE on failure.
Since
libfixbuf 3.0.0

◆ fBufSetAutomaticNextMessage()

void fBufSetAutomaticNextMessage ( fBuf_t fbuf,
gboolean  automatic 
)

Sets the automatic next-message mode flag on a Buffer.

Buffers are created in automatic next-message mode by default.

For a Buffer allocated for export (fBufAllocForExport()) that is in automatic next-message mode, a call to fBufAppend(), fbSessionAddTemplate(), or fbSessionExportTemplates() that overruns the available space in the Buffer causes the current message to be emitted (fBufEmit()) to the fbExporter_t and a new message started.

For a Buffer allocated for reading (fBufAllocForCollection() or fbListenerWait()) that is in automatic next-message mode, a call to fBufNext() that reaches the end of Buffer causes the next message to be read (fBufNextMessage()) from the fbCollector_t.

In manual next-message mode, the end of message on any buffer export/read call causes the call to return an error with a GError code of FB_ERROR_EOM.

Parameters
fbufan IPFIX message buffer
automaticTRUE for this buffer to be automatic, FALSE for manual
Since
libfixbuf 3.0.0; previously called fBufSetAutomaticMode().

◆ fBufSetAutomaticMode()

void fBufSetAutomaticMode ( fBuf_t fbuf,
gboolean  automatic 
)

Deprecated.

Use fBufSetAutomaticNextMessage() instead.

◆ fBufSetAutomaticElementInsert()

gboolean fBufSetAutomaticElementInsert ( fBuf_t fbuf,
GError **  err 
)

Enables automatic insertion of RFC 5610 elements read from a Buffer.

RFC 5610 records allow an application to retrieve information about a non-standard information elements. By default, automatic insertion mode is disabled.

In automatic insertion mode, when the buffer reads an information element type record that has a non-zero value for the privateEnterpriseNumber and that is not already present in the buffer's session's information model, a new information element (fbInfoElement_t) is created and added to the information model (fbInfoModel_t). This function creates the internal template for the Info Element Type Record (fbInfoElementOptRec_t) and calls fbInfoElementAddOptRecElement() to add it to the buffer's session.

For export of RFC 5610 elements, use fbSessionSetMetadataExportElements().

Parameters
fbufan IPFIX message buffer
errGerror pointer
Returns
TRUE on success, FALSE if the internal template could not be created
Since
libfixbuf 3.0.0; previously called fBufSetAutomaticInsert().

◆ fBufSetAutomaticInsert()

gboolean fBufSetAutomaticInsert ( fBuf_t fbuf,
GError **  err 
)

A deprecated alias for fBufSetAutomaticElementInsert().

Parameters
fbufan IPFIX message buffer
errGerror pointer
Returns
TRUE on success, FALSE if the internal template could not be created
Deprecated:
Use fBufSetAutomaticElementInsert() instead.

◆ fBufSetAutomaticMetadataAttach()

gboolean fBufSetAutomaticMetadataAttach ( fBuf_t fbuf,
GError **  err 
)

Instructes a collection Buffer to process Template Metadata records.

Template Metadata records allow the exporter to provide a name and a description to a template. As of libfixbuf 3.0.0, the Template Metadata also includes relationships among templates (for example, some are used in a fbSubTemplateList_t or a fbSubTemplateMultiList_t) and the fbInfoElement_t used by each fbBasicList_t in the Template.

Once the fbCollector_t sees the template metadata records, they may be queried using fbSessionGetTemplateInfo(), fbSessionGetTemplatePath(), and fbTemplateInfoGetNextBasicList(). See fbTemplateInfo_t and fbBasicListInfo_t for more information.

This function enables recognition of these records and defines two internal templates for reading the data.

To export Template Metadata records, use fbSessionSetMetadataExportTemplates() and provide the metadata with the fbTemplate_t to fbSessionAddTemplate().

Parameters
fbufAn IPFIX message buffer.
errAn error description.
Returns
TRUE on success or FALSE if the
Since
libfixbuf 3.0.0

◆ fBufGetSession()

fbSession_t* fBufGetSession ( const fBuf_t fbuf)

Retrieves the session associated with a buffer.

Parameters
fbufan IPFIX message buffer
Returns
the associated session

◆ fBufFree()

void fBufFree ( fBuf_t fbuf)

Frees a buffer.

Also frees any associated session, exporter, or collector, closing exporting process or collecting process endpoint connections and removing collecting process endpoints from any listeners, as necessary.

Parameters
fbufan IPFIX message buffer

◆ fBufAllocForExport()

fBuf_t* fBufAllocForExport ( fbSession_t session,
fbExporter_t exporter 
)

Allocates a new buffer for export.

Associates the buffer with a given session and exporting process endpoint; these become owned by the buffer. Session and Exporter are freed by fBufFree(). Must never be freed by the user. Use fBufAppend() to add data to the buffer, and use fBufEmit() to flush the buffer.

Exits the application on allocation failure.

Parameters
sessiona session initialized with appropriate internal and external templates
exporteran exporting process endpoint
Returns
A new IPFIX message buffer, owning the Session and Exporter.

◆ fBufGetExporter()

fbExporter_t* fBufGetExporter ( const fBuf_t fbuf)

Retrieves the exporting process endpoint associated with a buffer.

The buffer must have been allocated with fBufAllocForExport(); otherwise, returns NULL.

Parameters
fbufan IPFIX message buffer
Returns
the associated exporting process endpoint

◆ fBufSetExporter()

void fBufSetExporter ( fBuf_t fbuf,
fbExporter_t exporter 
)

Associates an exporting process endpoint with a buffer.

The exporter will be used to write IPFIX messgaes to a transport. The exporter becomes owned by the buffer; any previous exporter associated with the buffer is closed if necessary and freed.

Parameters
fbufan IPFIX message buffer
exporteran exporting process endpoint

◆ fBufRemaining()

size_t fBufRemaining ( fBuf_t fbuf)

When using fBufSetBuffer(), returns the number of unprocessed octets in the octet array.

An IPFIX collector that is not using libfixbuf to handle connections would use this function upon receiving an FB_ERROR_BUFSZ error from fBufNext(), fBufNextCollectionTemplate(), or fBufNextRecord(). The remaining data is the beginning of the next IPFIX message.

Parameters
fbufan IPFIX message buffer
Returns
Number of octets in the octet array that were not processed.

◆ fBufSetBuffer()

void fBufSetBuffer ( fBuf_t fbuf,
uint8_t *  buf,
size_t  buflen 
)

Sets an octet array on an fBuf for collection.

This may be used by applications that want to handle their own connections, file reading, etc. This call should be made after the call to read() and before calling fBufNext(), fBufNextCollectionTemplate(), or fBufNextRecord(). These functions return FB_ERROR_BUFSZ when there is not enough data in the octet array to read a complete IPFIX message. Upon receipt of FB_ERROR_BUFSZ, the application should call fBufRemaining() to get the number of octets in the array that were not processed.

Parameters
fbufan IPFIX message buffer
bufthe octet array containing IPFIX data to be processed
buflenthe length of IPFIX data in buf
See also
Connection-less Collector Connection-less collector

◆ fBufAppend()

gboolean fBufAppend ( fBuf_t fbuf,
uint8_t *  recbase,
size_t  recsize,
GError **  err 
)

Appends a record to a buffer.

Uses the present internal template set via fBufSetInternalTemplate() to describe the record of size recsize located in memory at recbase. Uses the present export template set via fBufSetExportTemplate() to describe the record structure to be written to the buffer. Information Elements present in the external template that are not present in the internal template are transcoded into the message as zeroes. If the buffer is in automatic mode, may cause a message to be emitted via fBufEmit() if there is insufficient space in the buffer for the record.

If the internal template contains any variable length Information Elements, those must be represented in the record by fbVarfield_t structures.

Parameters
fbufan IPFIX message buffer
recbasepointer to internal record
recsizesize of internal record in bytes
erran error description, set on failure. Must not be NULL, as it is used internally in automatic mode to detect message restart.
Returns
TRUE on success, FALSE on failure.

◆ fBufEmit()

gboolean fBufEmit ( fBuf_t fbuf,
GError **  err 
)

Emits the message currently in a buffer using the associated exporting process endpoint.

Parameters
fbufan IPFIX message buffer
erran error description, set on failure.
Returns
TRUE on success, FALSE on failure.

◆ fBufSetExportTime()

void fBufSetExportTime ( fBuf_t fbuf,
uint32_t  extime 
)

Sets the export time on the message currently in a buffer.

This will be used as the export time of the message created by the first call to fBufAppend() after the current message, if any, is emitted. Use 0 for the export time to cause the export time to be taken from the system clock at message creation time.

Parameters
fbufan IPFIX message buffer
extimethe export time in epoch seconds.

◆ fBufAllocForCollection()

fBuf_t* fBufAllocForCollection ( fbSession_t session,
fbCollector_t collector 
)

Allocates a new buffer for collection.

Associates the buffer with a given session and collecting process endpoint; these become owned by the buffer and must not be freed by the user. The session and collector are freed by fBufFree(). Use fBufNext() to read data from the buffer, and fBufNextMessage() to move the buffer to the next IPFIX message.

To process an octet array of IPFIX data (see fBufSetBuffer()), invoke this function with a NULL collector.

Exits the application on allocation failure.

Parameters
sessiona session initialized with appropriate internal templates
collectoran collecting process endpoint
Returns
A new IPFIX message buffer, owning the Session and Collector.

◆ fBufGetCollector()

fbCollector_t* fBufGetCollector ( const fBuf_t fbuf)

Retrieves the collecting process endpoint associated with a buffer.

The buffer must have been allocated with fBufAllocForCollection(); otherwise, returns NULL.

Parameters
fbufan IPFIX message buffer
Returns
the associated collecting process endpoint

◆ fBufSetCollector()

void fBufSetCollector ( fBuf_t fbuf,
fbCollector_t collector 
)

Associates an collecting process endpoint with a buffer.

The collector will be used to read IPFIX messgaes from a transport. The collector becomes owned by the buffer; any previous collector associated with the buffer is closed if necessary and freed.

Parameters
fbufan IPFIX message buffer
collectoran collecting process endpoint

◆ fBufNext()

gboolean fBufNext ( fBuf_t fbuf,
uint8_t *  recbase,
size_t *  recsize,
GError **  err 
)

Retrieves a record from a Buffer associated with a collecting process.

Uses the external template taken from the message to read the next record available from a data set in the message. Copies the record to a data buffer at recbase, with a maximum record size pointed to by recsize, described by the present internal template set via fBufSetInternalTemplate(). Reads and processes any templates and options templates between the last record read (or beginning of message) and the next data record. Information Elements present in the internal template that are not present in the external template are transcoded into the record at recbase as zeroes. If the buffer is in automatic mode, may cause a message to be read via fBufNextMessage() if there are no more records available in the message buffer.

If the internal template contains any variable length Information Elements, those must be represented in the record at recbase by fbVarfield_t structures.

Parameters
fbufan IPFIX message buffer
recbasepointer to internal record buffer; will contain record data after call.
recsizeOn call, pointer to size of internal record buffer in bytes. Contains number of bytes actually transcoded at end of call.
erran error description, set on failure. Must not be NULL, as it is used internally in automatic mode to detect message restart.
Returns
TRUE on success, FALSE on failure.

◆ fBufNextRecord()

gboolean fBufNextRecord ( fBuf_t fbuf,
fbRecord_t record,
GError **  err 
)

Sets the internal template on a Buffer and gets its next record.

Sets the internal template of fbuf to the value specified by the tid member of record (fBufSetInternalTemplate()) and fills the rec member (whose size is specified by reccapacity) with the next record from the Buffer (fBufNext()). Returns TRUE on success, or sets err and returns FALSE otherwise.

Before calling this function, the caller must set the tid member to the template to use and ensure that the rec and reccapacity members have been initialized.

On a successful call, the tmpl member points to the internal template, the rec member holds the record's data, and recsize is the length of that data.

Parameters
fbufan IPFIX message buffer
recordan object to be updated with the record's data
erran error description, set on failure.
Returns
TRUE on success, FALSE on failure
Since
libfixbuf 3.0.0

◆ fBufNextMessage()

gboolean fBufNextMessage ( fBuf_t fbuf,
GError **  err 
)

Reads a new message into a buffer using the associated collecting process endpoint.

Called by fBufNext() on end of message in automatic mode; should be called after an FB_ERROR_EOM return from fBufNext() in manual mode, or to skip the current message and go on to the next in the stream.

Parameters
fbufan IPFIX message buffer
erran error description, set on failure.
Returns
TRUE on success, FALSE on failure.

◆ fBufGetExportTime()

uint32_t fBufGetExportTime ( const fBuf_t fbuf)

Retrieves the export time on the message currently in a buffer.

Parameters
fbufan IPFIX message buffer
Returns
the export time in epoch seconds.

◆ fBufGetCollectionTemplate()

fbTemplate_t* fBufGetCollectionTemplate ( const fBuf_t fbuf,
uint16_t *  ext_tid 
)

Retrieves the external template used to read the last record from the buffer.

If no record has been read, returns NULL. Stores the external template ID within the current domain in ext_tid, if not NULL.

This routine is not particularly useful to applications, as it would be called after the record described by the external template had been transcoded, and as such could not be used to select an appropriate internal template for a given external template. However, it is used by fBufNextCollectionTemplate(), and may be useful in certain contexts, so is made public.

Usually, you'll want to use fBufNextCollectionTemplate() instead.

Parameters
fbufan IPFIX message buffer
ext_tidpointer to external template ID storage, or NULL.
Returns
the external template describing the last record read.

◆ fBufNextCollectionTemplate()

fbTemplate_t* fBufNextCollectionTemplate ( fBuf_t fbuf,
uint16_t *  ext_tid,
GError **  err 
)

Retrieves the external template that will be used to read the next record from the buffer.

If no next record is available, returns NULL. Stores the external template ID within the current domain in ext_tid, if not NULL. Reads and processes any templates and options templates between the last record read (or beginning of message) and the next data record. If the buffer is in automatic mode, may cause a message to be read via fBufNextMessage() if there are no more records available in the message buffer.

Parameters
fbufan IPFIX message buffer
ext_tidpointer to external template ID storage, or NULL.
erran error description, set on failure. Must not be NULL, as it is used internally in automatic mode to detect message restart.
Returns
the external template describing the last record read.

◆ fbInfoModelAlloc()

fbInfoModel_t* fbInfoModelAlloc ( void  )

Allocates a new information model.

The information model contains all the default information elements in the IANA-managed number space, and may be extended via fbInfoModelAddElement(), fbInfoModelAddElementArray(), fbInfoModelReadXMLFile(), and fbInfoModelReadXMLData().

An Information Model is required to create Templates and Sessions. Each application should have only one Information Model.

Exits the application on allocation failure.

Returns
A new Information Model.

◆ fbInfoModelFree()

void fbInfoModelFree ( fbInfoModel_t model)

Frees an information model.

Must not be called until all sessions and templates depending on the information model have also been freed; i.e., at application cleanup time.

Parameters
modelAn information model

◆ fbInfoModelAddElement()

void fbInfoModelAddElement ( fbInfoModel_t model,
const fbInfoElement_t ie 
)

Adds a single information element to an information model.

The information element is assumed to be in "canonical" form; that is, its ref.name field should contain the information element name. The information element and its name are copied into the model; the caller may free or reuse its storage after this call.

See fbInfoModelAddElementArray() for a more convenient method of statically adding information elements to information models.

Parameters
modelAn information model
iePointer to an information element to copy into the model

◆ fbInfoModelAddElementArray()

void fbInfoModelAddElementArray ( fbInfoModel_t model,
const fbInfoElement_t ie 
)

Adds multiple information elements in an array to an information model.

The information elements are assumed to be in "canonical" form; that is, their ref.name fields should contain the information element name. Each information element and its name are copied into the model; the caller may free or reuse its storage after this call.

The ie parameter points to the first information element in an array, usually statically initialized with an array of FB_IE_INIT_FULL macros followed by an FB_IE_NULL macro.

Parameters
modelAn information model
iePointer to an IE array to copy into the model
See also
fbInfoModelReadXMLFile() and fbInfoModelReadXMLData() for alternate ways to add information elements to information models.

◆ fbInfoModelReadXMLFile()

gboolean fbInfoModelReadXMLFile ( fbInfoModel_t model,
const gchar *  filename,
GError **  err 
)

Adds information specified in the given XML file to the information model.

The XML file is expected to be in the format used by the IANA IPFIX Entities registry, with the following two additions:

  • A <cert:enterpriseId> field may be used to mark the enterprise ID for an element.
  • A <cert:reversible> field may be used to mark an element as reversible (as per RFC 5103). Valid values for this field are true, false, yes, no, 1, and 0.

If the XML being parsed contains registries for the element data types, semantics, or units, those will be parsed and used to interpret the corresponding fields in the element records. (These registries exist in IANA's registry.)

A parsed element that already exists in the given InfoModel will be replace the existing element.

Parameters
modelAn information model
filenameThe file containing the XML description
errReturn location for a GError
Returns
FALSE if an error occurred, TRUE on success
Since
libfixbuf 2.1.0
See also
fbInfoModelReadXMLData()

◆ fbInfoModelReadXMLData()

gboolean fbInfoModelReadXMLData ( fbInfoModel_t model,
const gchar *  xml_data,
gssize  xml_data_len,
GError **  err 
)

Adds information specified in the given XML data to the information model.

The XML data is expected to be in the format used by the IANA IPFIX Entities registry, with the following two additions:

  • A <cert:enterpriseId> field may be used to mark the enterprise ID for an element.
  • A <cert:reversible> field may be used to mark an element as reversible (as per RFC 5103). Valid values for this field are true, false, yes, no, 1, and 0.

If the XML being parsed contains registries for the element data types, semantics, or units, those will be parsed and used to interpret the corresponding fields in the element records. (These registries exist in IANA's registry.)

A parsed element that already exists in the given InfoModel will be replace the existing element.

Parameters
modelAn information model
xml_dataA pointer to the XML data
xml_data_lenThe length of xml_data in bytes
errReturn location for a GError
Returns
FALSE if an error occurred, TRUE on success
Since
libfixbuf 2.1.0
See also
fbInfoModelReadXMLFile()

◆ fbInfoModelGetElementByName()

const fbInfoElement_t* fbInfoModelGetElementByName ( const fbInfoModel_t model,
const char *  name 
)

Returns a pointer to the canonical information element within an information model given the information element name.

The returned information element is owned by the information model and must not be modified.

Parameters
modelAn information model
nameThe name of the information element to look up
Returns
The named information element within the model, or NULL if no such element exists.

◆ fbInfoModelGetElementByID()

const fbInfoElement_t* fbInfoModelGetElementByID ( const fbInfoModel_t model,
uint16_t  id,
uint32_t  ent 
)

Returns a pointer to the canonical information element within an information model given the information element ID and enterprise ID.

The returned information element is owned by the information model and must not be modified.

Parameters
modelAn information model
idAn information element id
entAn enterprise id
Returns
The named information element within the model, or NULL if no such element exists.

◆ fbInfoModelContainsElement()

gboolean fbInfoModelContainsElement ( const fbInfoModel_t model,
const fbInfoElement_t element 
)

Returns TRUE if element is present in the information model either by name or by element and enterprise id.

Parameters
modelAn information model
elementAn information element
Returns
TRUE if element is inmodel`.
Since
libfixbuf 3.0.0

◆ fbInfoModelCountElements()

guint fbInfoModelCountElements ( const fbInfoModel_t model)

Returns the number of information elements in the information model.

Parameters
modelAn information model
Returns
The number of information elements in the information model

◆ fbInfoModelIterInit()

void fbInfoModelIterInit ( fbInfoModelIter_t iter,
const fbInfoModel_t model 
)

Initializes an information model iterator for iteration over the information elements (fbInfoElement_t) in the model.

The caller uses fbInfoModelIterNext() to visit the elements.

Parameters
iterA pointer to the iterator to initialize
modelAn information model

◆ fbInfoModelIterNext()

const fbInfoElement_t* fbInfoModelIterNext ( fbInfoModelIter_t iter)

Returns a pointer to the next information element in the information model.

Returns NULL once all information elements have been returned.

Parameters
iterAn information model iterator
Returns
The next information element within the model, or NULL if there are no more elements.

◆ fbInfoElementAllocTypeTemplate()

fbTemplate_t* fbInfoElementAllocTypeTemplate ( fbInfoModel_t model,
GError **  err 
)

Allocates and returns the Options Template that will be used to define Information Element Type Records.

This function does not add the template to the session or fbuf. This function allocates the template, appends the appropriate elements to the template, and sets the scope on the template. See RFC 5610 for more info.

Parameters
modelA pointer to an existing info model
errGError
Returns
A newly allocated template or NULL in the unlikely event a required InfoElement is missing.

◆ fbInfoElementWriteOptionsRecord()

gboolean fbInfoElementWriteOptionsRecord ( fBuf_t fbuf,
const fbInfoElement_t model_ie,
uint16_t  itid,
uint16_t  etid,
GError **  err 
)

Exports an options record to the given fbuf with information element type information about the given information element.

See RFC 5610 for details. Use fbInfoElementAllocTypeTemplate() and add the returned template to the session, before calling this function.

Parameters
fbufAn existing fbuf
model_ieA pointer to the information element to export type info
itidThe internal template id of the Options Template.
etidThe external template id of the Options Template.
errGError
Returns
TRUE if successful, FALSE if an error occurred.

◆ fbInfoElementAddOptRecElement()

gboolean fbInfoElementAddOptRecElement ( fbInfoModel_t model,
const fbInfoElementOptRec_t rec 
)

Adds an element that we received via an RFC 5610 Options Record to the given info model.

Returns TRUE if the element was added to the model or FALSE if it was not added because it either already exists in the model or has an privateEnterpriseNumber of 0 or FB_IE_PEN_REVERSE.

Parameters
modelAn information model
recA pointer to the received fbInfoElementOptRec.
Returns
TRUE if item was successfully added to info model.

◆ fbTemplateIsMetadata()

gboolean fbTemplateIsMetadata ( const fbTemplate_t tmpl,
uint32_t  tests 
)

Checks to see if a template describes a meta-data record according to the bit-field value in tests.

With the exception of FB_TMPL_IS_OPTIONS, this function returns TRUE if any test is true—that is, you may check multiple aspects of a template. If tests includes FB_TMPL_IS_OPTIONS and the template is not an options template, the function immediately returns false and no other tests are performed.

Values for tests are:

FB_TMPL_IS_OPTIONS - Checks whether the template is an options template.

FB_TMPL_IS_META_ELEMENT - Checks whether the template contains all of the elements required by RFC 5610 for describing an information element type (type metadata). See fbInfoElementOptRec_t and fbInfoElementAddOptRecElement().

FB_TMPL_IS_META_TEMPLATE_v3 - Checks whether the template contains the elements requred to describe a template as used in libfixbuf 3.0.0. This includes those in FB_TMPL_IS_META_TEMPLATE_V1 and silkAppLabel, a second templateId, and a subTemplateList. See fbTemplateInfo_t.

FB_TMPL_IS_META_BASICLIST - Checks whether the template contains the elements requred to describe a basicList as part of the template metadata. See fbBasicListInfo_t.

FB_TMPL_IS_META_TEMPLATE_V1 - Checks whether the template contains the elements requred to describe a template as defined in libfixbuf 1.8.0. Specifically, it checks whether the Template contains templateId, templateName, and templateDescription. Templates matching this may also match FB_TMPL_IS_META_TEMPLATE_V3.

Parameters
tmplA pointer to the template
testsA bitfield specifing which tests to check
Returns
TRUE if template passes the test
Since
libfixbuf 3.0.0

◆ fbTemplateAlloc()

fbTemplate_t* fbTemplateAlloc ( fbInfoModel_t model)

Allocates a new empty template.

The template will be associated with the given Information Model, and only able to use Information Elements defined within that Information Model. Templates may be associated with multiple sessions, with different template IDs each time, and as such are reference counted and owned by sessions. A template must be associated with at least one session or it will be leaked; each template is freed after its last associated session is freed. To free a template that has not yet been added to a session, use fbTemplateFreeUnused().

Use fbTemplateAppend(), fbTemplateAppendSpec(), fbTemplateAppendSpecId(), fbTemplateAppendSpecArray(), and fbTemplateAppendArraySpecId() to "fill in" a template after creating it, and before associating it with any session.

Exits the application on allocation failure.

Parameters
modelAn information model
Returns
A newly allocated empty Template.

◆ fbTemplateAppend()

gboolean fbTemplateAppend ( fbTemplate_t tmpl,
const fbInfoElement_t ex_ie,
GError **  err 
)

Appends an information element to a template.

The ex_ie information element parameter is used as an example. Its enterprise and element numbers are used to find the canonical element from the template's fbInfoModel_t, and the length in ex_ie is used as the length of appended fbTemplateField_t.

If no matching information element exists in the template's model, a new element is created, given the name "_alienInformationElement", given the datatype FB_OCTET_ARRAY, and added to the model.

The primary use of this function is by fBuf_t's template reader, but the function may be used to simulate receipt of templates over the wire. Typically templates are built with fbTemplateAppendSpec(), fbTemplateAppendSpecArray(), fbTemplateAppendSpecId(), and fbTemplateAppendArraySpecId().

Returns TRUE on success. Fills err and returns FALSE if tmpl is already associated with an fbSession_t (fbSessionAddTemplate()), if ex_ie names an existing element and the length in ex_ie is illegal for the datatype, or if tmpl is at its maximum size.

Parameters
tmplTemplate to append information element to
ex_ieExample IE to add to the template
erran error description, set on failure.
Returns
TRUE on success, FALSE on failure.

◆ fbTemplateAppendSpec()

gboolean fbTemplateAppendSpec ( fbTemplate_t tmpl,
const fbInfoElementSpec_t spec,
uint32_t  wantedFlags,
GError **  err 
)

Potentially appends an information element described by the specifier to a template.

If the high bits in the wantedFlags parameter include all the high bits of the specifier's flags member, the fbInfoElement_t named by the specifier is copied from the template's associated fbInfoModel_t and the element's length is set to that from the specifier.

When the specifier's flags member is 0, the element is always included; otherwise the following must by true: (wantedFlags && flags) == flags. The wantedFlags parameter and flags member support building multiple templates with different information element features from a single specifier.

If wantedFlags prevents the element from being added to the template, no other checks of spec are performed and the function returns TRUE.

Fills err and returns FALSE if spec names an unknown element, if the len_override value in spec is illegal for the fbInfoElementDataType_t of the element, if tmpl is associated with a fbSession_t (fbSessionAddTemplate()), or if tmpl is at its maximum size.

Parameters
tmplTemplate to append the information element to.
specSpecifier describing information element to append.
wantedFlagsFlags on whether to append the info element specifier.
errAn error description, set on failure.
Returns
TRUE on success, FALSE on failure.
See also
fbTemplateAppendSpecArray() fbTemplateAppendSpecId()

◆ fbTemplateAppendSpecArray()

gboolean fbTemplateAppendSpecArray ( fbTemplate_t tmpl,
const fbInfoElementSpec_t spec,
uint32_t  wantedFlags,
GError **  err 
)

Appends information elements described by a specifier array to a template.

Calls fbTemplateAppendSpec() for each member of the array until the FB_IESPEC_NULL convenience macro is encountered.

Parameters
tmplTemplate to append the information elements to.
specPointer to first specifier in specifier array to append.
wantedFlagsFlags on whether to append each info element specifier.
errAn error description, set on failure.
Returns
TRUE on success, FALSE on failure.
See also
fbTemplateAppendArraySpecId()

◆ fbTemplateAppendSpecId()

gboolean fbTemplateAppendSpecId ( fbTemplate_t tmpl,
const fbInfoElementSpecId_t spec,
uint32_t  wantedFlags,
GError **  err 
)

Potentially appends an information element described by the specifier to a template.

If the high bits in the wantedFlags parameter include all the high bits of the specifier's flags member, the fbInfoElement_t referenced by the specifier is copied from the template's associated fbInfoModel_t and the element's length is set to that from the specifier.

When the specifier's flags member is 0, the element is always included; otherwise the following must by true: (wantedFlags && flags) == flags. The wantedFlags parameter and flags member support building multiple templates with different information element features from a single specifier.

If wantedFlags prevents the element from being added to the template, no other checks of spec are performed and the function returns TRUE.

Fills err and returns FALSE if the enterpriseId and elementId of spec reference an unknown element, if the len_override value in spec is illegal for the fbInfoElementDataType_t of the element, if tmpl is already associated with a fbSession_t (fbSessionAddTemplate()), or if tmpl is at its maximum size.

Parameters
tmplTemplate to append the information element to.
specSpecifier describing the information element to append.
wantedFlagsFlags on whether to append the info element specifier.
errAn error description, set on failure.
Returns
TRUE on success, FALSE on failure.
See also
fbTemplateAppendArraySpecId() fbTemplateAppendSpec()
Since
libfixbuf 3.0.0

◆ fbTemplateAppendArraySpecId()

gboolean fbTemplateAppendArraySpecId ( fbTemplate_t tmpl,
const fbInfoElementSpecId_t spec,
uint32_t  wantedFlags,
GError **  err 
)

Appends information elements described by a specifier array to a template.

Calls fbTemplateAppendSpecId() for each member of the array until the FB_IESPECID_NULL convenience macro is encountered.

Parameters
tmplTemplate to append the information elements to.
specPointer to first specifier in specifier array to append.
wantedFlagsFlags on whether to append each info element specifier.
errAn error description, set on failure.
Returns
TRUE on success, FALSE on failure.
See also
fbTemplateAppendSpecArray()
Since
libfixbuf 3.0.0

◆ fbTemplateCopy()

fbTemplate_t* fbTemplateCopy ( const fbTemplate_t tmpl,
uint32_t  flags 
)

Creates a new template that is a copy of tmpl perhaps modified by the values specified in flags.

If flags is 0, the new template is an exact copy, having the same elements in the same order, having the same number of scope elements, and the elements having the same lengths.

When flags includes FB_TMPL_COPY_REMOVE_PADDING, the new templace does not contain the paddingOctets elements that were present in tmpl, if any. This may be used when exporting data to create a compact external template from an existing internal template.

When flags includes FB_TMPL_COPY_IGNORE_SCOPE, the options scope of the new template is not set.

Parameters
tmplTemplate to copy
flagsControls features of the new template
Returns
A newly allocated template or NULL in the unlikely event an InfoElement is no longer in the InfoModel.
Since
libfixbuf 3.0.0

◆ fbTemplateCountElements()

uint16_t fbTemplateCountElements ( const fbTemplate_t tmpl)

Determines number of information elements in a template.

Parameters
tmplA template
Returns
information element count

◆ fbTemplateSetOptionsScope()

gboolean fbTemplateSetOptionsScope ( fbTemplate_t tmpl,
uint16_t  scope_count 
)

Sets the number of information elements in a template that are scope.

This causes the template to become an options template. This function may be called after all the scope information elements have been appended to the template and before the template has been added to an fbSession_t.

A scope_count argument of zero sets the scope count to the number of IEs.

Returns TRUE on success. Returns FALSE if a scope was previously set for tmpl, if the scope_count is larger than the number of elements, if tmpl is already associated with a fbSession_t (fbSessionAddTemplate()), or if the template contains no elements.

Parameters
tmplTemplate to set scope on
scope_countNumber of scope information elements
Note
The return type was void prior to libfixbuf 3.0.0.

◆ fbTemplateGetOptionsScope()

uint16_t fbTemplateGetOptionsScope ( const fbTemplate_t tmpl)

Determines number of scope information elements in a template.

The template is an options template if nonzero.

Parameters
tmplA template
Returns
scope information element count

◆ fbTemplateContainsElement()

gboolean fbTemplateContainsElement ( const fbTemplate_t tmpl,
const fbInfoElement_t element 
)

Determines if a template contains a given information element.

Matches against information element private enterprise number and number. Returns FALSE if either parameter is NULL.

Parameters
tmplTemplate to search
elementPointer to an information element to search for
Returns
TRUE if the template contains the given IE
See also
fbTemplateContainsElementByName(), fbTemplateContainsSpecId(), fbTemplateFindFieldByElement(), fbTemplateFindFieldByIdent()

◆ fbTemplateFindFieldByElement()

const fbTemplateField_t* fbTemplateFindFieldByElement ( const fbTemplate_t tmpl,
const fbInfoElement_t ie,
uint16_t *  position,
uint16_t  skip 
)

Searches a Template for an Information Element and returns a TemplateField if found.

If position is non-NULL, the search begins from the position it references (where the first position is 0); on success, its referent is updated with the position of the found element. When skip is non-zero, the (skip+1)'th field matching ie is returned.

To visit all elements that use ie, use a construct like:

for (i = 0; fbTemplateFindFieldByElement(t, ie, &i, 0); ++i) { ... }
Parameters
tmplThe template to be searched
ieThe info element to search for
positionThe starting position for search if non-NULL; updated with location of found field
skipThe number of matching fields to ignore before returning
Returns
The field object for ie or NULL if not found
Since
libfixbuf 3.0.0
See also
fbTemplateFindFieldByIdent() to search by an Element's number and enterprise number; fbTemplateFindFieldByDataType() to search by an Element's datatype.

◆ fbTemplateFindFieldByIdent()

const fbTemplateField_t* fbTemplateFindFieldByIdent ( const fbTemplate_t tmpl,
uint32_t  ent,
uint16_t  num,
uint16_t *  position,
uint16_t  skip 
)

Searches a Template for a TemplateField by an fbInfoElement_t's private enterprise number and element number.

If position is non-NULL, the search begins from the position it references (where the first position is 0); on success, its referent is updated with the position of the found element. When skip is non-zero, the (skip+1)'th field matching datatype is returned.

To visit all elements having a particular ident, use a construct like:

for (i = 0; fbTemplateFindFieldByIdent(t, ent, num, &i, 0); ++i) { ... }
Parameters
tmplThe template to be searched
entThe private enterprise number of the element to search for
numThe element number of the element to search for
positionThe starting position for search if non-NULL; updated with location of found field
skipThe number of matching fields to ignore before returning
Returns
The field object for the element number or NULL if not found
Since
libfixbuf 3.0.0
See also
fbTemplateFindFieldByElement() to search when the fbInfoElement_t is available and fbTemplateFindFieldByDataType() to search by an Element's data type.

◆ fbTemplateFindFieldByDataType()

const fbTemplateField_t* fbTemplateFindFieldByDataType ( const fbTemplate_t tmpl,
fbInfoElementDataType_t  datatype,
uint16_t *  position,
uint16_t  skip 
)

Searches a Template for a TemplateField by an fbInfoElement_t's datatype.

If position is non-NULL, the search begins from the position it references (where the first position is 0); on success, its referent is updated with the position of the found element. When skip is non-zero, the (skip+1)'th field matching datatype is returned.

To visit all elements of type dt, use a construct like:

for (i = 0; fbTemplateFindFieldByDataType(t, dt, &i, 0); ++i) { ... }
Parameters
tmplThe template to be searched
datatypeThe type of the info element to search for
positionThe starting position for search if non-NULL; updated with location of found field
skipThe number of matching fields to ignore before returning
Returns
The field object for datatype or NULL if not found
Since
libfixbuf 3.0.0
See also
fbTemplateFindFieldByElement() and fbTemplateFindFieldByIdent() to search for a specific fbInfoElement_t

◆ fbTemplateContainsElementByName()

gboolean fbTemplateContainsElementByName ( const fbTemplate_t tmpl,
const fbInfoElementSpec_t spec 
)

Determines if a template contains at least one instance of a given information element (fbInfoElement_t), specified by name in the template's information model (fbInfoModel_t).

Returns FALSE if tmpl is NULL or if the name in spec does not name a known element.

The len_override and flags members of spec are ignored.

Parameters
tmplTemplate to search
specSpecifier of information element to search for
Returns
TRUE if the template contains the given IE
See also
fbTemplateContainsElement(), fbTemplateContainsAllElementsByName(), fbTemplateContainsAllFlaggedElementsByName(), fbTemplateContainsSpecId()

◆ fbTemplateContainsAllElementsByName()

gboolean fbTemplateContainsAllElementsByName ( const fbTemplate_t tmpl,
const fbInfoElementSpec_t spec 
)

Determines if a template contains at least one instance of each fbInfoElement_t in a given information element specifier array.

The array must be terminated by an empty specifier (FB_IESPEC_NULL). Returns TRUE if the array contains only FB_IESPEC_NULL. Returns FALSE if any names used in spec are unknown by the template's fbInfoModel_t.

Repeating an element's name in spec does not test whether the element appears multiple times in the template. Use fbTemplateFindFieldByElement() to test for multiple occurrences of an element.

The len_override and flags members of InfoElementSpec are ignored.

Parameters
tmplTemplate to search
specPointer to specifier array to search for
Returns
TRUE if the template contains all the given IEs
See also
fbTemplateContainsElementByName(), fbTemplateContainsAllFlaggedElementsByName(), fbTemplateContainsAllArraySpecId()

◆ fbTemplateContainsAllFlaggedElementsByName()

gboolean fbTemplateContainsAllFlaggedElementsByName ( const fbTemplate_t tmpl,
const fbInfoElementSpec_t spec,
uint32_t  wantedFlags 
)

Determines if a template contains at least one instance of each information element in a given information element specifier array that match the given wantedFlags argument.

Returns TRUE if wantedFlags do not match any of the element specifiers in the array or if the array contains only FB_IESPEC_NULL.

Repeating an element's name in spec does not test whether the element appears multiple times in the template. Use fbTemplateFindFieldByElement() to test for multiple occurrences of an element.

The len_override member of InfoElementSpec is ignored.

Parameters
tmplTemplate to search
specPointer to specifier array to search for
wantedFlagsFlags to choose info element specifiers. Specifier elements whose flags member is non-zero and contains high bits that are not present in wantedFlags are not checked.
Returns
TRUE if the template contains all the given IEs
See also
fbTemplateContainsElementByName(), fbTemplateContainsAllElementsByName(), fbTemplateContainsAllFlaggedArraySpecId()

◆ fbTemplateContainsSpecId()

gboolean fbTemplateContainsSpecId ( const fbTemplate_t tmpl,
const fbInfoElementSpecId_t spec 
)

Determines if a template contains at least one instance of a given information element (fbInfoElement_t), specified by the element's enterpriseId and elementId.

The len_override and flags members of spec are ignored.

Parameters
tmplTemplate to search
specSpecifier of information element to search for
Returns
TRUE if the template contains the given IE
Since
libfixbuf-3.0.0
See also
fbTemplateContainsElement(), fbTemplateContainsElementByName(), fbTemplateContainsAllArraySpecId(), fbTemplateContainsAllFlaggedArraySpecId()

◆ fbTemplateContainsAllArraySpecId()

gboolean fbTemplateContainsAllArraySpecId ( const fbTemplate_t tmpl,
const fbInfoElementSpecId_t spec 
)

Determines if a template contains at least one instance of each fbInfoElement_t in a specifier array.

The array must be terminated by an empty specifier (FB_IESPECID_NULL). Returns TRUE if the array contains only FB_IESPECID_NULL.

Repeating an {enterpriseId, elementId} pair in spec does not test whether the element appears multiple times in the template. Use fbTemplateFindFieldByIdent() to test for multiple occurrences of an element.

The len_override and flags members of InfoElementSpecId are ignored.

Parameters
tmplTemplate to search
specPointer to specifier array to search for
Returns
TRUE if the template contains all the given IEs
Since
libfixbuf-3.0.0
See also
fbTemplateContainsSpecId(), fbTemplateContainsAllFlaggedArraySpecId(), fbTemplateContainsAllElementsByName()

◆ fbTemplateContainsAllFlaggedArraySpecId()

gboolean fbTemplateContainsAllFlaggedArraySpecId ( const fbTemplate_t tmpl,
const fbInfoElementSpecId_t spec,
uint32_t  wantedFlags 
)

Determines if a template contains at least one instance of each fbInfoElement_t in a specifier array that match the given wantedFlags argument.

Returns TRUE if wantedFlags do not match any of the element specifiers in the array or if the array contains only FB_IESPECID_NULL.

Repeating an {enterpriseId, elementId} pair in spec does not test whether the element appears multiple times in the template. Use fbTemplateFindFieldByIdent() to test for multiple occurrences of an element.

The len_override member of InfoElementSpecId is ignored.

Parameters
tmplTemplate to search
specPointer to specifier array to search for
wantedFlagsFlags to choose info element specifiers. Specifier elements whose flags member is non-zero and contains high bits that are not present in wantedFlags are not checked.
Returns
TRUE if the template contains all the given IEs
Since
libfixbuf-3.0.0
See also
fbTemplateContainsSpecId(), fbTemplateContainsAllArraySpecId(), fbTemplateContainsAllFlaggedElementsByName()

◆ fbTemplateGetFieldByPosition()

const fbTemplateField_t* fbTemplateGetFieldByPosition ( const fbTemplate_t tmpl,
uint16_t  position 
)

Returns a field in a template at a specific position.

The positions of the first and last fields are 0 and one less than fbTemplateCountElements().

Parameters
tmplPointer to the template
positionIndex of the field to return
Returns
A pointer to the field at position, or NULL if position is greater than number of elements.
Since
libfixbuf 3.0.0.

◆ fbTemplateGetIndexedIE()

const fbTemplateField_t* fbTemplateGetIndexedIE ( const fbTemplate_t tmpl,
uint16_t  position 
)

Deprecated alias for fbTemplateGetFieldByPosition.

Parameters
tmplPointer to the template
positionIndex of the field to return
Returns
A pointer to the field at position, or NULL if position is greater than number of elements.
Deprecated:
Use fbTemplateGetFieldByPosition()

◆ fbTemplateGetInfoModel()

fbInfoModel_t* fbTemplateGetInfoModel ( const fbTemplate_t tmpl)

Returns the information model, as understood by the template.

Parameters
tmplTemplate Pointer
Returns
The information model
Since
libfixbuf 2.1.0

◆ fbTemplateFreeUnused()

void fbTemplateFreeUnused ( fbTemplate_t tmpl)

Frees a template if it is not currently in use by any Session.

Use this to clean up while creating templates in case of error.

Parameters
tmpltemplate to free

◆ fbTemplateGetContext()

void* fbTemplateGetContext ( const fbTemplate_t tmpl)

Gets the context pointer associated with a Template.

The context pointer is set during the fbNewTemplateCallback_fn when the new template is received or by fbTemplateSetContext().

Parameters
tmplTemplate Pointer
Returns
ctx The application Context Pointer

◆ fbTemplateSetContext()

void fbTemplateSetContext ( fbTemplate_t tmpl,
void *  tmpl_ctx,
void *  app_ctx,
fbTemplateCtxFree_fn  ctx_free 
)

Sets the context pointers on a Template.

If there is an existing context pointer on the Template, its free function (fbTemplateCtxFree_fn) is called before overwriting the existing values.

Parameters
tmplThe Template to update.
tmpl_ctxThe context pointer to set, may be NULL.
app_ctxThe application context pointer to set, may be NULL.
ctx_freeThe function to be called to free tmpl_ctx, may be NULL.
See also
fbSessionAddNewTemplateCallback(), fbNewTemplateCallback_fn
Since
libfixbuf 2.2.0

◆ fbTemplateGetIELenOfMemBuffer()

uint16_t fbTemplateGetIELenOfMemBuffer ( const fbTemplate_t tmpl)

Returns the number of octets required for a data buffer (an octet array) to store a data record described by this template.

Another description is this is the length of the record when this template is used as an internal template.

Parameters
tmplThe Template to query.
Since
libfixbuf 2.2.0

◆ fbTemplatesAreEqual()

gboolean fbTemplatesAreEqual ( const fbTemplate_t tmpl1,
const fbTemplate_t tmpl2 
)

Returns TRUE when templates tmpl1 and tmpl2 are equal.

To be equal, the templates must have same set of fbInfoElement_t's in the same order, each element pair must have the same length, and the templates must have the same options scope.

Parameters
tmpl1A template to compare
tmpl2A template to compare
Returns
TRUE when the templates are equal, non-zero otherwise
See also
fbTemplatesCompare(), fbTemplateSetCompare().
Since
libfixbuf 3.0.0

◆ fbTemplatesCompare()

int fbTemplatesCompare ( const fbTemplate_t tmpl1,
const fbTemplate_t tmpl2,
unsigned int  flags 
)

Compares templates tmpl1 and tmpl2 according to flags and returns 0 if the are the same and non-zero otherwise.

Currently the return value cannot be used for ordering templates since it may return any non-zero value when the templates differ. In the future, the function will be modified to return a value suitable for ordering the templates.

If flags is 0, this function is similar to fbTemplatesAreEqual(): the templates must have the same elements in the same order, matching elements must have the same length, and the scope counts must be the same.

The following values may be ORed and passed as flags to affect the comparison:

FB_TMPL_CMP_IGNORE_PADDING - Causes the comparison to ignore any paddingOctets elements in the templates.

FB_TMPL_CMP_IGNORE_LENGTHS - Causes the comparison to ignore the lengths when comparing elements between the templates.

FB_TMPL_CMP_IGNORE_SCOPE - Causes the comparison to ignore the options scope count when comparing the templates.

Parameters
tmpl1A template to compare
tmpl2A template to compare
flagsControls what aspects of the templates are checked
Returns
0 when the templates are the same, non-zero otherwise
See also
fbTemplatesAreEqual(), fbTemplatesSetCompare()
Since
libfixbuf 3.0.0

◆ fbTemplatesSetCompare()

fbTemplatesSetCompareStatus_t fbTemplatesSetCompare ( const fbTemplate_t tmpl1,
const fbTemplate_t tmpl2,
uint16_t *  matching_fields,
unsigned int  flags 
)

Compares two Templates to determine if one is a subset of the other.

(This description uses "subset" and "superset", but Templates may contain repeated elements and are therefore "multisets". The function tests whether one Template is sub-multiset of the other.)

To be a subset, all elements in one tmpl1 must be contained in tmpl2 with at least their multiplicity in tmpl1. If tmpl2 is a subset of tmpl1, then tmpl1 is a superset of tmpl2.

When comparing elements, the lengths must be identical unless FB_TMPL_CMP_IGNORE_LENGTHS is included in flags. Elements of type paddingOctets are compared unless FB_TMPL_CMP_IGNORE_PADDING is included in flags.

When matching_fields is non-NULL, its referent is set to the number of elements the templates have in common.

Parameters
tmpl1The first template to compare
tmpl2The second template to compare
flagsControls what aspects of the templates are checked
matching_fieldsOutput value to get the number of elements they have in common; may be NULL
Returns
FB_TMPL_SETCMP_EQUAL if the templates have the same elements, FB_TMPL_SETCMP_SUBSET if tmpl1 is a strict subset of tmpl2, FB_TMPL_SETCMP_SUPERSET if tmpl1 is a strict superset of tmpl2, FB_TMPL_SETCMP_COMMON if the templates have at least one common element, FB_TMPL_SETCMP_DISJOINT if the templates have no elements in common
See also
fbTemplatesAreEqual(), fbTemplatesCompare()
Since
libfixbuf 3.0.0

◆ fbRecordGetFieldCount()

uint16_t fbRecordGetFieldCount ( const fbRecord_t record)

Returns the number of fields in a record.

Parameters
recordThe record to get the field count of
Since
libfixbuf 3.0.0

◆ fbRecordFreeLists()

void fbRecordFreeLists ( fbRecord_t record)

Releases all of the memory allocated during transcode of this record, freeing the list structures, recursively, allocated when fixbuf was encoding or decoding the record.

Does not free the memory referenced by the rec member of record.

Parameters
recordThe record to be cleared.
Since
libfixbuf 3.0.0

◆ fbRecordValueClear()

void fbRecordValueClear ( fbRecordValue_t value)

Releases any memory used by the string buffer on value (that is used to store the fbVarfield_t) and re-initializes value.

Does nothing if value is NULL.

Does not release any memory associated with the list structures.

Parameters
valueThe value to be cleared.
Since
libfixbuf 3.0.0
See also
To clear value while taking ownership of the string buffer, use fbRecordValueTakeVarfieldBuf().

◆ fbRecordValueCopy()

fbRecordValue_t* fbRecordValueCopy ( fbRecordValue_t dstValue,
const fbRecordValue_t srcValue 
)

Copies srcValue to dstValue and returns dstValue.

If the fbInfoElementDataType_t of the fbInfoElement_t referenced by srcValue is string (FB_STRING) or octetArray (FB_OCTET_ARRAY), creates a new string buffer on dstValue to hold the value. Otherwise, does a shallow copy of the value. Note that lists are NOT recursively copied by this function.

The caller should fbRecordValueClear() dstValue once it is no longer needed.

The function assumes dstValue is empty. If it previously held a string buffer, call fbRecordValueClear() on it before calling this function.

Parameters
dstValueThe location to store the copied value.
srcValueThe value to be copied.
Returns
dstValue
Since
libfixbuf 3.0.0

◆ fbRecordValueTakeVarfieldBuf()

gchar* fbRecordValueTakeVarfieldBuf ( fbRecordValue_t value)

Returns a pointer to the string buffer used by value to store fbVarfield_t values and transfers ownership of that buffer to the caller.

The caller must use g_free() to release the memory when it is no longer needed. Returns NULL if value is NULL or if there is no string buffer on value.

Since
libfixbuf 3.0.0

◆ fbRecordGetValueForField()

gboolean fbRecordGetValueForField ( const fbRecord_t record,
const fbTemplateField_t field,
fbRecordValue_t value 
)

Gets the value from a Record given a Field used by the Record's fbTemplate_t.

The value is returned via an fbRecordValue_t structure.

If field is owned by the fbTemplate_t currently associated with record, fills the referent of value with that field's value in record and returns TRUE. Otherwise leaves value unchanged and returns FALSE. If field is NULL, returns FALSE.

When getting a value of type FB_STRING or FB_OCTET_ARRAY, the value is copied into a buffer on value. Use fbRecordValueClear() to free this memory or fbRecordValueTakeVarfieldBuf() to take ownership of it.

To get a TemplateField from a Template, use fbTemplateGetFieldByPosition(), fbTemplateFindFieldByElement(), fbTemplateFindFieldByDataType(), and fbTemplateFindFieldByIdent().

Parameters
recordThe record to get the value from.
fieldThe field to get the value of.
valueAn output parameter to fill with the value.
Returns
TRUE unless field is NULL or not owned by the Template of record
Since
libfixbuf 3.0.0
See also
fbRecordCopyFieldValue() for alternate way to get the value of a Field.

◆ fbRecordCopyFieldValue()

gboolean fbRecordCopyFieldValue ( const fbRecord_t record,
const fbTemplateField_t field,
void *  dest,
size_t  destlen 
)

Copies the value from a Record given a Field used by the Record's fbTemplate_t.

The value is copied to the specified destination.

If field is owned by the Template currently associated with record and the destlen value has exactly the correct value, copies the value of the field to dest and returns TRUE. Otherwise leaves dest unchanged and returns FALSE.

The correct value of destlen depends on the fbInfoElementDataType_t of the Field:

FB_OCTET_ARRAY, FB_STRING – sizeof(fbVarfield_t); dest should be treated as an fbVarfield_t regardless of how the value is represented in libfixbuf. There is no guarantee that the value is NUL terminated.

FB_UINT_8, FB_INT_8, FB_BOOL – 1

FB_UINT_16, FB_INT_16 – 2

FB_UINT_32, FB_INT_32, FB_IP4_ADDR, FB_DT_SEC, FB_FLOAT_32 – 4

FB_MAC_ADDR – 6

FB_UINT_64, FB_INT_64, FB_DT_MILSEC, FB_FLOAT_64 – 8

FB_DT_MICROSEC, FB_DT_NANOSEC – sizeof(struct timespec); dest should be treated as struct timespec.

FB_IP6_ADDR – 16

FB_BASIC_LIST – sizeof(fbBasicList_t *); dest should be treated as a pointer to an fbBasicList_t.

FB_SUB_TMPL_LIST – sizeof(fbSubTemplateList_t *); dest should be treated as a pointer to an fbSubTemplateList_t.

FB_SUB_TMPL_MULTI_LIST – sizeof(fbSubTemplateMultiList_t *); dest should be treated as a pointer to an fbSubTemplateMultiList_t.

To get a TemplateField from a Template, use fbTemplateGetFieldByPosition(), fbTemplateFindFieldByElement(), fbTemplateFindFieldByDataType(), and fbTemplateFindFieldByIdent().

Parameters
recordThe record to get the value from.
fieldThe field to get the value of.
destThe destination where the value should be copied.
destlenThe length of the destination which must exactly match the required length for the data type.
Returns
TRUE unless field is NULL, field is not owned by the Template of record, or destlen is incorrect.
Since
libfixbuf 3.0.0
See also
fbRecordGetValueForField() for alternate way to get the value of a Field.

◆ fbRecordFindValueForInfoElement()

gboolean fbRecordFindValueForInfoElement ( const fbRecord_t record,
const fbInfoElement_t ie,
fbRecordValue_t value,
uint16_t *  position,
uint16_t  skip 
)

Searches a Record for an Element and gets its Value.

This function is a convenience wrapper over fbTemplateFindFieldByElement() and fbRecordGetValueForField().

Parameters
recordThe record to get the value from.
ieThe info element to search for
valueAn output parameter to fill with the value.
positionThe starting position for search if non-NULL; updated with location of found field
skipThe number of matching IEs to ignore before returning
Returns
TRUE if a matching element is found, FALSE otherwise
Since
libfixbuf 3.0.0

◆ fbRecordFindBasicListOfIE()

const fbBasicList_t* fbRecordFindBasicListOfIE ( const fbRecord_t record,
const fbInfoElement_t contentsElement,
uint16_t *  position,
uint16_t  skip 
)

Searches record for a basicList of contentsElement values.

Specifically, searches record for element whose type is FB_BASIC_LIST, where the list contains contentsElement items; if found, returns the basicList. If not found, returns NULL.

If position is non-NULL, the search begins from that element position (where the first position is 0); on success, its referent is updated with the position of the found element. When skip is non-zero, the (skip+1)'th basicList whose contents matches contentsElement is returned.

Parameters
recordThe Record to be searched
contentsElementThe element to search for
positionThe starting position for search if non-NULL; updated with location of found field
skipThe number of matching lists to ignore before returning
Returns
the matching list is found, NULL otherwise
Since
libfixbuf 3.0.0

◆ fbRecordFindStlOfTemplate()

const fbSubTemplateList_t* fbRecordFindStlOfTemplate ( const fbRecord_t record,
const fbTemplate_t tmpl,
uint16_t *  position,
uint16_t  skip 
)

Searches record for a subTemplateList that uses tmpl.

Specifically, searches record for element whose type is FB_SUB_TMPL_LIST, where the list uses the template tmpl; if found, returns the subTemplateList. If not found, returns NULL.

If position is non-NULL, the search begins from that element position (where the first position is 0); on success, its referent is updated with the position of the found element. When skip is non-zero, the (skip+1)'th subTemplateList that uses tmpl is returned.

Parameters
recordThe Record to be searched
tmplThe Template to search for
positionThe starting position for search if non-NULL; updated with location of found field
skipThe number of matching lists to ignore before returning
Returns
The matching list is found, NULL otherwise
Since
libfixbuf 3.0.0

◆ fbRecordFindAllElementValues()

int fbRecordFindAllElementValues ( const fbRecord_t record,
const fbInfoElement_t ie,
unsigned int  flags,
fbRecordValueCallback_fn  callback,
void *  ctx 
)

Recursively searches a Record and all its sub-records for an Info Element.

Checks the fbTemplate_t of record for elements that match ie. For each one found, callback is invoked with the record, the field, the value of that element in record, and a user-provided context.

The InfoElement used by each BasicList on record is checked, for any that match ie, callback is invoked as described above and includes a reference to the BasicList.

The function also recurses into each SubTemplateList and SubTemplateMultiList on record looking for matching elements.

If any invocation of callback returns a non-zero value, recursion stops and that return value is passed to the previous invocation and eventually to the caller.

Parameters
recordThe Record to be searched
ieThe Information Element to search for
flagsIgnored (place to tailor how the recursion happens)
callbackThe function invoked on each value found
ctxA context for the caller's use
Returns
The result of the callback or 0.
Since
libfixbuf 3.0.0.

◆ fbRecordFindAllSubRecords()

int fbRecordFindAllSubRecords ( const fbRecord_t record,
uint16_t  tid,
unsigned int  flags,
fbRecordSubRecordCallback_fn  callback,
void *  ctx 
)

Recursively searches a Record for uses of a fbTemplate_t having a particular ID.

Checks whether the fbTemplate_t of record has ID tid. If so, callback is invoked with the record and a user-provided context.

The function also recurses into each BasicList, SubTemplateList, and SubTemplateMultiList on record looking for uses of the Template ID.

If any invocation of callback returns a non-zero value, recursion stops and that return value is passed to the previous invocation and eventually to the caller.

Parameters
recordThe Record to be searched
tidThe Template ID to search for
flagsIgnored (place to tailor how the recursion happens)
callbackThe function invoked on each record found
ctxA context for the caller's use
Returns
The result of the callback or 0.
Since
libfixbuf 3.0.0.

◆ fbRecordCopyToTemplate()

gboolean fbRecordCopyToTemplate ( const fbRecord_t srcRec,
fbRecord_t dstRec,
const fbTemplate_t tmpl,
uint16_t  tid,
GError **  err 
)

Copies a Record to a destination Record that uses a different Template.

Given a source Record srcRec, a destination Record dstRec that has a valid rec buffer, and a destination Template tmpl, this function copies the values from srcRec to dstRec for the fields the Records have in common. Fields in tmpl that do not have a match in srcRec are left initialized to 0 or NULL. The tmpl and tid parameters are assigned to the 'tmpl' and tid members of dstRec; the tid value is not otherwise used.

srcRec and dstRec must be different fbRecord_t objects that use different buffers.

When copying an fbVarfield_t, the dstRec is set to point at the data in srcRec. Reusing the srcRec will affect the data in dstRec.

For structured data items (lists), the list object on dstRec is initialized with the same element type (fbBasicList_t) or template (fbSubTemplateList_t) as on srcRec, but the dstRec is initialized with size 0. The caller must manually resize the list and copy the data between the lists as desired, including re-initializing the list if needed.

Parameters
srcRecThe Record to be copied.
dstRecThe destination Record to copy srcRec into.
tmplThe Template for the destination Record.
tidThe Template ID for the destination Record.
errAn error description, set on error.
Returns
TRUE on success or FALSE on failure.
Since
libfixbuf 3.0.0.

◆ fbSessionAlloc()

fbSession_t* fbSessionAlloc ( fbInfoModel_t model)

Allocates an empty transport session state container.

The new session is associated with the given information model, contains no templates, and is usable either for collection or export.

Each fbExporter_t, fbListener_t, and fbCollector_t must have its own session; session state cannot be shared.

The fbSession_t returned by this function is not freed by calling fBufFree() or fbListenerFree(). It should be freed by the application by calling fbSessionFree().

Exits the application on allocation failure.

Parameters
modelAn information model. Not freed by fbSessionFree(). Must be freed by user after calling fbSessionFree().
Returns
A newly allocated, empty session state container.

◆ fbSessionSetMetadataExportElements()

uint16_t fbSessionSetMetadataExportElements ( fbSession_t session,
gboolean  enabled,
uint16_t  tid,
GError **  err 
)

Configures a session to export type information for enterprise-specific information elements as options records according to RFC 5610.

Regardless of the enabled value, this function creates the type information template and adds it to the session with the template ID tid or an arbitrary ID when tid is FB_TID_AUTO.

If enabled is TRUE, the information metadata is exported each time fbSessionExportTemplates() is called.

When collecting, use fBufSetAutomaticElementInsert() to automatically update the information model with these RFC 5610 elements.

Parameters
sessionpointer
enabledTRUE to enable type metadata export, FALSE to disable
tidthe template id to use for type-information records
errerror mesasge
Returns
the template id for type-information records or 0 if the template could not be added to the session.
Since
libfixbuf 2.3.0

◆ fbSessionSetMetadataExportTemplates()

uint16_t fbSessionSetMetadataExportTemplates ( fbSession_t session,
gboolean  enabled,
uint16_t  tmplInfoTid,
uint16_t  blInfoTid,
GError **  err 
)

Configures a Session to export template metadata (fbTemplateInfo_t) as options records.

Template metadata includes the name of a Template and optionally additional information as described by fbTemplateInfoInit() and fbTemplateInfoAddBasicList().

If enabled, the metadata is exported each time fbSessionExportTemplates() or fbSessionExportTemplate() is called. In addition, the metadata is exported when fbSessionAddTemplate() is called if the tmplInfo parameter is not NULL and the Session is associated with an fbExporter_t.

Regardless of the enabled value, this function creates the template-metadata template and adds it to the session with the template ID tid or an arbitrary ID when tid is FB_TID_AUTO.

When collecting, use fBufSetAutomaticMetadataAttach() to recognize the Template Metadata records.

Parameters
sessionpointer
enabledTRUE to enable template metadata export, FALSE to disable
tmplInfoTidthe template id to use for TemplateInfo records
blInfoTidthe template id to use for the fbBasicListInfo_t records
errerror mesasge
Returns
the template id for TemplateInfo records or 0 if the template could not be added to the session.
Since
libfixbuf 2.3.0, modified in libfixbuf 3.0.0 to take blInfoTid.

◆ fbSessionGetInfoModel()

fbInfoModel_t* fbSessionGetInfoModel ( const fbSession_t session)

Gets the info model for the session.

Parameters
session
Returns
a pointer to the info model for the session

◆ fbSessionAddNewTemplateCallback()

void fbSessionAddNewTemplateCallback ( fbSession_t session,
fbNewTemplateCallback_fn  callback,
void *  app_ctx 
)

This function sets the callback that allows the application to set its own context variable with a new incoming template.

Assigning a callback is not required and is only useful if the application either needs to store some information about the template or to prevent certain nested templates from being transcoded. If the application's template contains a subTemplateMultiList or subTemplateList and the callback is not used, all incoming templates contained in these lists will be fully transcoded and the application is responsible for freeing any nested lists contained within those objects.

This function should be called after fbSessionAlloc(). Fixbuf often clones sessions upon receiving a connection. In the TCP case, the application has access to the session right after fbListenerWait() returns by calling fBufGetSession(). In the UDP case, the application does not have access to the fbSession until after a call to fBufNext() for fBufNextCollectionTemplate() and by this time the application may have already received some templates. Therefore, it is important to call this function before fBufNext(). Any callbacks added to the session will be carried over to cloned sessions.

Parameters
sessionpointer session to assign the callback to
callbackthe function that should be called when a new template is received
app_ctxparameter that gets passed into the callback function. This can be used to pass session-specific information state information to the callback function.

◆ fbSessionSetCallbackCopyTemplates()

void fbSessionSetCallbackCopyTemplates ( fbSession_t incomingSession,
fbSession_t exportSession 
)

Arranges for templates read by incomingSession to be copied to exportSession by setting the new template callback.

This is a convenience function that sets the new template callback function (see fbSessionAddNewTemplateCallback()) on incomingSession to fbSessionCopyIncomingTemplatesCallback(), using exportSession as the value for the app_ctx paramter.

Parameters
incomingSessionSession reading the templates to be copied
exportSessionSession where the templates are to be copied
Since
libfixbuf 3.0.0

◆ fbSessionCopyIncomingTemplatesCallback()

void fbSessionCopyIncomingTemplatesCallback ( fbSession_t incomingSession,
uint16_t  tid,
fbTemplate_t tmpl,
void *  exportSession,
void **  tmpl_ctx,
fbTemplateCtxFree_fn tmpl_ctx_free_fn 
)

Arranges for templates read by incomingSession to be copied to exportSession.

This function may be used as the value of the callback parameter to fbSessionAddNewTemplateCallback(). The caller should use exportSession as the value for the app_ctx parameter to that function. (See fbSessionSetCallbackCopyTemplates() that simplies this process.)

When invoked, the function calls fbSessionAddTemplatesForExport() using the exportSession, tid, and tmpl as the value for the first three parameters.

Parameters
incomingSessionSession reading the templates to be copied
tidID for the template that was received
tmplTemplate that was received
exportSessionSession where the templates are to be copied
tmpl_ctxUnused
tmpl_ctx_free_fnUnused
Since
libfixbuf 3.0.0

◆ fbSessionAddTemplatePair()

void fbSessionAddTemplatePair ( fbSession_t session,
uint16_t  ext_tid,
uint16_t  int_tid 
)

Adds an external-internal fbTemplate_t mapping pair for list elements in a Session.

When used on a Session connected to an fbCollector_t, it tells the Session that any sub-records in a an fbSubTemplateList_t or fbSubTemplateMultiList_t that use the incoming external template ext_tid should be mapped to (transcoded into) the internal template int_tid.

If the value of int_tid is 0, the Session does not decode any list where the external template is ext_tid. This allows a collector to specify which templates that are used in lists it wishes handle.

For any other int_tid, the Session transcodes list sub-records that use ext_tid to the Template whose ID is int_tid. If int_tid equals ext_tid and the Session does not contain a Template for int_tid, the transcoder uses the external template as the internal template.

The template pair is not added if int_tid has a value other than ext_tid or 0 and session does not have an internal template for int_tid.

Once any template pair has been added to a Session, the default behavior is that all unspecified incoming external template IDs used by lists are ignored. If no template pairs exist for a Session, the default behavior is that all incoming external templates used by lists are fully decoded.

When the Session is used by an fbExporter_t, the template mapping pairs set by this function are not used.

Parameters
sessionpointer to the session to add the pair to
ext_tidthe external template ID
int_tidthe internal template ID used to decode the data when the associated external template is used

◆ fbSessionRemoveTemplatePair()

void fbSessionRemoveTemplatePair ( fbSession_t session,
uint16_t  ext_tid 
)

Removes a template mapping pair for list sub-records from the Session.

This is called by fixbuf when a template is revoked from the session by the node on the other end of the connection.

Parameters
sessionpointer to the session to remove the pair from
ext_tidthe external template ID for the pair
See also
fbSessionAddTemplatePair()

◆ fbSessionLookupTemplatePair()

uint16_t fbSessionLookupTemplatePair ( const fbSession_t session,
uint16_t  ext_tid 
)

Finds the internal template ID to use for sub-records in a list that use the external template ext_tid in session.

Returns the internal ID for ext_tid as set by fbSessionAddTemplatePair(). If no template pairs have been specified for the Session, returns ext_tid. If template pairs exist and ext_tid is not found, returns 0.

Parameters
sessionpointer to the session used to find the pair
ext_tidexternal template ID used to find a pair
Returns
the internal template ID from the pair
See also
fbSessionAddTemplatePair()

◆ fbSessionFree()

void fbSessionFree ( fbSession_t session)

Frees a transport session state container.

This is done automatically when freeing the listener or buffer with which the session is associated. Use this call if a session needs to be destroyed before it is associated.

Parameters
sessionsession state container to free.

◆ fbSessionResetExternal()

void fbSessionResetExternal ( fbSession_t session)

Resets the external state (sequence numbers and templates) in a session state container.

FIXME: Verify that this call actually makes sense; either that a session is reassociatable with a new collector, or that you need to do this when reassociating a collector with a connection. Once this is done, rewrite this documentation

Parameters
sessionsession state container to reset

◆ fbSessionSetDomain()

void fbSessionSetDomain ( fbSession_t session,
uint32_t  domain 
)

Sets the current observation domain on a session.

The domain is used to scope sequence numbers and external templates. This is called automatically during collection, but must be called to set the domain for export before adding external templates or writing records.

Notice that a domain change does not automatically cause any associated export buffers to emit messages; a domain change takes effect with the next message started. Therefore, call fBufEmit() before setting the domain on the buffer's associated session.

Parameters
sessiona session state container
domainID of the observation domain to set

◆ fbSessionGetDomain()

uint32_t fbSessionGetDomain ( const fbSession_t session)

Retrieves the current domain on a session.

Parameters
sessiona session state container
Returns
the ID of the session's current observation domain

◆ fbSessionGetLargestInternalTemplateSize()

uint16_t fbSessionGetLargestInternalTemplateSize ( fbSession_t session)

Gets the largest decoded size of an internal template in the session.

This is the number of bytes needed by store the largest record described by an internal template in the session.

Parameters
sessiona session
Returns
The number of bytes needed to store the largest record described by an internal template in the session
Since
libfixbuf 2.2.0

◆ fbSessionGetCollector()

fbCollector_t* fbSessionGetCollector ( const fbSession_t session)

Retrieves the Collector that was associated with session by an explicit call to fBufAllocForCollection() or implicitly by fbListenerWait().

Returns NULL if session is not associated with a Collector (for example, it is being used for export).

One place this function is helpful is in the function assigned to fbSessionAddNewTemplateCallback() so that the callback may access the Collector and its context.

Parameters
sessiona session state container
Returns
fbCollector_t the collector that was created with the session

◆ fbSessionExportTemplate()

gboolean fbSessionExportTemplate ( fbSession_t session,
uint16_t  tid,
GError **  err 
)

Exports a single external fbTemplate_t in the current domain of a given Session.

Writes the template to the associated export fBuf_t. May cause a message to be emitted if the associated export buffer is in automatic mode, or return with FB_ERROR_EOM if the associated export buffer is not in automatic mode.

Also exports an options record containing the template's metadata if a fbTemplateInfo_t was specified to fbSessionAddTemplate() and metadata export is enabled (fbSessionSetMetadataExportTemplates()).

Parameters
sessiona session state container associated with an export buffer
tidtemplate ID within current domain to export
erran error description, set on failure.
Returns
TRUE on success, FALSE on failure.

◆ fbSessionExportTemplates()

gboolean fbSessionExportTemplates ( fbSession_t session,
GError **  err 
)

Exports all external templates in the current domain of a given session.

Writes templates to the associated export buffer. May cause a message to be emitted if the associated export buffer is in automatic mode, or return with FB_ERROR_EOM if the associated export buffer is not in automatic mode.

When template and/or information element metadata is enabled, those options records are also exported.

All external templates are exported each time this function is called.

Parameters
sessiona session state container associated with an export buffer
erran error description, set on failure.
Returns
TRUE on success, FALSE on failure.
See also
fbSessionSetMetadataExportTemplates() to enable template metadata, fbSessionSetMetadataExportElements() to enable information element metadata

◆ fbSessionAddTemplate()

uint16_t fbSessionAddTemplate ( fbSession_t session,
gboolean  internal,
uint16_t  tid,
fbTemplate_t tmpl,
fbTemplateInfo_t tmplInfo,
GError **  err 
)

Adds a Template to a Session.

Gives the Template the ID specified in tid, or assigns the Template an arbitrary ID if tid is FB_TID_AUTO.

If the Template is external (internal is false), adds the Template to the current domain and exports the Template if the Session is already associated with an export buffer (fBuf_t).

The tmplInfo parameter, which may be NULL, provides information about the Template including a name, and this data is exported as Option Records when the Session has been configured to do so (fbSessionSetMetadataExportTemplates()). When internal is TRUE, the tmplInfo parameter is ignored. When internal is FALSE and tmplInfo is provided, it must have a valid name. If the Session is associated with an export buffer and metadata export is enabled, the TemplateInfo is exported prior to exporting the Template.

After this call, the Session owns the TemplateInfo and will free it when the Session is freed. TemplateInfo may exist in exactly one Session; use fbTemplateInfoCopy() to add a copy of TemplateInfo to a different Session.

Calling this function twice with the same parameters may cause the Template to be freed and the Session to keep a handle to the invalid Template. If necessary, first use fbSessionGetTemplate() to check for the presence of the Template on the Session.

Parameters
sessionA session state container
internalTRUE if the template is internal, FALSE if external.
tidTemplate ID to assign, replacing any current template in case of collision; or FB_TID_AUTO to assign a new tId.
tmplTemplate to add
tmplInfoThe TemplateInfo for tmpl or NULL.
errAn error description, set on failure
Returns
The template ID of the added template, or 0 on failure.
Since
Modified in libfixbuf 3.0.0 to take the tmplInfo parameter.

◆ fbSessionAddTemplatesForExport()

uint16_t fbSessionAddTemplatesForExport ( fbSession_t session,
uint16_t  tid,
fbTemplate_t tmpl,
fbTemplateInfo_t tmplInfo,
GError **  err 
)

Adds a template to a session being used for export as both an internal template and an external template.

This is a convenience function to save the caller from invoking fbSessionAddTemplate() multiple times.

The function calls fbTemplateCopy() with flags parameter as FB_TMPL_COPY_REMOVE_PADDING to remove padding elements from tmpl, and adds that template as an external template on session with template ID tid, using fbSessionAddTemplate(). It then calls fbSessionAddTemplate() to add the original tmpl argument as an internal template using the template ID returned when the external template was added.

Parameters
sessionA session state container
tidTemplate ID to assign, replacing any current template in case of collision; or FB_TID_AUTO for a new tId.
tmplTemplate to add
tmplInfoTemplate metadata
errerror description, set on error
Returns
template id of newly added template, 0 on error
See also
fbSessionAddTemplate() for additional information.
Since
libfixbuf 3.0.0

◆ fbSessionRemoveTemplate()

gboolean fbSessionRemoveTemplate ( fbSession_t session,
gboolean  internal,
uint16_t  tid,
GError **  err 
)

Removes a template from a session.

If external, removes the template from the current domain, and exports a template revocation set if the session is associated with an export buffer.

Parameters
sessionA session state container
internalTRUE if the template is internal, FALSE if external.
tidTemplate ID to remove.
errAn error description, set on failure
Returns
TRUE on success, FALSE on failure.

◆ fbSessionGetTemplate()

fbTemplate_t* fbSessionGetTemplate ( const fbSession_t session,
gboolean  internal,
uint16_t  tid,
GError **  err 
)

Retrieves a template from a session by ID.

If external, retrieves the template within the current domain.

Parameters
sessionA session state container
internalTRUE if the template is internal, FALSE if external.
tidID of the template to retrieve.
errAn error description, set on failure. May be NULL.
Returns
The template with the given ID, or NULL on failure.

◆ fbExporterAllocNet()

fbExporter_t* fbExporterAllocNet ( const fbConnSpec_t spec)

Allocates an exporting process endpoint for a network connection.

The remote collecting process is specified by the given connection specifier. The underlying socket connection is not opened until the first message is emitted from the buffer associated with the exporter.

Exits the application on allocation failure or if libfixbuf does not support the network connection type.

Parameters
specremote endpoint connection specifier. A copy is made for the exporter, it is freed later. User is responsible for original spec pointer
Returns
a new exporting process endpoint

◆ fbExporterAllocFile()

fbExporter_t* fbExporterAllocFile ( const char *  path)

Allocates an exporting process endpoint for a named file.

The underlying file will not be opened until the first message is emitted from the buffer associated with the exporter.

Exits the application on allocation failure.

Parameters
pathpathname of the IPFIX File to write, or "-" to open standard output. Path is duplicated and handled. Original pointer is up to the user.
Returns
a new exporting process endpoint

◆ fbExporterAllocBuffer()

fbExporter_t* fbExporterAllocBuffer ( uint8_t *  buf,
uint16_t  bufsize 
)

Allocates an exporting process to use the existing buffer buf having the specified size.

Each call to fBufEmit() copies data into buf starting at buf[0]; use fbExporterGetMsgLen() to get the number of bytes copied into buf.

Exits the application on allocation failure.

Parameters
bufexisting buffer that IPFIX messages are copied to
bufsizesize of the buffer
Returns
a new exporting process endpoint

◆ fbExporterAllocFP()

fbExporter_t* fbExporterAllocFP ( FILE *  fp)

Allocates an exporting process endpoint for an opened ANSI C file pointer.

Exits the application on allocation failure.

Parameters
fpopen file pointer to write to. File pointer is created and freed outside of the Exporter functions.
Returns
a new exporting process endpoint

◆ fbExporterSetStream()

void fbExporterSetStream ( fbExporter_t exporter,
int  sctp_stream 
)

Sets the SCTP stream for the next message exported.

To change the SCTP stream used for export, first emit any message in the exporter's associated buffer with fbufEmit(), then use this call to set the stream for the next message. This call cancels automatic stream selection, use fbExporterAutoStream() to re-enable it. This call is a no-op for non-SCTP exporters.

Parameters
exporteran exporting process endpoint.
sctp_streamSCTP stream to use for next message.

◆ fbExporterAutoStream()

void fbExporterAutoStream ( fbExporter_t exporter)

Enables automatic SCTP stream selection for the next message exported.

Automatic stream selection is the default; use this call to re-enable it on a given exporter after using fbExporterSetStream(). With automatic stream selection, the minimal behavior specified in the original IPFIX protocol (RFC xxxx) is used: all templates and options templates are exported on stream 0, and all data is exported on stream 1. This call is a no-op for non-SCTP exporters.

Parameters
exporteran exporting process endpoint.

◆ fbExporterClose()

void fbExporterClose ( fbExporter_t exporter)

Forces the file or socket underlying an exporting process endpoint to close.

No effect on open file endpoints. The file or socket may be reopened on a subsequent message emission from the associated buffer.

Parameters
exporteran exporting process endpoint.

◆ fbExporterGetMsgLen()

size_t fbExporterGetMsgLen ( const fbExporter_t exporter)

Gets the (transcoded) message length that was copied to the exporting buffer upon fBufEmit() when using fbExporterAllocBuffer().

Parameters
exporteran exporting process endpoint.

◆ fbExporterGetOctetCount()

size_t fbExporterGetOctetCount ( const fbExporter_t exporter)

Gets the number of octets that have been written to the exporter's file, socket, or buffer since the exporter was opened (allocated for FP exporters) or the counter was last reset.

The returned value does not include any partial messages in an fBuf_t that have not yet been emitted to the exporter.

Parameters
exporteran exporting process endpoint.
See also
fbExporterGetOctetCountAndReset(), fbExporterResetOctetCount(), fBufEmit()
Since
libfixbuf 3.0.0

◆ fbExporterGetOctetCountAndReset()

size_t fbExporterGetOctetCountAndReset ( fbExporter_t exporter)

Gets the number of octets that have been written to the exporter's file, socket, or buffer since the exporter was opened (allocated for FP exporters) or the counter was last reset and resets the counter.

Parameters
exporteran exporting process endpoint.
See also
fbExporterGetOctetCount(), fbExporterResetOctetCount()
Since
libfixbuf 3.0.0

◆ fbExporterResetOctetCount()

void fbExporterResetOctetCount ( fbExporter_t exporter)

Resets the counter that holds the number of octets written to the exporter's file, socket, or buffer.

Parameters
exporteran exporting process endpoint.
See also
fbExporterGetOctetCount(), fbExporterGetOctetCountAndReset()
Since
libfixbuf 3.0.0

◆ fbCollectorAllocFile()

fbCollector_t* fbCollectorAllocFile ( void *  ctx,
const char *  path,
GError **  err 
)

Allocates a collecting process endpoint for a named file.

The underlying file will be opened immediately.

Exits the application on allocation failure.

Parameters
ctxapplication context; for application use, retrievable by fbCollectorGetContext()
pathpath of file to read, or "-" to read standard input. Used to get fp, user creates and frees.
errAn error description, set on failure.
Returns
a collecting process endpoint, or NULL if the file cannot be opened

◆ fbCollectorAllocFP()

fbCollector_t* fbCollectorAllocFP ( void *  ctx,
FILE *  fp 
)

Allocates a collecting process endpoint for an open file.

Exits the application on allocation failure.

Parameters
ctxapplication context; for application use, retrievable by fbCollectorGetContext()
fpfile pointer to file to read. Created and freed by user. Must be kept around for the life of the collector.
Returns
a collecting process endpoint.

◆ fbCollectorGetContext()

void* fbCollectorGetContext ( const fbCollector_t collector)

Retrieves the application context associated with a collector.

This context is taken from the ctx argument of fbCollectorAllocFile() or fbCollectorAllocFP(), or passed out via the ctx argument of the appinit function argument (fbListenerAppInit_fn) to fbListenerAlloc().

Parameters
collectora collecting process endpoint.
Returns
the application context

◆ fbCollectorClose()

void fbCollectorClose ( fbCollector_t collector)

Closes the file or socket underlying a collecting process endpoint.

No effect on open file endpoints. If the collector is attached to a buffer managed by a listener, the buffer will be removed from the listener (that is, it will not be returned by subsequent fbListenerWait() calls).

Parameters
collectora collecting process endpoint.

◆ fbCollectorSetAcceptOnly()

void fbCollectorSetAcceptOnly ( fbCollector_t collector,
struct sockaddr *  address,
size_t  address_length 
)

Sets the collector to only receive from the given IP address over UDP.

The port will be ignored. Use fbListenerGetCollector() to get the pointer to the collector after calling fbListenerAlloc(). ONLY valid for UDP. Set the address family in address.

Parameters
collectorpointer to collector
addresspointer to sockaddr struct with IP address and family.
address_lengthaddress length

◆ fbListenerAlloc()

fbListener_t* fbListenerAlloc ( const fbConnSpec_t spec,
fbSession_t session,
fbListenerAppInit_fn  appinit,
fbListenerAppFree_fn  appfree,
GError **  err 
)

Allocates a listener.

The listener will listen on a specified local endpoint, and create a new collecting process endpoint and collection buffer for each incoming connection. Each new buffer will be associated with a clone of a given session state container.

The application may associate context with each created collecting process endpoint, or veto a connection attempt, via a function colled on each connection attempt passed in via the appinit parameter. If this function will create application context, provide a function via the appfree parameter which will free it.

The fbListener_t returned should be freed by the application by calling fbListenerFree().

Exits the application on allocation failure.

Parameters
speclocal endpoint connection specifier. A copy is made of this, which is freed by listener. Original pointer freeing is up to the user.
sessionsession state container to clone for each collection buffer created by the listener. Not freed by listener. Must be kept alive while listener exists.
appinitapplication connection initiation function. Called on each collection attempt; vetoes connection attempts and creates application context.
appfreeapplication context free function.
errAn error description, set on failure.
Returns
a new listener, or NULL if the endpoint cannot be initialized.

◆ fbListenerFree()

void fbListenerFree ( fbListener_t listener)

Frees a listener.

Stops listening on the local endpoint, and frees any open buffers still managed by the listener.

Parameters
listenera listener

◆ fbListenerWait()

fBuf_t* fbListenerWait ( fbListener_t listener,
GError **  err 
)

Waits on a listener.

Accepts pending connections from exporting processes. Returns the next collection buffer with available data to read; if the collection buffer returned by the last call to fbListenerWait() is available, it is preferred. Blocks forever (or until fbListenerInterrupt() is called) if no messages or connections are available.

To effectively use fbListenerWait(), the application should set up an session state container with internal templates, call fbListenerWait() to accept a first connection, then read records from the collector buffer to end of message (FB_ERROR_EOM). At end of message, the application should then call fbListenerWait() to accept pending connections or switch to another collector buffer with available data. Note that each collection buffer returned created by fbListenerWait() is set automatically read the next message and not to raise FB_ERROR_EOM. To modify this behavior, call fBufSetAutomaticNextMessage() on the fBuf_t returned from this function with FALSE as the second parameter.

Parameters
listenera listener
errAn error description, set on failure.
Returns
a collection buffer with available data, or NULL on failure.
See also
fbListenerWaitNoCollectors() for a function that does not monitor active Collectors.

◆ fbListenerWaitNoCollectors()

fBuf_t* fbListenerWaitNoCollectors ( fbListener_t listener,
GError **  err 
)

Waits for an incoming connection, just like fbListenerWait(), except that this function does not monitor active collectors.

This allows for a multi-threaded application to have one thread monitoring the listeners, and one keeping track of Collectors.

Parameters
listenerThe listener to wait for connections on
errAn error description, set on failure.
Returns
a collection buffer for the new connection, NULL on failure.

◆ fbListenerInterrupt()

void fbListenerInterrupt ( fbListener_t listener)

Causes the current or next call to fbListenerWait() to unblock and return.

Use this from a thread or a signal handler to interrupt a blocked listener.

Parameters
listenerlistener to interrupt.

◆ fbListenerGetCollector()

gboolean fbListenerGetCollector ( const fbListener_t listener,
fbCollector_t **  collector,
GError **  err 
)

If a collector is associated with the listener class, this will return a handle to the collector state structure.

Parameters
listenerhandle to the listener state
collectorpointer to a collector state pointer, set on return if there is no error
erra GError structure holding an error message on error
Returns
FALSE on error, check err, TRUE on success

◆ fbCollectorClearTranslator()

gboolean fbCollectorClearTranslator ( fbCollector_t collector,
GError **  err 
)

Removes an input translator from a given collector such that it will operate on IPFIX protocol again.

Parameters
collectorthe collector on which to remove the translator
errwhen an error occurs, a GLib GError structure is set with an error description
Returns
TRUE on success, FALSE on failure

◆ fbCollectorSetNetflowV9Translator()

gboolean fbCollectorSetNetflowV9Translator ( fbCollector_t collector,
GError **  err 
)

Sets the collector input translator to convert NetFlowV9 into IPFIX for the given collector.

Parameters
collectorpointer to the collector state to perform Netflow V9 conversion on
errGError structure that holds the error message if an error occurs
Returns
TRUE on success, FALSE on error

◆ fbCollectorSetSFlowTranslator()

gboolean fbCollectorSetSFlowTranslator ( fbCollector_t collector,
GError **  err 
)

Sets the collector input translator to convert SFlow into IPFIX for the given collector.

Parameters
collectorpointer to the collector state to perform SFlow conversion on
errGError structure that holds the error message if an error occurs
Returns
TRUE on success, FALSE on error

◆ fbCollectorGetNetflowMissed()

uint32_t fbCollectorGetNetflowMissed ( const fbCollector_t collector,
const struct sockaddr *  peer,
size_t  peerlen,
uint32_t  obdomain 
)

Returns the number of potential missed export packets of the Netflow v9 session that is currently set on the collector (the session is set on the collector when an export packet is received) if peer is NULL.

If peer is set, this will look up the session for that peer/obdomain pair and return the missed export packets associated with that peer and obdomain. If peer/obdomain pair doesn't exist, this function returns 0. This can't return the number of missed flow records since Netflow v9 increases sequence numbers by the number of export packets it has sent, NOT the number of flow records (like IPFIX and netflow v5 does).

Parameters
collector
peer[OPTIONAL] peer address of NetFlow v9 exporter
peerlensize of peer object
obdomainobservation domain of NetFlow v9 exporter
Returns
number of missed packets since beginning of session

◆ fbCollectorGetSFlowMissed()

uint32_t fbCollectorGetSFlowMissed ( const fbCollector_t collector,
const struct sockaddr *  peer,
size_t  peerlen,
uint32_t  obdomain 
)

Returns the number of potential missed export packets of the SFlow session that is identified with the given ip/agentID.

The agent ID is a field that is in the sFlow header and is sent with every packet. Fixbuf keeps track of sequence numbers for sFlow sessions per agent ID.

Parameters
collector
peeraddress of exporter to lookup
peerlensizeof(peer)
obdomainobservation domain of peer exporter
Returns
number of missed packets since beginning of session

◆ fbCollectorGetPeer()

const struct sockaddr* fbCollectorGetPeer ( const fbCollector_t collector)

Retrieves information about the node connected to this collector.

Parameters
collectorpointer to the collector to get peer information from
Returns
pointer to sockaddr structure containing IP information of peer

◆ fbCollectorGetObservationDomain()

uint32_t fbCollectorGetObservationDomain ( const fbCollector_t collector)

Retrieves the observation domain of the node connected to the UDP collector.

The observation domain only gets set on the collector when collecting via UDP. If the collector is using another mode of transport, use fbSessionGetDomain().

Parameters
collector

◆ fbCollectorSetUDPMultiSession()

void fbCollectorSetUDPMultiSession ( fbCollector_t collector,
gboolean  multi_session 
)

Enables or disables multi-session mode for a fbCollector_t associated with a UDP fbListener_t.

The default setting is that multi-session mode is disabled.

When multi-session mode is enabled, libfixbuf invokes the appinit callback (fbListenerAppInit_fn) set on fbListenerAlloc() when a new UDP connection occurs, allowing the callback to examine the peer address and set a context for that UDP address. In addition, the appfree callback (fbListenerAppFree_fn) is invoked when the fbSession_t for that collector times-out.

Regardless of the multi-session mode setting, libfixbuf always calls the appinit function when a UDP listener is created, passing NULL as the peer address.

The caller may use fbListenerGetCollector() to get the collector given a listener.

Parameters
collectorpointer to collector associated with listener.
multi_sessionTRUE to enable multi-session, FALSE to disable

Data Structure Documentation

◆ fbBasicList_st

struct fbBasicList_st

fbBasicList_t provides the internal representation of an fbInfoElement_t of type basicList (FB_BASIC_LIST).

Data Fields
uint8_t * dataPtr pointer to the memory that stores the elements in the list
fbTemplateField_t field the description of one element in the list
uint16_t numElements number of elements in the list
uint16_t dataLength length of the buffer used to store the elements in the list
uint8_t semantic semantic field to describe the list

◆ fbConnSpec_st

struct fbConnSpec_st

Connection specifier.

Used to define a peer address for fbExporter_t, or a passive address for fbListener_t.

Data Fields
fbTransport_t transport Transport protocol to use.
char * host Hostname to connect/listen to.

NULL to listen on all interfaces.

char * svc Service name or port number to connect/listen to.
char * ssl_ca_file Path to certificate authority file.

Only used for OpenSSL transport.

char * ssl_cert_file Path to certificate file.

Only used for OpenSSL transport.

char * ssl_key_file Path to private key file.

Only used for OpenSSL transport.

char * ssl_key_pass Private key decryption password.

Only used for OpenSSL transport.

void * vai Pointer to address info cache.

Initialize to NULL. For fixbuf internal use only.

void * vssl_ctx Pointer to SSL context cache.

Initialize to NULL. For fixbuf internal use only.

◆ fbInfoElement_st

struct fbInfoElement_st

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.

Data Fields
uint32_t ent Private Enterprise Number.

Set to 0 for IETF-defined IEs.

uint16_t num Information Element number.

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

uint16_t len Standard information element length in octets; FB_IE_VARLEN for strings, octetArrays, and structured data (lists).
uint32_t flags Flags.

Bitwise OR of FB_IE_F_* constants. Use Macros to get units and semantic

uint8_t type Data Type, an fbInfoElementDataType_t.
uint64_t min range min
uint64_t max range max
const char * name Information element name.

Storage for this is managed by fbInfoModel.

const char * description Element description.

◆ fbInfoElementOptRec_st

struct fbInfoElementOptRec_st

The corresponding C struct for a record whose template is the RFC 5610 Information Element Type Options Template.

If collecting this record, use the function fbInfoElementAddOptRecElement() to add the fbInfoElement_t it describes to the fbInfoModel_t.

To export RFC5610 elements, use fbSessionSetMetadataExportElements().

fbInfoElementSpec_t rfc5610_spec[] = {
{"privateEnterpriseNumber", 4, 0 },
{"informationElementId", 2, 0 },
{"informationElementDataType", 1, 0 },
{"informationElementSemantics", 1, 0 },
{"informationElementUnits", 2, 0 },
{"paddingOctets", 6, 0 },
{"informationElementRangeBegin", 8, 0 },
{"informationElementRangeEnd", 8, 0 },
{"informationElementName", FB_IE_VARLEN, 0 },
{"informationElementDescription", FB_IE_VARLEN, 0 },
};
Data Fields
uint32_t ie_pen private enterprise number
uint16_t ie_id information element id
uint8_t ie_type ie data type (fbInfoElementDataType_t)
uint8_t ie_semantic ie semantic (fbInfoElementSemantics_t)
uint16_t ie_units ie units (fbInfoElementUnits_t)
uint8_t padding[6] padding to align within the template
uint64_t ie_range_begin ie range min
uint64_t ie_range_end ie range max
fbVarfield_t ie_name information element name
fbVarfield_t ie_desc information element description

◆ fbInfoElementSpec_st

struct fbInfoElementSpec_st

A single IPFIX Information Element specification.

Used to name an information element (fbInfoElement_t) for inclusion in an fbTemplate_t by fbTemplateAppendSpecArray() and for querying whether a template contains an element via fbTemplateContainsElementByName().

See also
fbInfoElementSpecId_t
Data Fields
const char * name Information element name.
uint16_t len_override The size of the information element in bytes.

For internal templates, this is the size of the memory location that will be filled by the transcoder (i.e., the size of a field in a struct). Zero cannot be used to default the size of elements used in internal templates. This is so changes in the "default" length will not silently be different then the sizes of fields in an internal struct definition. Zero can be used as the size of FB_IE_VARLEN elements. This field can also be used to specify reduced-length encoding.

uint32_t flags Application flags word.

If nonzero, then the wantedFlags argument to fbTemplateAppendSpec(), fbTemplateAppendSpecArray(), or fbTemplateContainsAllFlaggedElementsByName() MUST match ALL the bits of this flags word in order for the information element to be considered.

◆ fbInfoElementSpecId_st

struct fbInfoElementSpecId_st

A single IPFIX Information Element specification using the element's numeric identifier and private enterprise number.

Used to name an information element (fbInfoElement_t) for inclusion in an fbTemplate_t by fbTemplateAppendArraySpecId().

See also
fbInfoElementSpec_t
Since
libfixbuf 3.0.0
Data Fields
struct fbInfoElementSpecIdIdent_st ident
uint16_t len_override The size of the information element in bytes.

For internal templates, this is the size of the memory location that will be filled by the transcoder (i.e., the size of a field in a struct). Zero cannot be used to default the size of elements used in internal templates. This is so changes in the "default" length will not silently be different then the sizes of fields in an internal struct definition. Zero can be used as the size of FB_IE_VARLEN elements. This field can also be used to specify reduced-length encoding.

uint32_t flags Application flags word.

If nonzero, then the wantedFlags argument to fbTemplateAppendSpecId() or fbTemplateAppendArraySpecId() MUST match ALL the bits of this flags word in order for the information element to be considered.

◆ fbInfoElementSpecId_st::fbInfoElementSpecIdIdent_st

struct fbInfoElementSpecId_st::fbInfoElementSpecIdIdent_st

The numeric pair to identify the element.

Data Fields
uint32_t enterprise_id The private enterprise number (PEN) of the element or 0 for an IANA-defined element.
uint16_t element_id The numeric identifier of the element within its PEN.

◆ fbListenerEntry_st

struct fbListenerEntry_st

ListenerEntry's make up an fbListenerGroup_t as a linked list.

Data Fields
struct fbListenerEntry_st * next pointer to the next listener entry in the linked list
struct fbListenerEntry_st * prev pointer to the previous listener entry in the linked list
fbListener_t * listener pointer to the listener to add to the list

◆ fbListenerGroupResult_st

struct fbListenerGroupResult_st

A ListenerGroupResult contains the fbListener whose listening socket got a new connection (cf.

fbListenerGroupWait()). It is tied to the fBuf_t that is produced for the connection. These comprise a linked list.

Data Fields
struct fbListenerGroupResult_st * next Pointer to the next listener group result.
fbListener_t * listener pointer to the listener that received a new connection
fBuf_t * fbuf pointer to the fbuf created for that new connection

◆ fbRecord_st

struct fbRecord_st

fbRecord_t maintains a buffer holding an IPFIX record's data, the fbTemplate_t that describes that data and the template's ID.

The caller should initialize rec with an data buffer and store the length of that buffer in reccapacity. All fixbuf functions treat reccapacity as constant. FIXME—We could allow the fbRecord_t to maintain this buffer itself.

Before each call to fBufNextRecord(), the caller sets tid to the template to use to read the record. fBufNextRecord() updates tmpl and recsize reads the data into rec.

The caller is responsible for calling fbRecordFreeLists() before reusing the record. FIXME—We should probably change this.

Since
libfixbuf 3.0.0
Data Fields
const fbTemplate_t * tmpl The template that describes the bytes in rec.
uint8_t * rec The buffer holding the data for a record.
size_t reccapacity The number of bytes allocated for the rec buffer.
size_t recsize The number of bytes used by the record current in rec.
uint16_t tid The template ID for tmpl.

◆ fbRecordValue_st

struct fbRecordValue_st

fbRecordValue_t is used to access the value of a single Element (or Field) in an fbRecord_t.

When an fbRecordValue_t is created on the stack, it should be initialized with FB_RECORD_VALUE_INIT.

If you use it to access FB_STRING or FB_OCTET_ARRAY data, call either fbRecordValueClear() to ensure its internal string buffer is freed or fbRecordValueTakeVarfieldBuf() to take ownship of the internal string buffer before the RecordValue leaves scope.

Since
libfixbuf 3.0.0
Data Fields
const fbInfoElement_t * ie The element that describes this data.
GString * stringbuf An internal buffer used to store the varfield value.
union v_un v

◆ fbSubTemplateList_st

struct fbSubTemplateList_st

fbSubTemplateList_t provides the internal representation of an fbInfoElement_t of type subTemplateList (FB_SUB_TMPL_LIST).

Data Fields
const fbTemplate_t * tmpl pointer to the template used to structure the data in this list
uint8_t * dataPtr pointer to the buffer used to hold the data in this list
uint32_t dataLength octet length of the allocated buffer used to hold the data
uint32_t recordLength octet length of a record (in memory) described by the template
uint16_t numElements number of elements in the list
uint16_t tmplID ID of the template used to structure the data.
uint8_t semantic value used to describe the contents of the list, all-of, one-of, etc

◆ fbSubTemplateMultiList_st

struct fbSubTemplateMultiList_st

fbSubTemplateMultiList_t provides the internal representation of an fbInfoElement_t of type subTemplateMultiList (FB_SUB_TMPL_MULTI_LIST).

Data Fields
fbSubTemplateMultiListEntry_t * firstEntry pointer to the first entry in the multi list
uint16_t numElements number of sub template lists in the multi list
uint8_t semantic value used to describe the list of sub templates

◆ fbSubTemplateMultiListEntry_st

struct fbSubTemplateMultiListEntry_st

fbSubTemplateMultiListEntry_t represents structured data instances within a fbSubTemplateMultiList_t that share the same fbTemplate_t.

Data Fields
const fbTemplate_t * tmpl pointer to the template used to structure the data in this entry
uint8_t * dataPtr pointer to the buffer used to hold the data in this entry
uint32_t dataLength octet length of the buffer used to hold the data in this entry
uint32_t recordLength octet length of a record (in memory) described by the template
uint16_t numElements number of elements in this entry
uint16_t tmplID ID of the template used to structure the data in this entry.

◆ fbTemplateField_st

struct fbTemplateField_st

fbTemplateField_t represents an fbInfoElement_t that has been added to an fbTemplate_t.

Since
libfixbuf 3.0.0
Data Fields
const fbInfoElement_t * canon Pointer to canonical IE.
uint16_t midx Multiple IE index.

Defines the ordering of identical IEs in templates. Set and managed automatically by the fbTemplate_t routines.

uint16_t len Octet-length of this field as specified by the template specification.
uint16_t offset Octet-offset of this field in a record.

Calculated by template.

fbTemplate_t * tmpl Octet-length of this IE in memory.

Is this needed? Position of this field in the template. Is this needed? Pointer to the template that own this field. Is this needed?

◆ fbTemplateIter_st

struct fbTemplateIter_st

fbTemplateIter_t iterates over the fbTemplateField_t objects in an fbTemplate_t.

To use, define the fbTemplateIter_t on the stack, using FB_TEMPLATE_ITER_NULL to zero it if desired. Bind it to a Template with fbTemplateIterInit(), iterate over the TemplateFields with fbTemplateIterNext() until that function returns NULL.

Since
libfixbuf 3.0.0
Data Fields
const fbTemplate_t * tmpl
uint16_t pos

◆ fbVarfield_st

struct fbVarfield_st

A variable-length field value.

Variable-length information element content is represented by an fbVarfield_t on the internal side of the transcoder; that is, variable length fields in an IPFIX Message must be represented by this structure within the application record.

Data Fields
size_t len Length of content in buffer.
uint8_t * buf Content buffer.

In network byte order as appropriate. On write, this buffer will be copied into the message buffer. On read, this buffer points into the message buffer and must be copied by the caller before any call to fBufNext().

◆ fbRecordValue_st::v_un

union fbRecordValue_st::v_un

The value depending on the type of ie.

Data Fields
uint8_t ip6[16] Used when ie is FB_IP6_ADDR.
const fbBasicList_t * bl Used when ie is FB_BASIC_LIST.
const fbSubTemplateList_t * stl Used when ie is FB_SUB_TMPL_LIST.
const fbSubTemplateMultiList_t * stml Used when ie is FB_SUB_TMPL_MULTI_LIST.
fbVarfield_t varfield Used when ie is FB_STRING or FB_OCTET_ARRAY.

The buf member of varfield is backed by a GString; the value is terminated by \0. The len member is the length of buf not including the terminator.

struct timespec dt Used when ie is FB_DT_SEC, FB_DT_MILSEC, FB_DT_MICROSEC, or FB_DT_NANOSEC.

dt.tv_nsec is in nanoseconds; divide by 1000000 to get milliseconds or 1000 to get microseconds.

uint32_t ip4 Used when ie is FB_IP4_ADDR.
uint64_t u64 Used when ie is FB_UINT_8, FB_UINT_16, FB_UINT_32, FB_UINT_64, or FB_BOOL (0 == false, 1 == true).
int64_t s64 Used when ie is FB_INT_8, FB_INT_16, FB_INT_32, or FB_INT_64.
double dbl Used when ie is FB_FLOAT_64 or FB_FLOAT_32.
uint8_t mac[6] Used when ie is FB_MAC_ADDR.
#define FIXBUF_VERSION_MAJOR
The first number of libfixbuf's version number.
Definition: version.h:14
A single IPFIX Information Element specification.
Definition: public.h:1581
#define FB_IE_INIT_FULL(_name_, _ent_, _num_, _len_, _flags_, _min_, _max_, _type_, _desc_)
Convenience macro for creating full fbInfoElement_t static initializer.
Definition: public.h:166
#define FB_IE_F_ENDIAN
Information element endian conversion bit in the flags member of fbInfoElement_t.
Definition: public.h:242
const fbTemplateField_t * fbTemplateFindFieldByDataType(const fbTemplate_t *tmpl, fbInfoElementDataType_t datatype, uint16_t *position, uint16_t skip)
Searches a Template for a TemplateField by an fbInfoElement_t's datatype.
const fbTemplateField_t * fbTemplateFindFieldByElement(const fbTemplate_t *tmpl, const fbInfoElement_t *ie, uint16_t *position, uint16_t skip)
Searches a Template for an Information Element and returns a TemplateField if found.
fbSubTemplateMultiList_t provides the internal representation of an fbInfoElement_t of type subTempla...
Definition: public.h:2823
@ FB_SUB_TMPL_LIST
The "subTemplateList" data type: A structured data element as described in RFC6313,...
Definition: public.h:771
void * fbSubTemplateMultiListEntryNextDataPtr(const fbSubTemplateMultiListEntry_t *entry, const void *currentPtr)
Retrieves a pointer to the data record in this entry that follows the one at currentPtr.
#define FB_IESPEC_NULL
Convenience macro defining a null information element specification initializer (fbInfoElementSpec_t)...
Definition: public.h:1571
struct fbVarfield_st fbVarfield_t
A variable-length field value.
@ FB_BASIC_LIST
The "basicList" data type: A structured data element as described in RFC6313, Section 4....
Definition: public.h:768
fbBasicList_t provides the internal representation of an fbInfoElement_t of type basicList (FB_BASIC_...
Definition: public.h:2189
struct fbSubTemplateList_st fbSubTemplateList_t
A data type to represent an fbInfoElement_t of type subTemplateList (FB_SUB_TMPL_LIST).
Definition: public.h:1321
const fbTemplateField_t * fbTemplateFindFieldByIdent(const fbTemplate_t *tmpl, uint32_t ent, uint16_t num, uint16_t *position, uint16_t skip)
Searches a Template for a TemplateField by an fbInfoElement_t's private enterprise number and element...
#define FB_IE_F_REVERSIBLE
Information element reversible bit in the flags member of fbInfoElement_t.
Definition: public.h:259
#define FIXBUF_VERSION_MINOR
The second number of libfixbuf's version number.
Definition: version.h:16
#define FB_IE_VARLEN
Information element length constant for variable-length IE.
Definition: public.h:633
#define FB_TMPL_IS_OPTIONS
A tests flag for fbTemplateIsMetadata() to check whether the fbTemplate_t is an options template.
Definition: public.h:4274
@ FB_SUB_TMPL_MULTI_LIST
The "subTemplateMultiList" data type: A structured data element as described in RFC6313,...
Definition: public.h:774