ResultReceiver


public class ResultReceiver
extends Object implements Parcelable

java.lang.Object
   ↳ android.os.ResultReceiver


Generic interface for receiving a callback result from someone. Use this by creating a subclass and implement onReceiveResult(int, Bundle), which you can then pass to others and send through IPC, and receive results they supply with send(int, Bundle).

Note: the implementation underneath is just a simple wrapper around a Binder that is used to perform the communication. This means semantically you should treat it as such: this class does not impact process lifecycle management (you must be using some higher-level component to tell the system that your process needs to continue running), the connection will break if your process goes away for any reason, etc.

Summary

Inherited constants

int CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

int PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)".

Fields

public static final Creator<ResultReceiver> CREATOR

Public constructors

ResultReceiver(Handler handler)

Create a new ResultReceive to receive results.

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

void send(int resultCode, Bundle resultData)

Deliver a result to this receiver.

void writeToParcel(Parcel out, int flags)

Flatten this object in to a Parcel.

Protected methods

void onReceiveResult(int resultCode, Bundle resultData)

Override to receive results delivered to this object.

Inherited methods

Object clone()

Creates and returns a copy of this object.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

final Class<?> getClass()

Returns the runtime class of this Object.

int hashCode()

Returns a hash code value for the object.

final void notify()

Wakes up a single thread that is waiting on this object's monitor.

final void notifyAll()

Wakes up all threads that are waiting on this object's monitor.

String toString()

Returns a string representation of the object.

final void wait(long timeoutMillis, int nanos)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait(long timeoutMillis)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait()

Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

abstract int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

abstract void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 3
public static final Creator<ResultReceiver> CREATOR

Public constructors

ResultReceiver

Added in API level 3
public ResultReceiver (Handler handler)

Create a new ResultReceive to receive results. Your onReceiveResult(int, Bundle) method will be called from the thread running handler if given, or from an arbitrary thread if null.

Parameters
handler Handler

Public methods

describeContents

Added in API level 3
public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

send

Added in API level 3
public void send (int resultCode, 
                Bundle resultData)

Deliver a result to this receiver. Will call onReceiveResult(int, Bundle), always asynchronously if the receiver has supplied a Handler in which to dispatch the result.

Parameters
resultCode int: Arbitrary result code to deliver, as defined by you.

resultData Bundle: Any additional data provided by you.

writeToParcel

Added in API level 3
public void writeToParcel (Parcel out, 
                int flags)

Flatten this object in to a Parcel.

Parameters
out Parcel: The Parcel in which the object should be written. This value cannot be null.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Protected methods

onReceiveResult

Added in API level 3
protected void onReceiveResult (int resultCode, 
                Bundle resultData)

Override to receive results delivered to this object.

Parameters
resultCode int: Arbitrary result code delivered by the sender, as defined by the sender.

resultData Bundle: Any additional data provided by the sender.