Functions
uint32	mxfCSDBTxAperiodicWrite (HMXF_BUFFER buffer, uint64 options, uint64 startTime, uint64 count, MXF_CSDB_DATAREC *rec)

uint32	mxfCSDBTxPeriodicUpdateMsgWrite (HMXF_BUFFER buffer, uint64 count, MXF_CSDB_DATAREC *rec)

uint32	mxfCSDBRxAcqMsgSelectGet (HMXF_BUFFER buffer, uint64 maxCount, uint64 count, uint64 labels)

uint32	mxfCSDBRxAcqMsgSelectSet (HMXF_BUFFER buffer, uint64 select, uint64 count, uint64 *labels)

uint32	mxfCSDBRxAcqRead (HMXF_BUFFER buffer, uint64 maxRecCount, uint64 maxBytesCount, uint64 status, uint64 recCount, uint64 bytesCount, MXF_CSDB_DATAREC rec)

uint32	mxfCSDBRxSamplingExtEnableSet (HMXF_BUFFER buffer, uint64 state, uint64 count, uint64 *labels)

uint32	mxfCSDBRxSamplingExtEnableAllGet (HMXF_BUFFER buffer, uint64 maxCount, uint64 count, uint64 labels)

uint32	mxfCSDBRxSamplingMsgSelectSet (HMXF_BUFFER buffer, uint64 select, uint64 count, uint64 *labels)

uint32	mxfCSDBRxSamplingMsgSelectGet (HMXF_BUFFER buffer, uint64 maxCount, uint64 count, uint64 labels)

uint32	mxfCSDBRxSamplingRead (HMXF_BUFFER buffer, uint64 flags, uint64 maxMsgCount, uint64 maxBytesCount, uint64 msgCount, uint64 byteCount, MXF_CSDB_SAMPREC *rec)

uint32	mxfCSDBRxSamplingSingleRead (HMXF_BUFFER buffer, uint64 flags, uint64 label, uint64 si, MXF_CSDB_SAMPREC *rec)

uint32	mxfCSDBNextDataRecordPtrGet (MXF_CSDB_DATAREC currentRec, MXF_CSDB_DATAREC *nextRec)

uint32	mxfCSDBNextSamplingRecordPtrGet (MXF_CSDB_SAMPREC currentRec, MXF_CSDB_SAMPREC *nextRec)

uint32	mxfCSDBAsyncEventRxMsgSelectSet (HMXF_ASYNCEVENT asyncEvent, HMXF_CHANNEL channel, uint64 select, uint64 count, MXF_MSGID_CSDB *msg)

uint32	mxfCSDBAsyncEventRxMsgSelectGet (HMXF_ASYNCEVENT asyncEvent, HMXF_CHANNEL channel, uint64 maxCount, uint64 count, MXF_MSGID_CSDB msg)

uint32	mxfCSDBEmbeddedNVStorageFileMsgSelectSet (HMXF_CHANNEL channel, uint64 select, uint64 count, MXF_MSGID_CSDB *msgid)

uint32	mxfCSDBEmbeddedNVStorageFileMsgSelectGet (HMXF_CHANNEL channel, uint64 maxCount, uint64 count, MXF_MSGID_CSDB msgid)

uint32	mxfCSDBEmbeddedNVStorageFileMsgRead (HMXF_NVSTORAGE nvStorage, uint64 fileIndex, uint64 maxMsgCount, uint64 maxBytesCount, uint64 msgCount, uint64 byteCount, MXF_CSDB_DATAREC *msg)

uint32	mxfCSDBEmbeddedNVStorageFileMsgWrite (HMXF_NVSTORAGE nvStorage, uint64 fileIndex, uint64 maxMsgCount, MXF_CSDB_DATAREC msg, uint64 count)

Detailed Description

Function Documentation

uint32 mxfCSDBTxAperiodicWrite	(	HMXF_BUFFER	buffer,
		uint64	options,
		uint64	startTime,
		uint64	count,
		MXF_CSDB_DATAREC *	rec
	)

C#: public static extern UInt32 mxfCSDBTxAperiodicWrite(UInt64 buffer, UInt64 options, UInt64 startTime, UInt64 count, IntPtr rec);

