NDEVRDataPacket.h

/*--------------------------------------------------------------------------------------------
Copyright (c) 2020, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants
Licensee a limited, non-exclusive, non-transferable, royalty-free license
(without the right to sublicense) to use the API solely for the purpose of
Licensee's internal development efforts to develop applications for which
the API was provided.
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: NDEVRDataPacket
File: NDEVRServerClientModule
Included in API: True
Author(s): tyler.parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/Buffer.h>
#include <NDEVR/BinaryFile.h>
namespace NDEVR
{
    class ProgressInfo;
    struct NDEVRPacketHeader
    {
        static constexpr uint04 valid_start_check = 0xA5A5A5A5U; 
        uint04 start_check = valid_start_check; 
        uint04 checksum = Constant<uint04>::Invalid; 
        uint08 size = 0U;                       
        bool cache_to_disk;                     
    };

    struct NDEVRSERVERCLIENT_API NDEVRDataPacket
    {
        NDEVRDataPacket() {};
        NDEVRDataPacket(NDEVRDataPacket&& other);
        NDEVRDataPacket& operator=(NDEVRDataPacket&& other) noexcept;
        NDEVRDataPacket(const Buffer<uint01>& other, bool generate_checksum);
        NDEVRDataPacket(const HighCapacityBuffer<uint01>& other, bool generate_checksum);
        NDEVRDataPacket(HighCapacityBuffer<uint01>&& other, bool generate_checksum);
        NDEVRDataPacket(BinaryFile&& bf, bool generate_checksum);
        void clear();
        BinaryFile& binaryFile();
        uint08 addData(uint01* buffer, uint08 size);
        uint08 pullData(uint01* buffer, uint08 max_size);
        uint08 dataSize() const;
        void updatePointer(uint08 forward);
        void getProgress(ProgressInfo& info, uint08 extra_size) const;
        bool isComplete(uint08 extra_size) const;
        bool isComplete() const;
        bool hasStarted() const;
        bool isValid() const;
        void setupPacketHeader(bool generate_checksum);
        uint04 checksum() const;
        NDEVRPacketHeader packet_header;        
        uint08 handled_size = sizeof(NDEVRPacketHeader); 
    protected:
        BinaryFile m_file;                      
    };
}