Skip to main content

InputOwnershipRequest

Enum InputOwnershipRequest 

Source
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 iff InputOwnershipSignal.DISPLAY_UNOWNED is asserted.
  • Starnix (target = view_ref): owns direct input iff both InputOwnershipSignal.DISPLAY_PLATFORM_OWNED and InputOwnershipSignal.INPUT_CLIENT_OWNED are asserted.
  • SceneManager (target = platform: {}): owns platform pipeline input iff both InputOwnershipSignal.DISPLAY_PLATFORM_OWNED and InputOwnershipSignal.INPUT_PLATFORM_OWNED are asserted (pauses whenever DISPLAY_UNOWNED or INPUT_CLIENT_OWNED is 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 ViewRef replaces any previously registered view. This mechanism is intended for a single trusted client replacing its own view rather than independent concurrent components: because every GetEvent call returns a handle to the same shared kernel ownership_event, replacing the registered ViewRef does not silence earlier callers’ handles when their view is unlinked or destroyed and the new view goes fullscreen.
  • If the ViewTree contains 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 the ViewTree, 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 in unconnected_views) reverts ownership to INPUT_PLATFORM_OWNED while retaining the registration, so re-linking fullscreen restores INPUT_CLIENT_OWNED. Destroying the view permanently drops the registration, at which point ownership reverts to the platform.
  • Calls with virtcon: {} or platform: {} 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

Source

pub fn into_get_event( self, ) -> Option<(InputOwnershipTarget, InputOwnershipGetEventResponder)>

Source

pub fn method_name(&self) -> &'static str

Name of the method defined in FIDL

Trait Implementations§

Source§

impl Debug for InputOwnershipRequest

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T, D> Encode<Ambiguous1, D> for T
where D: ResourceDialect,

Source§

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
Source§

impl<T, D> Encode<Ambiguous2, D> for T
where D: ResourceDialect,

Source§

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.