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.
Okmeans stop request was accepted for an active stream.- After
Ok, the relatedTransfer filestream ends with terminalstatus = 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 returnsFileNotBeingTransferred.
Stop-file-transfer statuses
| Status | Constant | Returned when |
|---|---|---|
1 | Ok | Stop request accepted for an active transfer. |
305 | FileNotBeingTransferred | No 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 code | Error | When it happens |
|---|---|---|
4200 | connection is not initialized | Request was sent before successful Initialize. |
4201 | rate limit hit | Global per-session packet rate limit was exceeded. |
4302 | invalid request body | Packet body does not match the required schema for this operation. |
4304 | received unsupported data | Client sent unsupported frame type (request packets must be text JSON). |