Yamcs HTTP API
Methods
- Alarms
- Audit
- Buckets
- Clearance
- Commands
- Cop1
- Database
- Events
- File Transfer
- Iam
- Indexes
- Links
- Management
- Mdb Override
- Mdb
- Packets
- Parameter Archive
- Processing
- Queue
- Replication
- Rocks Db
- Server
- Sessions
- Stream Archive
- Table
- Time Correlation
- Time
- Timeline
Related
Yamcs Release Notes
Yamcs Server Manual
Source Code Documentation
Download this Document
Subscribe TransfersΒΆ
Receive transfer updates
WebSocket
This method requires to upgrade an HTTP connection to WebSocket. See details on how Yamcs uses WebSocket.
Use the message type file-transfers
.
Input Type
interface SubscribeTransfersRequest {
// Yamcs instance name.
instance: string;
// service name
serviceName: string;
}
Output Type
//message sent as reponse to the info and also when starting a new transfer
interface TransferInfo {
//unique identifier assigned by the file transfer service
id: string; // String decimal
//when the transfer has started. Note that this will not be set for QUEUED transfers.
startTime: string; // RFC 3339 timestamp
state: TransferState;
bucket: string;
objectName: string;
remotePath: string;
direction: TransferDirection;
totalSize: string; // String decimal
sizeTransferred: string; // String decimal
//reliable = true -> class 2 transfer
//reliable = false -> class 1 transfer
reliable: boolean;
//in case the transcation is failed, this provides more information
failureReason: string;
// valid for CFDP: transaction id;
// for the incoming transfers it is assigned by the remote peer so therefore might not be unique
transactionId: TransactionId;
// when the transfer has been created.
creationTime: string; // RFC 3339 timestamp
}
Related Types
interface TransactionId {
sequenceNumber: number;
initiatorEntity: string; // String decimal
}
enum TransferState {
RUNNING = "RUNNING",
PAUSED = "PAUSED",
FAILED = "FAILED",
COMPLETED = "COMPLETED",
QUEUED = "QUEUED",
CANCELLING = "CANCELLING",
}
enum TransferDirection {
UPLOAD = "UPLOAD",
DOWNLOAD = "DOWNLOAD",
}