MX Foundation 4
MXF_EMBEDDED_TXPERIODIC_UPDATEMSG Struct Reference

Embedded Periodic Update Transmit Information Structure.

#include <mxf_embedded.h>

Data Fields

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

Field Documentation

uint32 MXF_EMBEDDED_TXPERIODIC_UPDATEMSG::channelClass

Channel class of TX channel.

uint32 MXF_EMBEDDED_TXPERIODIC_UPDATEMSG::moduleIndex

Module index of TX channel.

uint32 MXF_EMBEDDED_TXPERIODIC_UPDATEMSG::portIndex

Port index of TX channel.

uint32 MXF_EMBEDDED_TXPERIODIC_UPDATEMSG::options

Flag options:

MXF_EMBEDDED_TXPERIODIC_UPDATEMSG_OPTIONS_DEFAULT: The records are added to the end of the buffer.
MXF_EMBEDDED_TXPERIODIC_UPDATEMSG_OPTIONS_CLEAR: Clears old records before writing new records.
uint64 MXF_EMBEDDED_TXPERIODIC_UPDATEMSG::handle

Reserved for future use.

uint32 MXF_EMBEDDED_TXPERIODIC_UPDATEMSG::reserved1

Reserved for future use.

uint32 MXF_EMBEDDED_TXPERIODIC_UPDATEMSG::bufferIndex

Buffer index of the Tx Periodic Update Message.

uint32 MXF_EMBEDDED_TXPERIODIC_UPDATEMSG::reserved2

Reserved for future use.

uint32 MXF_EMBEDDED_TXPERIODIC_UPDATEMSG::bufferCount

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

void* MXF_EMBEDDED_TXPERIODIC_UPDATEMSG::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.

uint64* MXF_EMBEDDED_TXPERIODIC_UPDATEMSG::reserved

Reserved for future use.

uint32 MXF_EMBEDDED_TXPERIODIC_UPDATEMSG::reserved3[4]

Reserved for future use.

Updated 10/23/2023