Interface KeyRing

interface KeyRing {
    active(): RoomKey[];
    current(): RoomKey;
    prune(): number;
    rotate(next: RoomKey): void;
}

Index

Methods

active current prune rotate

Methods

active

active(): RoomKey[]

All keys — current + still-in-grace ones. Most-recent first.

Returns RoomKey[]

current

current(): RoomKey

Returns RoomKey

prune

prune(): number

Drop keys that are past grace.

Returns number

rotate

rotate(next: RoomKey): void
Rotate: new key becomes current; previous key is retained for grace.
Parameters
- next: RoomKey
Returns void