Treeland app ID resolver v1
Warning! This protocol is EXPERIMENTAL and under active development. It may change at any time, including in backward-incompatible ways, without incrementing the interface major version and without prior notice. No compatibility guarantees of any kind are provided. Clients and compositors must track the upstream definition in treeland-protocols and must not rely on the current interface names, requests, events, or semantics remaining stable across releases.
treeland_app_id_resolver_manager_v1
Create a resolver object. Typically exactly one privileged helper (a Wayland client with DBus access) binds this interface and serves identification requests coming from the compositor.
get_resolver(id: new_id<treeland_app_id_resolver_v1>)
Argument | Type | Description |
|---|---|---|
| id | new_id<treeland_app_id_resolver_v1> |
Create or bind a resolver object. Only one resolver may be registered per session. Treeland is a multi-user compositor; different user sessions may each register their own resolver. If a resolver is already bound in the same session, the compositor will report an error on the manager and will NOT create a new resolver object for this request.
error { resolver_already_exists }
Argument | Value | Description |
|---|---|---|
| resolver_already_exists | 1 | A resolver is already registered in this session with the manager |
treeland_app_id_resolver_v1
The compositor sends identify_request with a unique request_id and a pidfd. The client must answer exactly once via respond(request_id, app_id). If resolution fails respond with an empty string.
respond(request_id: uint, app_id: string, sandbox_engine_name: string)
Argument | Type | Description |
|---|---|---|
| request_id | uint | the request ID from identify_request |
| app_id | string | the resolved application identifier, or empty string on failure |
| sandbox_engine_name | string | the sandbox engine / security context name (required, non-empty) |
Respond to an identify_request. The sandbox_engine_name must be provided and matches the context in which the process is running (container, sandbox, etc). If resolution fails, respond with an empty app_id.
identify_request(request_id: uint, pidfd: fd)
Argument | Type | Description |
|---|---|---|
| request_id | uint | monotonic id generated by compositor |
| pidfd | fd | pidfd referencing the target process |
Sent by the compositor to ask the helper to resolve a process to an application identifier.
Compositor Support
| treeland_app_id_resolver_manager_v1 | ↓ | ||
| Compositors | |||
| Cage | 0.3.0 | x | |
| COSMIC | 1.11.0 | x | |
| flakewm | 3.0.5 | 1 | |
| GameScope | 3.17.0 | x | |
| Hyprland | 0.57.2 | x | |
| Jay | 1.14.0 | x | |
| KWin | 6.7 | x | |
| Labwc | 0.20.2 | x | |
| Louvre | 2.14.1 | x | |
| Mango | 0.16.3 | x | |
| Mir | 2.26 | x | |
| Muffin | 6.7.4 | x | |
| Mutter | 51 | x | |
| niri | 26.04 | x | |
| phoc | 0.55 | x | |
| Pila | 0.5.1 | x | |
| Qtile | 0.37.1 | x | |
| river | 0.5.0 | x | |
| Sway | 1.11 | x | |
| Treeland | 0.8.0 | 1 | |
| Wayfire | 0.9.0 | x | |
| Weston | 15.0.1 | x | |
Copyright
SPDX-FileCopyrightText: 2025 UnionTech Software Technology Co., Ltd. SPDX-License-Identifier: MIT