|
CDI SDK
SDK for transporting chunks of data reliably and with low latency using a polled mode network driver.
|
| CAdapterConnectionState | Structure used to hold adapter connection state |
| CAdapterControlConnectionState | This defines a structure that contains the state information for a control interface adapter connection (type is kEndpointTypeControl) |
| CAdapterDataConnectionState | This defines a structure that contains the state information for a data adapter connection (type is kEndpointTypeData). This adapter type is used to transmit all data that is not part of a control interface |
| CAdapterEndpointState | Structure used to hold adapter endpoint state |
| CAdapterVirtualFunctionPtrTable | Structure definition used to define the virtual table API interface for adapters |
| CAncillaryDataPacket | The ANC data packet. See https://datatracker.ietf.org/doc/html/rfc8331#section-2.1 for details |
| CAncillaryDataPayloadErrors | Counters for keeping track of errors observed when parsing ANC payloads |
| CAncillaryDataPayloadHeader | The ANC payload header |
| CAppPayloadCallbackData | This defines a structure that contains all of the data required to use the application registered payload callback functions |
| CAwsSdkState | |
| CBaselineProfileData | Type used to hold baseline profile version and V-table to required APIs |
| CCallBackUserData | A structure to be used by the unit test callback function to signal to the test when the callback occurred and whether the callback was successful |
| CCaseParams | |
| CCdiAdapterConnectionConfigData | Structure definition used to configure an adapter endpoint |
| CCdiAdapterData | Configuration data used by the CdiCoreNetworkAdapterInitialize() API function |
| CCdiAdapterEndpointConfigData | Structure definition used to configure an adapter endpoint |
| CCdiAdapterEndpointStats | Transfer statistics data specific to an adapter endpoint. Used in the CdiTransferStats structure as a parameter of the user-registered CdiCoreStatsCallback() API function |
| CCdiAdapterState | Structure definition behind the handles shared with the user's application program. Its contents are opaque to the user's program where it only has a pointer to a declared but not defined structure |
| CCdiAvmAncillaryDataConfig | Ancillary Data payload configuration data. Used to define the format of the ancillary data payload conforming to the CDI baseline ancillary data format |
| CCdiAvmAncillaryDataPacket | An ancillary data packet. See https://datatracker.ietf.org/doc/html/rfc8331#section-2.1 for details |
| CCdiAvmAudioConfig | Audio payload configuration data. Used to define the format of the audio payload conforming to the CDI baseline audio format |
| CCdiAvmBaselineConfig | Structure that aggregates the audio, video, and ancillary data structures into a single structure |
| CCdiAvmBaselineConfigCommon | Structure that is common to all baseline profile versions. This allows the APIs to determine payload type and profile version. Once that has been determined, the structure can then be used by baseline version specific logic where it is cast to the appropriate type |
| CCdiAvmBaselineProfileVersion | Structure containing the version information common to audio, video, and metadata in the baseline configuration structure |
| CCdiAvmConfig | This is the generic AVM configuration structure which describes the format of each stream |
| CCdiAvmExtraData | Extra data that is sent along with the AVM payload to the receiver. It will be provided to the receiver through a registered user receive callback function |
| CCdiAvmRxCbData | A structure of this type is passed as the parameter to CdiAvmRxCallback(). It contains a single payload sent from a transmitter |
| CCdiAvmTxCbData | A structure of this type is passed as the parameter to CdiAvmTxCallback(). It contains data related to the transmission of a single payload to a receiver |
| CCdiAvmTxPayloadConfig | A structure used to configure a AVM transmit payload |
| CCdiAvmVideoConfig | Video payload configuration data. Used to define the format of the video payload conforming to the CDI baseline video profile |
| CCdiAvmVTableApi | Type used to hold V-table of APIs that must be implemented by baseline profiles |
| CCdiCloudWatchConfigData | A structure that is used to hold statistics gathering configuration data that is specific to CloudWatch |
| CCdiCloudWatchLogging | Class used to redirect AWS SDK logging to CDI logging methods |
| CCdiConnectionState | Structure definition behind the connection handles shared with the user's application program. Its contents are opaque to the user's program where it only has a pointer to a declared but not defined structure |
| CCdiCoreCbData | A structure of this type is passed as part of the data to the TX/RX registered user callback functions. It contains data related to the transmission of a single payload |
| CCdiCoreConfigData | SDK configuration data used by the CdiCoreInitialize() API function |
| CCdiCoreConnectionCbData | A structure of this type is passed as the parameter to CdiCoreConnectionCallback(). It contains data related to the status of a single connection |
| CCdiCoreExtraData | Extra data that is sent along with payloads to the receiver. It will be provided to the receiver through registered user receive data callback functions |
| CCdiCoreReadOnlySettings | SDK read-only settings used internally by SDK |
| CCdiCoreStatsCbData | A structure of this type is passed as the parameter to CdiCoreStatsCallback(). It contains data related to the statistics of a single connection |
| CCdiCoreTxPayloadConfig | A structure used to configure a transmit payload |
| CCdiDecodedPacketDataOffsetInfo | CDI decoded header for payload packets that contains a data offset value (payload type is kPayloadTypeDataOffset). Decoded headers are protocol independent |
| CCdiDecodedPacketHeader | Union of decoded CDI packet headers. Use to reserve memory that can be used to hold any type of decoded CDI packet header. Decoded headers are protocol independent |
| CCdiDecodedPacketNum0Info | CDI decoded header for payload packet #0. This packet never uses payload_data_offset, since it is always zero. Decoded headers are protocol independent |
| CCdiDecodedProbeAck | Control ACK packet that is a response for a transmitted command |
| CCdiDecodedProbeCommand | Probe command packet that is being transmitted |
| CCdiDecodedProbeHeader | Union of decoded probe headers. Use to reserve memory that can be used to hold any type of decoded CDI probe header. Decoded headers are protocol independent |
| CCdiEndpointState | Structure definition behind the connection handles shared with the user's application program. Its contents are opaque to the user's program where it only has a pointer to a declared but not defined structure |
| CCdiEnumStringKey | Type used for holding arrays of enums and related string representations |
| CCdiFifoCbData | A structure of this type is passed as the parameter to CdiFifoCallback(). It contains the state of a single FIFO read or write operation |
| CCdiFifoFullCbData | A structure of this type is passed as the parameter to CdiFifoFullCallback() |
| CCdiFifoState | Structure used to hold state data for a single FIFO |
| CCdiGlobalContext | Structure to hold variables that would otherwise be global in order to keep them contained in one manageable location. All members will be explicitly zeroed at program startup |
| CCdiList | This structure represents a list |
| CCdiListEntry | This structure represents a single list entry |
| CCdiListIterator | This structure represents a list iterator |
| CCdiLogCallbackData | This defines a structure that contains the information used to configure a callback log, referred to using the enumerated value kLogMethodCallback |
| CCdiLoggerState | Structure used to hold state data for a single logger |
| CCdiLogMessageCbData | A structure of this type is passed as the parameter to CdiLogMessageCallback(). It contains a single log message generated by the SDK |
| CCdiLogMethodData | A structure of this type is used to configure the type of log method that is being used. It is passed as the parameter to CdiCoreInitialize() and as part of the CdiTxConfigData or CdiRxConfigData configuration data passed to the Cdi...TxCreate() API functions |
| CCdiLogMultilineState | Structure used to hold state data for a multiline log message |
| CCdiLogState | Structure used to hold state data for a single log of any type (stdout, callback or file) |
| CCdiMemoryState | Structure definition behind the Scatter-Gather List internal data handles shared with the user's application program. Its contents are opaque to the user's program where it only has a pointer to a declared but not defined structure |
| CCdiMultilineLogBufferState | Structure used to hold a buffer for a multiline log message |
| CCDIPacketAvmCommonHeader | This defines a structure that contains the CDI packet #0 header that is common to all AVM payload types |
| CCDIPacketAvmNoConfig | This defines a structure that contains the CDI packet #0 header for a AVM video payload that does not contain any AVM configuration data |
| CCDIPacketAvmUnion | Union of AVM payload cdi headers. Use to reserve memory that can be used to hold any type of CDI packet AVM header |
| CCDIPacketAvmWithConfig | This defines a structure that contains the CDI packet #0 header for a AVM video payload that contains AVM configuration data |
| CCdiPacketizerState | Structure to store the current state of a packet being constructed. Its purpose is to allow for the suspension of the creation of a packet if a pool from which items need to be allocated is empty. A state object is passed in to CdiPayloadInit() prior to calls to CdiPayloadParseCDIPacket() for a given payload |
| CCdiPacketRxReorderInfo | Structure used to hold packet data used by Rx packet reordering |
| CCdiPayloadCounterStats | Transfer statistics data specific to payloads that contain counters that increment for the duration of the connection. They are never reset |
| CCdiPayloadPacketState | Structure used to hold state data for a single payload |
| CCdiPayloadTimeIntervalStats | Transfer statistics data specific to payloads that are reset at the start of each time interval as specified using CdiStatsConfigData.stats_period_seconds. A snapshot of the current values is made and provided through the user-registered callback function CdiCoreStatsCallback() |
| CCdiPoolCbData | Contains the state of a single pool get or put operation |
| CCdiPoolItem | This structure represents a single pool item |
| CCdiPoolState | This structure represents the current state of a memory pool |
| CCdiProtocol | Structure used to hold negotiated protocol version information |
| CCdiProtocolState | Structure used to hold internal state data used by this module |
| CCdiProtocolVersionNumber | CDI header used to identify protocol version number information |
| CCdiProtocolVTableApi | Type used to hold V-table of APIs that must be implemented by payload protocol versions |
| CCdiPtpTimestamp | A structure for holding a PTP timestamp defined in seconds and nanoseconds. This PTP time as defined by SMPTE ST 2059-2 and IEEE 1588-2008 with the exception that the seconds field is an unsigned 32 bit integer instead of the specified 48 bit integer |
| CCdiQueueCbData | A structure of this type is passed as the parameter to CdiQueueCallback(). It contains the state of a single queue read or write operation |
| CCdiRawExtraPacketHeader | Union of raw CDI extra packet headers. Use to reserve memory that can be used to hold raw CDI packet headers that contain extra data (ie. AVM configuration data). Each protocol version uses a specific data format and is kept internal. Use PayloadHeaderDecode() to decoded the raw packet header into CdiDecodedPacketHeader, which is protocol independent. Use PayloadHeaderInit() to convert a CdiDecodedPacketHeader into this format |
| CCdiRawPacketHeader | Union of raw CDI packet headers. Use to reserve memory that can be used to hold raw CDI packet headers that do not contain extra data. Each protocol version uses a specific data format and is kept internal. Use PayloadHeaderDecode() to decoded the raw packet header into CdiDecodedPacketHeader, which is protocol independent. Use PayloadHeaderInit() to convert a CdiDecodedPacketHeader into this format |
| CCdiRawProbeHeader | Union of raw probe headers. Use to reserve memory that can be used to hold any type of raw probe header. Each protocol version uses a specific data format and is kept internal. Use ProtocolPayloadHeaderDecode() to decoded the raw packet header into CdiDecodedProbeHeader, which is protocol independent. Use ProtocolProbeHeaderEncode() to convert a CdiDecodedProbeHeader into this format |
| CCdiRawRxCbData | A structure of this type is passed as the parameter to CdiRawRxCallback(). It contains a single payload sent from a transmitter |
| CCdiRawTxCbData | A structure of this type is passed as the parameter to CdiRawTxCallback(). It contains data related to the transmission of a single payload to a receiver |
| CCdiReorderList | Structure containing top, bottom pointers and sequence numbers of sgls that comprise payload. when the entire payload is received, this will be one list |
| CCdiRxConfigData | Configuration data used by one of the Cdi...RxCreate() API functions |
| CCdiSglEntry | This structure represents a single, contiguous region of memory as part of a scatter-gather list |
| CCdiSgList | This structure defines a scatter-gather list (SGL) which is used to represent an array of data comprising one or more contiguous regions of memory |
| CCdiSignalHandlerInfo | Structure used to hold signal handler data |
| CCdiSinglyLinkedList | This structure represents a list |
| CCdiSinglyLinkedListEntry | This structure represents a single list entry |
| CCdiStatsConfigData | A structure that is used to hold statistics gathering configuration data |
| CCdiThreadInfo | Structure to keep track of thread state info |
| CCdiTimeoutCbData | Structure for Callback functions to use to return data from callback |
| CCdiTransferStats | Transfer statistics data. Used as a parameter of the user-registered CdiCoreStatsCallback() API function |
| CCdiTxConfigData | Configuration data used by one of the Cdi...TxCreate() API functions |
| CCdiTxConfigDataStream | Stream configuration data used by the CdiAvmTxStreamEndpointCreate() API function |
| CCloudWatchCounterBasedDeltas | Counter based statistics data that contain deltas since the last set was generated |
| CCloudWatchState | Structure used to hold state data for statistics |
| CCloudWatchTransferStats | A structure that is used to hold statistics gathering configuration data that is specific to CloudWatch |
| CCluster | This data structure represents a cluster. Each cluster in the t-digest contains a mean and a weight (number of samples) |
| CCommandLineState | |
| CComponentStateData | Structure used to hold component state data for a single component |
| CControlCommand | Structure used to hold a control command |
| CControlInterfaceConfigData | Type used to hold control interface configuration data |
| CControlInterfaceState | Type used to hold control interface state data |
| CControlPacketAck | Control ACK packet that is a response for a transmitted command |
| CControlPacketCommand | Probe command packet that is being transmitted |
| CControlPacketCommonHeader | Common header for all probe control packets. NOTE: Last digit of Protocol Version is the probe version. This file supports probe versions 0 - 3 |
| CEfaAdapterState | Structure used to hold EFA adapter state data |
| CEfaConnectionState | Structure used to hold EFA connection state data |
| CEfaEndpointState | Structure used to hold EFA endpoint state data |
| CEfaProbePacket | Packet format used by probe when sending probe packets over the EFA interface |
| CEfaRxState | This defines a structure that contains all of the state information that is specific to the Rx side of a single EFA endpoint |
| CEfaTxState | This defines a structure that contains all of the state information that is specific to the Tx side of a single EFA endpoint |
| CEndpointData | Structure used to hold state data for the dynamic statistics reconfiguration test used by TestDynamicStatsReconfigure() |
| CEndpointManagerState | This defines a structure that contains all the state information for endpoint state changes |
| CEntry | |
| ►CFrameData | A structure for storing all info related to a NDI frame, and a specific connection, including test settings, connection configuration data from the SDK, and state information for the test connection |
| CGenPacketControl | Control structure for PacketizeAncCb and UnpacketizeAncCb callbacks |
| CGenPacketControl2 | Control structure for UnpacketizeAncCb2 callback |
| CGlobalTestSettings | A structure that holds all of the global test settings set from the command-line |
| CInitFunctionArgs | Structure used to pass arguments to InitStaticBufferContents() through CdiPoolForEachItem() |
| CInternalEndpointState | This defines a structure that contains all the state information for endpoint state changes |
| CLibfabricApi | V-table interface to the libfabric API. This allows multiple versions of libfabric to be used within this SDK |
| CLogCallbackData | Structure used to hold state data that is unique to a callback log. Calback log CdiLogState instances that use the same log message callback address and user callback parameter will share a single instance of this data |
| CLogFileData | Structure used to hold state data that is unique to a file log. File log CdiLogState instances that use the same filename will share a single instance of this data |
| CMemoryLinearState | This defines a structure used to contain all of the state information for a linear buffer |
| CMetricsClass | Abstract base class used to interface C functions to the C++ AWS-SDK for CloudWatch metrics and for the CDI metrics gathering service |
| CMetricsDestinationInfo | Structure that holds the parts of StatisticsState structure required per statistics gathering path |
| CMetricsGatherer | |
| CMetricsGathererConfigData | A structure that is used to hold statistics gathering configuration data for instantiating a metrics gathering client handler |
| CNdiTime | A structure for storing breakdown of NDI timestamp in seconds, milliseconds, and nanoseconds |
| COptArg | A structure that describes a single command line option and its associated arguments |
| COptDef | A structure that is used by the user to define a single option. An array of these option structs is passed to GetOpt() for command line parsing |
| CPacket | |
| CPacketCommonHeader | CDI header for payload packets that don't use data offset values (payload type is not kPayloadTypeDataOffset) |
| CPacketDataOffsetHeader | CDI header for payload packets that contains a data offset value (payload type is kPayloadTypeDataOffset) |
| CPacketHeaderUnion | Union of payload cdi headers. Use to reserve memory that can be used to hold any type of CDI packet header |
| CPacketNum0Header | CDI header for payload packet #0. This packet never uses payload_data_offset, since it is always zero |
| CPollThreadState | This defines a structure that contains the state information for a single instance of a poll thread |
| CPoolInitArgs | Structure used to pass arguments into InitPoolSgl() |
| CProbeEndpointState | This defines a structure that contains all of the state information for the sending side of a single flow. Its contents are opaque to the calling program |
| CProbePacketUnion | Structure used to hold a union of packets that are transmitted over the control or EFA interface |
| CProbePacketWorkRequest | Structure used to hold a transmit packet work request. The lifespan of a work request starts when a packet is queued to be sent and ends when a message is received that is has either been successfully sent or a failure has occurred |
| CQueueItem | This structure represents a single queue item |
| CQueueState | Structure used to hold state data for a single queue |
| CReceiveBufferRecord | Definition of memory space where rx data is placed |
| CReceiveBufferState | |
| CRiffChunkHeader | Structure for the 8 byte chunk header that proceeds every payload |
| CRiffFileHeader | Structure for the 12 byte file header at the start of every RIFF file |
| CRunTestParams | Enum/name/function keys |
| CRxAdapterConnectionState | This defines a structure that contains the state information for an rx adapter connection |
| CRxConState | This defines a structure that contains all of the state information for an rx connection. The data is only required internally by receive connections |
| CRxEndpointProbeState | This defines a structure that contains all of the state information for the receiving side of a single flow |
| CRxEndpointState | This defines a structure that contains the state information for an Rx endpoint. The data is only required internally by the RxPacketReceive() API and not used elsewhere |
| CRxPayloadState | This defines a structure that contains all of the state information for the receiving side of a payload. The data is only required internally by the RxPacketReceive() function and not used elsewhere |
| CRxPayloadWorkRequestState | This defines a structure that contains all of the state information for the receiving side of a payload's work request. The lifespan of the data begins when packet #0 (CDI header) of a Rx CDI packet is received and ends when the user-registered CdiRawRxCallback() Rx callback function is invoked |
| CSemInfo | Structure used to hold semaphore state data |
| CSignalInfo | Structure used to hold signal state data |
| CSocketEndpointState | State definition for socket endpoint |
| CSocketInfo | Structure used to hold semaphore state data |
| CStatisticsState | Structure used to hold state data for statistics |
| CStatsData | Structure used to hold state data for the dynamic statistics reconfiguration test used by TestDynamicStatsReconfigure() |
| CStatsThreadArgs | |
| CStreamSettings | A structure that holds all the settings for a stream as set from the command line |
| CTDigest | The main structure of the t-digest |
| CTestConnectionInfo | A structure for storing all info related to a specific connection, including test settings, connection configuration data from the SDK, and state information for the test connection |
| CTestConnectionStreamInfo | A structure for storing all connection info related to a specific stream, such as data buffer pointers and file handles |
| CTestDynamicState | Structure used to hold state data for dynamic tests |
| CTestRxPayloadState | A structure for storing data to be sent to the FIFO used in TestRxVerify() |
| CTestSettings | A structure that holds all the test settings for a connection as set from the command line |
| CTestTxThreadLocalData | Container for any data we need separate for each Tx thread |
| CTestTxUserData | A structure for storing data to be sent with a payload as user_cb_data |
| CThreadUtilizationState | Type used to hold thread utilization state data |
| CTimeoutCbFifoData | A structure for reading and writing FIFO entries which contains callback data and callback function pointer |
| CTimeoutDataState | TimeoutDataState is the basic object used to build the list of timers This object contains a timeout, a next and previous handle, and user data pointer, and a user data callback function pointer |
| CTimeoutInstanceState | This structure contains all of the state information for the timer instance. This includes signals, thread ID's, and pointers to the memory pool and timer list |
| CTxConState | This defines a structure that contains all of the state information for the sending side of a single flow |
| CTxEndpointProbeState | This defines a structure that contains all of the state information for the sending side of a single flow |
| CTxEndpointState | This defines a structure that contains the state information for the sending side's endpoint of a single flow |
| CTxExtraPacketHeader | Structure used to hold Tx packet headers that contain extra data. Must reside in the DMA Tx memory region, since it is used directly by the adapter. It includes space for message prefix |
| CTxPacketHeader | Structure used to hold Tx packet headers. Must reside in the DMA Tx memory region, since it is used directly by the adapter. It includes space for message prefix |
| CTxPacketWorkRequest | Structure used to hold a transmit packet work request. The lifespan of a work request starts when a packet is queued to be sent and ends when a message is received that it has either been successfully sent or a failure has occurred |
| CTxPayloadState | This defines a structure that contains all of the state information for sending a single payload |
| CUnpacketizeAncControl | Control structure for Anc unpacketize callback |
| CUserMetrics |