Function soapysdr_sys::SoapySDRDevice_readStreamStatus

pub unsafe extern "C" fn SoapySDRDevice_readStreamStatus(
    device: *mut SoapySDRDevice,
    stream: *mut SoapySDRStream,
    chanMask: *mut usize,
    flags: *mut c_int,
    timeNs: *mut c_longlong,
    timeoutUs: c_long
) -> c_int

Readback status information about a stream. This call is typically used on a transmit stream to report time errors, underflows, and burst completion.

Client code compatibility: Client code may continually poll readStreamStatus() in a loop. Implementations of readStreamStatus() should wait in the call for a status change event or until the timeout expiration. When stream status is not implemented on a particular stream, readStreamStatus() should return SOAPY_SDR_NOT_SUPPORTED. Client code may use this indication to disable a polling loop.

\param device a pointer to a device instance \param stream the opaque pointer to a stream handle \param chanMask to which channels this status applies \param flags optional input flags and output flags \param timeNs the buffer’s timestamp in nanoseconds \param timeoutUs the timeout in microseconds \return 0 for success or error code like timeout