Burst Transmissions

group Burst_transmissions

Functions

BurstId ConfigureFrameListBurst(API_HANDLE, uint32_t duration_ms, uint32_t frequency, const char **channel_list, size_t channel_count, BOOL stop_on_error, BurstFrameType frame_type, const void *frames, size_t frame_count, int iterations)

Configures a burst based on a list of given frames.

Parameters:

  • duration_ms – : the duration of the burst

  • frequency – : the burst frequency (frames per second)

  • channel_list – : a list of channel names to send the burst on

  • channel_count – : the number of channel names in the list

  • stop_on_error – : whether a transmission error should abort the burst

  • frame_type – : the type of frame, one of BURST_FT_CAN, BURST_FT_FLEXRAY, BURST_FT_ETHERNET

  • frames – : a list of frames to send

  • frame_count – : the number of frames in the list

  • iterations – : how many times the list is repeated (-1 for infinite)

Returns:

BurstId

BurstId ConfigureFrameCallbackBurst(API_HANDLE, uint32_t duration_ms, uint32_t frequency, const char **channel_list, size_t channel_count, BOOL stop_on_error, BurstFrameType frame_type, BOOL (*callback)(void*))

Configures a burst based on a user defined callback function.

Parameters:

  • duration_ms – : the duration of the burst

  • frequency – : the burst frequency (frames per second)

  • channel_list – : a list of channel names to send the burst on

  • channel_count – : the number of channel names in the list

  • stop_on_error – : whether a transmission error should abort the burst

  • frame_type – : the type of frame, one of BURST_FT_CAN, BURST_FT_FLEXRAY, BURST_FT_ETHERNET

  • callback – : pointer to a function that will return the next frame to be sent

Returns:

BurstId

void BurstFramePrefetching(API_HANDLE, BOOL on_off)

Enable or disable frame prefetching.

void TransmitBursts(API_HANDLE)

Transmits all configured bursts.

void RemoveBurst(API_HANDLE, BurstId handle)

Deletes a configured burst.

Parameters:

handle – : the burst id of the burst to be removed

void ClearBursts(API_HANDLE)

Deletes all configured bursts.