aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/Tango.Telemetry/ITelemetryStreamingSource.cs
blob: 725be0193549bba1966144337c25011a8d6d67f5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
using System;

namespace Tango.Telemetry
{
    /// <summary>
    /// Represents a telemetry source that emits real-time streaming telemetry.
    /// </summary>
    public interface ITelemetryStreamingSource : ITelemetrySource
    {
        /// <summary>
        /// Occurs when new telemetry data is available to be processed.
        /// </summary>
        event EventHandler<TelemetryAvailableEventArgs> TelemetryAvailable;

        /// <summary>
        /// Gets a value indicating whether the streaming source is currently running.
        /// </summary>
        bool IsStarted { get; }

        /// <summary>
        /// Starts the telemetry streaming process.
        /// </summary>
        void Start();

        /// <summary>
        /// Stops the telemetry streaming process.
        /// </summary>
        void Stop();
    }
}