aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/Tango.Integration/ExternalBridge/IExternalBridgeService.cs
blob: c0b41fd00ccaa679ef96c2bc3149a077133562ff (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
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Tango.BL.Entities;
using Tango.Integration.Operation;
using Tango.PMR.Integration;
using Tango.Transport;
using Tango.Transport.Transporters;

namespace Tango.Integration.ExternalBridge
{
    public interface IExternalBridgeService : ITransporter
    {
        /// <summary>
        /// Occurs when a new client is waiting for authentication.
        /// </summary>
        event EventHandler<ExternalBridgeClientConnectedEventArgs> ConnectionRequest;

        /// <summary>
        /// Occurs when the last client has been disconnected.
        /// </summary>
        event EventHandler ClientDisconnected;

        /// <summary>
        /// Occurs when the service has received a new color profile request.
        /// </summary>
        event EventHandler<ColorProfileRequestEventArgs> ColorProfileRequest;

        /// <summary>
        /// Gets or sets the machine operator.
        /// </summary>
        IMachineOperator MachineOperator { get; set; }

        /// <summary>
        /// Gets or sets the machine.
        /// </summary>
        Machine Machine { get; set; }

        /// <summary>
        /// Gets a value indicating whether this instance is started.
        /// </summary>
        bool IsStarted { get; }

        /// <summary>
        /// Gets or sets a value indicating whether this <see cref="IExternalBridgeService"/> is enabled.
        /// </summary>
        bool Enabled { get; set; }

        /// <summary>
        /// Gets a value indicating whether a remote client is authenticated and in session.
        /// </summary>
        bool IsInSession { get; }

        /// <summary>
        /// Starts this instance.
        /// </summary>
        void Start();

        /// <summary>
        /// Stops this instance.
        /// </summary>
        void Stop();

        /// <summary>
        /// Disconnects the current remote client session.
        /// </summary>
        void DisconnectSession();

        /// <summary>
        /// Gets the current session login intent.
        /// </summary>
        ExternalBridgeLoginIntent SessionIntent { get; }
    }
}