RemoteCallbackList Class
Definition
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.
Takes care of the grunt work of maintaining a list of remote interfaces,
typically for the use of performing callbacks from a
android.app.Service to its clients.
[Android.Runtime.Register("android/os/RemoteCallbackList", DoNotGenerateAcw=true)]
[Java.Interop.JavaTypeParameters(new System.String[] { "E extends android.os.IInterface" })]
public class RemoteCallbackList : Java.Lang.Object
[<Android.Runtime.Register("android/os/RemoteCallbackList", DoNotGenerateAcw=true)>]
[<Java.Interop.JavaTypeParameters(new System.String[] { "E extends android.os.IInterface" })>]
type RemoteCallbackList = class
inherit Object
- Inheritance
- Attributes
Remarks
Takes care of the grunt work of maintaining a list of remote interfaces, typically for the use of performing callbacks from a android.app.Service to its clients. In particular, this:
<ul> <li> Keeps track of a set of registered IInterface objects, taking care to identify them through their underlying unique IBinder (by calling IInterface#asBinder IInterface.asBinder(). <li> Attaches a IBinder.DeathRecipient IBinder.DeathRecipient to each registered interface, so that it can be cleaned out of the list if its process goes away. <li> Performs locking of the underlying list of interfaces to deal with multithreaded incoming calls, and a thread-safe way to iterate over a snapshot of the list without holding its lock. </ul>
To use this class, simply create a single instance along with your service, and call its #register and #unregister methods as client register and unregister with your service. To call back on to the registered clients, use #beginBroadcast, #getBroadcastItem, and #finishBroadcast.
If a registered interface's process goes away, this class will take care of automatically removing it from the list. If you want to do additional work in this situation, you can create a subclass that implements the #onCallbackDied method.
Java documentation for android.os.RemoteCallbackList.
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
| Name | Description |
|---|---|
| RemoteCallbackList() |
Creates a RemoteCallbackList with |
| RemoteCallbackList(IntPtr, JniHandleOwnership) |
A constructor used when creating managed representations of JNI objects; called by the runtime. |
Fields
| Name | Description |
|---|---|
| FrozenCalleePolicyDrop |
Obsolete.
When the callback recipient's process is frozen, callbacks are suppressed as if they never happened. |
| FrozenCalleePolicyEnqueueAll |
Obsolete.
When the callback recipient's process is frozen, callbacks are enqueued so they're invoked after the recipient is unfrozen. |
| FrozenCalleePolicyEnqueueMostRecent |
Obsolete.
When the callback recipient's process is frozen, only the most recent callback is enqueued, which is later invoked after the recipient is unfrozen. |
| FrozenCalleePolicyUnset |
Obsolete.
Callbacks are invoked immediately regardless of the frozen state of the target process. |
Properties
| Name | Description |
|---|---|
| Class |
Returns the runtime class of this |
| Executor |
Returns the executor used when invoking callbacks asynchronously. |
| FrozenCalleePolicy |
Returns the frozen callee policy. |
| Handle |
The handle to the underlying Android instance. (Inherited from Object) |
| JniIdentityHashCode |
Gets the identity hash code assigned to this Java peer by the interop runtime. (Inherited from Object) |
| JniManagedPeerState |
Gets the state flags last assigned by the runtime. (Inherited from JavaObject) |
| JniPeerMembers |
Provides JNI peer-member metadata for this type. |
| MaxQueueSize |
Returns the max queue size. |
| PeerReference |
Gets the JNI object reference for this Java peer. (Inherited from Object) |
| RegisteredCallbackCount |
Returns the number of registered interfaces. |
| ThresholdClass |
This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. |
| ThresholdType |
This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. |
Methods
| Name | Description |
|---|---|
| BeginBroadcast() |
Use |
| Broadcast(IConsumer) |
Performs |
| Clone() |
Creates and returns a copy of this object. (Inherited from Object) |
| Construct(JniObjectReference, JniObjectReferenceOptions) |
Delegates construction of this peer to the runtime's value manager. (Inherited from JavaObject) |
| Dispose() |
Releases the resources held by this Java peer. (Inherited from Object) |
| Dispose(Boolean) |
Releases the resources held by this Java peer. (Inherited from Object) |
| DisposeUnlessReferenced() |
Asks the value manager to dispose this peer unless its mapping retains this same managed instance. (Inherited from JavaObject) |
| Equals(Object) |
Tests whether another managed peer refers to the same Java object. (Inherited from JavaObject) |
| Equals(Object) |
Indicates whether some other object is "equal to" this one. (Inherited from Object) |
| FinishBroadcast() |
Clean up the state of a broadcast previously initiated by calling
|
| GetBroadcastCookie(Int32) |
Retrieve the cookie associated with the item
returned by |
| GetBroadcastItem(Int32) |
Retrieve an item in the active broadcast that was previously started
with |
| GetHashCode() |
Returns a hash code value for the object. (Inherited from Object) |
| GetRegisteredCallbackCookie(Int32) |
Return any cookie associated with a currently registered interface. |
| GetRegisteredCallbackItem(Int32) |
Return a currently registered interface. |
| JavaFinalize() |
Obsolete.
Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object) |
| Kill() |
Disable this interface list. |
| 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) |
| OnCallbackDied(Object, Object) |
Called when the process hosting an interface in the list has gone away. |
| OnCallbackDied(Object) |
Old version of |
| Register(Object, Object) |
Add a new interface to the list. |
| Register(Object) |
Simple version of |
| SetHandle(IntPtr, JniHandleOwnership) |
Sets the Handle property. (Inherited from Object) |
| SetPeerReference(JniObjectReference, JniObjectReferenceOptions) |
Stores a reference value in the control block without creating a JNI reference copy. (Inherited from JavaObject) |
| ToArray<T>() |
Creates a managed array from this Java array wrapper. (Inherited from Object) |
| ToString() |
Returns a string representation of the object. (Inherited from Object) |
| Unregister(Object) |
Remove from the list an interface that was previously added with
|
| UnregisterFromRuntime() |
Unregisters this Java peer from the interop runtime. (Inherited from Object) |
| 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, 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) |
| 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) |
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJavaPeerable.Disposed() |
Marks this peer as disposed and calls |
| IJavaPeerable.Finalized() |
Marks this peer as disposed and calls |
| IJavaPeerable.JniObjectReferenceControlBlock |
Gets the native control-block pointer used by this peer. (Inherited from JavaObject) |
| IJavaPeerable.SetJniIdentityHashCode(Int32) |
Stores the identity hash code supplied by the runtime. (Inherited from JavaObject) |
| IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) |
Replaces the stored managed peer state flags. (Inherited from JavaObject) |
| IJavaPeerable.SetPeerReference(JniObjectReference) |
Updates the peer reference and releases a disposed peer's control block when the reference is invalid. (Inherited from JavaObject) |
Extension Methods
| Name | Description |
|---|---|
| GetJniTypeName(IJavaPeerable) |
Gets the JNI name of the type of the instance |
| JavaAs<TResult>(IJavaPeerable) |
Try to coerce |
| JavaCast<TResult>(IJavaObject) |
Performs an Android runtime-checked type conversion. |
| JavaCast<TResult>(IJavaObject) |
Reuses a compatible managed peer or obtains a wrapper of the requested type. |
| TryJavaCast<TResult>(IJavaPeerable, TResult) |
Try to coerce |