# airdress.host_link.*

{/* Generated by scripts/generate-event-reference.mjs from https://schemas.airdress.co/operator/events/v1.json (operator v0.1.138).
    Do not edit by hand: run `pnpm generate:event-reference` and commit the result. */}

The events in the `airdress.host_link` family. How to read a section, and what
each audience means, is on the [event reference](/events/) page.

## `airdress.host_link.checkpoint.completed`

Owner info

Postgres finished a checkpoint the fleet host asked for before a snapshot.

**Audience: owner.** About the airdress as a whole. Only the owner receives it: the owner's devices and the owner's subscriptions.

**Where it goes**

- **The operator's journal**, as one log line at this level, and **the event log**, where `airdress events tail` reads it.
- **Subscriptions** that name it, within its audience.
- Not functions bound to this operator's events: it is kept off that path as too frequent or too internal. A subscription with a function target still receives it.

**Versions**

- Version 1: first carried by operator v0.1.138.

**Data**

| Field | Type | Required | Description |
| ----- | ---- | -------- | ----------- |
| `elapsed_ms` | integer (uint64) | yes |  |

<details>
<summary>JSON Schema</summary>

```json
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "Postgres finished a checkpoint the fleet host asked for before a snapshot.",
  "properties": {
    "elapsed_ms": {
      "format": "uint64",
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "elapsed_ms"
  ],
  "title": "HostLinkCheckpointCompleted",
  "type": "object"
}
```

</details>

## `airdress.host_link.checkpoint.failed`

Owner error Functions

A checkpoint the fleet host asked for failed; its snapshot waits.

**Audience: owner.** About the airdress as a whole. Only the owner receives it: the owner's devices and the owner's subscriptions.

**Where it goes**

- **The operator's journal**, as one log line at this level, and **the event log**, where `airdress events tail` reads it.
- **Subscriptions** that name it, within its audience.
- **Functions bound to this operator's events** (`source: operator`).

**Versions**

- Version 1: first carried by operator v0.1.138.

**Data**

| Field | Type | Required | Description |
| ----- | ---- | -------- | ----------- |
| `error` | string | yes |  |

<details>
<summary>JSON Schema</summary>

```json
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "A checkpoint the fleet host asked for failed; its snapshot waits.",
  "properties": {
    "error": {
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "title": "HostLinkCheckpointFailed",
  "type": "object"
}
```

</details>

## `airdress.host_link.listening`

Owner info Functions

The host-link listener is open on `addr`.

**Audience: owner.** About the airdress as a whole. Only the owner receives it: the owner's devices and the owner's subscriptions.

**Where it goes**

- **The operator's journal**, as one log line at this level, and **the event log**, where `airdress events tail` reads it.
- **Subscriptions** that name it, within its audience.
- **Functions bound to this operator's events** (`source: operator`).

**Versions**

- Version 1: first carried by operator v0.1.138.

**Data**

| Field | Type | Required | Description |
| ----- | ---- | -------- | ----------- |
| `addr` | string | yes |  |
| `interface` | string | yes |  |

<details>
<summary>JSON Schema</summary>

```json
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "The host-link listener is open on `addr`.",
  "properties": {
    "addr": {
      "type": "string"
    },
    "interface": {
      "type": "string"
    }
  },
  "required": [
    "addr",
    "interface"
  ],
  "title": "HostLinkListening",
  "type": "object"
}
```

</details>

## `airdress.host_link.peer_refused`

Owner warn

A request reached the host-link listener from beyond the link and was refused.

**Audience: owner.** About the airdress as a whole. Only the owner receives it: the owner's devices and the owner's subscriptions.

**Where it goes**

- **The operator's journal**, as one log line at this level, and **the event log**, where `airdress events tail` reads it.
- **Subscriptions** that name it, within its audience.
- Not functions bound to this operator's events: it is kept off that path as too frequent or too internal. A subscription with a function target still receives it.

**Versions**

- Version 1: first carried by operator v0.1.138.

**Data**

| Field | Type | Required | Description |
| ----- | ---- | -------- | ----------- |
| `peer` | string | yes |  |

<details>
<summary>JSON Schema</summary>

