DevNullReceiver Satellite#

Name

DevNullReceiver

Description

A satellite that receives data and drops it

Category

Developer Tools

Language

C++

Building#

The DevNullReceiver satellite has no additional dependencies. The satellite is not build by default, building can be enabled via:

meson configure build -Dsatellite_dev_null_receiver=true

Parameters#

None

Custom Commands#

Command

Description

Arguments

Return Value

Allowed States

get_data_rate

Get data rate during the last run in Gbps

-

data rate, double

ORBIT

Framework Parameters#

This satellite inherits the following framework parameters from its base classes:

Parameters inherited from ReceiverSatellite#

Parameter

Type

Description

Default Value

_allow_overwriting

Bool

Switch whether overwriting files is allowed or not. If set to false and a file exists already, this satellite will go into ERROR state.

false

_data_transmitters

List of strings

List of canonical names of transmitter satellites this receiver should connect to and receive data messages from. If empty, this receiver will connect to all transmitters.

[]

_eor_timeout

Unsigned integer

Timeout waiting for the reception of the end-of-run message. The receiver satellite will wait this number of seconds for receiving the EOR message from each connected transmitter satellite, and will go into error state if the message has not been received within this period. The timeout will only be started after the pending data messages have been read from the queue.

10

Parameters inherited from Satellite#

Autonomous Operation#

Parameter

Type

Description

Default Value

_heartbeat_interval

Unsigned integer

Interval in seconds between heartbeats to be sent to other Constellation components

10

_role

Role name

Role this satellite should take in the Constellation. Accepted values are ESSENTIAL, DYNAMIC, TRANSIENT and NONE.

DYNAMIC

Transition Orchestration#

Parameters to control autonomous transition orchestration of satellites:

Parameter

Type

Description

Default Value

_conditional_transition_timeout

Unsigned integer

Timeout in seconds to wait for all conditions to be satisfied for conditional transitioning

30

_require_initializing_after

List of strings

List of canonical names of remote satellites for conditional transitioning in initializing state

-

_require_launching_after

List of strings

List of canonical names of remote satellites for conditional transitioning in launching state

-

_require_landing_after

List of strings

List of canonical names of remote satellites for conditional transitioning in landing state

-

_require_starting_after

List of strings

List of canonical names of remote satellites for conditional transitioning in starting state

-

_require_stopping_after

List of strings

List of canonical names of remote satellites for conditional transitioning in stopping state

-

Framework Metrics#

This satellite inherits the following framework metrics from its base classes:

Metrics inherited from ReceiverSatellite#

Metric

Description

Value Type

Metric Type

Interval

BYTES_RECEIVED

Amount of bytes received from all transmitters

Integer

LAST_VALUE

10s

DISKSPACE_FREE

Amount of megabytes available on the file system the current output file is located

Integer

LAST_VALUE

10s

OUTPUT_FILE

Path of the currently used output file for this satellite. Updated whenever it changes.

String

LAST_VALUE

-

Metrics inherited from Satellite#

None