linebuf_8h_source.html

#ifndef _IPXE_LINEBUF_H

#define _IPXE_LINEBUF_H


/** @file

 *

 * Line buffering

 *

 */


FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );

FILE_SECBOOT ( PERMITTED );


#include <stdint.h>

#include <stddef.h>


/** A line buffer */


struct line_buffer {

        /** Data buffer */

        char *data;

        /** Length of buffered data */

        size_t len;

        /** Most recently consumed length */

        size_t consumed;

};


extern char * buffered_line ( struct line_buffer *linebuf );

extern int line_buffer ( struct line_buffer *linebuf,

                         const char *data, size_t len );

extern void empty_line_buffer ( struct line_buffer *linebuf );


#endif /* _IPXE_LINEBUF_H */

len
ring len
Length.
Definition dwmac.h:226

data
uint8_t data[48]
Additional event data.
Definition ena.h:11

FILE_LICENCE
#define FILE_LICENCE(_licence)
Declare a particular licence as applying to a file.
Definition compiler.h:896

FILE_SECBOOT
#define FILE_SECBOOT(_status)
Declare a file's UEFI Secure Boot permission status.
Definition compiler.h:926

stdint.h

line_buffer
int line_buffer(struct line_buffer *linebuf, const char *data, size_t len)
Buffer up received data by lines.
Definition linebuf.c:92

buffered_line
char * buffered_line(struct line_buffer *linebuf)
Retrieve buffered-up line.
Definition linebuf.c:46

empty_line_buffer
void empty_line_buffer(struct line_buffer *linebuf)
Discard line buffer contents.
Definition linebuf.c:66

stddef.h

line_buffer
A line buffer.
Definition linebuf.h:17

line_buffer::len
size_t len
Length of buffered data.
Definition linebuf.h:21

line_buffer::data
char * data
Data buffer.
Definition linebuf.h:19

line_buffer::consumed
size_t consumed
Most recently consumed length.
Definition linebuf.h:23