SynchronizedSubscriptionInfo Class

Configuration object for synchronized data subscriptions.

Inheritance Hierarchy

SystemObject
GSF.TimeSeries.TransportSubscriptionInfo
GSF.TimeSeries.TransportSynchronizedSubscriptionInfo

Namespace: GSF.TimeSeries.Transport
Assembly: GSF.TimeSeries (in GSF.TimeSeries.dll) Version: 2.4.218-beta

Syntax

C++

JavaScript

Copy

public sealed class SynchronizedSubscriptionInfo : SubscriptionInfo

Public NotInheritable Class SynchronizedSubscriptionInfo
	Inherits SubscriptionInfo

public ref class SynchronizedSubscriptionInfo sealed : public SubscriptionInfo

[<SealedAttribute>]
type SynchronizedSubscriptionInfo = 
    class
        inherit SubscriptionInfo
    end

GSF.TimeSeries.Transport.SynchronizedSubscriptionInfo = function();

Type.createClass(
	'GSF.TimeSeries.Transport.SynchronizedSubscriptionInfo',
	GSF.TimeSeries.Transport.SubscriptionInfo);

View Source

The SynchronizedSubscriptionInfo type exposes the following members.

Constructors

	Name	Description
	SynchronizedSubscriptionInfo	Creates a new instance of the SynchronizedSubscriptionInfo class.

Top

Properties

	Name	Description
	AllowPreemptivePublishing	Gets or sets the flag that determines whether frames should be published as soon as the data is available. If false, frames will be published when their timestamp expires (realTime > timestamp + lagTime).
	AllowSortsByArrival	Gets or sets the flag that determines whether to allow measurement sorting based on the measurement's time of arrival, if its timestamp is unreasonable.
	ConstraintParameters	Gets or sets the additional constraint parameters supplied to temporal adapters in a temporal session. (Inherited from SubscriptionInfo)
	DataChannelLocalPort	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. (Inherited from SubscriptionInfo)
	DownsamplingMethod	Gets or sets the down-sampling method used when the frame rate of the subscription is lower than the frame rate of the measurement's source.
	ExtraConnectionStringParameters	Gets or sets the additional connection string parameters to be applied to the connection string sent to the publisher during subscription. (Inherited from SubscriptionInfo)
	FilterExpression	Gets or sets the filter expression used to define which measurements are being requested by the subscriber. (Inherited from SubscriptionInfo)
	FramesPerSecond	Gets or sets the frame rate of the subscription in frames per second.
	IgnoreBadTimestamps	Gets or sets the flag that determines whether to ignore bad timestamps when sorting measurements.
	LagTime	Gets or sets the allowed past time deviation tolerance in seconds (can be sub-second). (Inherited from SubscriptionInfo)
	LeadTime	Gets or sets the allowed future time deviation tolerance, in seconds (can be sub-second). (Inherited from SubscriptionInfo)
	ProcessingInterval	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. (Inherited from SubscriptionInfo)
	RemotelySynchronized	Gets or sets the flag that determines whether this subscription is remotely synchronized or locally synchronized.
	RequestNaNValueFilter	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. (Inherited from SubscriptionInfo)
	StartTime	Gets or sets the start time of the requested temporal session for streaming historic data. (Inherited from SubscriptionInfo)
	StopTime	Gets or sets the stop time of the requested temporal session for streaming historic data. (Inherited from SubscriptionInfo)
	TimeResolution	Gets or sets the maximum time resolution, in ticks, to use when sorting measurements by timestamps into their proper destination frame.
	UdpDataChannel	Gets or sets the flag that determines whether the subscriber is requesting its data over a separate UDP data channel. (Inherited from SubscriptionInfo)
	UseCompactMeasurementFormat	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. (Inherited from SubscriptionInfo)
	UseLocalClockAsRealTime	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. (Inherited from SubscriptionInfo)
	UseMillisecondResolution	Gets or sets the flag that determines whether measurement timestamps use millisecond resolution. If false, they will use Ticks resolution. (Inherited from SubscriptionInfo)

Top

Methods

	Name	Description
	Copy	Creates a shallow copy of this SubscriptionInfo object. (Inherited from SubscriptionInfo)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Extension Methods

	Name	Description
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)

Top

Reference

GSF.TimeSeries.Transport Namespace