aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/FSE/Tango.FSE.Common/Logging/ILoggingProvider.cs
blob: 42978fe7087c69b19f4e14239f8eaf7decbd1fca (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
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Tango.FSE.Common.FileSystem;
using Tango.Integration.Logging;
using Tango.Logging;
using Tango.PPC.Shared.Logs;

namespace Tango.FSE.Common.Logging
{
    /// <summary>
    /// Represents global application/firmware logs provider.
    /// </summary>
    public interface ILoggingProvider
    {
        /// <summary>
        /// Gets the last retrieved history of the application log files.
        /// </summary>
        ObservableCollection<RemoteLogFile> ApplicationLogFiles { get; }

        /// <summary>
        /// Gets the last retrieved history of the embedded firmware log files.
        /// </summary>
        ObservableCollection<RemoteLogFile> FirmwareLogFiles { get; }

        /// <summary>
        /// Gets the history of application log files.
        /// </summary>
        /// <returns></returns>
        Task<List<RemoteLogFile>> GetApplicationLogFiles();

        /// <summary>
        /// Gets the history of the embedded firmware log files.
        /// </summary>
        /// <returns></returns>
        Task<List<RemoteLogFile>> GetFirmwareLogFiles();

        /// <summary>
        /// Downloads the specified remote log file.
        /// </summary>
        /// <param name="logFile">The log file.</param>
        /// <param name="targetFile">Target file.</param>
        /// <returns></returns>
        Task<FileSystemHandler> DownloadLogFile(RemoteLogFile logFile, String targetFile);

        /// <summary>
        /// Occurs when a new FSE application log is available.
        /// </summary>
        event EventHandler<LogItemBase> FSELogAvailable;

        /// <summary>
        /// Occurs when a new PPC application log is available.
        /// </summary>
        event EventHandler<LogItemBase> ApplicationLogAvailable;

        /// <summary>
        /// Occurs when a new embedded firmware log is available.
        /// </summary>
        event EventHandler<EmbeddedLogItem> FirmwareLogAvailable;
    }
}