RemoteCallbackList 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.

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: Object

Object
RemoteCallbackList

Attributes: RegisterAttribute JavaTypeParametersAttribute

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

RemoteCallbackList()	Creates a RemoteCallbackList with `#FROZEN_CALLEE_POLICY_UNSET`.
RemoteCallbackList(IntPtr, JniHandleOwnership)	A constructor used when creating managed representations of JNI objects; called by the runtime.

Fields

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

Class	Returns the runtime class of this `Object`. (Inherited from Object)
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	(Inherited from Object)
JniPeerMembers
MaxQueueSize	Returns the max queue size.
PeerReference	(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

BeginBroadcast()	Use `#broadcast(Consumer)` instead to ensure proper handling of frozen processes.
Broadcast(IConsumer)	Performs `callback` on each registered interface.
Clone()	Creates and returns a copy of this object. (Inherited from Object)
Dispose()	(Inherited from Object)
Dispose(Boolean)	(Inherited from Object)
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 `#beginBroadcast`.
GetBroadcastCookie(Int32)	Retrieve the cookie associated with the item returned by `#getBroadcastItem(int)`.
GetBroadcastItem(Int32)	Retrieve an item in the active broadcast that was previously started with `#beginBroadcast`.
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()	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 `#onCallbackDied(E, Object)` that does not provide a cookie.
Register(Object, Object)	Add a new interface to the list.
Register(Object)	Simple version of `RemoteCallbackList#register(E, Object)` that does not take a cookie object.
SetHandle(IntPtr, JniHandleOwnership)	Sets the Handle property. (Inherited from Object)
ToArray<T>()	(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 `#register`.
UnregisterFromRuntime()	(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

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)	Gets the JNI name of the type of the instance `self`.
JavaAs<TResult>(IJavaPeerable)	Try to coerce `self` to type `TResult`, checking that the coercion is valid on the Java side.
TryJavaCast<TResult>(IJavaPeerable, TResult)	Try to coerce `self` to type `TResult`, checking that the coercion is valid on the Java side.

Applies to

Share via