You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
84 lines
3.5 KiB
84 lines
3.5 KiB
/**
|
|
* Digital Voice Modem - Host Software
|
|
* GPLv2 Open Source. Use is subject to license terms.
|
|
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
*
|
|
* @package DVM / Host Software
|
|
*
|
|
*/
|
|
/*
|
|
* Copyright (C) 2022 by Bryan Biedenkapp N2PLL
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
|
|
*/
|
|
#if !defined(__NXDN_LC__PACKET_INFORMATION_H__)
|
|
#define __NXDN_LC__PACKET_INFORMATION_H__
|
|
|
|
#include "Defines.h"
|
|
|
|
namespace nxdn
|
|
{
|
|
namespace lc
|
|
{
|
|
// ---------------------------------------------------------------------------
|
|
// Class Declaration
|
|
// Represents the packet information data for link control data.
|
|
// ---------------------------------------------------------------------------
|
|
|
|
class HOST_SW_API PacketInformation {
|
|
public:
|
|
/// <summary>Initializes a new instance of the PacketInformation class.</summary>
|
|
PacketInformation();
|
|
/// <summary>Finalizes a instance of the PacketInformation class.</summary>
|
|
~PacketInformation();
|
|
|
|
/// <summary>Decodes packet information.</summary>
|
|
bool decode(const uint8_t messageType, const uint8_t* data);
|
|
/// <summary>Encodes packet information.</summary>
|
|
void encode(const uint8_t messageType, uint8_t* data);
|
|
|
|
/// <summary>Helper to reset data values to defaults.</summary>
|
|
void reset();
|
|
|
|
public:
|
|
/** Common Data **/
|
|
/// <summary>Flag indicating if confirmed delivery is needed.</summary>
|
|
__PROPERTY(bool, delivery, Delivery);
|
|
/// <summary>Flag indicating if the packet is a selective retry packet.</summary>
|
|
__PROPERTY(bool, selectiveRetry, SelectiveRetry);
|
|
/// <summary>Count of data blocks in t he transmission packet.</summary>
|
|
__PROPERTY(uint8_t, blockCount, BlockCount);
|
|
/// <summary>Number of padding octets of the last block.</summary>
|
|
__PROPERTY(uint8_t, padCount, PadCount);
|
|
/// <summary>Flag indicating the first fragment.</summary>
|
|
__PROPERTY(bool, start, Start);
|
|
/// <summary>Flag indicating if the Tx fragment count circulates.</summary>
|
|
__PROPERTY(bool, circular, Circular);
|
|
/// <summary>The number and sequence of fragments.</summary>
|
|
__PROPERTY(uint16_t, fragmentCount, FragmentCount);
|
|
|
|
/** Response Data */
|
|
/// <summary>Response class.</summary>
|
|
__PROPERTY(uint8_t, rspClass, ResponseClass);
|
|
/// <summary>Response type.</summary>
|
|
__PROPERTY(uint8_t, rspType, ResponseType);
|
|
/// <summary>Error Block Flag.</summary>
|
|
__PROPERTY(uint16_t, rspErrorBlock, ResponseErrorBlock);
|
|
};
|
|
} // namespace lc
|
|
} // namespace nxdn
|
|
|
|
#endif // __NXDN_LC__PACKET_INFORMATION_H__
|