File SolidSyslogSdElement.h¶

FileList > Core > Interface > SolidSyslogSdElement.h

The SD authoring API for one [SD-ID PARAM="value"...] element: _Begin / _Param / _End, which own the brackets and SD-NAME charset so the author writes only names and values.

#include "ExternC.h"
#include <stdint.h>

Public Functions¶

Type	Name
void	SolidSyslogSdElement_Begin (struct SolidSyslogSdElement * element, const char * name, uint32_t enterpriseNumber) Opens an SD-ELEMENT: emits "[name" for an IANA-registered name ( `enterpriseNumber` 0) or "[name@enterpriseNumber" for a private one.
void	SolidSyslogSdElement_End (struct SolidSyslogSdElement * element) Closes the SD-ELEMENT: closes any open param value's quote and emits ']' (nothing if _Begin suppressed the element).
struct SolidSyslogSdValue *	SolidSyslogSdElement_Param (struct SolidSyslogSdElement * element, const char * name) Opens an SD-PARAM and returns the value sink to stream its value into.

Public Functions Documentation¶

function SolidSyslogSdElement_Begin¶

Opens an SD-ELEMENT: emits "[name" for an IANA-registered name ( enterpriseNumber 0) or "[name@enterpriseNumber" for a private one.

void SolidSyslogSdElement_Begin (
    struct SolidSyslogSdElement * element,
    const char * name,
    uint32_t enterpriseNumber
)

A NULL name suppresses the whole element, so a conditional element needs no placeholder; the matching _End is still required.

function SolidSyslogSdElement_End¶

Closes the SD-ELEMENT: closes any open param value's quote and emits ']' (nothing if _Begin suppressed the element).

void SolidSyslogSdElement_End (
    struct SolidSyslogSdElement * element
)

function SolidSyslogSdElement_Param¶

Opens an SD-PARAM and returns the value sink to stream its value into.

struct SolidSyslogSdValue * SolidSyslogSdElement_Param (
    struct SolidSyslogSdElement * element,
    const char * name
)

Always returns a usable sink, never NULL: a NULL name (or a suppressed element) skips the param but still absorbs the caller's value writes. The returned pointer belongs to the element and stays valid until the next _Param or _End.

The documentation for this class was generated from the following file Core/Interface/SolidSyslogSdElement.h