CDI SDK
SDK for transporting chunks of data reliably and with low latency using a polled mode network driver.
Loading...
Searching...
No Matches
cdi_raw_api.h
Go to the documentation of this file.
1// -------------------------------------------------------------------------------------------
2// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
3// This file is part of the AWS CDI-SDK, licensed under the BSD 2-Clause "Simplified" License.
4// License details at: https://github.com/aws/aws-cdi-sdk/blob/mainline/LICENSE
5// -------------------------------------------------------------------------------------------
6
7#ifndef CDI_RAW_API_H__
8#define CDI_RAW_API_H__
9
17// Page for CDI-RAW
50#include "cdi_core_api.h"
51
52//*********************************************************************************************************************
53//***************************************** START OF DEFINITIONS AND TYPES ********************************************
54//*********************************************************************************************************************
55
68
79typedef void (*CdiRawRxCallback)(const CdiRawRxCbData* data_ptr);
80
89
98typedef void (*CdiRawTxCallback)(const CdiRawTxCbData* data_ptr);
99
100//*********************************************************************************************************************
101//******************************************* START OF PUBLIC FUNCTIONS ***********************************************
102//*********************************************************************************************************************
103
123 CdiConnectionHandle* ret_handle_ptr);
124
143 CdiConnectionHandle* ret_handle_ptr);
144
169 const CdiCoreTxPayloadConfig* payload_config_ptr,
170 const CdiSgList* sgl_ptr, int max_latency_microsecs);
171
172#endif // CDI_RAW_API_H__
This file declares the public API data types, structures and functions that comprise the CDI low-leve...
CdiReturnStatus
Values used for API function return codes.
Definition cdi_core_api.h:189
CDI_INTERFACE CdiReturnStatus CdiRawTxPayload(CdiConnectionHandle con_handle, const CdiCoreTxPayloadConfig *payload_config_ptr, const CdiSgList *sgl_ptr, int max_latency_microsecs)
Definition cdi_raw_api.c:66
CDI_INTERFACE CdiReturnStatus CdiRawTxCreate(CdiTxConfigData *config_data_ptr, CdiRawTxCallback tx_cb_ptr, CdiConnectionHandle *ret_handle_ptr)
Definition cdi_raw_api.c:46
CDI_INTERFACE CdiReturnStatus CdiRawRxCreate(CdiRxConfigData *config_data_ptr, CdiRawRxCallback rx_cb_ptr, CdiConnectionHandle *ret_handle_ptr)
Definition cdi_raw_api.c:56
void(* CdiRawTxCallback)(const CdiRawTxCbData *data_ptr)
Prototype of transmit data callback function. The user code must implement a function with this proto...
Definition cdi_raw_api.h:98
void(* CdiRawRxCallback)(const CdiRawRxCbData *data_ptr)
Prototype of receive data callback function. The user code must implement a function with this protot...
Definition cdi_raw_api.h:79
#define CDI_INTERFACE
Specify C linkage when compiling as C++ and define API interface export for Windows.
Definition cdi_utility_api.h:34
Structure definition behind the connection handles shared with the user's application program....
Definition private.h:371
A structure of this type is passed as part of the data to the TX/RX registered user callback function...
Definition cdi_core_api.h:418
A structure used to configure a transmit payload.
Definition cdi_core_api.h:351
A structure of this type is passed as the parameter to CdiRawRxCallback(). It contains a single paylo...
Definition cdi_raw_api.h:60
CdiSgList sgl
If no error occurred, the payload's data as a scatter-gather list. If the payload is in linear format...
Definition cdi_raw_api.h:66
CdiCoreCbData core_cb_data
Core common data shared between registered user TX/RX callback functions.
Definition cdi_raw_api.h:62
A structure of this type is passed as the parameter to CdiRawTxCallback(). It contains data related t...
Definition cdi_raw_api.h:85
CdiCoreCbData core_cb_data
Core common data shared between registered user TX/RX callback functions.
Definition cdi_raw_api.h:87
Configuration data used by one of the Cdi...RxCreate() API functions.
Definition cdi_core_api.h:760
This structure defines a scatter-gather list (SGL) which is used to represent an array of data compri...
Definition cdi_core_api.h:728
Configuration data used by one of the Cdi...TxCreate() API functions.
Definition cdi_core_api.h:624