Sends aperiodic data record for transmission. The data items to be transmitted are specified within the records, along with a time tag and a control word. The first data item is transmitted at the specified start time.

The records to transmit on time tag must be placed in chronological order in the array. The same time tag must not appear more than once in the array. When the start time is specified, the time tag of the first record or the start time should be at least 50 msec in advance to be relatively precise otherwise it will be sent as soon as possible. Also, the cumulative time of all record’s time tag and the start time must be smaller than 30 seconds.

Note: This function is the specific version for CSDB of the multi-protocol mxfTxAperiodicWrite() function.

Parameters

[in]	buffer	buffer handle.
[in]	options	options for controlling the transmitter before for sending the data records. The details of the options are explained below. MXF_TXAPERIODIC_FLAG_DEFAULT MXF_TXAPERIODIC_FLAG_USE_RECORD_ABSOLUTE_TIME MXF_TXAPERIODIC_FLAG_ABSOLUTE_START_TIME MXF_TXAPERIODIC_FLAG_USE_RECORD_RELATIVE_TIME
[in]	startTime	start time based on the timebase. This is the time at which the data held in the first record is transmitted by the device. The time is either expressed accordingly to the process time base or relative to the current real-time clock value (i.e. offset in the future). If the bit MXF_TXAPERIODIC_FLAG_ABSOLUTE_START_TIME of the transmit flag is set, then the start time is specified in absolute time (rather than relative). MXF_TXAPERIODIC_FLAG_USE_RECORD_ABSOLUTE_TIME or MXF_TXAPERIODIC_FLAG_USE_RECORD_RELATIVE_TIME options cannot be used with a start time.
[in]	count	number of records to write
[in]	rec	records to write. The records in the buffer need to be indexed using the mxfCSDBNextDataRecordPtrGet() function.

The options parameter modifies the transmission scheme as described below;

MXF_TXAPERIODIC_FLAG_DEFAULT

This is the default transmission flag, the scheduling priority defined when the buffer area was defined (see mxfTxAperiodicBufferAlloc()) is used to schedule transmissions.

The time tag field is not used and must be set to 0. The records are transmitted with minimum delay between them.
MXF_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 formatted according to the process time base.

This flag cannot be used with MXF_TXAPERIODIC_FLAG_USE_RECORD_RELATIVE_TIME, MXF_TXAPERIODIC_FLAG_ABSOLUTE_START_TIME or a start time.
MXF_TXAPERIODIC_FLAG_USE_RECORD_RELATIVE_TIME

When set, the relative transmit time of each data must be set in the record time tag. The process time base resolution is used, but the time base itself is ignored.

This option causes transmission of the first record at the specified offset and transmission of the remaining records after a delay that is computed by subtracting the record time tag from the time tag of preceding records (i.e. delta time).

Let’s assume N data records to be transmitted with the MXF_TXAPERIODIC_FLAG_USE_RECORD_RELATIVE_TIME.

The actual record data transmit time will be computed as follows:

Time rec1 = Transmission offset (min 50 msec)
Time rec2 = Time rec1 + (rec2 time tag – rec1 time tag )
Time rec3 = Time rec2 + (rec3 time tag – rec2 time tag )
…
Time recN = Time recN-1 + (recN time tag - recN-1 time tag )

This flag cannot be used with MXF_TXAPERIODIC_FLAG_USE_RECORD_ABSOLUTE_TIME, MXF_TXAPERIODIC_FLAG_ABSOLUTE_START_TIME or a start time.
MXF_TXAPERIODIC_FLAG_ABSOLUTE_START_TIME

When set, the startTime parameter must be formatted according to the process time base.

If not set, the startTime parameter is expressed as a relative time from the current real time clock value. The process time base resolution is used, but the time base itself is ignored.

This flag cannot be used with MXF_TXAPERIODIC_FLAG_USE_RECORD_ABSOLUTE_TIME or MXF_TXAPERIODIC_FLAG_USE_RECORD_RELATIVE_TIME options.

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfTxAperiodicWrite(); mxfTxAperiodicBufferAlloc(); mxfTxAperiodicBufferStatusGet(); mxfTxAperiodicClear(); mxfSystemTimeBaseSet(); mxfCSDBNextDataRecordPtrGet()

