FileTransferStatus.cs

using System;
using System.Linq;
using System.Text;
using OSDP.Net.Messages;
using OSDP.Net.Messages.SecureChannel;
 
namespace OSDP.Net.Model.ReplyData
{
    public class FileTransferStatus : PayloadData
    {
        private const int DataLength = 7;

        [Flags]
        public enum ControlFlags
        {
            None = 0x0,

            Interleave = 0x1,

            LeaveSecureChannel = 0x2,

            PollResponseAvailable = 0x4
        }

        public enum StatusDetail
        {
            UnknownError = -4,
            FileDataUnacceptable = -3,
            UnrecognizedFileContents = -2,
            AbortFileTransfer = -1,
            OkToProceed = 0,
            FileContentsProcessed = 1,
            RebootingNow = 2,
            FinishingFileTransfer = 3,
            UnknownStatus = 4
        }

        private FileTransferStatus()
        {
        }

        public FileTransferStatus(StatusDetail detail, ControlFlags action = ControlFlags.None,
            ushort requestedDelay = 0, ushort updateMessageMaximum = 0)
        {
            Detail = detail;
            Action = action;
            RequestedDelay = requestedDelay;
            UpdateMessageMaximum = updateMessageMaximum;
        }

        public ControlFlags Action { get; private set; }

        public ushort RequestedDelay { get;private set;  }

        public StatusDetail Detail { get; private set; }

        public ushort UpdateMessageMaximum { get; private set; }

        public override byte Code => (byte)ReplyType.FileTransferStatus;

        public override ReadOnlySpan<byte> SecurityControlBlock() => SecurityBlock.ReplyMessageWithDataSecurity;

        public override byte[] BuildData()
        {
            var data = new byte[DataLength];
            data[0] = (byte)Action;
 
            var delay = Message.ConvertShortToBytes(RequestedDelay);
            data[1] = delay[0];
            data[2] = delay[1];
 
            // StatusDetail travels as a signed little-endian short, so the enum value is reinterpreted
            // rather than clamped; negative values are the PD's error codes.
            var detail = Message.ConvertShortToBytes(unchecked((ushort)(short)Detail));
            data[3] = detail[0];
            data[4] = detail[1];
 
            var messageMaximum = Message.ConvertShortToBytes(UpdateMessageMaximum);
            data[5] = messageMaximum[0];
            data[6] = messageMaximum[1];
 
            return data;
        }

        internal static FileTransferStatus ParseData(ReadOnlySpan<byte> data)
        {
            var dataArray = data.ToArray();
            if (dataArray.Length != DataLength)
            {
                throw new Exception("Invalid size for the data");
            }
 
            return new FileTransferStatus
            {
                Action = (ControlFlags)dataArray[0],
                RequestedDelay = Message.ConvertBytesToUnsignedShort(dataArray.Skip(1).Take(2).ToArray(), true),
                Detail = SetStatusDetailDefault(Message.ConvertBytesToShort(dataArray.Skip(3).Take(2).ToArray(), true)),
                UpdateMessageMaximum = Message.ConvertBytesToUnsignedShort(dataArray.Skip(5).Take(2).ToArray(), true)
            };
        }

        public override string ToString()
        {
            var build = new StringBuilder();
            build.AppendLine($"             Action: {Action:G}");
            build.AppendLine($"    Requested Delay: {RequestedDelay}");
            build.AppendLine($"      Status Detail: {Detail}");
            build.AppendLine($" Update Message Max: {UpdateMessageMaximum}");
 
            return build.ToString();
        }
 
        private static StatusDetail SetStatusDetailDefault(short value)
        {
            return value switch
            {
                < -3 => StatusDetail.UnknownError,
                > 3 => StatusDetail.UnknownStatus,
                _ => (StatusDetail)value
            };
        }
    }
}