aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/FSE/Tango.FSE.Common/Connection/IMachineProvider.cs
blob: 8c4512c4133378085c38c9bdbe029ad3e75ed0b3 (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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Tango.BL;
using Tango.BL.Entities;
using Tango.Integration.ExternalBridge;
using Tango.Integration.Operation;

namespace Tango.FSE.Common.Connection
{
    /// <summary>
    /// Represents the machine connection provider.
    /// </summary>
    public interface IMachineProvider : INotifyApplicationReady
    {
        /// <summary>
        /// Occurs when machine operator has connected.
        /// </summary>
        event EventHandler<MachineConnectedEventArgs> MachineConnected;

        /// <summary>
        /// Occurs when the machine operator has disconnected.
        /// </summary>
        event EventHandler<MachineDisconnectedEventArgs> MachineDisconnected;

        /// <summary>
        /// Gets the database machine entity associated with the current machine.
        /// </summary>
        Machine Machine { get; }

        /// <summary>
        /// Gets or sets a value indicating whether a machine is currently connected.
        /// </summary>
        bool IsConnected { get; }

        /// <summary>
        /// Gets the current connected machine connection type.
        /// </summary>
        MachineConnectionTypes ConnectionType { get; }

        /// <summary>
        /// Gets a value indicating whether the machine is connected and the <see cref="ConnectionType"/> equals <see cref="MachineConnectionTypes.Wifi"/> or <see cref="MachineConnectionTypes.SignalR"/>.
        /// </summary>
        bool IsPPCAvailable { get; }

        /// <summary>
        /// Gets the connection time span.
        /// </summary>
        TimeSpan ConnectionTime { get; }

        /// <summary>
        /// Gets a value indicating whether this instance is busy connecting/disconnecting.
        /// </summary>
        bool IsBusy { get; }

        /// <summary>
        /// Gets the machine operator.
        /// </summary>
        IExternalBridgeClient MachineOperator { get; }

        /// <summary>
        /// Connects to the specified machine.
        /// </summary>
        /// <param name="machine">The machine.</param>
        /// <returns></returns>
        Task<bool> ConnectToMachine(IExternalBridgeClient machine);

        /// <summary>
        /// Disconnects the current connected machine.
        /// </summary>
        /// <returns></returns>
        Task DisconnectMachine();

        /// <summary>
        /// Disconnects the currently connected machine and displays a "waiting for reconnection dialog" with a timeout.
        /// Useful when doing remote application restart.
        /// </summary>
        /// <param name="beginDelay">The amount of time to wait before starting reconnection attempts.</param>
        /// <param name="timeout">The timeout for when to drop the reconnection attempt.</param>
        /// <param name="message">The message to display to the user</param>
        /// <returns></returns>
        Task DisconnectAndWaitForReconnection(TimeSpan beginDelay, TimeSpan timeout, String message = null);
    }
}