Examples:: csdb_aperiodic.c, csdb_aperiodic.cs, csdb_flexsmp.c, and csdb_flexsmp.cs.

uint32 mxfCSDBTxPeriodicUpdateMsgWrite	(	HMXF_BUFFER	buffer,
		uint64	count,
		MXF_CSDB_DATAREC *	rec
	)

C#: public static extern UInt32 mxfCSDBTxPeriodicUpdateMsgWrite(UInt64 buffer, UInt64 count, IntPtr rec);

Writes messages of the record array into the specified buffer. The last message of each buffer is sent forever until a new message is written into the buffer.

Note: This function is the specific version for CSDB of the multi-protocol mxfTxPeriodicUpdateMsgWrite() function.

Parameters

[in]	buffer	buffer handle.
[in]	count	count of records to write.
[in]	rec	array of record(s) to write. The records in the buffer need to be indexed using mxfCSDBNextDataRecordPtrGet() function.

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfTxPeriodicUpdateMsgWrite(); mxfTxPeriodicUpdateMsgBufferStatusGet(); mxfTxPeriodicUpdateMsgClear(); mxfCSDBNextDataRecordPtrGet()

Examples:: csdb_buffer_threshold.c, csdb_buffer_threshold.cs, csdb_periodic.c, csdb_periodic.cs, csdb_rx_event_handler.c, csdb_rx_event_handler.cs, csdb_rx_sampling.c, csdb_rx_sampling.cs, multi.c, and multi.cs.

uint32 mxfCSDBRxAcqMsgSelectGet	(	HMXF_BUFFER	buffer,
		uint64	maxCount,
		uint64 *	count,
		uint64 *	labels
	)

C#: public static extern UInt32 mxfCSDBRxAcqMsgSelectGet(UInt64 buffer, UInt64 maxCount, out UInt64 count, UInt64[] labels);

Returns the list of labels selected for acquisition.

Note: This function is the specific version for CSDB of the multi-protocol mxfRxAcqMsgSelectGet() function.

Parameters

[in]	buffer	buffer handle.
[in]	maxCount	maximum number of labels in the array.
[out]	count	returned number of labels in the label array.
[out]	labels	address of the returned label array.

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfRxAcqMsgSelectGet(); mxfRxAcqBufferAlloc(); mxfRxAcqBufferGet(); mxfCSDBRxAcqMsgSelectSet()

uint32 mxfCSDBRxAcqMsgSelectSet	(	HMXF_BUFFER	buffer,
		uint64	select,
		uint64	count,
		uint64 *	labels
	)

C#: public static extern UInt32 mxfCSDBRxAcqMsgSelectSet(UInt64 buffer, UInt64 select, UInt64 count, UInt64[] labels);

public static extern UInt32 mxfCSDBRxAcqMsgSelectSet(UInt64 buffer, UInt64 select, UInt64 count, IntPtr labels);

Selects or deselects the label(s) to be acquired on the specified acquisition buffer.

Upon data arrival, the embedded process will check if the received label is found in the current selection list. The receive data record will be added to the acquisition buffer only if the label is found in the selection list, otherwise it is discarded.

By default, after a device reset, no filtering is performed and all labels are received.

Note: count set to 0 with labels set to NULL means ALL labels.; This function is the specific version for CSDB of the multi-protocol mxfRxAcqMsgSelectSet() function.

Parameters

[in] buffer buffer handle.

[in]

select

action to perform with the message ID array.

Option	Description
MXF_MSG_DESELECT	Deselects the label(s).
MXF_MSG_SELECT_ADD	Adds the specified label(s).
MXF_MSG_SELECT_ONLY	Replaces the current selection with the provided list.

[in] count number of entries in labels.

[in] labels address of array of labels

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfRxAcqMsgSelectSet(); mxfRxAcqBufferAlloc(); mxfRxAcqBufferGet(); mxfCSDBRxAcqMsgSelectGet()

