com.xconns.peerdevicenet

Class Router.MsgId

java.lang.Object

com.xconns.peerdevicenet.Router.MsgId

Enclosing class:

Router

public static final class Router.MsgId
extends java.lang.Object

Messenger api allows clients communicate with Router services using "Messenger" design pattern with messages identified by message ids; clients will use a messenger to send messages to Router services and register another messenger to receive messages from Router services; there is 1-1 correspondence between intent names and message ids. All message data are passed as a bundle with data items indexed by keys. The message data keys is defined at Router.MsgKey class.

include the following groups of message ids:

1. message ids for communicating with ConnectionService:
   1. network detection, connection and disconnection: GET_NETWORKS, GET_ACTIVE_NETWORK, ACTIVATE_NETWORK, CONNECT_NETWORK, DISCONNECT_NETWORK, NETWORK_CONNECTING, NETWORK_CONNECTED, NETWORK_DISCONNECTED, NETWORK_CONNECTION_FAILED.
   2. peer discovery: START_SEARCH, SEARCH_FOUND_DEVICE, SEARCH_COMPLETE.
   3. peer device connection: CONNECT, DISCONNECT, ACCEPT_CONNECTION, DENY_CONNECTION, CONNECTING, CONNECTION_FAILED, CONNECTED, DISCONNECTED.
   4. info retrieval: SET_CONNECTION_INFO, GET_CONNECTION_INFO, GET_DEVICE_INFO
2. message ids for communicating with GroupService:
   1. group membership: JOIN_GROUP, LEAVE_GROUP, SELF_JOIN, PEER_JOIN, SELF_LEAVE, PEER_LEAVE
   2. message passing: SEND_MSG, RECV_MSG
   3. info retrieval: GET_CONNECTED_PEERS

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

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

        //first bind to messenger service:
        Intent intent = new Intent("com.xconns.peerdevicenet.Messenger");
        bindService(intent, mConnection, Context.BIND_AUTO_CREATE);
        ......
        //then at onServiceConnected(): register a receiver messenger to receive messages:
        Message msg = Message.obtain(null, Router.MsgId.REGISTER_RECEIVER);
        msg.replyTo = mMessenger;
        mService.send(msg);
            

