Package com.xconns.peerdevicenet

PeerDeviceNet enables P2P, M2M connection and communication among mobile,IoT devices (phones, tablets, etc.).

See: Description

Interface Summary

Interface	Description
RouterConnectionClient.ConnectionHandler	ConnectionHandler exposes client side async messaging one-way AIDL api to allow ConnectionService call back to notify events such as network attachment and detachment, device connection and disconnection.
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.

Class Summary

Class	Description
DeviceInfo	Info of a device in peer-peer network: its name, address and port number.
NetInfo	Info of the network connecting peer devices: its type (wifi, hotspot, ...), name (SSID,...), encrypt password, interface name, support multicast or not, etc.
Router	Messaging api for clients to communicate with Router services using intents and messenger.
Router.ConnFailureCode	Reasons why peer device connections failed.
Router.Intent	Intenting api allows clients communicate with Router services using intents; clients will send intents/messages to Router services by calling startService() and received intents/messages from Router services by registering BroadcastReceivers.
Router.MsgId	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.
Router.MsgKey	key names for indexing data items in message bundle.
RouterConnectionClient	RouterConnectionClient wrapper class is the preferred way to access the asynchronous one-way AIDL api of Router Connection Service.
RouterGroupClient	RouterGroupClient wrapper class is the preferred way to access the asynchronous one-way AIDL api of Router Group Service.

Package com.xconns.peerdevicenet Description

PeerDeviceNet enables P2P, M2M connection and communication among mobile,IoT devices (phones, tablets, etc.).

At mobile devices, PeerDeviceNet runtime (Router) runs as android services in a background process. Currently it includes the following services

1. ConnectionService, supports the following functions:
   1. connect, disconnect networks, detect attachments and detachments (wifi, wifi direct, mobile hotspot).
   2. perform peer devices discovery
   3. handle device connections and disconnections.
2. GroupService, supports the following functions:
   1. join/leave communication group, detect peer devices joining or leaving.
   2. send messages to peers in group and receive messages from peers in group.

PeerDeviceNet APIs provides asynchronous messaging interfaces between clients and Router services (Connection Service and Group Service). Router services will expose their APIs as asynchronous messages (or one-way AIDL methods). Similarly clients will provide async messaging (or one-way AIDL methods) APIs to allow Router services to call back or notify clients for events such as network attachment and detachment, peer device connection and disconnection.

Both runtime/Router and api have been published as two jar/aar files at Maven Central. You can download the latest jars from MavenCentral Site, or grab via Maven or gradle as following:

1. API: peerdevicenet-api.jar
1. maven
<dependency>
<groupId>com.xconns.peerdevicenet</groupId>
<artifactId>peerdevicenet-api</artifactId>
<version>1.1.8</version>
</dependency>

2. gradle
   com.xconns.peerdevicenet:peerdevicenet-api:1.1.8
   
2. Runtime: peerdevicenet-router.aar
1. maven
<dependency>
<groupId>com.xconns.peerdevicenet</groupId>
<artifactId>peerdevicenet-router</artifactId>
<version>1.1.8</version>
<packaging>aar</packaging>
</dependency>

2. gradle
   com.xconns.peerdevicenet:peerdevicenet-router:1.1.8
   

These asynchronous messaging apis between clients and Router services can be accessed in three ways:

1. intent actions
Intent API provides high level access to Router's features. To use this API, all you need is to have PeerDeviceNet (Router) installed on users devices to gain the runtime support. Apps send normal android intents using PeerDeviceNet specific action names and pack message data as intent "extra" data items with PeerDeviceNet specific keys. All the PeerDeviceNet action names are defined at Router.Intent class and "extra" data keys at Router.MsgKey class which you get when you add the client jar file to your project.
2. one-way AIDL methods
To access Router services thru these apis, you can use directly access aidl apis or use client wrapper classes RouterConnectionClient and RouterGroupClient. These wrapper classes also handle some common book-keeping for you. There is also DeviceInfo class and NetInfo class used at aidl apis which defines information about devices and networks.
3. messages sent thru Messengers
This api defines a group of PeerDeviceNet specific message ids to allow apps use android's "Messenger" design pattern to talk to Router services. Apps use messengers to send message data as a bundle with data items indexed by keys. All the PeerDeviceNet message ids are defined at Router.MsgId class and message data keys at Router.MsgKey class.