/*

 * Copyright 2013-2022 Step Function I/O, LLC

 *

 * Licensed to Green Energy Corp (www.greenenergycorp.com) and Step Function I/O

 * LLC (https://stepfunc.io) under one or more contributor license agreements.

 * See the NOTICE file distributed with this work for additional information

 * regarding copyright ownership. Green Energy Corp and Step Function I/O LLC license

 * this file to you under the Apache License, Version 2.0 (the "License"); you

 * may not use this file except in compliance with the License. You may obtain

 * a copy of the License at:

 *

 * http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */

#ifndef OPENDNP3_APPCONTROLFIELD_H

#define OPENDNP3_APPCONTROLFIELD_H

#include <cstdint>

namespace opendnp3

{

/** Represents the first byte in every APDU

 */

struct AppControlField

{

    const static AppControlField DEFAULT;

    static AppControlField Request(uint8_t seq);

    AppControlField() = default;

    explicit AppControlField(uint8_t byte);

    AppControlField(bool fir, bool fin, bool con, bool uns, uint8_t seq = 0);

    uint8_t ToByte() const;

    bool IsFirAndFin() const

    {

        return FIR && FIN;

    }

    bool FIR = true;

    bool FIN = true;

    bool CON = false;

    bool UNS = false;

    uint8_t SEQ = 0;

private:

    static const uint8_t FIR_MASK = 0x80;

    static const uint8_t FIN_MASK = 0x40;

    static const uint8_t CON_MASK = 0x20;

    static const uint8_t UNS_MASK = 0x10;

    static const uint8_t SEQ_MASK = 0x0F;

};

} // namespace opendnp3

#endif