//-----------------------------------------------------------------------
// <copyright file="FT_FLOW_CONTROL.cs" company="bedug.com">
//     Copyright © 2012 Nils Hammar and Future Technology Devices International Limited. All rights reserved.
// </copyright>
//-----------------------------------------------------------------------

namespace FtdiApi.Constants
{
    /// <summary>
    /// Permitted flow control values for FTDI devices
    /// </summary>
    [System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:ElementsMustBeDocumented", Justification = "Reviewed.")]
    [System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.LayoutRules", "SA1516:ElementsMustBeSeparatedByBlankLine", Justification = "Reviewed.")]
    [System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.OrderingRules", "SA1201:ElementsMustAppearInTheCorrectOrder", Justification = "Reviewed.")]
    [System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.ReadabilityRules", "SA1121:UseBuiltInTypeAlias", Justification = "Reviewed.")]
    [System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.OrderingRules", "SA1202:ElementsMustBeOrderedByAccess", Justification = "Reviewed.")]
    [System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.NamingRules", "SA1305:FieldNamesMustNotUseHungarianNotation", Justification = "Reviewed.")]
    [System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.NamingRules", "SA1306:FieldNamesMustBeginWithLowerCaseLetter", Justification = "Reviewed.")]
    [System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.LayoutRules", "SA1503:CurlyBracketsMustNotBeOmitted", Justification = "Reviewed.")]
    [System.Diagnostics.CodeAnalysis.SuppressMessage("StyleCop.CSharp.NamingRules", "SA1310:FieldNamesMustNotContainUnderscore", Justification = "Reviewed.")]
    public class FT_FLOW_CONTROL
    {
        /// <summary>
        /// No flow control
        /// </summary>
        public const ushort FT_FLOW_NONE = 0x0000;

        /// <summary>
        /// RTS/CTS flow control
        /// </summary>
        public const ushort FT_FLOW_RTS_CTS = 0x0100;

        /// <summary>
        /// DTR/DSR flow control
        /// </summary>
        public const ushort FT_FLOW_DTR_DSR = 0x0200;

        /// <summary>
        /// Xon/Xoff flow control
        /// </summary>
        public const ushort FT_FLOW_XON_XOFF = 0x0400;
    }
}