/* c8 ignore start */

import { EventEmitter } from "eventemitter3"
import { NetworkAdapterEvents, PeerMetadata } from "../index.js"
import { PeerId } from "../types.js"
import { Message } from "./messages.js"
import { NetworkAdapterInterface } from "./NetworkAdapterInterface.js"

/** An interface representing some way to connect to other peers
 *
 * @remarks
 * The {@link Repo} uses one or more `NetworkAdapter`s to connect to other peers.
 * Because the network may take some time to be ready the {@link Repo} will wait
 * until the adapter emits a `ready` event before it starts trying to use it
 *
 * This utility class can be used as a base to build a custom network adapter. It
 * is most useful as a simple way to add the necessary event emitter functionality
 */
export abstract class NetworkAdapter
  extends EventEmitter<NetworkAdapterEvents>
  implements NetworkAdapterInterface
{
  peerId?: PeerId
  peerMetadata?: PeerMetadata

  abstract isReady(): boolean
  abstract whenReady(): Promise<void>

  /** Called by the {@link Repo} to start the connection process
   *
   * @argument peerId - the peerId of this repo
   * @argument peerMetadata - how this adapter should present itself to other peers
   */
  abstract connect(peerId: PeerId, peerMetadata?: PeerMetadata): void

  /** Called by the {@link Repo} to send a message to a peer
   *
   * @argument message - the message to send
   */
  abstract send(message: Message): void

  /** Called by the {@link Repo} to disconnect from the network */
  abstract disconnect(): void
}