Sidebar
file_transfer_ft
Table of Contents
File Transfer Layer (ft)
This layer enables generic transmission and reception of files. It can be placed on top of UDP, TCP or TLS layers.
File Transfer Layer Configuration Parameters
| Parameter | Type | Description |
|---|---|---|
| Alias | String | |
| Debug Log Level | Number | Debug Level |
| Dependencies | String | Other dependencies to this element |
| Destination Peer | Number | |
| Event Filter | String | Filter of Event |
| Exact Match | Boolean | |
| Filename RX | Number | File Transfer Received Filename |
| Filename TX | Number | File Transfer Transmitted Filename |
| L3 Dst | String | Destination L3 Address |
| L4 Dst | String | Destination L4 Address |
| Max Event Queue Size | Number | Maximum Queue Size |
| Name | String | Component Name |
| No Events | Boolean | |
| Passthrough | Boolean | High-to-Low Layer Passthrough |
| Raw Data To Inject | String | Data Packet to Inject |
| Raw Dst L2 To Inject | String | Destination L2 Address |
| Raw Dst L3 To Inject | String | Destination L3 Address |
| Raw Dst L4 To Inject | String | Destination L4 Address |
| Request Timeout | Number | |
| Save Dynamic Config | Boolean | |
| Show Commands | Boolean | Show Commands |
| Show Events | Boolean | Show Events |
| Watch | Boolean | Watch Layer |
File Transfer Layer Real-Time Parameters
| Parameter | Type | Description |
|---|---|---|
| Allow Blocking Event | Boolean | Blocking Events |
| Blocked | Boolean | Disable Component |
| Debug Log Level | Number | Debug Level |
| Filename RX | String | File Transfer Received Filename |
| Filename TX | String | File Transfer Transmitted Filename |
| L3 Dst | String | Destination L3 Address |
| L4 Dst | String | Destination L4 Address |
| Passthrough | Boolean | High-to-Low Layer Passthrough |
| Watch | Boolean | Watch Layer |
File Transfer Layer Functions
| Function | Type | Description |
|---|---|---|
| fileTransferStartRx(layer) | function | Start Reception |
| fileTransferStartTx(layer) | function | Start Transfer |
| fileTransferStopRx(layer) | function | Stop Transfer |
| fileTransferStopTx(layer) | function | Stop Transfer |
| getFtAllowBlockingEvent(layer) | getter | Get “Allow Blocking Event” Parameter |
| getFtBlocked(layer) | getter | Get “Blocked” Parameter |
| getFtDebugLogLevel(layer) | getter | Get “Debug Log Level” Parameter |
| getFtDestinationPeer(layer) | getter | Get “Destination Peer” Parameter |
| getFtFilenameRX(layer) | getter | Get “Filename RX” Parameter |
| getFtFilenameTX(layer) | getter | Get “Filename TX” Parameter |
| getFtL3Dst(layer) | getter | Get “L3 Dst” Parameter |
| getFtL4Dst(layer) | getter | Get “L4 Dst” Parameter |
| getFtNoEvents(layer) | getter | Get “No Events” Parameter |
| getFtPassthrough(layer) | getter | Get “Passthrough” Parameter |
| getFtWatch(layer) | getter | Get “Watch” Parameter |
| getStatsFtAvailableInstances(layer) | getter | Get “Available Instances” Parameter |
| getStatsFtDownstreamLastPacket(layer) | getter | Get “Downstream Last Packet” Parameter |
| getStatsFtDownstreamPacketCount(layer) | getter | Get “Downstream Packet Count” Parameter |
| getStatsFtMaxDownstreamDelay(layer) | getter | Get “Max Downstream Delay” Parameter |
| getStatsFtMaxUpstreamDelay(layer) | getter | Get “Max Upstream Delay” Parameter |
| getStatsFtMeanDownstreamDelay(layer) | getter | Get “Mean Downstream Delay” Parameter |
| getStatsFtMeanUpstreamDelay(layer) | getter | Get “Mean Upstream Delay” Parameter |
| getStatsFtMinDownstreamDelay(layer) | getter | Get “Min Downstream Delay” Parameter |
| getStatsFtMinUpstreamDelay(layer) | getter | Get “Min Upstream Delay” Parameter |
| getStatsFtName(layer) | getter | Get “Name” Parameter |
| getStatsFtRateBpsDownstream(layer) | getter | Get “Rate Bps Downstream” Parameter |
| getStatsFtRateBpsUpstream(layer) | getter | Get “Rate Bps Upstream” Parameter |
| getStatsFtTimestampIn(layer) | getter | Get “Timestamp In” Parameter |
| getStatsFtTimestampOut(layer) | getter | Get “Timestamp Out” Parameter |
| getStatsFtType(layer) | getter | Get “Type” Parameter |
| getStatsFtUpstreamLastPacket(layer) | getter | Get “Upstream Last Packet” Parameter |
| getStatsFtUpstreamPacketCount(layer) | getter | Get “Upstream Packet Count” Parameter |
| getStatsFtVarianceDownstreamDelay(layer) | getter | Get “Variance Downstream Delay” Parameter |
| getStatsFtVarianceUpstreamDelay(layer) | getter | Get “Variance Upstream Delay” Parameter |
| setFtAllowBlockingEvent(layer,value) | setter | Set “Allow Blocking Event” Parameter |
| setFtBlocked(layer,value) | setter | Set “Blocked” Parameter |
| setFtDebugLogLevel(layer,value) | setter | Set “Debug Log Level” Parameter |
| setFtFilenameRX(layer,value) | setter | Set “Filename RX” Parameter |
| setFtFilenameTX(layer,value) | setter | Set “Filename TX” Parameter |
| setFtL3Dst(layer,value) | setter | Set “L3 Dst” Parameter |
| setFtL4Dst(layer,value) | setter | Set “L4 Dst” Parameter |
| setFtNoEvents(layer,value) | setter | Set “No Events” Parameter |
| setFtPassthrough(layer,value) | setter | Set “Passthrough” Parameter |
| setFtWatch(layer,value) | setter | Set “Watch” Parameter |
file_transfer_ft.txt · Last modified: 2021/07/26 01:35 by vps