libs/connecteddevice/src/com/google/android/connecteddevice/transport/ConnectionProtocol.kt

/*
 * Copyright (C) 2021 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.google.android.connecteddevice.transport

import com.google.android.connecteddevice.util.SafeLog
import com.google.android.connecteddevice.util.ThreadSafeCallbacks
import java.util.UUID
import java.util.concurrent.ConcurrentHashMap
import java.util.concurrent.Executor

/**
 * Representation of a communication protocol that provides actions and event notifications for
 * interacting with devices.
 */
abstract class ConnectionProtocol {
  // protocolId -> callbacks
  protected val deviceCallbacks: ConcurrentHashMap<String, ThreadSafeCallbacks<DeviceCallback>> =
    ConcurrentHashMap()

  /** Begin the discovery process for a new device to associate with. */
  abstract fun startAssociationDiscovery(callback: DiscoveryCallback)

  /**
   * Begin the discovery process for a device that will respond to the supplied [id].
   */
  abstract fun startConnectionDiscovery(
    id: UUID,
    callback: DiscoveryCallback
  )

  /** Stop an ongoing discovery for the provided device. */
  abstract fun stopDiscovery(id: UUID)

  /** Send data to a device. */
  abstract fun sendData(protocolId: String, data: ByteArray, callback: DataSendCallback? = null)

  /** Disconnect a specific device. */
  abstract fun disconnectDevice(protocolId: String)

  /**
   * Disconnect all active connections, cancel any discoveries in progress, and clean up to a
   * neutral state.
   */
  abstract fun reset()

  /**
   * Returns the maximum number of bytes that can be written in a single message for the device
   * matching the [protocolId].
   */
  abstract fun getMaxWriteSize(protocolId: String): Int

  /** Register a callback to be notified of events for a device on this protocol. */
  fun registerCallback(
    protocolId: String,
    callback: DeviceCallback,
    executor: Executor
  ) {
    val callbacks = deviceCallbacks.computeIfAbsent(protocolId) { ThreadSafeCallbacks() }
    callbacks.add(callback, executor)
  }

  /** Unregister a previously registered callback. */
  fun unregisterCallback(
    protocolId: String,
    callback: DeviceCallback
  ) {
    if (!deviceCallbacks.containsKey(protocolId)) {
      SafeLog.logw(
        TAG,
        "Attempted to delete callback for device $protocolId that does not exist."
      )
      return
    }
    deviceCallbacks[protocolId]?.remove(callback)
  }

  /** Event notifications on the discovery process. */
  interface DiscoveryCallback {
    /** Invoked when discovery for a device has started successfully. */
    fun onDiscoveryStartedSuccessfully()

    /** Invoked when discovery for a device failed to start. */
    fun onDiscoveryFailedToStart()

    /** Invoked when a device connection is established in response to the discovery. */
    fun onDeviceConnected(protocolId: String)
  }

  /** Event notifications for a device on the protocol. */
  interface DeviceCallback {
    /** Invoked when a device has disconnected. */
    fun onDeviceDisconnected(protocolId: String)

    /** Invoked when the protocol has negotiated a new maximum data size. */
    fun onDeviceMaxDataSizeChanged(protocolId: String, maxBytes: Int)

    /** Invoked when data has been received from a device. */
    fun onDataReceived(protocolId: String, data: ByteArray?)
  }

  /** Callback for the result of sending data. */
  interface DataSendCallback {
    /** Invoked when the data was successfully sent. */
    fun onDataSentSuccessfully()

    /** Invoked when the data failed to send. */
    fun onDataFailedToSend()
  }

  companion object {
    private const val TAG = "ConnectionProtocol"
  }
}