JSON Schema
PipelineConfig
| Field | Type | Label | Description |
|---|---|---|---|
| version | uint32 | ||
| plumr_config | plumr.protobuf.Config | ||
| meta | Meta | ||
| kpis | Kpis | optional | |
| variables | Variable | repeated |
DataRate
| Field | Type | Label | Description |
|---|---|---|---|
| goodput_expression | string | ||
| overhead_expression | string | ||
| type | DataRateType | optional |
DecoratedText
| Field | Type | Label | Description |
|---|---|---|---|
| text | string | ||
| color | string | optional |
Gauge
| Field | Type | Label | Description |
|---|---|---|---|
| expression | string |
KpiMetric
| Field | Type | Label | Description |
|---|---|---|---|
| label | string | ||
| value_over_time | ValueOverTime | ||
| value | Value | ||
| gauge | Gauge | ||
| data_rate | DataRate | ||
| value_over_time_comparison | ValueOverTimeComparison | ||
| value_to_text | ValueToText | ||
| value_to_text_conditions | ValueToTextConditions | ||
| multiple_values_over_time | MultipleValuesOverTime | ||
| multiple_values | MultipleValues | ||
| description | string | ||
| id | string | ||
| column_span | int32 | optional |
Kpis
| Field | Type | Label | Description |
|---|---|---|---|
| variables | Kpis.VariablesEntry | repeated | |
| metrics | KpiMetric | repeated |
Kpis.VariablesEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | string |
MultipleValues
| Field | Type | Label | Description |
|---|---|---|---|
| unit | string | optional | |
| values | MultipleValuesItem | repeated |
MultipleValuesItem
| Field | Type | Label | Description |
|---|---|---|---|
| expression | string | ||
| label | string | ||
| description | string | optional | |
| color | string | optional |
MultipleValuesOverTime
| Field | Type | Label | Description |
|---|---|---|---|
| unit | string | optional | |
| values | MultipleValuesOverTimeItem | repeated | |
| graph_type | MultipleValuesOverTimeGraphType | optional |
MultipleValuesOverTimeItem
| Field | Type | Label | Description |
|---|---|---|---|
| expression | string | ||
| label | string | ||
| description | string | optional | |
| color | string | optional |
Value
| Field | Type | Label | Description |
|---|---|---|---|
| expression | string | ||
| unit | string | optional |
ValueOverTime
| Field | Type | Label | Description |
|---|---|---|---|
| expression | string | ||
| unit | string | optional | |
| min_expression | string | optional | |
| max_expression | string | optional | |
| avg_expression | string | optional |
ValueOverTimeComparison
| Field | Type | Label | Description |
|---|---|---|---|
| value1_expression | string | ||
| value2_expression | string | ||
| unit | string | optional | |
| value1_text | string | optional | |
| value2_text | string | optional | |
| value1_min_expression | string | optional | |
| value2_min_expression | string | optional | |
| value1_max_expression | string | optional | |
| value2_max_expression | string | optional | |
| value1_avg_expression | string | optional | |
| value2_avg_expression | string | optional |
ValueToText
| Field | Type | Label | Description |
|---|---|---|---|
| expression | string | ||
| mapping | ValueToText.MappingEntry | repeated |
ValueToText.MappingEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | DecoratedText |
ValueToTextCondition
| Field | Type | Label | Description |
|---|---|---|---|
| expression | string | ||
| text | string | ||
| color | string | optional |
ValueToTextConditions
| Field | Type | Label | Description |
|---|---|---|---|
| conditions | ValueToTextCondition | repeated |
DataRateType
| Name | Number | Description |
|---|---|---|
| TOTAL | 0 | |
| RATE | 1 |
MultipleValuesOverTimeGraphType
| Name | Number | Description |
|---|---|---|
| AREA_STACK | 0 | |
| LINE | 1 |
Variable
| Field | Type | Label | Description |
|---|---|---|---|
| id | string | ||
| label | string | ||
| description | string | ||
| paths | string | repeated |
DisplayCoordinates
| Field | Type | Label | Description |
|---|---|---|---|
| x | int32 | ||
| y | int32 |
Meta
| Field | Type | Label | Description |
|---|---|---|---|
| component_display_coordinates | Meta.ComponentDisplayCoordinatesEntry | repeated | |
| component_display_order | Meta.ComponentDisplayOrderEntry | repeated |
Meta.ComponentDisplayCoordinatesEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | DisplayCoordinates |
Meta.ComponentDisplayOrderEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | int32 |
LogConfig
| Field | Type | Label | Description |
|---|---|---|---|
| default_level | nanoping.logging.Level | ||
| log_filters | plumr.protobuf.LogFilter | repeated |
Config
Pipeline configuration.
| Field | Type | Label | Description |
|---|---|---|---|
| pipeline | Config.PipelineEntry | repeated | The components of the pipeline. |
| shm_config | ShmConfig | optional | Configuration for the shared memory file. |
| log_filters | LogFilter | repeated | Filters for log messages. |
| lifecycle_handler | LifecycleHandler | optional | Lifecycle handler for the pipeline. |
Config.PipelineEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | component.Component |
LogActions
| Field | Type | Label | Description |
|---|---|---|---|
| actions | string | repeated |
LogFilter
Filter for log messages.
| Field | Type | Label | Description |
|---|---|---|---|
| level | LogLevel | ||
| actions | LogActions | ||
| path_filter | string | optional | Path filter to log. |
| file | string | optional | File to store log in. |
| mode | LogMode | optional | Mode to log in. |
ShmConfig
Dump metrics of the pipelines into the shared memory file.
| Field | Type | Label | Description |
|---|---|---|---|
| file_path | string | The path of the shared memory file | |
| bytes | int32 | The size of the shared memory file in bytes | |
| interval_ms | int32 | Interval in milliseconds between writing metrics to the shared memory file. |
LogLevel
Log levels used for filtering log messages.
| Name | Number | Description |
|---|---|---|
| STATE | 0 | |
| DEBUG | 1 | |
| INFO | 2 | |
| WARN | 3 | |
| ERROR | 4 | |
| FATAL | 5 |
LogMode
| Name | Number | Description |
|---|---|---|
| APPEND | 0 | Append to the file. |
| TRUNCATE | 1 | Truncate the file. |
SimulatedNetwork
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | optional | |
| output | string | optional | |
| mtu | int32 | optional | |
| network_name | string | ||
| receivers | string | repeated |
BoringSSLDecrypt
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| aes_128_gcm_sha_256 | Aes128GcmSha256 | ||
| aes_256_gcm_sha_384 | Aes256GcmSha384 | ||
| chacha20_poly1305_sha_256 | Chacha20Poly1305Sha256 |
ConstantAuthSign
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| constant | uint64 |
UdpRemote
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | optional | |
| mtu | int32 | optional | |
| interface | string | optional | |
| backend | UdpBackend | optional |
Bomb
| Field | Type | Label | Description |
|---|---|---|---|
| delay | uint32 | ||
| poison | Poison |
Poison
| Name | Number | Description |
|---|---|---|
| NONE | 0 | |
| VERIFY_FAIL | 1 | |
| ASSERT_FAIL | 2 | |
| THROW_EXCEPTION | 3 | |
| LOG_FATAL | 4 |
Aes128GcmSha256
| Field | Type | Label | Description |
|---|---|---|---|
| key | string |
Aes256GcmSha384
| Field | Type | Label | Description |
|---|---|---|---|
| key | string |
Chacha20Poly1305Sha256
| Field | Type | Label | Description |
|---|---|---|---|
| key | string |
Splitter
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| outputs | string | repeated |
PeerRouter
| Field | Type | Label | Description |
|---|---|---|---|
| ingress | PeerRouter.InputOutput | ||
| egress | PeerRouter.InputOutput |
PeerRouter.InputOutput
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string |
SessionReader
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string |
UnixSocket
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | optional | |
| output | string | optional | |
| mtu | uint32 | optional | |
| server | UnixSocketServerOptions | ||
| client | UnixSocketClientOptions |
UnixSocketClientOptions
| Field | Type | Label | Description |
|---|---|---|---|
| server_address | string | ||
| bind_address | int32 |
UnixSocketServerOptions
| Field | Type | Label | Description |
|---|---|---|---|
| listen_address | string |
BandwidthLimitConstant
| Field | Type | Label | Description |
|---|---|---|---|
| flows | EmulationFlow | repeated | |
| bandwidth_limit_mbit | double | ||
| max_queue_size | uint32 | optional |
BoringSSLPoly1305Checker
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| shared_secret | string |
UdpBackend
| Name | Number | Description |
|---|---|---|
| GENERIC | 0 | |
| LINUX_NO_GRO | 1 | |
| LINUX | 2 |
LossDynamic
| Field | Type | Label | Description |
|---|---|---|---|
| flows | EmulationFlow | repeated | |
| phases | LossPhase | repeated | |
| seed | int32 | optional |
LossPhase
| Field | Type | Label | Description |
|---|---|---|---|
| duration | uint32 | ||
| loss_probability | double |
Parity2dDecoder
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string |
LossGilbertElliot
| Field | Type | Label | Description |
|---|---|---|---|
| flows | EmulationFlow | repeated | |
| good_loss_probability | double | ||
| bad_loss_probability | double | ||
| good_to_bad_probability | double | ||
| bad_to_good_probability | double | ||
| seed | int32 | optional |
BandwidthLimitDynamic
| Field | Type | Label | Description |
|---|---|---|---|
| flows | EmulationFlow | repeated | |
| phases | BandwidthLimitPhase | repeated | |
| max_queue_size | uint32 | optional |
BandwidthLimitPhase
| Field | Type | Label | Description |
|---|---|---|---|
| duration | uint32 | ||
| bandwidth_limit_mbit | double |
TagMux
| Field | Type | Label | Description |
|---|---|---|---|
| inputs | TagMux.TaggedInput | repeated | |
| output | string |
TagMux.TaggedInput
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| tag | int32 |
FlowCombiner
| Field | Type | Label | Description |
|---|---|---|---|
| inputs | string | repeated | |
| output | string |
Component
A component within the pipeline.
| Field | Type | Label | Description |
|---|---|---|---|
| trace_traffic_source | TraceTrafficSource | ||
| traffic_sink | TrafficSink | ||
| chacha20_encrypt | Chacha20Encrypt | ||
| chacha20_decrypt | Chacha20Decrypt | ||
| constant_auth_sign | ConstantAuthSign | ||
| constant_auth_verify | ConstantAuthVerify | ||
| tag_mux | TagMux | ||
| tag_demux | TagDemux | ||
| rely_encoder | RelyEncoder | ||
| rely_decoder | RelyDecoder | ||
| tun | Tun | ||
| udp | Udp | ||
| observer | Observer | ||
| fragmentizer | Fragmentizer | ||
| defragmentizer | Defragmentizer | ||
| uniform_loss | UniformLoss | ||
| reed_solomon_encoder | ReedSolomonEncoder | ||
| reed_solomon_decoder | ReedSolomonDecoder | ||
| periodic_burst_loss | PeriodicBurstLoss | ||
| gilbert_elliot_loss | GilbertElliotLoss | ||
| random_burst_loss | RandomBurstLoss | ||
| delay_fixed | DelayFixed | ||
| delay_jitter | DelayJitter | ||
| uniform_traffic_source | UniformTrafficSource | ||
| sporadic_traffic_source | SporadicTrafficSource | ||
| video_traffic_source | VideoTrafficSource | ||
| parity_2d_encoder | Parity2dEncoder | ||
| parity_2d_decoder | Parity2dDecoder | ||
| throughput_tracker | ThroughputTracker | ||
| loss_tracker_sender | LossTrackerSender | ||
| loss_tracker_receiver | LossTrackerReceiver | ||
| latency_tracker_sender | LatencyTrackerSender | ||
| latency_tracker_receiver | LatencyTrackerReceiver | ||
| throughput_traffic_source | ThroughputTrafficSource | ||
| raft | Raft | ||
| splitter | Splitter | ||
| tcp | Tcp | ||
| session_writer | SessionWriter | ||
| session_reader | SessionReader | ||
| delay_fixed_sequencer | DelayFixedSequencer | ||
| uniform_loss_sequencer | UniformLossSequencer | ||
| timed_burst_loss | TimedBurstLoss | ||
| bandwidth_constrictor | BandwidthConstrictor | ||
| bandwidth_constrictor_sequencer | BandwidthConstrictorSequencer | ||
| tap | Tap | ||
| rlnc_encoder | RlncEncoder | ||
| rlnc_decoder | RlncDecoder | ||
| kodok_encoder | KodokEncoder | ||
| kodok_decoder | KodokDecoder | ||
| flow_filter | FlowFilter | ||
| flow_combiner | FlowCombiner | ||
| simulated_network | SimulatedNetwork | ||
| peer_router | PeerRouter | ||
| peer_writer | PeerWriter | ||
| boringssl_encrypt | BoringSSLEncrypt | ||
| boringssl_decrypt | BoringSSLDecrypt | ||
| boringssl_poly1305_signer | BoringSSLPoly1305Signer | ||
| boringssl_poly1305_checker | BoringSSLPoly1305Checker | ||
| udp_local | UdpLocal | ||
| udp_remote | UdpRemote | ||
| unix_socket | UnixSocket | ||
| relay_network_lookup | RelayNetworkLookup | ||
| relay_routing_fabric | RelayRoutingFabric | ||
| client_id_reader | ClientIDReader | ||
| client_id_writer | ClientIDWriter | ||
| gate | Gate | ||
| bomb | Bomb | ||
| delay_constant | DelayConstant | ||
| delay_dynamic | DelayDynamic | ||
| loss_constant | LossConstant | ||
| loss_dynamic | LossDynamic | ||
| loss_gilbert_elliot | LossGilbertElliot | ||
| bandwidth_limit_constant | BandwidthLimitConstant | ||
| bandwidth_limit_dynamic | BandwidthLimitDynamic | ||
| bandwidth_tracker | BandwidthTracker | ||
| bandwidth_traffic_source | BandwidthTrafficSource |
BandwidthTrafficSource
| Field | Type | Label | Description |
|---|---|---|---|
| output | string | ||
| bandwidth_mbit | double | ||
| duration_ms | uint32 | ||
| min_packet_size | uint32 | optional | |
| max_packet_size | uint32 | optional | |
| seed | uint32 | optional |
LossTrackerSender
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string |
TagDemux
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| outputs | TagDemux.TaggedOutput | repeated |
TagDemux.TaggedOutput
| Field | Type | Label | Description |
|---|---|---|---|
| name | string | ||
| tag | int32 |
LossTrackerReceiver
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| sampling_interval_ms | uint32 | optional |
LatencyTrackerSender
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string |
DelayConstant
| Field | Type | Label | Description |
|---|---|---|---|
| flows | EmulationFlow | repeated | |
| delay | uint32 | ||
| jitter | uint32 | optional | |
| allow_reordering | bool | optional | |
| seed | int32 | optional |
VideoTrafficSource
| Field | Type | Label | Description |
|---|---|---|---|
| output | string | ||
| fps | uint32 | ||
| p_frames | uint32 | ||
| total_packets | uint32 | ||
| min_packet_size | uint32 | optional | |
| max_packet_size | uint32 | optional | |
| seed | uint32 | optional |
RelayNetworkLookup
| Field | Type | Label | Description |
|---|---|---|---|
| network | RelayNetworkLookup.InputOutput | ||
| client | RelayNetworkLookup.InputOutput | ||
| client_id | uint32 | repeated |
RelayNetworkLookup.InputOutput
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string |
LatencyTrackerReceiver
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| sampling_interval_ms | uint32 | optional | |
| latency_budget | int32 | optional |
ClientIDWriter
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| client_id | uint32 |
PeerWriter
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| remote_address | string |
RelayRoutingFabric
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| routes | RelayRoutingFabric.RouteEntry | repeated | |
| fabric_type | RelayRoutingFabricType |
RelayRoutingFabric.RouteEntry
| Field | Type | Label | Description |
|---|---|---|---|
| client_id | uint32 | ||
| route | string |
RelayRoutingFabricType
| Name | Number | Description |
|---|---|---|
| IP | 0 |
TrafficSink
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| mtu | int32 | ||
| latency_budget | uint32 | optional | |
| timeout_ms | uint32 | optional |
FixedReplication
Raft stream extension for fixed replication repair mode.
Raft
| Field | Type | Label | Description |
|---|---|---|---|
| streams | RaftStream | repeated | |
| carriers | RaftCarrier | repeated | |
| max_packet_bytes | uint32 | optional |
RaftCarrier
Raft carrier responsible for transporting data from the stream, protected with FEC and ARQ.
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| carrier_handle | uint32 |
RaftExtension
| Field | Type | Label | Description |
|---|---|---|---|
| fixed_replication | FixedReplication |
RaftStream
Raft stream representing incoming data streams to be transmitted.
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | optional | |
| output | string | optional | |
| stream_handle | uint32 | ||
| timeout | uint32 | ||
| delivery_policy | DeliveryPolicy | optional | |
| extension | RaftExtension | optional |
DeliveryPolicy
| Name | Number | Description |
|---|---|---|
| ON_TIMEOUT | 0 | |
| ON_ORDERED | 1 |
TraceTrafficSource
| Field | Type | Label | Description |
|---|---|---|---|
| output | string | ||
| trace_file | string | ||
| loops | uint32 | optional | |
| loop_delay | uint32 | optional | |
| seed | uint32 | optional |
ConstantAuthVerify
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| constant | uint64 |
Observer
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string |
LossConstant
| Field | Type | Label | Description |
|---|---|---|---|
| flows | EmulationFlow | repeated | |
| loss_probability | double | ||
| seed | int32 | optional |
Tcp
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | optional | |
| output | string | optional | |
| listen_address | string | optional | |
| remote_address | string | optional | |
| application_facing | bool |
RelyEncoder
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| timeout | int32 | ||
| max_payloads | int32 | ||
| repair_time_window | int32 | ||
| repair_target_rate | double |
RelyDecoder
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| timeout | int32 | ||
| release_in_order | bool |
RlncDecoder
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string |
Tap
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| interface_name | string | ||
| ip | string | ||
| netmask | string | optional | |
| is_default_route | bool | optional | |
| mtu | uint32 | optional |
ClientIDReader
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| client_id | uint32 |
ReedSolomonDecoder
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string |
Fragmentizer
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| fragment_size | uint32 | optional |
Parity2dEncoder
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| columns | int32 | ||
| rows | int32 |
Gate
| Field | Type | Label | Description |
|---|---|---|---|
| flows | EmulationFlow | repeated | |
| closed | bool |
EmulationFlow
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string |
BoringSSLPoly1305Signer
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| shared_secret | string |
FlowFilter
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| match_output | string | ||
| mismatch_output | string | ||
| filters | FlowFilterFilter | repeated |
FlowFilterCondition
Possible filter conditions currently only IPv4 is supported.
| Field | Type | Label | Description |
|---|---|---|---|
| layer3_protocol | FlowFilterLayer3ProtocolCondition | ||
| layer3_source_ip | string | ||
| layer3_destination_ip | string | ||
| layer4_source_port | uint32 | ||
| layer4_destination_port | uint32 |
FlowFilterFilter
A set of filter conditions that need to match
| Field | Type | Label | Description |
|---|---|---|---|
| conditions | FlowFilterCondition | repeated |
FlowFilterLayer3ProtocolCondition
Possible transport protocols to match on
| Name | Number | Description |
|---|---|---|
| TCP | 0 | |
| UDP | 1 |
ReedSolomonEncoder
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| symbols | int32 | ||
| repair | int32 |
SporadicTrafficSource
| Field | Type | Label | Description |
|---|---|---|---|
| output | string | ||
| total_packets | uint32 | ||
| min_packets | uint32 | ||
| max_packets | uint32 | ||
| min_idle | uint32 | ||
| max_idle | uint32 | ||
| min_packet_size | uint32 | optional | |
| max_packet_size | uint32 | optional | |
| seed | uint32 | optional |
DelayDynamic
| Field | Type | Label | Description |
|---|---|---|---|
| flows | EmulationFlow | repeated | |
| phases | DelayPhase | repeated | |
| allow_reordering | bool | optional | |
| seed | int32 | optional |
DelayPhase
| Field | Type | Label | Description |
|---|---|---|---|
| duration | uint32 | ||
| delay | uint32 | ||
| jitter | uint32 | optional |
UniformTrafficSource
| Field | Type | Label | Description |
|---|---|---|---|
| output | string | ||
| total_packets | uint32 | ||
| interval | uint32 | ||
| min_packet_size | uint32 | optional | |
| max_packet_size | uint32 | optional | |
| seed | uint32 | optional |
BoringSSLEncrypt
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| aes_128_gcm_sha_256 | Aes128GcmSha256 | ||
| aes_256_gcm_sha_384 | Aes256GcmSha384 | ||
| chacha20_poly1305_sha_256 | Chacha20Poly1305Sha256 |
Command
Command to be executed.
| Field | Type | Label | Description |
|---|---|---|---|
| cmd | string | Command to execute. | |
| cwd | string | optional | Current working directory for the command. |
| policy | CommandExecutionPolicy | Policy for executing the command. | |
| timeout | uint32 | optional | Timeout for command execution in milliseconds. If not specified will default to 10 sec. |
| env | Environment | optional | Environment variables for the command. |
Environment
Environment variables.
| Field | Type | Label | Description |
|---|---|---|---|
| vars | Environment.VarsEntry | repeated | Mapping of environment variable names to their values. |
Environment.VarsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | string |
LifecycleHandler
Handler for lifecycle events.
| Field | Type | Label | Description |
|---|---|---|---|
| env | Environment | optional | Global environment variables for lifecycle events. |
| on_setup | Command | repeated | Commands to execute during setup. |
| pre_start | Command | repeated | Commands to execute before starting the pipeline. |
| post_start | Command | repeated | Commands to execute after starting the pipeline. |
| pre_stop | Command | repeated | Commands to execute before stopping the pipeline. |
| post_stop | Command | repeated | Commands to execute after stopping the pipeline. |
CommandExecutionPolicy
Policies for executing commands.
| Name | Number | Description |
|---|---|---|
| STOP_ON_ERROR | 0 | Stop the pipeline if the command fails. |
| CONTINUE_ON_ERROR | 1 | Continue executing the pipeline if the command fails. |
| RUN_IN_BACKGROUND | 2 | Run the command in the background. If you use this policy in a post_stop command, the process will be killed immediately after launch |
RlncEncoder
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| symbols | int32 | ||
| repair | int32 |
UdpLocal
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | optional | |
| output | string | ||
| mtu | int32 | optional | |
| address | string | ||
| interface | string | optional | |
| backend | UdpBackend | optional |
SessionWriter
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string |
Tun
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| interface_name | string | ||
| ip | string | ||
| netmask | string | optional | |
| is_default_route | bool | optional | |
| generic_offload | bool | optional | |
| mtu | uint32 | optional |
RelayConfiguration
| Field | Type | Label | Description |
|---|---|---|---|
| entry_pipeline | string | ||
| endpoints | RelayConfiguration.EndpointsEntry | repeated | |
| routes | RelayConfiguration.RoutesEntry | repeated |
RelayConfiguration.EndpointsEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | RelayEndpoint |
RelayConfiguration.RoutesEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | RelayRoute |
RelayEndpoint
| Field | Type | Label | Description |
|---|---|---|---|
| pipeline | string | ||
| carriers | string | repeated |
RelayRoute
| Field | Type | Label | Description |
|---|---|---|---|
| endpoints | string | repeated | |
| conmment | string | optional |
Defragmentizer
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string |
BandwidthTracker
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| window_ms | uint32 | optional | |
| buckets | uint32 | optional |
PeriodicBurstLoss
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| interval | int32 | ||
| burst | int32 |
ThroughputTrafficSource
| Field | Type | Label | Description |
|---|---|---|---|
| output | string | ||
| throughput_mbit | double | ||
| duration_ms | uint32 | ||
| payload_size | uint32 | ||
| seed | uint32 | optional | |
| batch_size | uint32 | optional |
UniformLossSequencer
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| loss_probs | double | repeated | |
| intervals | int32 | repeated | |
| repeat | bool | optional | |
| seed | int32 | optional |
RandomBurstLoss
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| loss_prob | double | ||
| burst | int32 | ||
| seed | int32 | optional |
TimedBurstLoss
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| interval_ms | int32 | ||
| burst_packets | int32 | optional | |
| burst_duration_ms | int32 | optional | |
| cancel_timer_ms | int32 | optional |
DelayFixedSequencer
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| delays | int32 | repeated | |
| intervals | int32 | repeated | |
| repeat | bool | optional |
UniformLoss
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| loss_prob | double | ||
| seed | int32 | optional |
Chacha20Encrypt
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| magic_constant | string | ||
| key | string | ||
| nonce | string | ||
| rounds | int32 |
DelayJitter
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| delay | int32 | ||
| jitter | int32 | ||
| seed | int32 | optional |
KodokDecoder
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string |
BandwidthConstrictorSequencer
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| bandwidth_limits_mbit | float | repeated | |
| max_queue_sizes | int32 | repeated | |
| intervals | int32 | repeated | |
| repeat | bool | optional |
GilbertElliotLoss
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| good_loss_prob | double | ||
| bad_loss_prob | double | ||
| good_to_bad_prob | double | ||
| bad_to_good_prob | double | ||
| seed | int32 | optional |
Chacha20Decrypt
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| magic_constant | string | ||
| key | string | ||
| nonce | string | ||
| rounds | int32 |
BandwidthConstrictor
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| bandwidth_limit_mbit | float | ||
| max_queue_size | int32 | optional |
ThroughputTracker
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| interval_ms | uint32 | optional |
KodokEncoder
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| repair_configs | RepairConfig | repeated | |
| timeout | int32 | optional |
RepairConfig
Configuration of the FEC repair generation at a specific point during the encoding.
| Field | Type | Label | Description |
|---|---|---|---|
| source_packets | int32 | ||
| repair_packets | int32 |
Udp
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | optional | |
| output | string | optional | |
| local_address | string | optional | |
| remote_address | string | optional | |
| interface | string | optional | |
| mtu | int32 | optional | |
| socket_buffer_size | int32 | optional | |
| multicast_ttl | uint32 | optional | |
| multicast_group | string | optional | |
| lock_to_first_peer | bool |
DelayFixed
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| delay | int32 |
PeriodicBurstLoss
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| interval | int32 | ||
| burst | int32 |
ThroughputTrafficSource
| Field | Type | Label | Description |
|---|---|---|---|
| output | string | ||
| throughput_mbit | double | ||
| duration_ms | uint32 | ||
| payload_size | uint32 | ||
| seed | uint32 | optional | |
| batch_size | uint32 | optional |
UniformLossSequencer
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| loss_probs | double | repeated | |
| intervals | int32 | repeated | |
| repeat | bool | optional | |
| seed | int32 | optional |
RandomBurstLoss
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| loss_prob | double | ||
| burst | int32 | ||
| seed | int32 | optional |
TimedBurstLoss
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| interval_ms | int32 | ||
| burst_packets | int32 | optional | |
| burst_duration_ms | int32 | optional | |
| cancel_timer_ms | int32 | optional |
DelayFixedSequencer
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| delays | int32 | repeated | |
| intervals | int32 | repeated | |
| repeat | bool | optional |
UniformLoss
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| loss_prob | double | ||
| seed | int32 | optional |
Chacha20Encrypt
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| magic_constant | string | ||
| key | string | ||
| nonce | string | ||
| rounds | int32 |
DelayJitter
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| delay | int32 | ||
| jitter | int32 | ||
| seed | int32 | optional |
KodokDecoder
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string |
BandwidthConstrictorSequencer
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| bandwidth_limits_mbit | float | repeated | |
| max_queue_sizes | int32 | repeated | |
| intervals | int32 | repeated | |
| repeat | bool | optional |
GilbertElliotLoss
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| good_loss_prob | double | ||
| bad_loss_prob | double | ||
| good_to_bad_prob | double | ||
| bad_to_good_prob | double | ||
| seed | int32 | optional |
Chacha20Decrypt
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| magic_constant | string | ||
| key | string | ||
| nonce | string | ||
| rounds | int32 |
BandwidthConstrictor
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| bandwidth_limit_mbit | float | ||
| max_queue_size | int32 | optional |
ThroughputTracker
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| interval_ms | uint32 | optional |
KodokEncoder
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| repair_configs | RepairConfig | repeated | |
| timeout | int32 | optional |
RepairConfig
Configuration of the FEC repair generation at a specific point during the encoding.
| Field | Type | Label | Description |
|---|---|---|---|
| source_packets | int32 | ||
| repair_packets | int32 |
Udp
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | optional | |
| output | string | optional | |
| local_address | string | optional | |
| remote_address | string | optional | |
| interface | string | optional | |
| mtu | int32 | optional | |
| socket_buffer_size | int32 | optional | |
| multicast_ttl | uint32 | optional | |
| multicast_group | string | optional | |
| lock_to_first_peer | bool |
DelayFixed
| Field | Type | Label | Description |
|---|---|---|---|
| input | string | ||
| output | string | ||
| delay | int32 |