Class FileTransferManager

Entry point for peer-to-peer file transfer over WebRTC data channels.

Wraps a DataChannelHub and orchestrates both directions of transfer. For each peer it maintains a single JSON control channel (labelled CONTROL_CHANNEL_LABEL) carrying the offer/accept/complete/cancel handshake, and opens per-transfer binary channels for the framed chunk data. Outbound transfers are started with FileTransferManager.sendFile; inbound offers surface as FileTransferEvent.IncomingOffer events carrying a ReceiveTransfer the application accepts or rejects. The manager routes inbound control messages and data channels to the right Transfer, buffering data channels that arrive before their offer.

Remarks

The manager does not create or negotiate RTCPeerConnections itself — that is the hub's job. Completed, failed, and cancelled transfers are automatically removed from the manager's registry.

Example

const manager = new FileTransferManager(hub, { parallelChannels: 4 })

// Sending
const send = manager.sendFile(peerId, file)
send.on('progress', (p) => console.log(p.ratio))

// Receiving
manager.on('incoming-offer', (transfer) => {
    transfer.accept(new MemorySink())
})

Hierarchy (View Summary)

EventEmitter<FileTransferManagerEvents>
- FileTransferManager

Index

Constructors

constructor

Methods

close emit getTransfer listenerCount off on once removeAllListeners resumeSend sendFile transfers

Constructors

constructor

new FileTransferManager(
hub: DataChannelHub,
options?: FileTransferOptions,
): FileTransferManager
Parameters
- hub: DataChannelHub
  The data-channel hub used to open outbound channels and observe inbound ones.
- options: FileTransferOptions = {}
  Default tuning and checksum settings applied to every transfer; see FileTransferOptions. Per-send overrides are passed to FileTransferManager.sendFile.
Returns FileTransferManager
Overrides EventEmitter.constructor
- Defined in packages/sdk/src/filetransfer/FileTransferManager.ts:98

Methods

close

close(): void
Shuts down the manager: detaches from the hub, cancels every in-flight transfer, and closes all control channels. Idempotent. After closing, FileTransferManager.sendFile throws.

Returns void
- Defined in packages/sdk/src/filetransfer/FileTransferManager.ts:217

emit

emit<K extends keyof FileTransferManagerEvents>(
event: K,
...args: FileTransferManagerEvents[K],
): boolean
Synchronously invokes every listener registered for event, in registration order.
Type Parameters
- K extends keyof FileTransferManagerEvents
Parameters
- event: K
  The event name to emit.
- ...args: FileTransferManagerEvents[K]
  The argument tuple to pass to each listener, matching Events[event].
Returns boolean
true if at least one listener was invoked, false if there were none.

Remarks
The listener list is snapshotted before dispatch, so mutations made by handlers take effect only on subsequent emissions. Listeners are isolated: if one throws, the remaining listeners still run and the error is surfaced via console.error rather than swallowed silently (consistent with LocalMessageBus).
Inherited from EventEmitter.emit
- Defined in packages/core/src/EventEmitter.ts:95

getTransfer

getTransfer(id: string): Transfer | undefined
Looks up a tracked transfer by id.
Parameters
- id: string
  The transfer id.
Returns Transfer | undefined
The Transfer, or undefined if unknown or already terminal.
- Defined in packages/sdk/src/filetransfer/FileTransferManager.ts:209

listenerCount

listenerCount<K extends keyof FileTransferManagerEvents>(event: K): number
Returns the number of listeners currently registered for event.
Type Parameters
- K extends keyof FileTransferManagerEvents
Parameters
- event: K
  The event name to count listeners for.
Returns number
The count of registered listeners (0 if none).
Inherited from EventEmitter.listenerCount
- Defined in packages/core/src/EventEmitter.ts:128

off

off<K extends keyof FileTransferManagerEvents>(
event: K,
listener: (...args: FileTransferManagerEvents[K]) => void,
): this
Removes a previously registered listener for event.
Type Parameters
- K extends keyof FileTransferManagerEvents
Parameters
- event: K
  The event name the listener was registered for.
- listener: (...args: FileTransferManagerEvents[K]) => void
  The exact function reference passed to on or once.
