comedi_mark_buffer_read(3)

comedi_mark_buffer_read3

Streaming buffer control

Usage

#include <comedilib.h>

int comedi_mark_buffer_read(comedi_t * device, unsigned int subdevice, unsigned int num_bytes);

Overview

The function comedi_mark_buffer_read is used on a subdevice that has a Comedi input command in progress. It should only be used if you are using a mmap mapping to read data from Comedi's buffer (as opposed to calling read on the device file descriptor), since Comedi will automatically keep track of how many bytes have been transferred via read calls. This function is used to indicate that the next num_bytes bytes in the buffer are no longer needed and may be discarded.

Return value

On success, comedi_mark_buffer_read returns the number of bytes successfully marked as read. The return value may be less than the num_bytes. On failure, -1 is returned.

Releases

12 releases since Debian 3.0 (Woody); the text changed 9 times.

  1. 3.0
  2. 3.1–4.0
  3. 5.0–6.0
  4. 7
  5. 8
  6. 9
  7. 10
  8. 11
  9. 12
  10. 13

Authors

David Schleef <[email protected]>

Author.

Frank Mori Hess <[email protected]>

Author.

Herman Bruyninckx <[email protected]>

Author.

Bernd Porr <[email protected]>

Author.

Ian Abbott <[email protected]>

Author.

Éric Piel <[email protected]>

Author.

From libcomedi-dev 0.11.0+5-1.3+b1 in Debian 13 (Trixie). Parsed by carta from the page's man source.