Click or drag to resize

Settings Class

.NET STTP API
Defines the STTP subscription related settings.
Inheritance Hierarchy
SystemObject
  sttpSettings

Namespace: sttp
Assembly: sttp.net (in sttp.net.dll) Version: 1.0.0
Syntax
Copy
public class Settings
Request Example View Source

The Settings type exposes the following members.

Constructors
 NameDescription
Public methodSettingsInitializes a new instance of the Settings class
Top
Properties
 NameDescription
Public propertyConstraintParameters Gets or sets any custom constraint parameters for a requested temporal data playback. This can include parameters that may be needed to initiate, filter, or control historical data access.
Public propertyExtraConnectionStringParameters Gets or sets any extra custom connection string parameters that may be needed for a subscription.
Public propertyIncludeTime Gets or sets flag that determines if time should be included in non-compressed, compact measurements.
Public propertyProcessingInterval Gets or sets the initial playback speed, in milliseconds, for a requested temporal data playback.
Remarks
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.
Public propertyPublishInterval Gets or sets flag that defines the down-sampling publish interval, in seconds, to use when Throttled is true.
Public propertyRequestNaNValueFilter Gets or sets flag that requests that the publisher filter, i.e., does not send, any NaN values.
Public propertyStartTime Gets or sets 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.
Public propertyStopTime Gets or sets 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.
Public propertyThrottled Gets or sets flag that setermines if data will be published using down-sampling.
Public propertyUDPDataChannelInterface Gets or sets the desired UDP binding interface to use for publication. Empty string means to bind to same interface as TCP command channel.
Public propertyUDPDataChannelPort Gets or sets 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.
Public propertyUseMillisecondResolution Gets or sets flag that determines if time should be restricted to milliseconds in non-compressed, compact measurements.
Top
Methods
 NameDescription
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Remarks
The Settings class exists as a simplified implementation of the [!:SubscriptionInfo] class found in the sttp.transport namespace. Internally, the Subscriber class maps Settings values to a [!:SubscriptionInfo] instance for use with a DataSubscriber.
See Also