Struct sttp::Settings

pub struct Settings {

    pub throttled: bool,
    pub publish_interval: f64,
    pub udp_port: u16,
    pub include_time: bool,
    pub enable_time_reasonability_check: bool,
    pub lag_time: f64,
    pub lead_time: f64,
    pub use_local_clock_as_real_time: bool,
    pub use_millisecond_resolution: bool,
    pub request_nan_value_filter: bool,
    pub start_time: String,
    pub stop_time: String,
    pub constraint_parameters: String,
    pub processing_interval: i32,
    pub extra_connection_string_parameters: String,
}

Defines STTP subscription related settings.

Settings exists as a simplified implementation of the SubscriptionInfo found in the transport module. Internally, the Subscriber class maps Settings values to a SubscriptionInfo instance for use with a DataSubscriber.

Fields

throttled: bool

Determines if data will be published using down-sampling.

publish_interval: f64

Defines the down-sampling publish interval, in seconds, to use when Throttled is true.

udp_port: u16

Defines the desired UDP port to use for publication. Zero value means do not receive data on UDP, i.e., data will be delivered to the STTP client via TCP.

include_time: bool

Determines if time should be included in non-compressed, compact measurements.

enable_time_reasonability_check: bool

Determines if publisher should perform time reasonability checks. When enabled LagTime and LeadTime will be used to determine if a measurement timestamp is reasonable.

lag_time: f64

Defines the allowed past time deviation tolerance in seconds (can be sub-second). Value is used to determine if a measurement timestamp is reasonable. Only applicable when EnableTimeReasonabilityCheck is true.

lead_time: f64

Defines the allowed future time deviation tolerance in seconds (can be sub-second). Value is used to determine if a measurement timestamp is reasonable. Only applicable when EnableTimeReasonabilityCheck is true.

use_local_clock_as_real_time: bool

Determines if publisher should use local clock as real time. If false, the timestamp of the latest measurement will be used as real-time. Only applicable when EnableTimeReasonabilityCheck is true.

use_millisecond_resolution: bool

Determines if time should be restricted to milliseconds in non-compressed, compact measurements.

request_nan_value_filter: bool

Requests that the publisher filter, i.e., does not send, any NaN values.

start_time: String

Defines the start time for a requested temporal data playback, i.e., a historical subscription. Simply by specifying a StartTime and StopTime, a subscription is considered a historical subscription. Note that the publisher may not support historical subscriptions, in which case the subscribe will fail.

stop_time: String

Defines the stop time for a requested temporal data playback, i.e., a historical subscription. Simply by specifying a StartTime and StopTime, a subscription is considered a historical subscription. Note that the publisher may not support historical subscriptions, in which case the subscribe will fail.

constraint_parameters: String

include parameters that may be needed to initiate, filter, or control historical data access.

processing_interval: i32

Defines the initial playback speed, in milliseconds, for a requested temporal data playback. With the exception of the values of -1 and 0, this value specifies the desired processing interval for data, i.e., basically a delay, or timer interval, over which to process data. A value of -1 means to use the default processing interval while a value of 0 means to process data as fast as possible.

extra_connection_string_parameters: String

Defines any extra custom connection string parameters that may be needed for a subscription.

Trait Implementations

impl Clone for Settings

fn clone(&self) -> Settings

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for Settings

Define the default values for STTP subscription Settings.

fn default() -> Self

Returns the “default value” for a type.