MXF_EMBEDDED_TXAPERIODIC_MSG Struct Reference

Embedded Aperiodic Transmit Information Structure. More...

#include <mxf_embedded.h>

Data Fields
uint32	channelClass
uint32	moduleIndex
uint32	portIndex
uint32	reserved1
uint64	handle
uint32	priority
uint32	options
uint32	reserved2
uint32	bufferCount
void *	buffer
uint64 *	reserved
uint32	reserved3 [4]

Detailed Description

Examples:

ar429_embedded_side_discrete.c, and ar429_embedded_side_timer.c.

Field Documentation

uint32 MXF_EMBEDDED_TXAPERIODIC_MSG::channelClass

Channel class of TX channel.

Examples:

ar429_embedded_side_discrete.c, and ar429_embedded_side_timer.c.

uint32 MXF_EMBEDDED_TXAPERIODIC_MSG::moduleIndex

Module index of TX channel.

Examples:

ar429_embedded_side_discrete.c, and ar429_embedded_side_timer.c.

uint32 MXF_EMBEDDED_TXAPERIODIC_MSG::portIndex

Port index of TX channel.

Examples:

ar429_embedded_side_discrete.c, and ar429_embedded_side_timer.c.

uint32 MXF_EMBEDDED_TXAPERIODIC_MSG::reserved1

Reserved for future use.

uint64 MXF_EMBEDDED_TXAPERIODIC_MSG::handle

Reserved for future use.

uint32 MXF_EMBEDDED_TXAPERIODIC_MSG::priority

Which TX queue priority to use:

MXF_EMBEDDED_TXAPERIODIC_PRIORITY_LOW: Low priority.
MXF_EMBEDDED_TXAPERIODIC_PRIORITY_NORMAL: Normal priority.
MXF_EMBEDDED_TXAPERIODIC_PRIORITY_HIGH: High priority.

Examples:

ar429_embedded_side_discrete.c, and ar429_embedded_side_timer.c.

uint32 MXF_EMBEDDED_TXAPERIODIC_MSG::options

Options flag:

MXF_EMBEDDED_TXAPERIODIC_FLAG_DEFAULT: This is the default transmission flag. The time tag field is not used and must be set to 0. The records are transmitted with minimum delay between them.
MXF_EMBEDDED_TXAPERIODIC_FLAG_USE_RECORD_ABSOLUTE_TIME: When set, the absolute transmit time of each data must be set in the record time tag. The time tag must be in nanoseconds.

Examples:

ar429_embedded_side_discrete.c, and ar429_embedded_side_timer.c.

uint32 MXF_EMBEDDED_TXAPERIODIC_MSG::reserved2

Reserved for future use.

uint32 MXF_EMBEDDED_TXAPERIODIC_MSG::bufferCount

Number of data records in the data record array (buffer).

Examples:

ar429_embedded_side_discrete.c, and ar429_embedded_side_timer.c.

void* MXF_EMBEDDED_TXAPERIODIC_MSG::buffer

Data record array pointer. The record format depends on the channel class. The records are packed in the buffer. The mxfEmbeddedNextRecordPtrGet() function must be used to navigate from one record to the other in the buffer.

Examples:

ar429_embedded_side_discrete.c, and ar429_embedded_side_timer.c.

uint64* MXF_EMBEDDED_TXAPERIODIC_MSG::reserved

Reserved for future use.

uint32 MXF_EMBEDDED_TXAPERIODIC_MSG::reserved3[4]

Reserved for future use.