com.xconns.peerdevicenet

Class RouterGroupClient

java.lang.Object

com.xconns.peerdevicenet.RouterGroupClient

public class RouterGroupClient
extends java.lang.Object

RouterGroupClient wrapper class is the preferred way to access the asynchronous one-way AIDL api of Router Group Service. It enables two-way asynchronous messaging between clients and GroupService, and performs some extra book keeping.

• bind to (later unbind) Router Group Service and automatically join the group named in constructor.
• expose api methods to invoke GroupService one-way asynchronous api as defined by IRouterGroupService.aidl; perform operations such as sending a message.
• register a GroupHandler which exposes client side one-way asynchronous messaging api to allow GroupService call back to notify events such as peer device leaving group, or receiving a message
• buffering api calls when the binding with GroupService is not ready yet, and resend buffered calls when the binding is ready.

Since RouterGroupClient will join the named group automatically when it binds to GroupService, it expose the following simple api:

• broadcast message to whole group or send message to a specific peer device

   send(DeviceInfo dest, byte[] msg)
   

• query existing peer devices in this group:

   getPeerDevices()
   

A sample scenario of using RouterGroupClient to interact with GroupService is as following:

1. Initialization at onCreate() or onResume():

    //bind to GroupService, join the group named by "groupId" and register GroupHandler 
    //as client side async messaging api for GroupService to call back.
    mGroupClient = new RouterGroupClient(this, groupId, null, mGroupHandler);
    mGroupClient.bindService(); 
    

2. call service async api to perform operations:

    //send a message to peers.
    RotateMsg m = new RotateMsg(RotateMsg.INIT_ORIENT_REQ, 0, 0); //req init orientation
    mGroupClient.send(null, m.marshall());
    

3. cleanup at onPause() or onDestroy():

    //leave group and unbind from GroupService
    mGroupClient.unbindService();
    

For detailed tutorial on how to use RouterGroupClient to talk to GroupService and send/receive messages to peers, please check out github sample project.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RouterGroupClient.GroupHandler GroupHandler exposes client side async messaging one-way AIDL api to allow GroupService notify events such as peer devices joining group, peer devices leaving a group or receiving a message.

Constructor Summary

Constructors

Constructor and Description
RouterGroupClient(Context c, java.lang.String grp, DeviceInfo[] p, RouterGroupClient.GroupHandler h) RouterGroupClient constructor; register a GroupHandler to expose client side one-way asynchronous messaging api for GroupService to call back.

Method Summary

Modifier and Type	Method and Description
void	bindService() bind to Router Group Service.
void	getPeerDevices() request the info of peer devices in this group; the response is returned at GroupHandler.onGetPeerDevices().
void	send(DeviceInfo dest, byte[] msg) send a message to all peers in a group, or to a specific device.
void	unbindService() unbind from Router Group Service.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RouterGroupClient

public RouterGroupClient(Context c,
                         java.lang.String grp,
                         DeviceInfo[] p,
                         RouterGroupClient.GroupHandler h)

RouterGroupClient constructor; register a GroupHandler to expose client side one-way asynchronous messaging api for GroupService to call back.

Parameters:

c - context in which to bind to GroupService.

grp - string name of group.

p -

h - register a GroupHandler to expose client side one-way asynchronous messaging api for GroupService to call back.

Method Detail

bindService

public void bindService()

bind to Router Group Service.

unbindService

public void unbindService()

unbind from Router Group Service.

send

public void send(DeviceInfo dest,
                 byte[] msg)

send a message to all peers in a group, or to a specific device.

Parameters:

dest - the target device to send message; if set to null, the message is broadcast to all peers in group.

msg - the message to send.

getPeerDevices

public void getPeerDevices()

request the info of peer devices in this group; the response is returned at GroupHandler.onGetPeerDevices().