ark::pipeline::SubscriberConfiguration

Defined in header “ark/pipeline/subscriber.hh”.


A configuration for a particular subscriber, based on a message type and channel name.

Typedefs

  • using TypePtr = std::shared_ptr< const Type >
    A shared_ptr-wrapped type this is for storage internally.

  • using ExpectedRuntimesCallbackType = std::function< std::chrono::nanoseconds(std::chrono::nanoseconds, const TypePtr &)>
    Expected runtime callback signature.

Variables

  • std::string channel_name
    The name of the channel this is string matched against publishers in a particular pipeline.

  • size_t maximum_queue_depth= 1
    The maximum number of items that can be stored on the queue before the oldest items are dropped.

  • std::optional< std::chrono::nanoseconds > expected_runtime
    Expected runtime of this callback. This is used for things like simulation, so that the system can better simulate parallelization and things like dropped messages or latency.

    If this is set, this will override any expected runtimes coming from configuration files. If unset, it will be considered ‘1ns’ unless otherwise overridden.

  • ExpectedRuntimesCallbackType dynamic_expected_runtime
    The callback that is invoked when this subscriber is executed. simulation, so that the system can better simulate parallelization and things like dropped messages or latency.

    If this is set, this will override any expected runtimes coming from configuration files.

  • Callback< Type > callback
    The callback that is invoked when this subscriber is executed.