aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/Tango.PMR/ITangoMessage.cs
blob: 6d3d8d40559181151395e6e78be65229a25a96c1 (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
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Tango.PMR.Common;

namespace Tango.PMR
{
    /// <summary>
    /// Represents a Tango message.
    /// </summary>
    public interface ITangoMessage
    {
        /// <summary>
        /// Gets the container that will encapsulate the actual PMR message.
        /// </summary>
        MessageContainer Container { get; set; }

        /// <summary>
        /// Gets or sets the PMR message type.
        /// </summary>
        MessageType Type { get; set; }

        /// <summary>
        /// Serializes the Tango message to byte array.
        /// </summary>
        /// <returns></returns>
        byte[] ToBytes();

        /// <summary>
        /// Serializes the Tango message to byte array representing a serialized JSON object of this Tango message.
        /// </summary>
        /// <returns></returns>
        byte[] ToJsonBytes();
    }
}