Function cwipc_encoder_available

• Defined in File api.h

Function Documentation

bool cwipc_encoder_available(cwipc_encoder *obj, bool wait)

Return true if a data buffer is currently available (C interface).

If this cwipc_encoder is not multi-threading capable the wait parameter is ignored. If it is multi-threaded aware and no data is currently available it may wait a reasonable amount of time (think: about a second) to see whether one becomes available.

Parameters:

• obj – The cwipc_encoder object.

• wait – Set to true if the caller is willing to wait until one is available.