2. use messenger to send messages to Router services to perform operations:

        Message msg = Message.obtain(null, Router.MsgId.SEND_MSG, 0, 0);
        Bundle b = new Bundle();
        b.putByteArray(Router.MSG_DATA, msg_data.getBytes());
        b.putString(Router.GROUP_ID, groupId);
        msg.setData(b);
        mService.send(msg);
            

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

        // first tell Router services we are leaving:
        Message msg = Message.obtain(null, Router.MsgId.LEAVE_GROUP);
        msg.setData(b);
        mService.send(msg);
        // then unregister receiver messenger:
        msg = Message.obtain(null, Router.MsgId.UNREGISTER_RECEIVER);
        msg.replyTo = mMessenger;
        mService.send(msg);
        // finally unbind messenger service
        unbindService(mConnection);
            

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACCEPT_CONNECTION message id for accepting a peer's connection request.
static int	ACTIVATE_NETWORK message id for request and reply to activate a network for use to discover and connect peer devices.
static int	CONNECT message id for request to connect to a peer device.
static int	CONNECT_NETWORK message id to request connecting to a network
static int	CONNECTED message id to notify client that a peer connected.
static int	CONNECTING message id to notify client that a peer device is trying to connect.
static int	CONNECTION_FAILED message id to notify client that connection to peer failed.
static int	DENY_CONNECTION message id for denying peer's connection request.
static int	DISCONNECT message id for request to disconnect a peer device.
static int	DISCONNECT_NETWORK message id to request disconnecting from a network
static int	DISCONNECTED message id to notify client that a peer disconnected.
static int	ERROR message id for Router to return error messages to clients.
static int	GET_ACTIVE_NETWORK message id for request and reply info of the network currently used to discover and connect peer devices.
static int	GET_CONNECTED_PEERS message id for request and reply to get connected peer device info.
static int	GET_CONNECTION_INFO message id for request and reply of connection related info at ConnectionService.
static int	GET_DEVICE_INFO message id for request and reply of my device info at ConnectionService.
static int	GET_NETWORKS message id for request and reply info of networks currently attached to device.
static int	JOIN_GROUP message id for request to join a group
static int	LEAVE_GROUP message id for request to leave a group
static int	NETWORK_CONNECTED message id to notify clients device is attached to a new network.
static int	NETWORK_CONNECTING message id to notify clients that a connection to network is in process
static int	NETWORK_CONNECTION_FAILED message id to notify clients that connection to a network failed
static int	NETWORK_DISCONNECTED message id to notify clients device is detached from a network.
static int	PEER_JOIN message id to notify client a peer device joined group.
static int	PEER_LEAVE message id to notify client a peer device left group.
static int	RECV_MSG message id to notify client to receive a message from peers.
static int	REGISTER_RECEIVER message id to register a receiver messenger.
static int	SEARCH_COMPLETE intent action name to notify clients that search session completed, either because search session time out or client stoped search explicitly.
static int	SEARCH_FOUND_DEVICE message id to notify client that new device found during search.
static int	SEARCH_START message id to notify client the search session started.
static int	SELF_JOIN message id to notify client it has successfully joined a group.
static int	SELF_LEAVE message id to notify client it has left a group.
static int	SEND_MSG message id to send a message to peers.
static int	SEND_REMOTE_BROADCAST
static int	SET_CONNECTION_INFO message id for request and reply of setting connection related info in ConnectionService.
static int	START_REMOTE_ACTIVITY
static int	START_REMOTE_SERVICE
static int	START_SEARCH message id for request to start a new peer search session.
static int	STOP_SEARCH message id for request to stop current active peer search session.
static int	UNREGISTER_RECEIVER message id to unregister a receiver messenger.

Constructor Summary

Constructors

Constructor and Description
MsgId()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

ERROR

public static final int ERROR

message id for Router to return error messages to clients.

Message Data is a bundle indexed by MsgKey:

MSG_DATA string

error message string.

See Also:

Constant Field Values

START_SEARCH

public static final int START_SEARCH

message id for request to start a new peer search session.

Message data is a bundle indexed by MsgKey:

SEARCH_TIMEOUT seconds

search session timeout.

PEER_NAME string

search leader device name (can be missing or null).

PEER_ADDR string

search leader device address (can be missing or null).

PEER_PORT string

search leader device port (can be missing or null).

See Also:

Constant Field Values

STOP_SEARCH

public static final int STOP_SEARCH

message id for request to stop current active peer search session.

See Also:

Constant Field Values

SEARCH_START

public static final int SEARCH_START

message id to notify client the search session started.

Message data is a bundle indexed by MsgKey:

PEER_NAME string

search leader device name (can be missing or null).

PEER_ADDR string

search leader device address (can be missing or null).

PEER_PORT string

search leader device port (can be missing or null).

See Also:

Constant Field Values

SEARCH_FOUND_DEVICE

public static final int SEARCH_FOUND_DEVICE

message id to notify client that new device found during search.

Message data is a bundle indexed by MsgKey:

PEER_NAME string

found device name (can be missing or null).

PEER_ADDR string

found device address (can be missing or null).

PEER_PORT string

found device port (can be missing or null).

USE_SSL boolean

does the found device use SSL for conenction?

See Also:

Constant Field Values

SEARCH_COMPLETE

public static final int SEARCH_COMPLETE

intent action name to notify clients that search session completed, either because search session time out or client stoped search explicitly.

See Also:

Constant Field Values

CONNECT

public static final int CONNECT

message id for request to connect to a peer device.

Message data is a bundle indexed by MsgKey:

