Documentation
¶
Overview ¶
Package forward — range 0.3.93.* (ADR 0185 service/app/forward block, declared in the core per ADR 0160).
Package forward — declares the sentinel *errs.Error outcomes of the store-and-forward export queue. Each var's name equals its errs.Define Reason in SCREAMING_SNAKE form.
Index ¶
Constants ¶
const CodeBatchTooLarge errs.Code = 0x00_03_5D_03 // 0.3.93.3
CodeBatchTooLarge identifies a batch larger on its own than the forwarder's MaxBytes, which no policy can make room for.
const CodeForwardFull errs.Code = 0x00_03_5D_02 // 0.3.93.2
CodeForwardFull identifies a batch the forwarder did not keep because its queue held its bound of batches or bytes, under DropNewest, under Block once BlockTimeout ran out, or under DropOldest when nothing older could be taken out.
const CodeForwardMisconfigured errs.Code = 0x00_03_5D_01 // 0.3.93.1
CodeForwardMisconfigured identifies a forwarder refused at construction — no broker, no sender, no classification, a negative bound or timeout, an unknown full policy — or an adapter built over no forwarder.
Variables ¶
var ( // ForwardMisconfigured refuses a forwarder that could never forward. ForwardMisconfigured = errs.Static(CodeForwardMisconfigured, "FORWARD_MISCONFIGURED", "The export forwarder cannot run as configured", "service/app/forward: New refused its Config, or an adapter was built over a nil forwarder; the fields name the setting and the problem", 0, 78) // ForwardFull refuses a batch the forwarder's queue had no room for. The // batch is counted Dropped; a caller in front — a trace BatchSink — // counts it failed as it did a collector that was down. ForwardFull = errs.Static(CodeForwardFull, "FORWARD_FULL", "The export queue is full", "service/app/forward: the queue held MaxBatches batches or MaxBytes bytes and the full policy kept the older batches; the fields name the policy", 503, 0) // BatchTooLarge refuses a batch larger than the forwarder's MaxBytes on // its own. It is counted Dropped. The fields name its size and the bound, // never its bytes. BatchTooLarge = errs.Static(CodeBatchTooLarge, "BATCH_TOO_LARGE", "The export batch is larger than the queue may hold", "service/app/forward: a batch is larger than Config.MaxBytes on its own; the fields carry its size and the bound", 413, 0) )
Functions ¶
This section is empty.
Types ¶
This section is empty.
Source Files