# B.26 notify.*

_Peios / Using Peios / Events / Field Index_

> Every field the evman catalogue defines under notify: its type, values and meaning, and the events that carry it.

Every field the catalogue defines under `notify`, in path order. Each entry gives the field's definition and, under **Carried by**, every event type that writes it.

## B.26.1 <a id="notify.errno"></a>`notify.errno`

- **Type:** `int.errno`
- **Asserted:** no
- **Carried in:** the payload
- **Defined in:** `peinit.evman`

The error number a service sent as `ERRNO=`, as a negative errno. Services
send it positive, by convention; this field holds it negated.

The field is the service's claim about itself, informational only; peinit
neither acts on nor retains it. The protocol does not require the text to
be a number: text that is not a positive number has no errno to carry, and
the record is written without this field.

**Carried by:**

- [`peinit.notify.errno.reported`](/peios/using-peios/events/peinit/peinit-notify-errno-reported.md)

## B.26.2 <a id="notify.exit-status"></a>`notify.exit-status`

- **Type:** `int`
- **Asserted:** no
- **Carried in:** the payload
- **Defined in:** `peinit.evman`

The exit status a service sent as `EXIT_STATUS=`, informationally. Not
the exit code of any process: a service may send it while still running,
and its real exit appears in `object.process.exit-code`. Text that is not
an integer is not carried, and the record is written without this field.

**Carried by:**

- [`peinit.notify.exit-status.reported`](/peios/using-peios/events/peinit/peinit-notify-exit-status-reported.md)

## B.26.3 <a id="notify.progress.bounded"></a>`notify.progress.bounded`

- **Type:** `bool`
- **Asserted:** no
- **Carried in:** the payload
- **Defined in:** `peinit.evman`

Whether the progress a service or submitted job reported declares an end:
true for `PROGRESS=N/` and `PROGRESS=N/M`, false for a bare `PROGRESS=N`,
which counts with no end (PSPU <span>§</span>4.19). It is what tells a viewer to draw a
bar or to expect one rather than show a rising count.

True with `notify.progress.total` absent means the end is declared but not
yet known. Absent when no progress figure has been reported, as when a
service has sent only `PROGRESS_UNIT=`.

Not implied by `notify.progress.total`: `PROGRESS=N` and `PROGRESS=N/` both
leave the total absent, and PSPU <span>§</span>4.19 has a viewer draw them differently.

**Carried by:**

- [`peinit.job.status.reported`](/peios/using-peios/events/peinit/peinit-job-status-reported.md)
- [`peinit.notify.progress.reported`](/peios/using-peios/events/peinit/peinit-notify-progress-reported.md)

## B.26.4 <a id="notify.progress.current"></a>`notify.progress.current`

- **Type:** `uint`
- **Asserted:** no
- **Carried in:** the payload
- **Defined in:** `peinit.evman`

How far a service or submitted job has got, as it reported with
`PROGRESS=`: the count before any `/`. Its unit is
`notify.progress.unit`. It may fall from one record to the next; do not
read motion from the difference between two.

**Carried by:**

- [`peinit.job.status.reported`](/peios/using-peios/events/peinit/peinit-job-status-reported.md)
- [`peinit.notify.progress.reported`](/peios/using-peios/events/peinit/peinit-notify-progress-reported.md)

## B.26.5 <a id="notify.progress.total"></a>`notify.progress.total`

- **Type:** `uint`
- **Asserted:** no
- **Carried in:** the payload
- **Defined in:** `peinit.evman`

The end `notify.progress.current` is counting towards, as reported after
the `/` of `PROGRESS=`. At least 1, and never less than the current
value. The total may change between records, because a job that
rescans has learned something.

Absent when the service gave no total, and **absence alone does not say
whether one is coming**. `PROGRESS=N` counts with no end, while
`PROGRESS=N/` counts towards an end not yet known, and both leave this
field absent; `notify.progress.bounded` is what tells them apart.

**Carried by:**

- [`peinit.job.status.reported`](/peios/using-peios/events/peinit/peinit-job-status-reported.md)
- [`peinit.notify.progress.reported`](/peios/using-peios/events/peinit/peinit-notify-progress-reported.md)

## B.26.6 <a id="notify.progress.unit"></a>`notify.progress.unit`

- **Type:** `str.enum`
- **Values:** `bytes` · `items` · `percent`
- **Set:** closed
- **Asserted:** no
- **Carried in:** the payload
- **Defined in:** `peinit.evman`

What `notify.progress.current` and `notify.progress.total` count, as
reported with `PROGRESS_UNIT=`. Absent when the service gave no unit.

**Carried by:**

- [`peinit.job.status.reported`](/peios/using-peios/events/peinit/peinit-job-status-reported.md)
- [`peinit.notify.progress.reported`](/peios/using-peios/events/peinit/peinit-notify-progress-reported.md)

## B.26.7 <a id="notify.status"></a>`notify.status`

- **Type:** `str`
- **Asserted:** no
- **Carried in:** the payload
- **Defined in:** `peinit.evman`

The text a service sent as `STATUS=`: free text describing what it is
doing. The service's own words, unvalidated; never read it as a
statement by peinit.

**Carried by:**

- [`peinit.job.status.reported`](/peios/using-peios/events/peinit/peinit-job-status-reported.md)
- [`peinit.notify.status.reported`](/peios/using-peios/events/peinit/peinit-notify-status-reported.md)

*Generated from `peinit.evman` by `pkm/tools/gen-events-book.py`. Edit the fragment, not this page.*