PEER_NAME string

peer device name.

PEER_ADDR string

peer device address.

PEER_PORT string

peer device port.

AUTHENTICATION_TOKEN binary

authentication data for peer to verify connection.

CONNECT_TIMEOUT integer

connection timeout.

See Also:

Constant Field Values

DISCONNECT

public static final int DISCONNECT

message id for request to disconnect a peer device.

Message data is a bundle indexed by MsgKey:

PEER_NAME string

peer device name.

PEER_ADDR string

peer device address.

PEER_PORT string

peer device port.

See Also:

Constant Field Values

ACCEPT_CONNECTION

public static final int ACCEPT_CONNECTION

message id for accepting a peer's connection request.

Message data is a bundle indexed by MsgKey:

PEER_NAME string

peer device name.

PEER_ADDR string

peer device address.

PEER_PORT string

peer device port.

See Also:

Constant Field Values

DENY_CONNECTION

public static final int DENY_CONNECTION

message id for denying peer's connection request.

Message data is a bundle indexed by MsgKey:

PEER_NAME string

peer device name.

PEER_ADDR string

peer device address.

PEER_PORT string

peer device port.

CONN_DENY_CODE integer

Connection Failure code for the reason of denial.

See Also:

Constant Field Values

CONNECTING

public static final int CONNECTING

message id to notify client that a peer device is trying to connect.

Message data is a bundle indexed by MsgKey:

PEER_NAME string

peer device name.

PEER_ADDR string

peer device address.

PEER_PORT string

peer device port.

AUTHENTICATION_TOKEN binary

authentication data from peer for verification.

See Also:

Constant Field Values

CONNECTION_FAILED

public static final int CONNECTION_FAILED

message id to notify client that connection to peer failed.

Message data is a bundle indexed by MsgKey:

PEER_NAME string

peer device name.

PEER_ADDR string

peer device address.

PEER_PORT string

peer device port.

CONN_DENY_CODE integer

Connection Failure code for the reason of denial.

See Also:

Constant Field Values

CONNECTED

public static final int CONNECTED

message id to notify client that a peer connected.

Message data is a bundle indexed by MsgKey:

PEER_NAME string

peer device name.

PEER_ADDR string

peer device address.

PEER_PORT string

peer device port.

See Also:

Constant Field Values

DISCONNECTED

public static final int DISCONNECTED

message id to notify client that a peer disconnected.

Message data is a bundle indexed by MsgKey:

PEER_NAME string

peer device name.

PEER_ADDR string

peer device address.

PEER_PORT string

peer device port.

See Also:

Constant Field Values

JOIN_GROUP

public static final int JOIN_GROUP

message id for request to join a group

Message data is a bundle indexed by MsgKey:

GROUP_ID string

name of group to join.

See Also:

Constant Field Values

LEAVE_GROUP

public static final int LEAVE_GROUP

message id for request to leave a group

Message data is a bundle indexed by MsgKey:

GROUP_ID string

name of group to leave.

See Also:

Constant Field Values

SELF_JOIN

public static final int SELF_JOIN

message id to notify client it has successfully joined a group.

Message data is a bundle indexed by MsgKey:

GROUP_ID string

name of group joined.

PEER_NAMES string array

peer device names.

PEER_ADDRS string array

peer device addresses.

PEER_PORTS string array

peer device ports.

See Also:

Constant Field Values

PEER_JOIN

public static final int PEER_JOIN

message id to notify client a peer device joined group.

Message data is a bundle indexed by MsgKey:

GROUP_ID string

name of group joined.

PEER_NAME string

peer device name.

PEER_ADDR string

peer device address.

PEER_PORT string

peer device port.

See Also:

Constant Field Values

SELF_LEAVE

public static final int SELF_LEAVE

message id to notify client it has left a group.

Message data is a bundle indexed by MsgKey:

GROUP_ID string

name of group left.

See Also:

Constant Field Values

