RouterConnectionClient

java.lang.Object
- com.xconns.peerdevicenet.RouterConnectionClient

```
public class RouterConnectionClient
extends java.lang.Object
```
RouterConnectionClient wrapper class is the preferred way to access the asynchronous one-way AIDL api of Router Connection Service. It enables two-way asynchronous messaging between clients and ConnectionService, and performs some extra book keeping:
- bind to (later unbind) Router ConnectionService to start a new session and hold session id.
- expose api methods which invoke ConnectionService one-way asynchronous messaging api as defined by IRouterConnectionService.aidl; perform operations such as retrieving network info, activating network, connecting or disconnecting device.
- register a ConnectionHandler which exposes client side one-way asynchronous messaging api to allow ConnectionService call back to notify events such as network detachment, device connection and disconnection.
- buffering api calls when the binding with ConnectionService is not ready, and resend buffered calls when the binding is ready.
It exposes the following groups of methods in accordance with ConnectionService AIDL api:
- network detection and management:
```
 void getNetworks()
 void getActiveNetwork()
 void connectNetwork(NetInfo net)
 void disconnectNetwork(NetInfo net)
 void activateNetwork(NetInfo net)
 
```
- peer discovery:
```
 void startPeerSearch(DeviceInfo groupLeader, int timeout)
 void stopPeerSearch()
 
```
- peer device connection:
```
 void acceptConnection(DeviceInfo peer)
 void connect(DeviceInfo peerInfo, byte[] token, int timeout)
 void denyConnection(DeviceInfo peer, int rejectCode)
 void disconnect(DeviceInfo peerInfo)
 
```
- info query:
```
 void setConnectionInfo(String devName, boolean useSSL, int liveTime,getDeviceInfo() int connTime, int searchTime)
 void getConnectionInfo()
 void getDeviceInfo()
 void getPeerDevices()
 
```
A sample scenario of using RouterConnectionClient to interact with ConnectionService is as following:
1. Initialization at onCreate() or onResume():
```
 //first bind to Router ConnectionService, and register ConnectionHandler.
 connClient = new RouterConnectionClient(this, connHandler);
 connClient.bindService();
 
```
2. call service async api to perform operations:
```
 connClient.connect(device, securityToken.getBytes(), connTimeout);
 
```
3. cleanup at onPause() or onDestroy():
```
 connClient.unbindService();
 
```
For detailed tutorial on how to use RouterConnectionClient to talk to ConnectionService and set up peer device connections, please check out github sample project.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`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.

Constructor Summary

Constructors
Constructor and Description
`RouterConnectionClient(Context c, RouterConnectionClient.ConnectionHandler h)` RouterConnectionClient constructor; register a ConnectionHandler to expose client side one-way asynchronous messaging api for ConnectionService to call back.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`acceptConnection(DeviceInfo peer)` accept the connection request from a peer device.
`void`	`activateNetwork(NetInfo net)` choose network as the network used to connect peer devices hereafter.
`void`	`bindService()` bind to Router Connection Service.
`void`	`connect(DeviceInfo peerInfo, byte[] token, int timeout)` send connection request to peer device.
`void`	`connectNetwork(NetInfo net)` connect to the specified network.
`void`	`denyConnection(DeviceInfo peer, int rejectCode)` deny the connection request from a peer device and tell the reason.
`void`	`disconnect(DeviceInfo peerInfo)` disconnect a connected peer device.
`void`	`disconnectNetwork(NetInfo net)` disconnect from specified network.
`void`	`getActiveNetwork()` request info of the network currently used to connect peer devices.
`void`	`getConnectionInfo()` request current connection related parameters at Connection Service.
`void`	`getDeviceInfo()` request current device info (name, address, port) known at Connection Service.
`void`	`getNetworks()` retrieve info of attached networks; the response is returned at ConnectionHandler.onGetNetworks().
`void`	`getPeerDevices()` retrieve info of connected peer devices; the response is returned at ConnectionHandler.onGetPeerDevices().
`void`	`setConnectionInfo(java.lang.String devName, boolean useSSL, int liveTime, int connTime, int searchTime)` set connection related parameters at Connection Service; they will be used as default hereafter.
`void`	`startPeerSearch(DeviceInfo groupLeader, int timeout)` start a new search session to find peer devices.
`void`	`stopPeerSearch()` stop current search session.
`void`	`unbindService()` unbind from Router Connection Service.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RouterConnectionClient
```
public RouterConnectionClient(Context c,
                              RouterConnectionClient.ConnectionHandler h)