uint32 mxfCSDBRxAcqRead	(	HMXF_BUFFER	buffer,
		uint64	maxRecCount,
		uint64	maxBytesCount,
		uint64 *	status,
		uint64 *	recCount,
		uint64 *	bytesCount,
		MXF_CSDB_DATAREC *	rec
	)

C#: public static extern UInt32 mxfCSDBRxAcqRead(UInt64 buffer, UInt64 maxMsgCount, UInt64 maxBytesCount, out UInt64 status, out UInt64 msgCount, out UInt64 byteCount, IntPtr rec);

Transfers the records from the channel acquisition buffer to the calling application.

Note: This function is the specific version for CSDB of the multi-protocol mxfRxAcqRead() function.

Parameters

[in]	buffer	buffer handle.
[in]	maxRecCount	maximum records to read (0 means all messages).
[in]	maxBytesCount	maximum number of bytes to be read.
[out]	status	last status set.
[out]	recCount	number of records returned.
[out]	bytesCount	number of bytes returned.
[out]	rec	address of data records. The records in the buffer need to be indexed using the mxfCSDBNextDataRecordPtrGet() function.

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfRxAcqRead(); mxfRxAcqStart(); mxfRxAcqBufferAlloc(); mxfRxAcqStop(); mxfCSDBNextDataRecordPtrGet()

Examples:: csdb_aperiodic.c, csdb_aperiodic.cs, csdb_buffer_threshold.c, csdb_buffer_threshold.cs, csdb_flexsmp.c, csdb_periodic.c, csdb_periodic.cs, and csdb_rx_acquisition_trigger.cs.

uint32 mxfCSDBRxSamplingExtEnableSet	(	HMXF_BUFFER	buffer,
		uint64	state,
		uint64	count,
		uint64 *	labels
	)

C#: public static extern UInt32 mxfCSDBRxSamplingExtEnableSet(UInt64 buffer, UInt64 state, UInt64 count, UInt64[] labels);

public static extern UInt32 mxfCSDBRxSamplingExtEnableSet(UInt64 buffer, UInt64 state, UInt64 count, IntPtr labels);

Enables or disables message discrimination using the SI. The message look-up table will have entry for each message Label-SI pair.

By default, after a device reset, message discrimination using the SI is disabled.

Note: count set to 0 with labels set to NULL means ALL label-si.; This function is the specific version for CSDB of the multi-protocol mxfRxSamplingExtEnableSet() function.

Parameters

[in]	buffer	buffer handle.
[in]	state	message address extension discrimination state. VMXF_ENABLE: Enables message address extension discrimination. VMXF_DISABLE: Disables message address extension discrimination.
[in]	count	number of entries in labels.
[in]	labels	address of array of labels.

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfRxSamplingExtEnableSet(); mxfCSDBRxSamplingExtEnableAllGet()

uint32 mxfCSDBRxSamplingExtEnableAllGet	(	HMXF_BUFFER	buffer,
		uint64	maxCount,
		uint64 *	count,
		uint64 *	labels
	)

C#: public static extern UInt32 mxfCSDBRxSamplingExtEnableAllGet(UInt64 buffer, UInt64 maxCount, out UInt64 count, UInt64[] labels);

Returns the list of labels that has message discrimination using the SI enabled.

Note: This function is the specific version for CSDB of the multi-protocol mxfRxSamplingExtEnableAllGet() function.

Parameters

[in]	buffer	buffer handle.
[in]	maxCount	maximum number of entries in labels.
[out]	count	number of entries in labels.
[out]	labels	address array of labels.

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfRxSamplingExtEnableAllGet(); mxfCSDBRxSamplingExtEnableSet()

uint32 mxfCSDBRxSamplingMsgSelectSet	(	HMXF_BUFFER	buffer,
		uint64	select,
		uint64	count,
		uint64 *	labels
	)

C#: public static extern UInt32 mxfCSDBRxSamplingMsgSelectSet(UInt64 buffer, UInt64 select, UInt64 maxCount, UInt64[] labels);

public static extern UInt32 mxfCSDBRxSamplingMsgSelectSet(UInt64 buffer, UInt64 select, UInt64 maxCount, IntPtr labels);

