Class P2PProtocol

Static ReadonlyBUFFER_HIGH_WATER

4 * 1024 * 1024
Copy

Static ReadonlyBUFFER_LOW_WATER

1 * 1024 * 1024
Copy

Static ReadonlyCHUNK_INDEX_BYTES

4
Copy

Static ReadonlyCONNECT_TIMEOUT_MS

30000
Copy

Static ReadonlyCONTROL_TIMEOUT_MS

30000
Copy

Static ReadonlyMAX_MESSAGE_SIZE

262144
Copy

Static ReadonlyNACK_RETRY_LIMIT

3
Copy

StaticchunkCount

• chunkCount(size: number, chunkPayloadSize: number): number

  Total chunks for a file size.

  Parameters

  • size: number

    The file size in bytes.

  • chunkPayloadSize: number

    The payload size of a single chunk.

  Returns number

  The number of chunks.

StaticchunkPayloadSize

• chunkPayloadSize(sctpMaxMessageSize?: number | null): number

  Usable payload bytes per chunk for a given negotiated SCTP max message size.

  Parameters

  • OptionalsctpMaxMessageSize: number | null

    The negotiated maximum, or null when unknown.

  Returns number

  The plaintext payload size of a single chunk.

StaticdecryptChunk

• decryptChunk(
      data: ArrayBuffer,
      key: CryptoKey,
  ): Promise<{ index: number; payload: ArrayBuffer }>

  Decrypt a binary frame into index and payload.

  Parameters

  • data: ArrayBuffer

    The frame to decrypt.

  • key: CryptoKey

    The transfer key.

  Returns Promise<{ index: number; payload: ArrayBuffer }>

  The chunk index and its payload.

  Throws

  Error If the frame was tampered with or the key is wrong.

StaticdecryptControl

• decryptControl(data: string, key: CryptoKey): Promise<P2PControlMessage>

  Decrypt a string frame into a control message.

  Parameters

  • data: string

    The frame to decrypt.

  • key: CryptoKey

    The transfer key.

  Returns Promise<P2PControlMessage>

  The control message.

  Throws

  Error If the key is wrong or the frame is garbage.

StaticencryptChunk

• encryptChunk(
      index: number,
      payload: ArrayBuffer,
      key: CryptoKey,
  ): Promise<ArrayBuffer>

  Encrypt a chunk into a binary frame.

  Parameters

  • index: number

    The absolute chunk index.

  • payload: ArrayBuffer

    The plaintext chunk payload.

  • key: CryptoKey

    The transfer key.

  Returns Promise<ArrayBuffer>

  The encrypted binary frame.

StaticencryptControl

• encryptControl(msg: P2PControlMessage, key: CryptoKey): Promise<string>

  Encrypt a control message into a string frame.

  Parameters

  • msg: P2PControlMessage

    The message to encrypt.

  • key: CryptoKey

    The transfer key.

  Returns Promise<string>

  The encrypted string frame.