Packets

Stop file transfer

Stops an active file transfer stream for the current session.

Stop file transfer requests termination of an active Transfer file stream by filename. This operation is available only after successful Initialize.

Request

Stop file transfer uses packet type = 8.

{
  "type": 8,
  "id": 9,
  "filename": "client.dll"
}

Prop

Type

Response

{
  "id": 9,
  "status": 1
}

Prop

Type

Behavior notes

  • Request packet and response packet are regular text JSON websocket frames.
  • Ok means stop request was accepted for an active stream.
  • After Ok, the related Transfer file stream ends with terminal status = FileTransferStopped.
  • A final in-flight transfer chunk can still arrive before terminal stop status, so client should continue reading transfer frames until terminal status.
  • If there is no active transfer for this filename, server returns FileNotBeingTransferred.

Stop-file-transfer statuses

StatusConstantReturned when
1OkStop request accepted for an active transfer.
305FileNotBeingTransferredNo active transfer exists for the provided filename in this session.

Connection-close cases (before/around this usecase)

Stop file transfer itself returns regular JSON responses, but session can still be closed by protocol/session guards:

Close codeErrorWhen it happens
4200connection is not initializedRequest was sent before successful Initialize.
4201rate limit hitGlobal per-session packet rate limit was exceeded.
4302invalid request bodyPacket body does not match the required schema for this operation.
4304received unsupported dataClient sent unsupported frame type (request packets must be text JSON).

On this page