Struct SolidSyslogOriginSdConfig¶

ClassList > SolidSyslogOriginSdConfig

#include <SolidSyslogOriginSd.h>

struct SolidSyslogOriginSdConfig
{
    const char* Software;
    const char* SwVersion;
    const char* EnterpriseId;
    SolidSyslogOriginIpCountFunction GetIpCount;
    SolidSyslogOriginIpAtFunction GetIpAt;
    void* IpContext;
};

Detailed Description¶

Wiring for the "origin" SD-ELEMENT (RFC 5424 §7.2).

Every field is independently optional: a NULL string omits its PARAM, and the ip PARAMs are emitted only when both GetIpCount and GetIpAt are non-NULL. The string pointers are borrowed, not copied, and read at Format time, so they (and everything else provided) must outlive the created SD; the config struct itself is only read during Create.

Public Attributes Documentation¶

EnterpriseId¶

NULL omits the enterpriseId PARAM.

const char* SolidSyslogOriginSdConfig::EnterpriseId;

RFC 5424 §7.2.2 asks for your IANA-registered private enterprise number on its own - "32473", or "32473.1.2" if you use sub-identifiers below it - rather than the 1.3.6.1.4.1 arc the number already sits under. Registering one is the caller's to do, and the value's form is not checked here. Until you have one, RFC 5612 reserves 32473 for examples and testing: use it in a test build, not on a device that ships. Truncated to 64 bytes, a bound of this library's rather than the RFC's.

GetIpAt¶

SolidSyslogOriginIpAtFunction SolidSyslogOriginSdConfig::GetIpAt;

GetIpCount¶

Paired with GetIpAt; either NULL omits the ip PARAMs.

SolidSyslogOriginIpCountFunction SolidSyslogOriginSdConfig::GetIpCount;

IpContext¶

Passed to GetIpAt unchanged.

void* SolidSyslogOriginSdConfig::IpContext;

Software¶

NULL omits the software PARAM.

const char* SolidSyslogOriginSdConfig::Software;

Truncated to this library's 48 decoded-byte bound; RFC 5424 §7.2.3 allows 48 characters, so multi-byte UTF-8 truncates earlier, never later. §7.2.3 asks that it name the generating software rather than repeat APP-NAME.

SwVersion¶

NULL omits the swVersion PARAM.

const char* SolidSyslogOriginSdConfig::SwVersion;

Truncated to this library's 32 decoded-byte bound, on the same terms as Software above; RFC 5424 §7.2.4 allows 32 characters.

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