cdi_test_unit_api.h File Reference

The declarations in this header file correspond to the definitions in cdi_test_unit_api.c and are meant to provide access to helpful SDK data structures and functions that are not part of the core API functionality. More...

#include <stdbool.h>
#include "cdi_core_api.h"

Go to the source code of this file.

Enumerations
enum	CdiTestUnitName {   kTestUnitAll , kTestUnitAvmApi , kTestUnitSgl , kTestUnitTimeout ,   kTestUnitTDigest , kTestUnitRxpacketReorder , kTestUnitRxPayloadReorder , kTestUnitList ,   kTestUnitLogger , kTestUnitLast }
	This enumeration is used in to indicate which unit test to run. More...

Functions
const CdiEnumStringKey *	CdiTestUnitGetKeyArray (void)
	Get key array, only used internally by the CDI-SDK.
CDI_INTERFACE bool	CdiTestUnitRun (CdiTestUnitName test_name)

Detailed Description

The declarations in this header file correspond to the definitions in cdi_test_unit_api.c and are meant to provide access to helpful SDK data structures and functions that are not part of the core API functionality.

Enumeration Type Documentation

CdiTestUnitName

enum CdiTestUnitName

This enumeration is used in to indicate which unit test to run.

Enumerator
kTestUnitAll	Test all unit tests.
kTestUnitAvmApi	Test unit AVM functions.
kTestUnitSgl	Test unit SGL.
kTestUnitTimeout	Test unit timeout.
kTestUnitTDigest	Test unit T-digest.
kTestUnitRxpacketReorder	Test unit Rx packet reorderer.
kTestUnitRxPayloadReorder	Test unit Rx payload reorderer.
kTestUnitList	Unit test for doubly linked list implementation.
kTestUnitLogger	Test logger functions.
kTestUnitLast	End of list (for range checking, do no remove).

Function Documentation

CdiTestUnitGetKeyArray()

const CdiEnumStringKey * CdiTestUnitGetKeyArray

(

void

)

Get key array, only used internally by the CDI-SDK.

Returns

Pointer to enum string array.

CdiTestUnitRun()

CDI_INTERFACE bool CdiTestUnitRun

(

CdiTestUnitName

test_name

)

Function used to convert a string to a matching enum value.

Parameters

test_name

Enum from CdiTestUnitName which indicates which unit test to run.

Returns

true if all tests were successful, otherwise false.