Struct ProfileProviderProxy

pub struct ProfileProviderProxy { /* private fields */ }

Implementations

impl ProfileProviderProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.media/ProfileProvider.

pub fn take_event_stream(&self) -> ProfileProviderEventStream

Get a Stream of events from the remote end of the protocol.

Panics

Panics if the event stream was already taken.

pub fn register_handler_with_capacity( &self, thread_handle: Thread, name: &str, period: i64, capacity: f32, ) -> QueryResponseFut<(i64, i64), DefaultFuchsiaResourceDialect>

Register a thread as a media thread. This notifies the media subsystem that this thread should have an elevated scheduling profile applied to it in order to meet audio or video deadlines.

name is the name of a system scheduling role to apply to the thread given by thread_handle – different products may customize the underlying scheduling strategy based on the requested role. period is the suggested interval to be scheduled at. period may be zero if the thread has no preferred scheduling interval. capacity is the proportion of the scheduling interval the thread needs to be running to achieve good performance or to meet the scheduling deadline defined by period. capacity may be zero if the workload has no firm runtime requirements. Note that capacity should be a good faith estimate based on the worst case runtime the thread requires each period. Excessive capacity requests may be rejected or result in scaling back the performance of other threads to fit resource limits.

Capacity, max runtime, and period have the following relationship:

capacity = max runtime / period

Where:

0 <= max runtime <= period and 0 <= capacity <= 1

For heterogeneous systems, the capacity should be planned / measured against the highest performance processor(s) in the system. The system will automatically adjust the effective capacity to account for slower processors and operating points and will avoid processors and operating points that are too slow to meet the requested scheduling parameters (provided they are reasonable).

Returns the period and capacity (actually maximum runtime) that was applied, either of which may be zero to indicate not applicable.

pub fn unregister_handler( &self, thread_handle: Thread, name: &str, ) -> QueryResponseFut<(), DefaultFuchsiaResourceDialect>

Reset a thread’s scheduling profile to the default.

pub fn register_memory_range( &self, vmar_handle: Vmar, name: &str, ) -> QueryResponseFut<(), DefaultFuchsiaResourceDialect>

Register a memory range as being used for media processing. This notifies the media subsystem that this memory should have an elevated memory profile applied to it in order to meet audio or video deadlines.

name is the name of a system memory role to apply to the memory given by vmar_handle – different products may customize the underlying memory strategy based on the requested role.

pub fn unregister_memory_range( &self, vmar_handle: Vmar, ) -> QueryResponseFut<(), DefaultFuchsiaResourceDialect>

Reset a memory range’s memory profile.

Trait Implementations

impl Clone for ProfileProviderProxy

fn clone(&self) -> ProfileProviderProxy

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ProfileProviderProxy

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

Formats the value using the given formatter.

impl ProfileProviderProxyInterface for ProfileProviderProxy

type RegisterHandlerWithCapacityResponseFut = QueryResponseFut<(i64, i64)>

type UnregisterHandlerResponseFut = QueryResponseFut<()>

type RegisterMemoryRangeResponseFut = QueryResponseFut<()>

type UnregisterMemoryRangeResponseFut = QueryResponseFut<()>

fn register_handler_with_capacity( &self, thread_handle: Thread, name: &str, period: i64, capacity: f32, ) -> Self::RegisterHandlerWithCapacityResponseFut

fn unregister_handler( &self, thread_handle: Thread, name: &str, ) -> Self::UnregisterHandlerResponseFut

fn register_memory_range( &self, vmar_handle: Vmar, name: &str, ) -> Self::RegisterMemoryRangeResponseFut

fn unregister_memory_range( &self, vmar_handle: Vmar, ) -> Self::UnregisterMemoryRangeResponseFut

impl Proxy for ProfileProviderProxy

type Protocol = ProfileProviderMarker

The protocol which this Proxy controls.

fn from_channel(inner: AsyncChannel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Result<AsyncChannel, Self>

Attempt to convert the proxy back into a channel.

fn as_channel(&self) -> &AsyncChannel

Get a reference to the proxy’s underlying channel.

fn into_client_end(self) -> Result<ClientEnd<Self::Protocol>, Self>

Attempt to convert the proxy back into a client end.

fn is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.

fn on_closed(&self) -> OnSignals<'_, Unowned<'_, Handle>>

Returns a future that completes when the proxy receives the PEER_CLOSED signal.