|
DataSubscriberLocallySynchronizedSubscribe Method
|
Note: This API is now obsolete.
Subscribes (or re-subscribes) to a data publisher for a locally synchronized set of data points.
Namespace: GSF.TimeSeries.TransportAssembly: GSF.TimeSeries (in GSF.TimeSeries.dll) Version: 2.4.218-beta
Syntax [ObsoleteAttribute("Preferred method uses SubscriptionInfo object to subscribe.",
false)]
public virtual bool LocallySynchronizedSubscribe(
bool compactFormat,
int framesPerSecond,
double lagTime,
double leadTime,
string filterExpression,
string dataChannel = null,
bool useLocalClockAsRealTime = false,
bool ignoreBadTimestamps = false,
bool allowSortsByArrival = true,
long timeResolution = 10000,
bool allowPreemptivePublishing = true,
DownsamplingMethod downsamplingMethod = DownsamplingMethod.LastReceived,
string startTime = null,
string stopTime = null,
string constraintParameters = null,
int processingInterval = -1,
string waitHandleNames = null,
int waitHandleTimeout = 0
)
<ObsoleteAttribute("Preferred method uses SubscriptionInfo object to subscribe.",
false)>
Public Overridable Function LocallySynchronizedSubscribe (
compactFormat As Boolean,
framesPerSecond As Integer,
lagTime As Double,
leadTime As Double,
filterExpression As String,
Optional dataChannel As String = Nothing,
Optional useLocalClockAsRealTime As Boolean = false,
Optional ignoreBadTimestamps As Boolean = false,
Optional allowSortsByArrival As Boolean = true,
Optional timeResolution As Long = 10000,
Optional allowPreemptivePublishing As Boolean = true,
Optional downsamplingMethod As DownsamplingMethod = DownsamplingMethod.LastReceived,
Optional startTime As String = Nothing,
Optional stopTime As String = Nothing,
Optional constraintParameters As String = Nothing,
Optional processingInterval As Integer = -1,
Optional waitHandleNames As String = Nothing,
Optional waitHandleTimeout As Integer = 0
) As Boolean
public:
[ObsoleteAttribute(L"Preferred method uses SubscriptionInfo object to subscribe.",
false)]
virtual bool LocallySynchronizedSubscribe(
bool compactFormat,
int framesPerSecond,
double lagTime,
double leadTime,
String^ filterExpression,
String^ dataChannel = nullptr,
bool useLocalClockAsRealTime = false,
bool ignoreBadTimestamps = false,
bool allowSortsByArrival = true,
long long timeResolution = 10000,
bool allowPreemptivePublishing = true,
DownsamplingMethod downsamplingMethod = DownsamplingMethod::LastReceived,
String^ startTime = nullptr,
String^ stopTime = nullptr,
String^ constraintParameters = nullptr,
int processingInterval = -1,
String^ waitHandleNames = nullptr,
int waitHandleTimeout = 0
)
[<ObsoleteAttribute("Preferred method uses SubscriptionInfo object to subscribe.",
false)>]
abstract LocallySynchronizedSubscribe :
compactFormat : bool *
framesPerSecond : int *
lagTime : float *
leadTime : float *
filterExpression : string *
?dataChannel : string *
?useLocalClockAsRealTime : bool *
?ignoreBadTimestamps : bool *
?allowSortsByArrival : bool *
?timeResolution : int64 *
?allowPreemptivePublishing : bool *
?downsamplingMethod : DownsamplingMethod *
?startTime : string *
?stopTime : string *
?constraintParameters : string *
?processingInterval : int *
?waitHandleNames : string *
?waitHandleTimeout : int
(* Defaults:
let _dataChannel = defaultArg dataChannel null
let _useLocalClockAsRealTime = defaultArg useLocalClockAsRealTime false
let _ignoreBadTimestamps = defaultArg ignoreBadTimestamps false
let _allowSortsByArrival = defaultArg allowSortsByArrival true
let _timeResolution = defaultArg timeResolution 10000
let _allowPreemptivePublishing = defaultArg allowPreemptivePublishing true
let _downsamplingMethod = defaultArg downsamplingMethod DownsamplingMethod.LastReceived
let _startTime = defaultArg startTime null
let _stopTime = defaultArg stopTime null
let _constraintParameters = defaultArg constraintParameters null
let _processingInterval = defaultArg processingInterval -1
let _waitHandleNames = defaultArg waitHandleNames null
let _waitHandleTimeout = defaultArg waitHandleTimeout 0
*)
-> bool
[<ObsoleteAttribute("Preferred method uses SubscriptionInfo object to subscribe.",
false)>]
override LocallySynchronizedSubscribe :
compactFormat : bool *
framesPerSecond : int *
lagTime : float *
leadTime : float *
filterExpression : string *
?dataChannel : string *
?useLocalClockAsRealTime : bool *
?ignoreBadTimestamps : bool *
?allowSortsByArrival : bool *
?timeResolution : int64 *
?allowPreemptivePublishing : bool *
?downsamplingMethod : DownsamplingMethod *
?startTime : string *
?stopTime : string *
?constraintParameters : string *
?processingInterval : int *
?waitHandleNames : string *
?waitHandleTimeout : int
(* Defaults:
let _dataChannel = defaultArg dataChannel null
let _useLocalClockAsRealTime = defaultArg useLocalClockAsRealTime false
let _ignoreBadTimestamps = defaultArg ignoreBadTimestamps false
let _allowSortsByArrival = defaultArg allowSortsByArrival true
let _timeResolution = defaultArg timeResolution 10000
let _allowPreemptivePublishing = defaultArg allowPreemptivePublishing true
let _downsamplingMethod = defaultArg downsamplingMethod DownsamplingMethod.LastReceived
let _startTime = defaultArg startTime null
let _stopTime = defaultArg stopTime null
let _constraintParameters = defaultArg constraintParameters null
let _processingInterval = defaultArg processingInterval -1
let _waitHandleNames = defaultArg waitHandleNames null
let _waitHandleTimeout = defaultArg waitHandleTimeout 0
*)
-> bool
function LocallySynchronizedSubscribe(compactFormat, framesPerSecond, lagTime, leadTime, filterExpression, dataChannel, useLocalClockAsRealTime, ignoreBadTimestamps, allowSortsByArrival, timeResolution, allowPreemptivePublishing, downsamplingMethod, startTime, stopTime, constraintParameters, processingInterval, waitHandleNames, waitHandleTimeout);
View SourceParameters
- compactFormat Boolean
- Boolean value that determines if the compact measurement format should be used. Set to false for full fidelity measurement serialization; otherwise set to true for bandwidth conservation.
- framesPerSecond Int32
- The desired number of data frames per second.
- lagTime Double
- Allowed past time deviation tolerance, in seconds (can be sub-second).
- leadTime Double
- Allowed future time deviation tolerance, in seconds (can be sub-second).
- filterExpression String
- Filtering expression that defines the measurements that are being subscribed.
- dataChannel String (Optional)
- Desired UDP return data channel connection string to use for data packet transmission. Set to null to use TCP channel for data transmission.
- useLocalClockAsRealTime Boolean (Optional)
- Boolean value that determines whether or not to use the local clock time as real-time.
- ignoreBadTimestamps Boolean (Optional)
- Boolean value that determines if bad timestamps (as determined by measurement's timestamp quality) should be ignored when sorting measurements.
- allowSortsByArrival Boolean (Optional)
- Gets or sets flag that determines whether or not to allow incoming measurements with bad timestamps to be sorted by arrival time.
- timeResolution Int64 (Optional)
- Gets or sets the maximum time resolution, in ticks, to use when sorting measurements by timestamps into their proper destination frame.
- allowPreemptivePublishing Boolean (Optional)
- Gets or sets flag that allows system to preemptively publish frames assuming all expected measurements have arrived.
- downsamplingMethod DownsamplingMethod (Optional)
- Gets the total number of down-sampled measurements processed by the concentrator.
- startTime String (Optional)
- Defines a relative or exact start time for the temporal constraint to use for historical playback.
- stopTime String (Optional)
- Defines a relative or exact stop time for the temporal constraint to use for historical playback.
- constraintParameters String (Optional)
- Defines any temporal parameters related to the constraint to use for historical playback.
- processingInterval Int32 (Optional)
- Defines the desired processing interval milliseconds, i.e., historical play back speed, to use when temporal constraints are defined.
- waitHandleNames String (Optional)
- Comma separated list of wait handle names used to establish external event wait handles needed for inter-adapter synchronization.
- waitHandleTimeout Int32 (Optional)
- Maximum wait time for external events, in milliseconds, before proceeding.
Return Value
Booleantrue if subscribe transmission was successful; otherwise
false.
Remarks
When the startTime or stopTime temporal processing constraints are defined (i.e., not null), this
specifies the start and stop time over which the subscriber session will process data. Passing in null for the startTime
and stopTime specifies the subscriber session will process data in standard, i.e., real-time, operation.
With the exception of the values of -1 and 0, the processingInterval value specifies the desired historical playback data
processing interval in milliseconds. This is basically a delay, or timer interval, over which to process data. Setting this value to -1 means
to use the default processing interval while setting the value to 0 means to process data as fast as possible.
The startTime and stopTime parameters can be specified in one of the
following formats:
Time Format | Format Description |
---|
12-30-2000 23:59:59.033 | Absolute date and time. |
* | Evaluates to UtcNow. |
*-20s | Evaluates to 20 seconds before UtcNow. |
*-10m | Evaluates to 10 minutes before UtcNow. |
*-1h | Evaluates to 1 hour before UtcNow. |
*-1d | Evaluates to 1 day before UtcNow. |
See Also