Implements the Raft algorithm as a reliable transport protocol with integrated forward error correction and automatic repeat request (ARQ) mechanisms. This sophisticated transport layer provides guaranteed ordered delivery, fault tolerance, and data integrity through distributed consensus principles. Essential for mission-critical applications requiring guaranteed delivery, distributed system coordination, and reliable data replication across unreliable network infrastructures.
Tags: FEC, TRANSPORT_PROTOCOL, RELIABILITY
| Field | Type | Label | Description | Default Value |
|---|
| Streams | Streams | Repeated | The Raft streams representing incoming data streams to be transmitted. | |
| Carriers | Carriers | Repeated | The Raft carriers responsible for transporting data from the stream, protected with FEC and ARQ. | |
| Max Packet Bytes | Uint32 | Optional | The maximum packet size in bytes that can be produced by the Raft carrier outputs.This is required to be specified in the case where the carriers MTU cannot be automatically dededuced, e.g., if two raft components are connected back to back. | |
Streams
| Field | Type | Label | Description | Default Value |
|---|
| Input | String | Optional | | |
| Output | String | Optional | | |
| Stream Handle | Uint32 | | Unique identifier for the stream, must match the stream handle on the receiving end. | |
| Realtime Stream | Realtime Stream | | For application-level, latency-sensitive data produced and consumed directly by Raft. | |
| Transit Stream | Transit Stream | | For encapsulating other protocols (e.g. TCP or QUIC), where Raft acts as a forwarding or tunneling layer rather than the end-to-end protocol. | |
Realtime Stream
| Field | Type | Label | Description | Default Value |
|---|
| Timeout | Uint32 | | Timeout for the stream in milliseconds. | 100 |
| Jitter Buffer | Uint32 | Optional | Determines how long the stream should wait before delivering a packet to the application. The jitter buffer is used to smooth out variations in packet arrival times. If the jitter buffer is zero, packets will be delivered to the application as soon as they are received, assuming they can be delivered in an in-order manner. If unset, the stream will use the symbol timeout as the jitter buffer. The jitter buffer should be any value between zero and the symbol timeout. | |
| Extension | Extension | Optional | Optional extensions to the Raft stream configuration. | |
Extension
| Field | Type | Label | Description | Default Value |
|---|
| Fixed Replication | Fixed Replication | | Force raft to used fixed replication repair mode. This will automatically force all packets to be replicated to all valid carriers. | |
Fixed Replication
| Field | Type | Label | Description | Default Value |
|---|
Transit Stream
| Field | Type | Label | Description | Default Value |
|---|
| Bonding Delay | Uint32 | | Bonding selection threshold (ms). When multiple carriers are available, only those with measured latency <= bonding_delay are used | 500 |
Carriers
| Field | Type | Label | Description | Default Value |
|---|
| Input | String | | | |
| Output | String | | | |
| Carrier Handle | Uint32 | | Unique identifier for the carrier, must match the carrier handle on the receiving end. | |
| Bandwidth Priority | Uint32 | Optional | When set, enables bandwidth-driven operation where Raft only accepts packets that can be transferred given the current carrier bandwidth estimates. Either none or all carriers must have a priority set. Raft selects the highest priority carrier(s) until their estimated bandwidth capacity is reached. Higher values indicate higher priority, and carriers with the same priority are selected in a round-robin fashion. | 0 |
| Max Bandwidth Mbps | Uint32 | Optional | Maximum bandwidth in megabits per second that this carrier can use. This is only used when the in bandwidth-driven operation. | 1 |
| Auto Bandwidth Estimation | Bool | Optional | If set to false, the carrier will use the specified max_bandwidth_mbps as the bandwidth estimate. | true |