mirror of
https://github.com/LGUG2Z/komorebi.git
synced 2026-11-20 15:41:38 +01:00
feat(komorebi_link): record what komorebi says
The recorder subscribes to komorebi over its socket (a unix socket on macOS, `uds_windows` on Windows) and writes every notification with the state it came with, stamped on the master clock. Its accept loop only hands off to a writer thread, since komorebi notifies subscribers while holding its locks. What happens to the recording itself (a komorebi that exits, a stream that dies) is written as incidents, and a lock file says whether a recorder is still running in a session.
This commit is contained in:
1 parent
0de0f82840
commit
c748237741
12 files changed
+2454
No files matched your search
@@ -72,3 +72,4 @@ source and have not been checked against a recording of it: an analysis that rea
|
||||
| An implementor of `Rules` answers every question that has no default | the type system: a missing method is E0046, proved by a `compile_fail` example on `Rules` |
|
||||
| Code that reads komorebi's output asks `Rules` and does not match on `Flavor` | convention only |
|
||||
| Rules that were not checked against a recording of komorebi say so | the framework path: an analysis that reads such a session adds a warning |
|
||||
| A running recorder can be told from one that died | the OS: an exclusive lock on `recorder.lock`, held for as long as the recorder runs and dropped by the OS when the process ends however it ends |
|
||||
@@ -46,6 +46,24 @@ Video frame times and the OS trace are on the master clock already on both hosts
|
||||
`machTimestamp` on a Mac; Windows.Graphics.Capture on Windows). The field names ending in `_mach_ns` are spelled that way
|
||||
on every host: see [the architecture](ARCHITECTURE.md#the-master-clock).
|
||||
|
||||
### Locking a session
|
||||
|
||||
A recording holds an exclusive lock on `recorder.lock` in its session for as long as it runs, and writes its process id
|
||||
to `recorder.pid`. The OS drops the lock when the process dies, however it dies, so a lock that is held means a live
|
||||
recorder and one that is free means there is none. Windows file locks are mandatory, which is why the pid is not kept in
|
||||
the locked file.
|
||||
|
||||
### komorebi's log and how the recorder talks to it
|
||||
|
||||
| | komorebi for Mac | komorebi for Windows |
|
||||
|---|---|---|
|
||||
| data directory | `~/Library/Application Support/komorebi` | `%LOCALAPPDATA%\komorebi` |
|
||||
| log | `komorebi_plaintext.log.<UTC date>` in the data directory | `%TEMP%\komorebi_plaintext.log.<UTC date>` |
|
||||
| command and subscriber sockets | unix domain sockets in the data directory | unix domain sockets in the data directory, through `uds_windows` |
|
||||
| `--log-level debug` | `komorebi --log-level debug` | `komorebi.exe --log-level debug`; `RUST_LOG=debug` also prints every dependency, so name the crate: `RUST_LOG=komorebi=debug` |
|
||||
|
||||
The wire protocol is the same on both. The recorder's own binary does not depend on either komorebi's crates.
|
||||
|
||||
## Degraded modes
|
||||
|
||||
- `record --no-video` records everything but the screen, on the same clock. It asks the system nothing about displays and
|
||||
|
||||
Reference in new issue
Block a user