roq-udp-subscriber#

Purpose#

  • UDP (multicast) subscriber

Description#

The subscriber allows you receiver CustomMetrics over UDP (multicast).

Conda#

$ mamba install \
  --channel https://roq-trading.com/conda/stable \
  roq-udp-subscriber

$ cp $CONDA_PREFIX/share/roq-udp-subscriber/config.toml $CONFIG_FILE_PATH

# Then modify $CONFIG_FILE_PATH to match your specific configuration

$ roq-udp-subscriber \
      --name "udp-subscriber" \
      --config_file "$CONFIG_FILE_PATH" \
      --service_listen_address "$TCP_LISTEN_PORT_FOR_METRICS" \
      --listen_address "$TCP_LISTEN_PORT_FOR_WS_CLIENTS" \
      --flagfile "$FLAG_FILE"

Config#

A list of clients allowed to connect to the subscriber.

[users]

 [users.MD1]
 username="tbmd1"

Flags#

$ roq-udp-subscriber --help

--config_file

Config file (path)

--listen_address

Listen address (network address)

--udp_port

UDP port to subscribe from

--heartbeat_timeout

Heartbeat timeout, e.g. 10s

Constraints#