istream_consume()

`istream_consume()`#

Consumes data from the provided buffer (bf) and processes it into the istream. The function stops when the specified amount of data (len) is consumed or when the delimiter or required number of bytes is matched, triggering the configured event if applicable.

C

Prototype

PUBLIC size_t istream_consume(
    istream_h   istream,
    char        *bf,
    size_t      len
);

Parameters

Key	Type	Description
`istream`	`istream_h`	The handle to the istream where the data will be consumed.
`bf`	`char *`	The input buffer containing the data to process.
`len`	`size_t`	The length of the input buffer (`bf`) in bytes.

Return Value

Returns the number of bytes successfully consumed from the buffer.

Notes

If the istream is configured to read until a specified number of bytes (num_bytes):
1. Data is appended to the internal gbuffer until the required number of bytes is reached.
2. Once the requirement is met, the associated event is triggered.
If the istream is configured to read until a delimiter:
1. Data is appended byte-by-byte to the internal gbuffer.
2. The delimiter is matched against the end of the gbuffer’s data.
3. If the delimiter is found, the associated event is triggered.
The function performs the following checks:
- If len is 0, the function immediately returns 0.
- If the internal gbuffer is NULL, the function logs an error and returns 0.
- If the internal gbuffer becomes full while appending data, an error is logged, and the process stops.
When the event is triggered:
1. The current gbuffer is passed to the event handler.
2. A new gbuffer is created to continue processing subsequent data.
The event must be preconfigured using functions such as istream_read_until_delimiter or istream_read_until_num_bytes.

JS

Prototype

// Not applicable in JS

Python

Prototype

# Not applicable in Python

istream_consume()

istream_consume()#

`istream_consume()`#