pub enum InputOwnershipRequest {
GetEvent {
target: InputOwnershipTarget,
responder: InputOwnershipGetEventResponder,
},
}Expand description
Get information about ownership of input (replaces DisplayOwnership).
By default, user input is handled by the platform input pipeline
(SceneManager) and delivered to applications via standard UI protocols
(e.g. fuchsia.ui.pointer.TouchSource).
Low-level components (such as Starnix or Virtcon) that require direct access
to hardware input devices via fuchsia.input.report.Service must observe this
event to pause or resume reading from direct driver streams, preventing
duplicate processing or input leakage.
This protocol intentionally assumes a system-wide singleton direct-client model where only one direct client or the platform pipeline consumes input at any given time.
During ownership transitions (e.g. switching display ownership or view focus), an intermediate state may occur where neither the direct client nor the platform pipeline owns input. During any unowned or transition state, all consumers (both direct clients and the platform pipeline) must pause reading and processing hardware input reports until their respective ownership signal is asserted.
Security note:
A ViewRef is a duplicable identity token rather than proof of view ownership,
and any caller with access to this protocol can replace the registered ViewRef.
Therefore, InputOwnership must only be routed to trusted system components.
Variants§
GetEvent
Gets a duplicate handle to the shared kernel ownership_event whose
orthogonal signals inform clients and the system pipeline when direct
driver input access (fuchsia.input.report.Service) is granted or revoked:
Virtcon(target=virtcon: {}): owns input iffInputOwnershipSignal.DISPLAY_UNOWNEDis asserted.Starnix(target=view_ref): owns direct input iff bothInputOwnershipSignal.DISPLAY_PLATFORM_OWNEDandInputOwnershipSignal.INPUT_CLIENT_OWNEDare asserted.SceneManager(target=platform: {}): owns platform pipeline input iff bothInputOwnershipSignal.DISPLAY_PLATFORM_OWNEDandInputOwnershipSignal.INPUT_PLATFORM_OWNEDare asserted (pauses wheneverDISPLAY_UNOWNEDorINPUT_CLIENT_OWNEDis asserted).
Requesting direct input ownership:
Calling GetEvent with target = view_ref is also how a view requests
direct input ownership; there is no separate request method. GetEvent
supports pre-registering a valid ViewRef before the view is created or
attached to the ViewTree. On success, the server registers the ViewRef
as the system-wide direct input client, immediately evaluates it against
the latest ViewTree snapshot if one exists, and continues evaluating it
against the single-view + full-screen criteria on every subsequent ViewTree
update. INPUT_CLIENT_OWNED is asserted only while the registered view
meets those criteria; otherwise INPUT_PLATFORM_OWNED is asserted.
- Registration is singleton and last-writer-wins: a successful call with
a different
ViewRefreplaces any previously registered view. This mechanism is intended for a single trusted client replacing its own view rather than independent concurrent components: because everyGetEventcall returns a handle to the same shared kernelownership_event, replacing the registeredViewRefdoes not silence earlier callers’ handles when their view is unlinked or destroyed and the new view goes fullscreen. - If the
ViewTreecontains more than one view or overlay competing with the registered view, the criteria are not met and ownership falls back to the platform. Thus, when multiple views request direct input while coexisting in theViewTree, none of them is granted direct input, regardless of which one registered last. - Registration is tied to the lifetime of the view, not to this
channel or the returned event. Unlinking the view from the
ViewTree(placing it inunconnected_views) reverts ownership toINPUT_PLATFORM_OWNEDwhile retaining the registration, so re-linking fullscreen restoresINPUT_CLIENT_OWNED. Destroying the view permanently drops the registration, at which point ownership reverts to the platform. - Calls with
virtcon: {}orplatform: {}only observe ownership and do not modify the registered direct client.
If target is set to an unsupported or unknown variant, the call
returns InputOwnershipError.INVALID_TARGET.
Implementations§
Source§impl InputOwnershipRequest
impl InputOwnershipRequest
pub fn into_get_event( self, ) -> Option<(InputOwnershipTarget, InputOwnershipGetEventResponder)>
Sourcepub fn method_name(&self) -> &'static str
pub fn method_name(&self) -> &'static str
Name of the method defined in FIDL