Selects or deselects the label(s) to be received on the specified sampling buffer.

Upon data arrival, the embedded process check if the received label is defined in the current selection list. The receive data record will be added to the sampling buffer only if the label was added previously in the selection list, otherwise it is discarded.

By default, after a device reset, no filtering is performed and all labels are received.

Note: count set to 0 with labels set to NULL means ALL labels.; This function is the specific version for CSDB of the multi-protocol mxfRxSamplingMsgSelectSet() function.

Parameters

[in] buffer buffer handle.

[in]

select

action to perform with the message ID array.

Option	Description
MXF_MSG_DESELECT	Deselects the label(s).
MXF_MSG_SELECT_ADD	Adds the specified label(s).
MXF_MSG_SELECT_ONLY	Replaces the current selection with the provided list.

[in] count count of labels in the array.

[in] labels address of array of label(s).

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfRxSamplingMsgSelectSet(); mxfRxSamplingBufferAlloc(); mxfRxSamplingStart(); mxfCSDBRxSamplingRead(); mxfCSDBRxSamplingMsgSelectGet()

Examples:: csdb_rx_sampling.c, and csdb_rx_sampling.cs.

uint32 mxfCSDBRxSamplingMsgSelectGet	(	HMXF_BUFFER	buffer,
		uint64	maxCount,
		uint64 *	count,
		uint64 *	labels
	)

C#: public static extern UInt32 mxfCSDBRxSamplingMsgSelectGet(UInt64 buffer, UInt64 maxCount, out UInt64 count, UInt64[] labels);

Returns the list of labels selected for sampling.

Note: This function is the specific version for CSDB of the multi-protocol mxfRxSamplingMsgSelectGet() function.

Parameters

[in]	buffer	buffer handle.
[in]	maxCount	maximum number of labels in the array labels.
[out]	count	returned number of labels in the labels array.
[out]	labels	address of the returned labels array.

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfRxSamplingMsgSelectGet(); mxfRxSamplingBufferAlloc(); mxfRxSamplingStart(); mxfCSDBRxSamplingRead(); mxfCSDBRxSamplingMsgSelectSet()

uint32 mxfCSDBRxSamplingRead	(	HMXF_BUFFER	buffer,
		uint64	flags,
		uint64	maxMsgCount,
		uint64	maxBytesCount,
		uint64 *	msgCount,
		uint64 *	byteCount,
		MXF_CSDB_SAMPREC *	rec
	)

C#: public static extern UInt32 mxfCSDBRxSamplingRead(UInt64 buffer, UInt64 flags, UInt64 maxMsgCount, UInt64 maxBytesCount, out UInt64 msgCount, out UInt64 byeCount, IntPtr rec);

Reads all sampling records from the sampling buffer to the application buffer.

The sampling process maintains records for all of the received labels. A label is considered received if corresponding data words were received within the kill-time period. A record refresh from the receive port resets the kill-time timer and an updated copy is made available to the application.

The sampling record contains information on the arrival rate and the number of errors, as well as the latest data received for that label.

Note: This function is the specific version for CSDB of the multi-protocol mxfRxSamplingRead() function.

Parameters

[in] buffer buffer handle.

[in]

flags

option flag.

Flags	Description
MXF_RXSAMPLING_FLAG_DEFAULT	The record is kept in the buffer and the same record can be read again by the current or another application.
MXF_RXSAMPLING_FLAG_ERASE_WHEN_READ	After the sampling record is returned, it is removed from the buffer.

[in] maxMsgCount maximum number of messages to read (0 means all messages).

[in] maxBytesCount maximum number of bytes to read.

[out] msgCount number of messages returned.

[out] byteCount number of bytes returned.

[out] rec array of sampling record structure. The records in the buffer need to be indexed using mxfCSDBNextSamplingRecordPtrGet().

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfRxSamplingRead(); mxfRxSamplingBufferAlloc(); mxfCSDBRxSamplingMsgSelectSet(); mxfRxSamplingStart(); mxfCSDBNextSamplingRecordPtrGet()

Examples:: csdb_rx_sampling.c, and csdb_rx_sampling.cs.

