PerformanceHintManager.Session Class

Reference

Definition

Namespace:: Android.OS

Assembly:: Mono.Android.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A Session represents a group of threads with an inter-related workload such that hints for their performance should be considered as a unit.

[Android.Runtime.Register("android/os/PerformanceHintManager$Session", ApiSince=31, DoNotGenerateAcw=true)]
public class PerformanceHintManager.Session : Java.Lang.Object, IDisposable, Java.Interop.IJavaPeerable, Java.IO.ICloseable

[<Android.Runtime.Register("android/os/PerformanceHintManager$Session", ApiSince=31, DoNotGenerateAcw=true)>]
type PerformanceHintManager.Session = class
    inherit Object
    interface ICloseable
    interface IJavaObject
    interface IDisposable
    interface IJavaPeerable

Inheritance: Object

Object
PerformanceHintManager.Session

Attributes: RegisterAttribute

Implements: IJavaObject IJavaPeerable ICloseable IDisposable

Remarks

A Session represents a group of threads with an inter-related workload such that hints for their performance should be considered as a unit. The threads in a given session should be long-life and not created or destroyed dynamically.

Each session is expected to have a periodic workload with a target duration for each cycle. The cycle duration is likely greater than the target work duration to allow other parts of the pipeline to run within the available budget. For example, a renderer thread may work at 60hz in order to produce frames at the display's frame but have a target work duration of only 6ms.

Any call in this class will change its internal data, so you must do your own thread safety to protect from racing.

Note that the target work duration can be #updateTargetWorkDuration(long) updated if workloads change.

After each cycle of work, the client is expected to #reportActualWorkDuration(long) report the actual time taken to complete.

All timings should be in SystemClock#elapsedRealtimeNanos().

Java documentation for android.os.PerformanceHintManager.Session.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Constructors

PerformanceHintManager.Session(IntPtr, JniHandleOwnership)

Properties

Class	Returns the runtime class of this `Object`. (Inherited from Object)
Handle	The handle to the underlying Android instance. (Inherited from Object)
JniIdentityHashCode	(Inherited from Object)
JniPeerMembers
PeerReference	(Inherited from Object)
ThresholdClass
ThresholdType

Methods

Clone()	Creates and returns a copy of this object. (Inherited from Object)
Close()	Ends the current hint session.
Dispose()	(Inherited from Object)
Dispose(Boolean)	(Inherited from Object)
Equals(Object)	Indicates whether some other object is "equal to" this one. (Inherited from Object)
GetHashCode()	Returns a hash code value for the object. (Inherited from Object)
JavaFinalize()	Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object)
Notify()	Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object)
NotifyAll()	Wakes up all threads that are waiting on this object's monitor. (Inherited from Object)
ReportActualWorkDuration(Int64)	Reports the actual duration for the last cycle of work.
SetHandle(IntPtr, JniHandleOwnership)	Sets the Handle property. (Inherited from Object)
SetThreads(Int32[])	Set a list of threads to the performance hint session.
ToArray<T>()	(Inherited from Object)
ToString()	Returns a string representation of the object. (Inherited from Object)
UnregisterFromRuntime()	(Inherited from Object)
UpdateTargetWorkDuration(Int64)	Updates this session's target duration for each cycle of work.
Wait()	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object)
Wait(Int64)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)
Wait(Int64, Int32)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)

Explicit Interface Implementations

IJavaPeerable.Disposed()	(Inherited from Object)
IJavaPeerable.DisposeUnlessReferenced()	(Inherited from Object)
IJavaPeerable.Finalized()	(Inherited from Object)
IJavaPeerable.JniManagedPeerState	(Inherited from Object)
IJavaPeerable.SetJniIdentityHashCode(Int32)	(Inherited from Object)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)	(Inherited from Object)
IJavaPeerable.SetPeerReference(JniObjectReference)	(Inherited from Object)

Extension Methods

JavaCast<TResult>(IJavaObject)	Performs an Android runtime-checked type conversion.
JavaCast<TResult>(IJavaObject)
GetJniTypeName(IJavaPeerable)

Applies to