```json
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "A request reached the host-link listener from beyond the link and was refused.",
  "properties": {
    "peer": {
      "type": "string"
    }
  },
  "required": [
    "peer"
  ],
  "title": "HostLinkPeerRefused",
  "type": "object"
}
```

</details>

## `airdress.host_link.stopped`

Owner error Functions

The host-link listener stopped serving with an error.

**Audience: owner.** About the airdress as a whole. Only the owner receives it: the owner's devices and the owner's subscriptions.

**Where it goes**

- **The operator's journal**, as one log line at this level, and **the event log**, where `airdress events tail` reads it.
- **Subscriptions** that name it, within its audience.
- **Functions bound to this operator's events** (`source: operator`).

**Versions**

- Version 1: first carried by operator v0.1.138.

**Data**

| Field | Type | Required | Description |
| ----- | ---- | -------- | ----------- |
| `error` | string | yes |  |

<details>
<summary>JSON Schema</summary>

```json
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "The host-link listener stopped serving with an error.",
  "properties": {
    "error": {
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "title": "HostLinkStopped",
  "type": "object"
}
```

</details>

## `airdress.host_link.switches.set`

Owner info Functions

The host set switches and they were applied; `changed` of them moved.

**Audience: owner.** About the airdress as a whole. Only the owner receives it: the owner's devices and the owner's subscriptions.

**Where it goes**

- **The operator's journal**, as one log line at this level, and **the event log**, where `airdress events tail` reads it.
- **Subscriptions** that name it, within its audience.
- **Functions bound to this operator's events** (`source: operator`).

**Versions**

- Version 1: first carried by operator v0.1.138.

**Data**

| Field | Type | Required | Description |
| ----- | ---- | -------- | ----------- |
| `changed` | integer (uint) | yes |  |

<details>
<summary>JSON Schema</summary>

```json
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "The host set switches and they were applied; `changed` of them moved.",
  "properties": {
    "changed": {
      "format": "uint",
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "changed"
  ],
  "title": "HostLinkSwitchesSet",
  "type": "object"
}
```

</details>

## `airdress.host_link.switches.unwritable`

Owner error Functions

The host asked to set switches and the switches file could not be written; every switch keeps its value.

**Audience: owner.** About the airdress as a whole. Only the owner receives it: the owner's devices and the owner's subscriptions.

**Where it goes**

- **The operator's journal**, as one log line at this level, and **the event log**, where `airdress events tail` reads it.
- **Subscriptions** that name it, within its audience.
- **Functions bound to this operator's events** (`source: operator`).

**Versions**

- Version 1: first carried by operator v0.1.138.

**Data**

| Field | Type | Required | Description |
| ----- | ---- | -------- | ----------- |
| `error` | string | yes |  |
| `path` | string | yes |  |

<details>
<summary>JSON Schema</summary>

```json
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "The host asked to set switches and the switches file could not be written; every switch keeps its value.",
  "properties": {
    "error": {
      "type": "string"
    },
    "path": {
      "type": "string"
    }
  },
  "required": [
    "error",
    "path"
  ],
  "title": "HostLinkSwitchesUnwritable",
  "type": "object"
}
```

</details>

## `airdress.host_link.unavailable`

Owner error Functions

The host-link listener could not be opened. The operator serves on without it, and the fleet host's snapshots of it fail until it is.

**Audience: owner.** About the airdress as a whole. Only the owner receives it: the owner's devices and the owner's subscriptions.

**Where it goes**

- **The operator's journal**, as one log line at this level, and **the event log**, where `airdress events tail` reads it.
- **Subscriptions** that name it, within its audience.
- **Functions bound to this operator's events** (`source: operator`).

**Versions**

- Version 1: first carried by operator v0.1.138.

**Data**

| Field | Type | Required | Description |
| ----- | ---- | -------- | ----------- |
| `error` | string | yes |  |

<details>
<summary>JSON Schema</summary>

```json
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "The host-link listener could not be opened. The operator serves on without it, and the fleet host's snapshots of it fail until it is.",
  "properties": {
    "error": {
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "title": "HostLinkUnavailable",
  "type": "object"
}
```

</details>