uint32 mxfCSDBRxSamplingSingleRead	(	HMXF_BUFFER	buffer,
		uint64	flags,
		uint64	label,
		uint64	si,
		MXF_CSDB_SAMPREC *	rec
	)

C#: public static extern UInt32 mxfCSDBRxSamplingSingleRead(UInt64 buffer, UInt64 flags, UInt64 label, UInt64 si, IntPtr rec);

Reads a specific sampling record from the sampling buffer.

Note: This function is the specific version for CSDB of the multi-protocol mxfRxSamplingSingleRead() function.

Parameters

[in] buffer buffer handle.

[in]

flags

option flag.

Flags	Description
MXF_RXSAMPLING_FLAG_DEFAULT	The record is kept in the buffer and the same record can be read again by the current or another application.
MXF_RXSAMPLING_FLAG_ERASE_WHEN_READ	After the sampling record is returned, it is removed from the buffer.

[in] label message label.

[in] si message si.

[out] rec address of sampling record.

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfRxSamplingSingleRead(); mxfRxSamplingBufferAlloc(); mxfRxSamplingMsgSelectSet(); mxfRxSamplingStart(); mxfRxSamplingStop()

Examples:: csdb_rx_event_handler.c, and csdb_rx_event_handler.cs.

uint32 mxfCSDBNextDataRecordPtrGet	(	MXF_CSDB_DATAREC *	currentRec,
		MXF_CSDB_DATAREC **	nextRec
	)

C#: public static extern UInt32 mxfCSDBNextDataRecordPtrGet(IntPtr currentRec, out IntPtr nextRec);

Returns the next buffer address in a MXF_CSDB_DATAREC buffer array.

Note: This function is the specific version for CSDB of the multi-protocol mxfNextRecordPtrGet() function.

Parameters

[in]	currentRec	pointer to the beginning or the current record in the buffer.
[out]	nextRec	pointer to next record in the buffer.

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfNextRecordPtrGet(); mxfCSDBRxAcqRead(); mxfCSDBTxAperiodicWrite(); mxfCSDBTxPeriodicUpdateMsgWrite(); mxfCSDBNextSamplingRecordPtrGet()

Examples:: csdb_aperiodic.c, csdb_aperiodic.cs, csdb_buffer_threshold.c, csdb_buffer_threshold.cs, csdb_flexsmp.cs, csdb_periodic.c, csdb_periodic.cs, multi.c, and multi.cs.

uint32 mxfCSDBNextSamplingRecordPtrGet	(	MXF_CSDB_SAMPREC *	currentRec,
		MXF_CSDB_SAMPREC **	nextRec
	)

C#: public static extern UInt32 mxfCSDBNextSamplingRecordPtrGet(IntPtr currentRec, out IntPtr nextRec);

Returns the next buffer address in a MXF_CSDB_SAMPREC buffer array.

Note: This function is the specific version for CSDB of the multi-protocol mxfNextRecordPtrGet() function.

Parameters

[in]	currentRec	pointer to the beginning or the current record in the buffer.
[out]	nextRec	pointer to next record in the buffer.

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfNextRecordPtrGet(); mxfCSDBRxSamplingRead(); mxfCSDBNextDataRecordPtrGet()

Examples:: csdb_rx_sampling.c, and csdb_rx_sampling.cs.

uint32 mxfCSDBAsyncEventRxMsgSelectSet	(	HMXF_ASYNCEVENT	asyncEvent,
		HMXF_CHANNEL	channel,
		uint64	select,
		uint64	count,
		MXF_MSGID_CSDB *	msg
	)

C#: public static extern UInt32 mxfCSDBAsyncEventRxMsgSelectSet(UInt64 asyncEvent, UInt64 channel, UInt64 select, UInt64 count, MXF_MSGID_CSDB[] msgid);

public static extern UInt32 mxfCSDBAsyncEventRxMsgSelectSet(UInt64 asyncEvent, UInt64 channel, UInt64 select, UInt64 count, IntPtr msgid);

Selects or deselects the label-si pair (message id) for MXF_ASYNCEVENT_COND_RX_MSG condition on a specified RX channel.