PEER_LEAVE

public static final int PEER_LEAVE

message id to notify client a peer device left group.

Message data is a bundle indexed by MsgKey:

GROUP_ID string

name of group joined.

PEER_NAME string

peer device name.

PEER_ADDR string

peer device address.

PEER_PORT string

peer device port.

See Also:

Constant Field Values

SEND_MSG

public static final int SEND_MSG

message id to send a message to peers.

Message data is a bundle indexed by MsgKey:

PEER_NAME string

destination device name (can be missing or null for broadcast).

PEER_ADDR string

destination device address (can be missing or null for broadcast).

PEER_PORT string

destination device port (can be missing or null for broadcast).

GROUP_ID string

name of the group for broadcast message

MSG_ID string

message id

MSG_DATA string

message data

See Also:

Constant Field Values

RECV_MSG

public static final int RECV_MSG

message id to notify client to receive a message from peers.

Message data is a bundle indexed by MsgKey:

PEER_NAME string

source device name.

PEER_ADDR string

source device address.

PEER_PORT string

source device port.

GROUP_ID string

name of the group for broadcast message

MSG_ID string

message id

MSG_DATA string

message data

See Also:

Constant Field Values

SET_CONNECTION_INFO

public static final int SET_CONNECTION_INFO

message id for request and reply of setting connection related info in ConnectionService.

Request message data is a bundle indexed by MsgKey:

DEVICE_NAME string

my device name.

LIVENESS_TIMEOUT seconds

the period between successive checking of peers' aliveness.

CONNECT_TIMEOUT seconds

peer device connection timeout.

SEARCH_TIMEOUT seconds

peer search session timeout.

USE_SSL boolean

does my connections to peers use SSL?

See Also:

Constant Field Values

GET_CONNECTION_INFO

public static final int GET_CONNECTION_INFO

message id for request and reply of connection related info at ConnectionService.

Reply message data is a bundle indexed by MsgKey:

DEVICE_NAME string

my device name.

LIVENESS_TIMEOUT seconds

the period between successive checking of peers' aliveness.

CONNECT_TIMEOUT seconds

peer device connection timeout.

SEARCH_TIMEOUT seconds

peer search session timeout.

USE_SSL boolean

does my connections to peers use SSL?

See Also:

Constant Field Values

GET_DEVICE_INFO

public static final int GET_DEVICE_INFO

message id for request and reply of my device info at ConnectionService.

Reply message data is a bundle indexed by MsgKey:

PEER_NAME string

peer device name.

PEER_ADDR string

peer device address.

PEER_PORT string

peer device port.

See Also:

Constant Field Values

GET_CONNECTED_PEERS

public static final int GET_CONNECTED_PEERS

message id for request and reply to get connected peer device info.

Request message data is a bundle indexed by MsgKey:

GROUP_ID string

name of group to request peers info (can be missing or null if request all peer device info).

Reply message data is a bundle indexed by MsgKey:

GROUP_ID string

name of group to request info (can be missing or null if request all peer info).

PEER_NAMES string array

peer device names.

PEER_ADDRS string array

peer device addresses.

PEER_PORTS string array

peer device ports.

See Also:

Constant Field Values

GET_NETWORKS

public static final int GET_NETWORKS

message id for request and reply info of networks currently attached to device.

Reply Message Data is a bundle indexed by MsgKey:

NET_TYPES integer array

network types.

NET_NAMES string array

network names.

NET_PASSES string array

network passwds.

NET_INFOS binary array

network infos.

NET_INTF_NAMES string array

network interface names.

NET_ADDRS string array

network addresses.

See Also:

Constant Field Values

GET_ACTIVE_NETWORK

public static final int GET_ACTIVE_NETWORK

message id for request and reply info of the network currently used to discover and connect peer devices.

Reply message data is a bundle indexed by MsgKey:

NET_TYPE integer

network type.

NET_NAME string

network name.

NET_PASS string

