File SolidSyslogDiscardPolicy.h¶

FileList > Core > Interface > SolidSyslogDiscardPolicy.h

The discard policy: what a full queue does with the record that does not fit, and the function an integrator injects to answer which policy applies.

#include "SolidSyslogExternC.h"

Public Types Documentation¶

SolidSyslogDiscardPolicy¶

What a full queue does with the record that does not fit.

enum SolidSyslogDiscardPolicy {
    SOLIDSYSLOG_DISCARD_POLICY_OLDEST,
    SOLIDSYSLOG_DISCARD_POLICY_NEWEST,
    SOLIDSYSLOG_DISCARD_POLICY_HALT
};

Oldest makes room by dropping the oldest records it holds; Newest refuses the record being written; Halt refuses it too, and the logger stops moving records until the policy is changed or the device restarts. Records lost either way are reported by the queue that lost them, once per run.

SolidSyslogDiscardPolicyFunction¶

Answers which policy applies.

typedef enum SolidSyslogDiscardPolicy(* SolidSyslogDiscardPolicyFunction) (void *context);

A queue asks at the moment it has to decide, so the answer may change on a running device. The store and Service ask from the task that calls SolidSyslog_Service. The context is the one paired with it, passed back unchanged.

Public Functions Documentation¶

SolidSyslogDiscardPolicy_Default¶

The policy applied where none was injected: Oldest.

enum SolidSyslogDiscardPolicy SolidSyslogDiscardPolicy_Default (
    void * context
)

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