Click or drag to resize

SubscriptionInfo Class
Configuration object for data subscriptions.
Inheritance Hierarchy

Namespace: GSF.TimeSeries.Transport
Assembly: GSF.TimeSeries (in GSF.TimeSeries.dll) Version: 2.4.230-beta
Syntax
Copy
public abstract class SubscriptionInfo
View Source

The SubscriptionInfo type exposes the following members.

Constructors
 NameDescription
Protected methodSubscriptionInfo Creates a new instance of the SubscriptionInfo class.
Top
Properties
 NameDescription
Public propertyConstraintParameters Gets or sets the additional constraint parameters supplied to temporal adapters in a temporal session.
Public propertyDataChannelLocalPort Gets or sets the port number that the UDP data channel binds to. This value is only used when the subscriber requests a separate UDP data channel.
Public propertyExtraConnectionStringParameters Gets or sets the additional connection string parameters to be applied to the connection string sent to the publisher during subscription.
Public propertyFilterExpression Gets or sets the filter expression used to define which measurements are being requested by the subscriber.
Public propertyLagTime Gets or sets the allowed past time deviation tolerance in seconds (can be sub-second).
Public propertyLeadTime Gets or sets the allowed future time deviation tolerance, in seconds (can be sub-second).
Public propertyProcessingInterval Gets or sets the processing interval requested by the subscriber. A value of -1 indicates the default processing interval. A value of 0 indicates data will be processed as fast as possible.
Public propertyRequestNaNValueFilter Gets or sets the flag that determines whether to request that measurements sent to the subscriber should be filtered by the publisher prior to sending them.
Public propertyStartTime Gets or sets the start time of the requested temporal session for streaming historic data.
Public propertyStopTime Gets or sets the stop time of the requested temporal session for streaming historic data.
Public propertyUdpDataChannel Gets or sets the flag that determines whether the subscriber is requesting its data over a separate UDP data channel.
Public propertyUseCompactMeasurementFormat Gets or sets the flag that determines whether to use the compact measurement format or the full measurement format for transmitting measurements to the subscriber.
Public propertyUseLocalClockAsRealTime Gets or sets the flag that determines whether the server's local clock is used as real-time. If false, the timestamps of the measurements will be used as real-time.
Public propertyUseMillisecondResolution Gets or sets the flag that determines whether measurement timestamps use millisecond resolution. If false, they will use Ticks resolution.
Top
Methods
 NameDescription
Public methodCopy Creates a shallow copy of this SubscriptionInfo object.
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
Extension Methods
 NameDescription
Public Extension MethodGetEnumValueOrDefault Gets the enumeration constant for value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Public Extension MethodGetEnumValueOrDefaultT Gets the enumeration constant for this value, if defined in the enumeration, or a default value.
(Defined by EnumExtensions)
Top
See Also