The function must be called in addition to the mxfAsyncEventConditionsSet() function with MXF_ASYNCEVENT_COND_RX_MSG condition to cause an asynchronous event to occur when a specific label-si is received.

The message selection must be made by only one asynchronous event routine for a specific channel. Otherwise, an error code will be returned while conditions of other asynchronous event routines are present.

In this case, you must disable the MXF_ASYNCEVENT_COND_RX_MSG condition using mxfAsyncEventConditionsSet() function using another asynchronous event handle.

Note: count set to 0 with msg set to NULL means ALL label-si.; This function is the specific version for CSDB of the multi-protocol mxfAsyncEventRxMsgSelectSet() function.

Parameters

[in] asyncEvent asynchronous event handle.

[in] channel channel handle.

[in]

select

action to perform for the message ID.

Action	Description
MXF_MSG_DESELECT	Deselects the messages id.
MXF_MSG_SELECT_ADD	Adds the specified messages id.
MXF_MSG_SELECT_ONLY	Replaces the current selection with the provided list.

[in] count count of messages id.

[in] msg address of array of message id.

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfAsyncEventRxMsgSelectSet(); mxfAsyncEventHandlerInit(); mxfCSDBAsyncEventRxMsgSelectGet(); mxfAsyncEventConditionsSet()

Examples:: csdb_rx_event_handler.c, and csdb_rx_event_handler.cs.

uint32 mxfCSDBAsyncEventRxMsgSelectGet	(	HMXF_ASYNCEVENT	asyncEvent,
		HMXF_CHANNEL	channel,
		uint64	maxCount,
		uint64 *	count,
		MXF_MSGID_CSDB *	msg
	)

C#: public static extern UInt32 mxfCSDBAsyncEventRxMsgSelectGet(UInt64 asynceEvent, UInt64 channel, UInt64 maxCount, out UInt64 count, [Out] MXF_MSGID_CSDB[] msgid);

Returns the list of message IDs registered for a specified RX channel for the MXF_ASYNCEVENT_COND_RX_MSG asynchronous event condition ID.

Note: This function is the specific version for CSDB of the multi-protocol mxfAsyncEventRxMsgSelectGet() function.

Parameters

[in]	asyncEvent	asynchronous event handle.
[in]	channel	channel handle.
[in]	maxCount	maximum ID messages expected.
[out]	count	number of ID messages returned.
[out]	msg	returned message ID array.

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfAsyncEventRxMsgSelectGet(); mxfAsyncEventHandlerInit(); mxfCSDBAsyncEventRxMsgSelectSet(); mxfAsyncEventConditionsSet()

uint32 mxfCSDBEmbeddedNVStorageFileMsgSelectSet	(	HMXF_CHANNEL	channel,
		uint64	select,
		uint64	count,
		MXF_MSGID_CSDB *	msgid
	)

C#: public static extern UInt32 mxfCSDBEmbeddedNVStorageFileMsgSelectSet(UInt64 channel, UInt64 select, UInt64 count, MXF_MSGID_CSDB[] msgid);

public static extern UInt32 mxfCSDBEmbeddedNVStorageFileMsgSelectSet(UInt64 channel, UInt64 select, UInt64 count, IntPtr msgid);

Selects / deselects the specified message IDs on a channel for automatic embedded non-volatile storage recording.

Note: This function should be called before the function mxfEmbeddedNVStorageFileMsgSelectEnableSet() that starts the logging of messages on file for the specific channel.; count set to 0 with a msg set to NULL means ALL message IDs.; This function is the specific version for CSDB of the multi-protocol mxfEmbeddedNVStorageFileMsgSelectSet() function.

Parameters

[in] channel channel handle

[in]

select

action to perform with the provided selection list

Action	Description
MXF_MSG_DESELECT	Deselects the messages
MXF_MSG_SELECT_ADD	Adds the specified messages
MXF_MSG_SELECT_ONLY	Replaces the current selection with the provided list

[in] count count of messages

[in] msgid pointer to an array of message identifiers.

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfModuleChannelAllGet(); mxfEmbeddedNVStorageHandleGet(); mxfEmbeddedNVStorageFileMsgSelectEnableSet(); mxfEmbeddedNVStorageFileMsgSelectGet()

