payload.h

Go to the documentation of this file.

// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
// This file is part of the AWS CDI-SDK, licensed under the BSD 2-Clause "Simplified" License.
// License details at: https://github.com/aws/aws-cdi-sdk/blob/mainline/LICENSE
// -------------------------------------------------------------------------------------------
 
#ifndef CDI_PAYLOAD_H__
#define CDI_PAYLOAD_H__
 
#include <assert.h>
#include <stdbool.h>
#include <stdint.h>
 
#include "private_avm.h"
#include "cdi_core_api.h"
#include "cdi_pool_api.h"
 
//*********************************************************************************************************************
//***************************************** START OF DEFINITIONS AND TYPES ********************************************
//*********************************************************************************************************************
 
typedef enum {
    kPayloadTypeData = 0,   
    kPayloadTypeDataOffset, 
    kPayloadTypeProbe,      
    kPayloadTypeKeepAlive,  
} CdiPayloadType;
 
typedef struct {
    CdiPayloadType payload_type;         
    uint16_t maximum_packet_byte_size;   
    uint8_t maximum_tx_sgl_entries;      
 
    uint16_t payload_num;                
 
    uint16_t packet_sequence_num;        
    uint32_t packet_id;                  
    uint16_t packet_payload_data_size;   
 
    const CdiSglEntry* source_entry_ptr; 
    int source_entry_address_offset;     
    uint32_t payload_data_offset;        
} CdiPayloadPacketState;
 
typedef struct CdiPacketizerState* CdiPacketizerStateHandle;
 
typedef struct CdiConnectionState CdiConnectionState;
typedef struct TxPayloadState TxPayloadState;
typedef struct CdiRawPacketHeader CdiRawPacketHeader;
typedef struct CdiRawExtraPacketHeader CdiRawExtraPacketHeader;
typedef struct CdiProtocol CdiProtocol;
typedef struct CdiProtocol* CdiProtocolHandle;
 
//*********************************************************************************************************************
//******************************************* START OF PUBLIC FUNCTIONS ***********************************************
//*********************************************************************************************************************
 
bool PayloadInit(CdiConnectionState* con_state_ptr, const CdiSgList* source_sgl_ptr,
                 TxPayloadState* payload_state_ptr);
 
CdiPacketizerStateHandle PayloadPacketizerCreate(void);
 
void PayloadPacketizerDestroy(CdiPacketizerStateHandle packetizer_state_handle);
 
void PayloadPacketizerStateInit(CdiPacketizerStateHandle packetizer_state_handle);
 
bool PayloadPacketizerPacketGet(CdiProtocolHandle protocol_handle, CdiPacketizerStateHandle packetizer_state_handle,
                                char* header_ptr, int header_buffer_size, CdiPoolHandle packet_sgl_entry_pool_handle,
                                TxPayloadState* payload_state_ptr, CdiSgList* packet_sgl_ptr,
                                bool* ret_is_last_packet_ptr);
 
#endif  // CDI_PAYLOAD_H__