com.xconns.peerdevicenet

Interface RouterConnectionClient.ConnectionHandler

Enclosing class:

RouterConnectionClient

public 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. It implements IConnectionHandler.aidl.

It exposes the following groups of callback methods in accordance with ConnectionHandler AIDL api:

• network detection:

   void onGetActiveNetwork(NetInfo net)
   void onGetNetworks(NetInfo[] nets)
   void onNetworkActivated(NetInfo net)
   void onNetworkConnecting(NetInfo net)
   void onNetworkConnected(NetInfo net)
   void onNetworkDisconnected(NetInfo net)
   void onNetworkConnectionFailed(NetInfo net)
   

• peer discovery:

   onSearchStart(DeviceInfo groupLeader)
   onSearchFoundDevice(DeviceInfo device, boolean useSSL)
   onSearchComplete()
   

• peer device connection:

   onConnected(DeviceInfo peerInfo)
   onConnecting(DeviceInfo device, byte[] token)
   onConnectionFailed(DeviceInfo device, int rejectCode)
   onDisconnected(DeviceInfo peerInfo)
   

• info query:

   onSetConnectionInfo()
   onGetConnectionInfo(String devName, boolean useSSL, int liveTime, int connTime, int searchTime)
   onGetDeviceInfo(DeviceInfo device)
   onGetPeerDevices(DeviceInfo[] devices)
   

Method Summary

Modifier and Type	Method and Description
void	onConnected(DeviceInfo peerInfo) Notify client that a peer device successfully connected to this device; either because the client accept peer connection request or peer accept the client's connection request.
void	onConnecting(DeviceInfo device, byte[] token) Notify client a peer device is trying to connect to this device.
void	onConnectionFailed(DeviceInfo device, int rejectCode) Notify client its attempt to connect to peer device failed.
void	onDisconnected(DeviceInfo peerInfo) Notify client a peer device disconnected; either because the client or its peer called disconnect() api; or because network failed.
void	onError(java.lang.String errInfo) Notify clients about two kinds of errors: errors happening at server processing.
void	onGetActiveNetwork(NetInfo net) Pass to clients info about the network used to connect to peer devices.
void	onGetConnectionInfo(java.lang.String devName, boolean useSSL, int liveTime, int connTime, int searchTime) Reply to client connection related settings currently active at Connection Service; This is the response to getConnectionInfo() api call.
void	onGetDeviceInfo(DeviceInfo device) Reply to client info about this device; This is the response to getDeviceInfo() api call.
void	onGetNetworks(NetInfo[] nets) Pass to clients info about currently attached networks detected by ConnectionService.
void	onGetPeerDevices(DeviceInfo[] devices) Reply to client info about peer devices connected to this device.
void	onNetworkActivated(NetInfo net) Pass to clients info about network activated.
void	onNetworkConnected(NetInfo net) Notify clients that ConnectionService detects a new network.
void	onNetworkConnecting(NetInfo net) Notify clients that network connection is in process.
void	onNetworkConnectionFailed(NetInfo net) Notify clients that network connection attempt failed.
void	onNetworkDisconnected(NetInfo net) Notify clients that a network is disconnected.
void	onSearchComplete() Notify clients current active search session completes, either because clients called stopSearch() or search session timeout.
void	onSearchFoundDevice(DeviceInfo device, boolean useSSL) Notify clients in a search session a device is found.
void	onSearchStart(DeviceInfo groupLeader) Notify client a search session started; It is the response to startSearch() api call.
void	onSetConnectionInfo() Notify client its call to setConnectionInfo() api call succeed and connection related settings (device name, use SSL, connection timeout, etc.) have been updated successfully at Connection Service.

Method Detail

onError

void onError(java.lang.String errInfo)

Notify clients about two kinds of errors:

• errors happening at server processing.
• errors happening at client invoking ConnectionService api.

Parameters:

errInfo - the detailed error message

onGetNetworks

void onGetNetworks(NetInfo[] nets)

Pass to clients info about currently attached networks detected by ConnectionService. This is the response to getNetworks() api call.

Parameters:

nets - info about current networks to which the device is attached.

onGetActiveNetwork

void onGetActiveNetwork(NetInfo net)

Pass to clients info about the network used to connect to peer devices. This is the response to getActiveNetwork() call.

Parameters:

net - info about the network actively used to communicate with peer devices.

onNetworkConnected

void onNetworkConnected(NetInfo net)

Notify clients that ConnectionService detects a new network.

Parameters:

net - info about a network this device is newly attached.

onNetworkConnecting

void onNetworkConnecting(NetInfo net)

Notify clients that network connection is in process.

Parameters:

net - info about connecting network.

onNetworkConnectionFailed

void onNetworkConnectionFailed(NetInfo net)

Notify clients that network connection attempt failed.

Parameters:

net - info about network.

onNetworkDisconnected

void onNetworkDisconnected(NetInfo net)

Notify clients that a network is disconnected.

Parameters:

net - info about disconnected network.

onNetworkActivated

void onNetworkActivated(NetInfo net)

Pass to clients info about network activated. This is the response to activateNetwork() api call.

Parameters:

net - info of the network activated.

onSearchStart

void onSearchStart(DeviceInfo groupLeader)

Notify client a search session started; It is the response to startSearch() api call.

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.

onSearchFoundDevice

void onSearchFoundDevice(DeviceInfo device,
                         boolean useSSL)

Notify clients in a search session a device is found.

Parameters:

device - info of found device (name, address, port number).

useSSL - does connection to this device use TLS/SSL or not.

onSearchComplete

void onSearchComplete()

Notify clients current active search session completes, either because clients called stopSearch() or search session timeout.

onConnecting

void onConnecting(DeviceInfo device,
                  byte[] token)

Notify client a peer device is trying to connect to this device.

Parameters:

device - peer device info which try to connect

token - binary data passed by peer device as authentication token.

onConnectionFailed

void onConnectionFailed(DeviceInfo device,
                        int rejectCode)

Notify client its attempt to connect to peer device failed.

Parameters:

device - target peer device the client try to connect

rejectCode - reason of connection failure.

onConnected

void onConnected(DeviceInfo peerInfo)

Notify client that a peer device successfully connected to this device; either because the client accept peer connection request or peer accept the client's connection request.

Parameters:

peerInfo - info of connected device.

onDisconnected

void onDisconnected(DeviceInfo peerInfo)

Notify client a peer device disconnected; either because the client or its peer called disconnect() api; or because network failed.

Parameters:

peerInfo - info of disconnected device.

onSetConnectionInfo

void onSetConnectionInfo()

Notify client its call to setConnectionInfo() api call succeed and connection related settings (device name, use SSL, connection timeout, etc.) have been updated successfully at Connection Service.

onGetConnectionInfo

void onGetConnectionInfo(java.lang.String devName,
                         boolean useSSL,
                         int liveTime,
                         int connTime,
                         int searchTime)

Reply to client connection related settings currently active at Connection Service; This is the response to getConnectionInfo() api call.

Parameters:

devName - name of this device

useSSL - does this device use TLS/SSL connect to peer devices or not.

liveTime - the period between successive verifications of liveness of peer device.

connTime - peer device connection timeout.

searchTime - search session timeout.

onGetDeviceInfo

void onGetDeviceInfo(DeviceInfo device)

Reply to client info about this device; This is the response to getDeviceInfo() api call.

Parameters:

device - info of this device (name, address, port).

onGetPeerDevices

void onGetPeerDevices(DeviceInfo[] devices)

Reply to client info about peer devices connected to this device.

Parameters:

devices - peer devices currently connected.