Home Guides Reference Downloads

WearableListenerService

Receives events from other nodes, such as data changes, messages or connectivity events.

The life-cycle of this service is managed by Android Wear. This service will be bound to and events delivered as a result of various Android Wear events, including data, messages and events indicating a device has connected or disconnected from the Android Wear network.

Applications expecting to be notified of events while in the background should extend this class. Activities and other short-lived Android components may use addListener(DataClient.OnDataChangedListener), addListener(MessageClient.OnMessageReceivedListener) to receive events for a limited period of time.

Implementors could use a LocalBroadcastManager to dispatch events to other components in an application.

For best performance, limit the number of listeners and use mutually exclusive filters where there are multiple listeners. A common pattern is to use prefix filters to listen to different namespaces within an application.

Example manifest entry:
android:pathPrefix is optional.

 <service android:name=".MyWearableListenerService" >
   <intent-filter>
     <!-- listeners receive events that match the action and data filters -->
     <action android:name="com.google.android.gms.wearable.DATA_CHANGED" />
     <action android:name="com.google.android.gms.wearable.MESSAGE_RECEIVED" />
     <action android:name="com.google.android.gms.wearable.CAPABILITY_CHANGED" />
     <action android:name="com.google.android.gms.wearable.CHANNEL_EVENT" />
     <data android:scheme="wear" android:host="*" android:pathPrefix="/prefix" />
   </intent-filter>
 </service>

Inherited Constant Summary

Public Constructor Summary

WearableListenerService()

Public Method Summary

Looper
getLooper()
This method is used to retrieve the looper all callbacks will run on.
final IBinder
onBind(Intent intent)
void
onCapabilityChanged(CapabilityInfo capabilityInfo)
void
onChannelClosed(Channel channel, int closeReason, int appSpecificErrorCode)
Called when a channel is closed.
void
onChannelClosed(ChannelClient.Channel channel, int closeReason, int appSpecificErrorCode)
Called when a channel is closed.
void
onChannelOpened(Channel channel)
Called when a new channel is opened by a remote node.
void
onChannelOpened(ChannelClient.Channel channel)
Called when a new channel is opened by a remote node.
void
onConnectedNodes(List<Node> connectedNodes)
void
onCreate()
void
onDataChanged(DataEventBuffer dataEvents)
Receives data changed events.
void
onDestroy()
void
onInputClosed(Channel channel, int closeReason, int appSpecificErrorCode)
Called when the input side of a channel is closed.
void
onInputClosed(ChannelClient.Channel channel, int closeReason, int appSpecificErrorCode)
Called when the input side of a channel is closed.
void
onMessageReceived(MessageEvent messageEvent)
Receives message events.
void
onOutputClosed(Channel channel, int closeReason, int appSpecificErrorCode)
Called when the output side of a channel is closed.
void
onOutputClosed(ChannelClient.Channel channel, int closeReason, int appSpecificErrorCode)
Called when the output side of a channel is closed.
void
onPeerConnected(Node peer)
void
onPeerDisconnected(Node peer)

Inherited Method Summary

Public Constructors

public WearableListenerService ()

Public Methods

public Looper getLooper ()

This method is used to retrieve the looper all callbacks will run on. The default behavior is to construct a new background thread the first time called and use that thread. If a different looper is desired, subclasses should override this method.

public final IBinder onBind (Intent intent)

public void onCapabilityChanged (CapabilityInfo capabilityInfo)

public void onChannelClosed (Channel channel, int closeReason, int appSpecificErrorCode)

Called when a channel is closed. This can happen through an explicit call to close(GoogleApiClient) or close(GoogleApiClient, int) on either side of the connection, or due to disconnecting from the remote node.

Parameters
channel
closeReason the reason for the channel closing. One of CLOSE_REASON_DISCONNECTED, CLOSE_REASON_REMOTE_CLOSE, or CLOSE_REASON_LOCAL_CLOSE.
appSpecificErrorCode the error code specified on close(GoogleApiClient), or 0 if closeReason is CLOSE_REASON_DISCONNECTED.