network passwd.

NET_INFO binary

network info.

NET_INTF_NAME string

network interface name.

NET_ADDR string

network address.

See Also:

Constant Field Values

ACTIVATE_NETWORK

public static final int ACTIVATE_NETWORK

message id for request and reply to activate a network for use to discover and connect peer devices.

Request and reply message data is a bundle indexed by MsgKey:

NET_TYPE integer

network type.

NET_NAME string

network name.

NET_PASS string

network passwd.

NET_INFO binary

network info.

NET_INTF_NAME string

network interface name.

NET_ADDR string

network address.

See Also:

Constant Field Values

NETWORK_CONNECTED

public static final int NETWORK_CONNECTED

message id to notify clients device is attached to a new network.

Message data is a bundle indexed by MsgKey:

NET_TYPE integer

network type.

NET_NAME string

network name.

NET_PASS string

network passwd.

NET_INFO binary

network info.

NET_INTF_NAME string

network interface name.

NET_ADDR string

network address.

See Also:

Constant Field Values

NETWORK_DISCONNECTED

public static final int NETWORK_DISCONNECTED

message id to notify clients device is detached from a network.

Message data is a bundle indexed by MsgKey:

NET_TYPE integer

network type.

NET_NAME string

network name.

NET_PASS string

network passwd.

NET_INFO binary

network info.

NET_INTF_NAME string

network interface name.

NET_ADDR string

network address.

See Also:

Constant Field Values

CONNECT_NETWORK

public static final int CONNECT_NETWORK

message id to request connecting to a network

Message data is a bundle indexed by MsgKey:

NET_TYPE integer

network type.

NET_NAME string

network name.

NET_PASS string

network passwd.

NET_INFO binary

network info.

NET_INTF_NAME string

network interface name.

NET_ADDR string

network address.

See Also:

Constant Field Values

DISCONNECT_NETWORK

public static final int DISCONNECT_NETWORK

message id to request disconnecting from a network

Message data is a bundle indexed by MsgKey:

NET_TYPE integer

network type.

NET_NAME string

network name.

NET_PASS string

network passwd.

NET_INFO binary

network info.

NET_INTF_NAME string

network interface name.

NET_ADDR string

network address.

See Also:

Constant Field Values

NETWORK_CONNECTING

public static final int NETWORK_CONNECTING

message id to notify clients that a connection to network is in process

Message data is a bundle indexed by MsgKey:

NET_TYPE integer

network type.

NET_NAME string

network name.

NET_PASS string

network passwd.

NET_INFO binary

network info.

NET_INTF_NAME string

network interface name.

NET_ADDR string

network address.

See Also:

Constant Field Values

NETWORK_CONNECTION_FAILED

public static final int NETWORK_CONNECTION_FAILED

message id to notify clients that connection to a network failed

Message data is a bundle indexed by MsgKey:

NET_TYPE integer

network type.

NET_NAME string

network name.

NET_PASS string

network passwd.

NET_INFO binary

network info.

NET_INTF_NAME string

network interface name.

NET_ADDR string

network address.

See Also:

Constant Field Values

REGISTER_RECEIVER

public static final int REGISTER_RECEIVER

message id to register a receiver messenger.

Message data:

replyTo

receiver messenger to be registered.

See Also:

Constant Field Values

UNREGISTER_RECEIVER

public static final int UNREGISTER_RECEIVER

message id to unregister a receiver messenger.

Message data:

replyTo

receiver messenger to be unregistered.

See Also:

Constant Field Values

START_REMOTE_ACTIVITY

public static final int START_REMOTE_ACTIVITY

See Also:

Constant Field Values

START_REMOTE_SERVICE

public static final int START_REMOTE_SERVICE

See Also:

Constant Field Values

SEND_REMOTE_BROADCAST

public static final int SEND_REMOTE_BROADCAST

See Also:

Constant Field Values

Constructor Detail

MsgId

public MsgId()