```
    RouterConnectionClient constructor; register a ConnectionHandler to expose client side one-way asynchronous messaging api for ConnectionService to call back.
    
    Parameters:
    
    c - context (activity or service) in which to bind to Connection Service.
    
    h - register a ConnectionHandler to allow ConnectionService call back.
- Method Detail
  - bindService
```
public void bindService()
```
    bind to Router Connection Service.
  - unbindService
```
public void unbindService()
```
    unbind from Router Connection Service.
  - startPeerSearch
```
public void startPeerSearch(DeviceInfo groupLeader,
                            int timeout)
```
    start a new search session to find peer devices.
    
    Parameters:
    
    groupLeader - info of leader device which may run hotspot or own wifi direct group. It is the enabler for a group of devices to discover each other.
    
    timeout - search session timeout in seconds; if set to 0, search forever until stopped explicitly; if set to negative, use preset search timeout (default 30 seconds).
  - stopPeerSearch
```
public void stopPeerSearch()
```
    stop current search session.
  - acceptConnection
```
public void acceptConnection(DeviceInfo peer)
```
    accept the connection request from a peer device.
    
    Parameters:
    
    peer - info of connecting peer device.
  - denyConnection
```
public void denyConnection(DeviceInfo peer,
                           int rejectCode)
```
    deny the connection request from a peer device and tell the reason.
    
    Parameters:
    
    peer - info of connecting peer device.
    
    rejectCode - reason of denial.
  - connect
```
public void connect(DeviceInfo peerInfo,
                    byte[] token,
                    int timeout)
```
    send connection request to peer device.
    
    Parameters:
    
    peerInfo - info of peer device.
    
    token - binary data for authentication.
    
    timeout - connection timeout in seconds; if set to 0, wait forever; if set to negative, use preset value (default to 5 seconds).
  - disconnect
```
public void disconnect(DeviceInfo peerInfo)
```
    disconnect a connected peer device.
    
    Parameters:
    
    peerInfo - info of device to be disconnected.
  - setConnectionInfo
```
public void setConnectionInfo(java.lang.String devName,
                              boolean useSSL,
                              int liveTime,
                              int connTime,
                              int searchTime)
```
    set connection related parameters at Connection Service; they will be used as default hereafter.
    
    Parameters:
    
    devName - name of this device appearing to peers.
    
    useSSL - if use TLS/SSL for peer connections.
    
    liveTime - the period between successive verifications of peer devices aliveness.
    
    connTime - socket connection attempt timeout.
    
    searchTime - peer device search timeout.
  - getConnectionInfo
```
public void getConnectionInfo()
```
    request current connection related parameters at Connection Service. the response is returned at ConnectionHandler.onGetConnectionInfo().
  - getDeviceInfo
```
public void getDeviceInfo()
```
    request current device info (name, address, port) known at Connection Service. the response is returned at ConnectionHandler.onGetDeviceInfo().
  - getPeerDevices
```
public void getPeerDevices()
```
    retrieve info of connected peer devices; the response is returned at ConnectionHandler.onGetPeerDevices().
  - getNetworks
```
public void getNetworks()
```
    retrieve info of attached networks; the response is returned at ConnectionHandler.onGetNetworks().
  - getActiveNetwork
```
public void getActiveNetwork()
```
    request info of the network currently used to connect peer devices. the response is at ConnectionHandler.onGetActiveNetwork().
  - activateNetwork
```
public void activateNetwork(NetInfo net)
```
    choose network as the network used to connect peer devices hereafter.
    
    Parameters:
    
    net - info of the network to be activated.
  - connectNetwork
```
public void connectNetwork(NetInfo net)
```
    connect to the specified network.
    
    Parameters:
    
    net - info of the network to be activated.
  - disconnectNetwork
```
public void disconnectNetwork(NetInfo net)
```
    disconnect from specified network.
    
    Parameters:
    
    net - info of the network to be activated.

Class RouterConnectionClient

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RouterConnectionClient

Method Detail

bindService

unbindService

startPeerSearch

stopPeerSearch

acceptConnection

denyConnection

connect

disconnect

setConnectionInfo

getConnectionInfo

getDeviceInfo

getPeerDevices

getNetworks

getActiveNetwork

activateNetwork

connectNetwork

disconnectNetwork