uint32 mxfCSDBEmbeddedNVStorageFileMsgSelectGet	(	HMXF_CHANNEL	channel,
		uint64	maxCount,
		uint64 *	count,
		MXF_MSGID_CSDB *	msgid
	)

C#: public static extern UInt32 mxfCSDBEmbeddedNVStorageFileMsgSelectGet(UInt64 channel, UInt64 maxCount, out UInt64 count, [Out] MXF_MSGID_CSDB[] msgid);

Returns the specific message IDs registered on a channel for automatic embedded non-volatile storage recording.

Note: This function is the specific version for CSDB of the multi-protocol mxfEmbeddedNVStorageFileMsgSelectGet() function.

Parameters

[in]	channel	channel handle.
[in]	maxCount	maximum count of messages return in the array
[out]	count	count of messages returned
[out]	msgid	pointer to an array of message identifiers.

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfModuleChannelAllGet(); mxfEmbeddedNVStorageHandleGet(); mxfEmbeddedNVStorageFileMsgSelectSet(); mxfEmbeddedNVStorageFileMsgSelectEnableSet()

uint32 mxfCSDBEmbeddedNVStorageFileMsgRead	(	HMXF_NVSTORAGE	nvStorage,
		uint64	fileIndex,
		uint64	maxMsgCount,
		uint64	maxBytesCount,
		uint64 *	msgCount,
		uint64 *	byteCount,
		MXF_CSDB_DATAREC *	msg
	)

C#: public static extern UInt32 mxfCSDBEmbeddedNVStorageFileMsgRead(UInt64 storage, UInt64 fileIndex, UInt64 maxRecCount, UInt64 maxBytesCount, out UInt64 recCount, out UInt64 bytesCount, IntPtr rec);

Reads the records from a specific file. The messages format must be of type MXF_EMBEDDED_NVSTORAGE_MSGTYPE_CSDB.

Note: This function is the specific version for CSDB of the multi-protocol mxfEmbeddedNVStorageFileMsgRead() function.

Parameters

[in]	nvStorage	non-volatile storage handle
[in]	fileIndex	file index
[in]	maxMsgCount	maximum number of messages that can be returned
[in]	maxBytesCount	maximum byte count that can be returned
[out]	msgCount	count of messages returned
[out]	byteCount	number of bytes returned in the msg buffer
[out]	msg	pointer to read buffer containing messages. The records in the buffer need to be indexed using the mxfCSDBNextDataRecordPtrGet() function.

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfEmbeddedNVStorageHandleGet(); mxfEmbeddedNVStorageFileStatusGet()

uint32 mxfCSDBEmbeddedNVStorageFileMsgWrite	(	HMXF_NVSTORAGE	nvStorage,
		uint64	fileIndex,
		uint64	maxMsgCount,
		MXF_CSDB_DATAREC *	msg,
		uint64 *	count
	)

C#: public static extern UInt32 mxfCSDBEmbeddedNVStorageFileMsgWrite(UInt64 storage, UInt64 fileIndex, UInt64 maxRecCount, IntPtr rec, out UInt64 recCount);

Writes messages to the specified file. The messages format must be of type MXF_EMBEDDED_NVSTORAGE_MSGTYPE_CSDB.

Note: This function is the specific version for CSDB of the multi-protocol mxfEmbeddedNVStorageFileMsgWrite() function.

Parameters

[in]	nvStorage	non-volatile storage handle
[in]	fileIndex	file index
[in]	maxMsgCount	maximum number of messages to write
[in]	msg	pointer to messages to write. The records in the buffer need to be indexed using mxfCSDBNextDataRecordPtrGet() function.
[out]	count	number of messages actually written

Returns: MAXT_SUCCESS is returned when the function has succeeded.
Refer to mxf_error.h for a list of defined errors.
Call mxfSystemErrorStringGet() to transform the return code into a text string.

Availability:: Available in MX Foundation 4.0 and later.

See also: mxfEmbeddedNVStorageHandleGet(); mxfEmbeddedNVStorageFileStatusGet()

Functions

Detailed Description

Function Documentation