buffer.h (xorriso-1.5.2) | : | buffer.h (xorriso-1.5.4) | ||
---|---|---|---|---|
skipping to change at line 58 | skipping to change at line 58 | |||
* reader close the buffer. | * reader close the buffer. | |||
* | * | |||
* @param buf | * @param buf | |||
* the buffer | * the buffer | |||
* @param data | * @param data | |||
* pointer to a memory region of at least coun bytes, from which data | * pointer to a memory region of at least coun bytes, from which data | |||
* will be read. | * will be read. | |||
* @param | * @param | |||
* Number of bytes to write | * Number of bytes to write | |||
* @return | * @return | |||
* 1 succes, 0 read finished, < 0 error | * 1 success, 0 read finished, < 0 error | |||
*/ | */ | |||
int iso_ring_buffer_write(IsoRingBuffer *buf, uint8_t *data, size_t count); | int iso_ring_buffer_write(IsoRingBuffer *buf, uint8_t *data, size_t count); | |||
/** | /** | |||
* Read count bytes from the buffer into dest. It blocks until the desired | * Read count bytes from the buffer into dest. It blocks until the desired | |||
* bytes has been read. If the writer finishes before outputting enought | * bytes has been read. If the writer finishes before outputting enough | |||
* bytes, 0 (EOF) is returned, the number of bytes already read remains | * bytes, 0 (EOF) is returned, the number of bytes already read remains | |||
* unknown. | * unknown. | |||
* | * | |||
* @return | * @return | |||
* 1 success, 0 EOF, < 0 error | * 1 success, 0 EOF, < 0 error | |||
*/ | */ | |||
int iso_ring_buffer_read(IsoRingBuffer *buf, uint8_t *dest, size_t count); | int iso_ring_buffer_read(IsoRingBuffer *buf, uint8_t *dest, size_t count); | |||
/** Backend of API call iso_ring_buffer_get_status() | /** Backend of API call iso_ring_buffer_get_status() | |||
* | * | |||
skipping to change at line 97 | skipping to change at line 97 | |||
* 3="failing" : input had error and ended, | * 3="failing" : input had error and ended, | |||
* 5="abandoned" : consumption has ended prematurely | * 5="abandoned" : consumption has ended prematurely | |||
* 6="ended" : consumption has ended without input error | * 6="ended" : consumption has ended without input error | |||
* 7="aborted" : consumption has ended after input error | * 7="aborted" : consumption has ended after input error | |||
*/ | */ | |||
int iso_ring_buffer_get_buf_status(IsoRingBuffer *buf, size_t *size, | int iso_ring_buffer_get_buf_status(IsoRingBuffer *buf, size_t *size, | |||
size_t *free_bytes); | size_t *free_bytes); | |||
/** | /** | |||
* Close the buffer (to be called by the writer). | * Close the buffer (to be called by the writer). | |||
* You have to explicity close the buffer when you don't have more data to | * You have to explicitly close the buffer when you don't have more data to | |||
* write, otherwise reader will be waiting forever. | * write, otherwise reader will be waiting forever. | |||
* | * | |||
* @param error | * @param error | |||
* Writer has finished prematurely due to an error | * Writer has finished prematurely due to an error | |||
*/ | */ | |||
void iso_ring_buffer_writer_close(IsoRingBuffer *buf, int error); | void iso_ring_buffer_writer_close(IsoRingBuffer *buf, int error); | |||
/** | /** | |||
* Close the buffer (to be called by the reader). | * Close the buffer (to be called by the reader). | |||
* If for any reason you don't want to read more data, you need to call this | * If for any reason you don't want to read more data, you need to call this | |||
End of changes. 3 change blocks. | ||||
3 lines changed or deleted | 3 lines changed or added |