Returns this
This emitter, for chaining.

Remarks
If the listener is not currently registered, this is a no-op. Only the first matching registration is removed.
Inherited from EventEmitter.off
- Defined in packages/core/src/EventEmitter.ts:74

on

on<K extends keyof FileTransferManagerEvents>(
event: K,
listener: (...args: FileTransferManagerEvents[K]) => void,
): this
Registers a listener that is invoked every time event is emitted.
Type Parameters
- K extends keyof FileTransferManagerEvents
Parameters
- event: K
  The event name to listen for.
- listener: (...args: FileTransferManagerEvents[K]) => void
  Callback invoked with the event's argument tuple.
Returns this
This emitter, for chaining.
Inherited from EventEmitter.on
- Defined in packages/core/src/EventEmitter.ts:43

once

once<K extends keyof FileTransferManagerEvents>(
event: K,
listener: (...args: FileTransferManagerEvents[K]) => void,
): this
Registers a listener that is invoked at most once: it is removed automatically before being called the first time event is emitted.
Type Parameters
- K extends keyof FileTransferManagerEvents
Parameters
- event: K
  The event name to listen for.
- listener: (...args: FileTransferManagerEvents[K]) => void
  Callback invoked with the event's argument tuple on the next emission.
Returns this
This emitter, for chaining.

Remarks
Remove a pending one-time listener by passing the same function reference to off.
Inherited from EventEmitter.once
- Defined in packages/core/src/EventEmitter.ts:57

removeAllListeners

removeAllListeners(event?: keyof FileTransferManagerEvents): this
Removes listeners for a single event, or for all events.
Parameters
- Optionalevent: keyof FileTransferManagerEvents
  The event name to clear; if omitted, listeners for every event are removed.
Returns this
This emitter, for chaining.
Inherited from EventEmitter.removeAllListeners
- Defined in packages/core/src/EventEmitter.ts:116

resumeSend

resumeSend(transferId: string): void
Resume an interrupted resumable send by re-announcing it on freshly opened data channels (call after the peer connection reconnects). Only the chunks the receiver is still missing are resent. No-op unless the transfer exists, is a SendTransfer, and was interrupted.
Parameters
- transferId: string
  Id of the interrupted send transfer.
Returns void
- Defined in packages/sdk/src/filetransfer/FileTransferManager.ts:165

sendFile

sendFile(peerId: string, input: SendInput, opts?: SendOptions): SendTransfer
Offers a file to a peer and begins the send.

Opens parallelChannels binary data channels to the peer, wraps input in a FileSource, and returns a started SendTransfer. Actual byte streaming begins once the receiver accepts the offer.
Parameters
- peerId: string
  Identifier of the peer to send to; must have an active connection in the hub.
- input: SendInput
  The file to send: a File, Blob, or custom FileSource.
- opts: SendOptions = {}
  Optional per-transfer overrides merged over the manager defaults; see SendOptions.
Returns SendTransfer
The SendTransfer; subscribe to its events to track progress and completion.
Throws
FileTransferError with code InvalidState if the manager is closed, or ChannelClosed if there is no connection to peerId.
Example
```
const transfer = manager.sendFile('peer-42', file, { chunkSize: 32 * 1024, checksum: true })
transfer.on('complete', () => console.log('done'))
```
- Defined in packages/sdk/src/filetransfer/FileTransferManager.ts:126

transfers

transfers(): Transfer[]
Returns all currently-tracked transfers in both directions.

Returns Transfer[]
A snapshot array of active Transfers (terminal transfers are already removed).
- Defined in packages/sdk/src/filetransfer/FileTransferManager.ts:199

Class FileTransferManager

Remarks

Example

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns FileTransferManager

Methods

close

Returns void

emit

Type Parameters

Parameters

Returns boolean

Remarks

getTransfer

Parameters

Returns Transfer | undefined

listenerCount

Type Parameters

Parameters

Returns number

off

Type Parameters

Parameters

Returns this

Remarks

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

Remarks

removeAllListeners

Parameters

Returns this

resumeSend

Parameters

Returns void

sendFile

Parameters

Returns SendTransfer

Throws

Example

transfers

Returns Transfer[]

Settings

On This Page