aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/Tango.Transport/ITransportComponent.cs
blob: 7972f85513c45fbc5704442a259aa56d13c4c14d (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
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace Tango.Transport
{
    /// <summary>
    /// Represents a transport component.
    /// </summary>
    public interface ITransportComponent : IDisposable
    {
        /// <summary>
        /// Gets or sets the name of the transport component.
        /// </summary>
        String ComponentName { get; set; }

        /// <summary>
        /// Connects the transport component.
        /// </summary>
        /// <returns></returns>
        Task Connect();

        /// <summary>
        /// Disconnects the transport component.
        /// </summary>
        /// <returns></returns>
        Task Disconnect();

        /// <summary>
        /// Occurs when component state changes.
        /// </summary>
        event EventHandler<TransportComponentState> StateChanged;

        /// <summary>
        /// Gets the component state.
        /// </summary>
        TransportComponentState State { get; }
    }
}