linebuf.h File Reference

Line buffering. More...

#include <stdint.h>
#include <stddef.h>

Go to the source code of this file.

Data Structures
struct	line_buffer
	A line buffer. More...
Functions
	FILE_LICENCE (GPL2_OR_LATER)
char *	buffered_line (struct line_buffer *linebuf)
	Retrieve buffered-up line.
ssize_t	line_buffer (struct line_buffer *linebuf, const char *data, size_t len)
	Buffer up received data by lines.
void	empty_line_buffer (struct line_buffer *linebuf)
	Discard line buffer contents.

---

Detailed Description

Line buffering.

Definition in file linebuf.h.

---

Function Documentation

FILE_LICENCE

(

GPL2_OR_LATER

)

char* buffered_line

(

struct line_buffer *

linebuf

)

Retrieve buffered-up line.

Parameters:

linebuf

Line buffer

Return values:

line

Buffered line, or NULL if no line ready to read

Definition at line 40 of file linebuf.c.

References line_buffer::data, NULL, and line_buffer::ready.

Referenced by http_socket_deliver_iob(), and linebuf_test().

                                                     {
        return ( linebuf->ready ? linebuf->data : NULL );
}

ssize_t line_buffer	(	struct line_buffer *	linebuf,
		const char *	data,
		size_t	len
	)

Buffer up received data by lines.

Parameters:

	linebuf	Line buffer
	data	New data to add
	len	Length of new data to add

Return values:

len

Consumed length, or negative error number

After calling line_buffer(), use buffered_line() to determine whether or not a complete line is available. Carriage returns and newlines will have been stripped, and the line will be NUL-terminated. This buffered line is valid only until the next call to line_buffer() (or to empty_line_buffer()).

Note that line buffers use dynamically allocated storage; you should call empty_line_buffer() before freeing a struct line_buffer.

Definition at line 74 of file linebuf.c.

References line_buffer::data, empty_line_buffer(), ENOMEM, line_buffer::len, memchr(), memcpy, line_buffer::ready, and realloc().

Referenced by http_socket_deliver_iob(), and linebuf_test().

                                                     {
        const char *eol;
        size_t consume;
        size_t new_len;
        char *new_data;

        /* Free any completed line from previous iteration */
        if ( linebuf->ready )
                empty_line_buffer ( linebuf );

        /* Search for line terminator */
        if ( ( eol = memchr ( data, '\n', len ) ) ) {
                consume = ( eol - data + 1 );
        } else {
                consume = len;
        }

        /* Reallocate data buffer and copy in new data */
        new_len = ( linebuf->len + consume );
        new_data = realloc ( linebuf->data, ( new_len + 1 ) );
        if ( ! new_data )
                return -ENOMEM;
        memcpy ( ( new_data + linebuf->len ), data, consume );
        new_data[new_len] = '\0';
        linebuf->data = new_data;
        linebuf->len = new_len;

        /* If we have reached end of line, trim the line and mark as ready */
        if ( eol ) {
                linebuf->data[--linebuf->len] = '\0'; /* trim NL */
                if ( linebuf->data[linebuf->len - 1] == '\r' )
                        linebuf->data[--linebuf->len] = '\0'; /* trim CR */
                linebuf->ready = 1;
        }

        return consume;
}

void empty_line_buffer

(

struct line_buffer *

linebuf

)

Discard line buffer contents.

Parameters:

linebuf

Line buffer

Definition at line 49 of file linebuf.c.

References line_buffer::data, free(), line_buffer::len, NULL, and line_buffer::ready.

Referenced by http_free(), http_rx_header(), line_buffer(), and linebuf_test().

                                                       {
        free ( linebuf->data );
        linebuf->data = NULL;
        linebuf->len = 0;
        linebuf->ready = 0;
}