cdi_avm_api.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_AVM_API_H__
#define CDI_AVM_API_H__
 
// Page for CDI-AVM
#include <stdint.h>
 
#include "cdi_core_api.h"
#include "cdi_raw_api.h"
 
//*********************************************************************************************************************
//***************************************** START OF DEFINITIONS AND TYPES ********************************************
//*********************************************************************************************************************
 
typedef struct {
    char uri[257];
 
    uint8_t data[1024];
 
    int data_size;
} CdiAvmConfig;
 
typedef struct {
    uint16_t stream_identifier;
} CdiAvmExtraData;
 
typedef struct {
    CdiCoreTxPayloadConfig core_config_data;
 
    CdiAvmExtraData avm_extra_data;
} CdiAvmTxPayloadConfig;
 
typedef struct {
    CdiCoreCbData core_cb_data;
 
    CdiAvmExtraData avm_extra_data;
 
    CdiAvmConfig* config_ptr;
 
    CdiSgList sgl;
} CdiAvmRxCbData;
 
typedef void (*CdiAvmRxCallback)(const CdiAvmRxCbData* data_ptr);
 
typedef struct {
    CdiCoreCbData core_cb_data;
 
    CdiAvmExtraData avm_extra_data;
} CdiAvmTxCbData;
 
typedef void (*CdiAvmTxCallback)(const CdiAvmTxCbData* data_ptr);
 
typedef struct {
    const char* dest_ip_addr_str;
 
    int dest_port;
 
    const char* stream_name_str;
} CdiTxConfigDataStream;
 
//*********************************************************************************************************************
//******************************************* START OF PUBLIC FUNCTIONS ***********************************************
//*********************************************************************************************************************
 
CDI_INTERFACE CdiReturnStatus CdiAvmTxCreate(CdiTxConfigData* config_data_ptr, CdiAvmTxCallback tx_cb_ptr,
                                             CdiConnectionHandle* ret_handle_ptr);
 
CDI_INTERFACE CdiReturnStatus CdiAvmTxStreamConnectionCreate(CdiTxConfigData* config_data_ptr,
                                                             CdiAvmTxCallback tx_cb_ptr,
                                                             CdiConnectionHandle* ret_handle_ptr);
 
CDI_INTERFACE CdiReturnStatus CdiAvmTxStreamEndpointCreate(CdiConnectionHandle handle,
                                                           CdiTxConfigDataStream* stream_config_ptr,
                                                           CdiEndpointHandle* ret_handle_ptr);
 
CDI_INTERFACE CdiReturnStatus CdiAvmStreamEndpointDestroy(CdiEndpointHandle handle);
 
CDI_INTERFACE CdiReturnStatus CdiAvmRxCreate(CdiRxConfigData* config_data_ptr, CdiAvmRxCallback rx_cb_ptr,
                                             CdiConnectionHandle* ret_handle_ptr);
 
CDI_INTERFACE CdiReturnStatus CdiAvmTxPayload(CdiConnectionHandle con_handle,
                                              const CdiAvmTxPayloadConfig* payload_config_ptr,
                                              const CdiAvmConfig* avm_config_ptr, const CdiSgList* sgl_ptr,
                                              int max_latency_microsecs);
 
CDI_INTERFACE CdiReturnStatus CdiAvmEndpointTxPayload(CdiEndpointHandle endpoint_handle,
                                                      const CdiAvmTxPayloadConfig* payload_config_ptr,
                                                      const CdiAvmConfig* avm_config_ptr, const CdiSgList* sgl_ptr,
                                                      int max_latency_microsecs);
 
#endif // CDI_AVM_API_H__