« Close

Datasheets and User Guides

App Notes

Software & Driver

 

LJM_STREAM_RECEIVE_TIMEOUT_MS

Summary

Manually sets the timeout for LJM's stream data collection. Writing to this configuration sets LJM_STREAM_RECEIVE_TIMEOUT_MODE to LJM_STREAM_RECEIVE_TIMEOUT_MODE_MANUAL.

Writing a non-zero value to LJM_STREAM_RECEIVE_TIMEOUT_MS will manually set the timeout for LJM's stream data collection. Note that using LJM_STREAM_RECEIVE_TIMEOUT_MODE of LJM_STREAM_RECEIVE_TIMEOUT_MODE_CALCULATED is almost always better than using manual non-zero LJM_STREAM_RECEIVE_TIMEOUT_MS value.

Writing 0 to LJM_STREAM_RECEIVE_TIMEOUT_MS will cause LJM to never time out. This allows you to set up triggered stream or externally clocked stream on the T7. This is usually used in conjunction with LJM_STREAM_SCANS_RETURN set to LJM_STREAM_SCANS_RETURN_ALL_OR_NONE.

The constant LJM_STREAM_RECEIVE_TIMEOUT_MS can be used interchangeably with the string "LJM_STREAM_RECEIVE_TIMEOUT_MS".

Remarks

LJM_STREAM_RECEIVE_TIMEOUT_MS does not affect currently running or already initialized streams.

Relevant Functions

To read LJM_STREAM_RECEIVE_TIMEOUT_MS, use LJM_ReadLibraryConfigS.

To write LJM_STREAM_RECEIVE_TIMEOUT_MS, use LJM_WriteLibraryConfigS orLJM_LoadConfigurationFile.

LJM_STREAM_RECEIVE_TIMEOUT_MS affects the behavior of LJM_eStreamRead.

Example

[C/C++] Set the LJM_STREAM_RECEIVE_TIMEOUT_MS mode to infinite.

char ErrorString[LJM_MAX_NAME_SIZE];
int LJMError = 0;
LJMError = LJM_WriteLibraryConfigS(
     LJM_STREAM_RECEIVE_TIMEOUT_MS,
     0
);
if (LJMError != LJME_NOERROR) {
    LJM_ErrorToString(LJMError, ErrorString);
    printf("LJM_WriteLibraryConfigS error: %s\n", ErrorString);
}

For more LJM configurations, see Library Configuration Functions.