Software/Visual_Studio/Tango.Transport/ITransportEncoder.cs


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

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Tango.PMR;
using Tango.PMR.Common;

namespace Tango.Transport
{
    /// <summary>
    /// Represents a Transport message encoder capable of encoding or decoding <see cref="ITangoMessage">Tango Messages</see>.
    /// </summary>
    public interface ITransportEncoder
    {
        /// <summary>
        /// Encodes the specified tango message.
        /// </summary>
        /// <param name="tangoMessage">The tango message.</param>
        /// <returns></returns>
        byte[] Encode(ITangoMessage tangoMessage);

        /// <summary>
        /// Decodes the specified data to an <see cref="ITangoMessage"/>.
        /// </summary>
        /// <param name="data">The data.</param>
        /// <returns></returns>
        ITangoMessage Decode(byte[] data);

        /// <summary>
        /// Decodes only the <see cref="MessageContainer"/> part of the message.
        /// </summary>
        /// <param name="data">The data.</param>
        /// <returns></returns>
        MessageContainer DecodeContainer(byte[] data);
    }
}