public void onChannelClosed (ChannelClient.Channel channel, int closeReason, int appSpecificErrorCode)

Called when a channel is closed.

Parameters
channel the ChannelClient.Channel that was closed.
closeReason the reason for the input closing. One of CLOSE_REASON_DISCONNECTED, CLOSE_REASON_REMOTE_CLOSE, CLOSE_REASON_LOCAL_CLOSE, or CLOSE_REASON_NORMAL.
appSpecificErrorCode the error code specified on close(ChannelClient.Channel, int), or 0 if closeReason is CLOSE_REASON_DISCONNECTED or CLOSE_REASON_NORMAL.
See Also

public void onChannelOpened (Channel channel)

Called when a new channel is opened by a remote node.

public void onChannelOpened (ChannelClient.Channel channel)

Called when a new channel is opened by a remote node.

Parameters
channel the ChannelClient.Channel that was opened.
See Also

public void onConnectedNodes (List<Node> connectedNodes)

public void onCreate ()

public void onDataChanged (DataEventBuffer dataEvents)

Receives data changed events. The provided buffer will be closed after this method completes. Use freeze() on items in the buffer to use them outside of this callscope.

Multiple data events may delivered in a single call and may only contain final-state modifications of a data item. (Eg, multiple calls to putDataItem changing the value of the data item's getData() may only appear as a single event, with the last modification expressed).

Applications needing to track the of all its data items, may use getDataItems(GoogleApiClient) on boot to retrieve all existing data items.

public void onDestroy ()

public void onInputClosed (Channel channel, int closeReason, int appSpecificErrorCode)

Called when the input side of a channel is closed.

Parameters
channel
closeReason the reason for the input closing. One of CLOSE_REASON_DISCONNECTED, CLOSE_REASON_REMOTE_CLOSE, CLOSE_REASON_LOCAL_CLOSE, or CLOSE_REASON_NORMAL
appSpecificErrorCode the error code specified on close(GoogleApiClient), or 0 if closeReason is CLOSE_REASON_DISCONNECTED or CLOSE_REASON_NORMAL.

public void onInputClosed (ChannelClient.Channel channel, int closeReason, int appSpecificErrorCode)

Called when the input side of a channel is closed.

Parameters
channel the ChannelClient.Channel whose input was closed.
closeReason the reason for the input closing. One of CLOSE_REASON_DISCONNECTED, CLOSE_REASON_REMOTE_CLOSE, CLOSE_REASON_LOCAL_CLOSE, or CLOSE_REASON_NORMAL.
appSpecificErrorCode the error code specified on close(ChannelClient.Channel, int), or 0 if closeReason is CLOSE_REASON_DISCONNECTED or CLOSE_REASON_NORMAL.
See Also

public void onMessageReceived (MessageEvent messageEvent)

Receives message events.

public void onOutputClosed (Channel channel, int closeReason, int appSpecificErrorCode)

Called when the output side of a channel is closed.

Parameters
channel
closeReason the reason for the output closing. One of CLOSE_REASON_DISCONNECTED, CLOSE_REASON_REMOTE_CLOSE, CLOSE_REASON_LOCAL_CLOSE, or CLOSE_REASON_NORMAL
appSpecificErrorCode the error code specified on close(GoogleApiClient), or 0 if closeReason is CLOSE_REASON_DISCONNECTED or CLOSE_REASON_NORMAL.

public void onOutputClosed (ChannelClient.Channel channel, int closeReason, int appSpecificErrorCode)

Called when the output side of a channel is closed.

Parameters
channel the ChannelClient.Channel whose output was closed.
closeReason the reason for the output closing. One of CLOSE_REASON_DISCONNECTED, CLOSE_REASON_REMOTE_CLOSE, CLOSE_REASON_LOCAL_CLOSE, or CLOSE_REASON_NORMAL.
appSpecificErrorCode the error code specified on close(ChannelClient.Channel, int), or 0 if closeReason is CLOSE_REASON_DISCONNECTED or CLOSE_REASON_NORMAL.
See Also

public void onPeerConnected (Node peer)

public void onPeerDisconnected (Node peer)