@libp2p/multistream-select/src/index.ts

JavaScript implementation of multistream-select

/**
 * @packageDocumentation
 *
 * multistream-select is protocol multiplexing per connection/stream. [Full spec here](https://github.com/multiformats/multistream-select)
 *
 * ## Select a protocol flow
 *
 * The caller will send "interactive" messages, expecting for some acknowledgement from the callee, which will "select" the handler for the desired and supported protocol:
 *
 * ```
 * < /multistream-select/0.3.0  # i speak multistream-select/0.3.0
 * > /multistream-select/0.3.0  # ok, let's speak multistream-select/0.3.0
 * > /ipfs-dht/0.2.3            # i want to speak ipfs-dht/0.2.3
 * < na                         # ipfs-dht/0.2.3 is not available
 * > /ipfs-dht/0.1.9            # What about ipfs-dht/0.1.9 ?
 * < /ipfs-dht/0.1.9            # ok let's speak ipfs-dht/0.1.9 -- in a sense acts as an ACK
 * > <dht-message>
 * > <dht-message>
 * > <dht-message>
 * ```
 */

import { PROTOCOL_ID } from './constants.js'
import type { AbortOptions } from '@libp2p/interface'
import type { LengthPrefixedStreamOpts } from '@libp2p/utils'

export { PROTOCOL_ID }

export interface MultistreamSelectInit extends AbortOptions, Partial<LengthPrefixedStreamOpts> {
  /**
   * When false, and only a single protocol is being negotiated, use optimistic
   * select to send both the protocol name and the first data buffer in the
   * initial message, saving a round trip for connection establishment.
   *
   * @default true
   */
  negotiateFully?: boolean
}

export { select } from './select.js'
export { handle } from './handle.js'