Message

arg1 and arg2 are lower-cost alternatives to using setData() if you only need to store a few integer values.

arg1 and arg2 are lower-cost alternatives to using setData() if you only need to store a few integer values.

An arbitrary object to send to the recipient. When using Messenger to send the message across processes this can only be non-null if it contains a Parcelable of a framework class (not one implemented by the application). For other data transfer use setData(Bundle) .

Note that Parcelable objects here are not supported prior to the FROYO release.

Optional Messenger where replies to this message can be sent. The semantics of exactly how this is used are up to the sender and receiver.

User-defined message code so that the recipient can identify what this message is about. Each Handler has its own name-space for message codes, so you do not need to worry about yours conflicting with other handlers.

Constructor (but the preferred way to get a Message is to call Message.obtain() ).

Make this message like o. Performs a shallow copy of the data field. Does not copy the linked list fields, nor the timestamp or target/callback of the original message.

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

Retrieve callback object that will execute when this message is handled. This object must implement Runnable. This is called by the target Handler that is receiving this Message to dispatch it. If not set, the message will be dispatched to the receiving Handler's handleMessage(Message) .

Obtains a Bundle of arbitrary data associated with this event, lazily creating it if necessary. Set this value by calling setData(Bundle) . Note that when transferring data across processes via Messenger , you will need to set your ClassLoader on the Bundle via Bundle.setClassLoader() so that it can instantiate your objects when you retrieve them.

Retrieve the a Handler implementation that will receive this message. The object must implement Handler.handleMessage() . Each Handler has its own name-space for message codes, so you do not need to worry about yours conflicting with other handlers.

Return the targeted delivery time of this message, in milliseconds.

Same as obtain() , but sets the values of the target , what , arg1 , arg2 , and obj members.

Same as obtain() , but sets the values of the target , what , and obj members.

Same as obtain() , but sets the values for both target and what members on the Message.

Same as obtain() , but sets the value for the target member on the Message returned.

Same as obtain(Handler) , but assigns a callback Runnable on the Message that is returned.

Return a new Message instance from the global pool. Allows us to avoid allocating new objects in many cases.

Same as obtain() , but sets the values of the target , what , arg1 , and arg2 members.

Same as obtain() , but copies the values of an existing message (including its target) into the new one.

Like getData(), but does not lazily create the Bundle. A null is returned if the Bundle does not already exist. See getData() for further information on this.

Return a Message instance to the global pool. You MUST NOT touch the Message after calling this function -- it has effectively been freed.

Sends this Message to the Handler specified by getTarget() . Throws a null pointer exception if this field has not been set.

Sets a Bundle of arbitrary data values. Use arg1 and arg1 members as a lower cost way to send a few simple integer values, if you can.

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:

          getClass().getName() + '@' + Integer.toHexString(hashCode())
         

See Writing a useful toString method if you intend implementing your own toString method.

Flatten this object in to a Parcel.