lws-qpack.h File Reference

Go to the source code of this file.

Data Structures
struct	lws_qpack_dynamic_table_entry
struct	lws_qpack_dynamic_table
struct	lws_qpack_tx_table_entry
struct	lws_qpack_tx_encoder
struct	lws_qpack_context
struct	lws_qpack_stream_state

Macros
#define	LWS_QPACK_IGNORE_ENTRY   0xff

Typedefs
typedef int(*	lws_qpack_header_cb) (void *user, int name_idx, const char *name, size_t name_len, const char *value, size_t value_len)

Enumerations
enum	lws_qpack_dec_state {   LQP_DEC_PREFIX_RIC = 0 , LQP_DEC_PREFIX_BASE , LQP_DEC_INSTRUCTION , LQP_DEC_INT ,   LQP_DEC_STR_LEN , LQP_DEC_STR_DATA , LQP_DEC_STR_DATA_HUFF , LQP_DEC_WAIT_STR_LEN ,   LQP_DEC_EMIT }

Functions
LWS_VISIBLE LWS_EXTERN void	lws_qpack_destroy_dynamic_header (struct lws_qpack_context *ctx)
LWS_VISIBLE LWS_EXTERN int	lws_qpack_decode_encoder_stream (struct lws_qpack_stream_state *state, struct lws_qpack_context *ctx, const unsigned char *in, size_t in_len)
LWS_VISIBLE LWS_EXTERN int	lws_qpack_decode_header_block (struct lws_qpack_stream_state *state, struct lws_qpack_context *ctx, const unsigned char *in, size_t in_len, lws_qpack_header_cb cb, void *user)
LWS_VISIBLE LWS_EXTERN int	lws_qpack_find_static_index (int lws_hdr_idx, const char *value, int value_len)
LWS_VISIBLE LWS_EXTERN int	lws_qpack_get_static_token (int index, int *lws_hdr_idx, const char **value)
LWS_VISIBLE LWS_EXTERN int	lws_qpack_encode_static (unsigned char *buf, size_t buf_len, int index)
LWS_VISIBLE LWS_EXTERN int	lws_qpack_encode_int (unsigned char *buf, size_t buf_len, uint64_t val, uint8_t prefix_bits, uint8_t prefix_mask)
LWS_VISIBLE LWS_EXTERN int	lws_qpack_encode_string (unsigned char *buf, size_t buf_len, const char *str, size_t len)
LWS_VISIBLE LWS_EXTERN int	lws_qpack_encode_prefix (unsigned char *buf, size_t buf_len, uint64_t ric, uint64_t base, uint64_t max_entries)
LWS_VISIBLE LWS_EXTERN int	lws_qpack_encode_literal_with_name_ref (unsigned char *buf, size_t buf_len, int index, const char *val, size_t val_len)
LWS_VISIBLE LWS_EXTERN int	lws_qpack_encode_literal_with_literal_name (unsigned char *buf, size_t buf_len, const char *name, size_t name_len, const char *val, size_t val_len)
LWS_VISIBLE LWS_EXTERN int	lws_qpack_tx_encode_insert_name_ref (unsigned char *buf, size_t buf_len, int is_static, int index, const char *val, size_t val_len)
LWS_VISIBLE LWS_EXTERN int	lws_qpack_tx_encode_insert_literal (unsigned char *buf, size_t buf_len, const char *name, size_t name_len, const char *val, size_t val_len)
LWS_VISIBLE LWS_EXTERN int	lws_qpack_tx_encode_set_capacity (unsigned char *buf, size_t buf_len, uint32_t capacity)
LWS_VISIBLE LWS_EXTERN int	lws_qpack_dynamic_size (struct lws_qpack_context *ctx, int size)
LWS_VISIBLE LWS_EXTERN int	lws_qpack_tx_encode_dynamic_index (unsigned char *buf, size_t buf_len, uint32_t insert_index, uint32_t base)
LWS_VISIBLE LWS_EXTERN int	lws_qpack_tx_encode_dynamic_name_ref (unsigned char *buf, size_t buf_len, uint32_t insert_index, uint32_t base, const char *val, size_t val_len)
LWS_VISIBLE LWS_EXTERN struct lws *	lws_create_h3_dummy_wsi (struct lws_context *ctx, struct lws_qpack_tx_encoder *tx_enc)
LWS_VISIBLE LWS_EXTERN void	lws_qpack_set_wsi_base_and_ric (struct lws *wsi, uint32_t base, uint32_t ric)
LWS_VISIBLE LWS_EXTERN void	lws_destroy_h3_dummy_wsi (struct lws *wsi)
LWS_VISIBLE LWS_EXTERN void	lws_qpack_tx_encoder_destroy (struct lws_qpack_tx_encoder *enc)
LWS_VISIBLE LWS_EXTERN int	lws_qpack_huftable_decode (int pos, char c)
LWS_VISIBLE LWS_EXTERN int	lws_add_http3_header_by_name (struct lws *wsi, const unsigned char *name, const unsigned char *value, int length, unsigned char **p, unsigned char *end)
LWS_VISIBLE LWS_EXTERN int	lws_add_http3_header_by_token (struct lws *wsi, enum lws_token_indexes token, const unsigned char *value, int length, unsigned char **p, unsigned char *end)
LWS_VISIBLE LWS_EXTERN int	lws_add_http3_header_status (struct lws *wsi, unsigned int code, unsigned char **p, unsigned char *end)

---

Data Structure Documentation

lws_qpack_dynamic_table_entry

struct lws_qpack_dynamic_table_entry

Definition at line 34 of file lws-qpack.h.

Collaboration diagram for lws_qpack_dynamic_table_entry:

Data Fields
char *	value
uint16_t	value_len
uint16_t	hdr_len
uint16_t	lws_hdr_idx

lws_qpack_dynamic_table

struct lws_qpack_dynamic_table

Definition at line 41 of file lws-qpack.h.

Collaboration diagram for lws_qpack_dynamic_table:

Data Fields
struct lws_qpack_dynamic_table_entry *	entries
uint32_t	virtual_payload_usage
uint32_t	virtual_payload_max
uint32_t	virtual_payload_limit
uint32_t	insert_count
uint32_t	known_received_count
uint16_t	num_entries
uint16_t	used_entries
uint16_t	pos

lws_qpack_tx_table_entry

struct lws_qpack_tx_table_entry

Definition at line 54 of file lws-qpack.h.

Collaboration diagram for lws_qpack_tx_table_entry:

Data Fields
char *	name
char *	value
uint16_t	name_len
uint16_t	value_len
uint16_t	hdr_len
uint32_t	insert_index

lws_qpack_tx_encoder

struct lws_qpack_tx_encoder

Definition at line 63 of file lws-qpack.h.

Collaboration diagram for lws_qpack_tx_encoder:

Data Fields
struct lws_qpack_tx_table_entry *	entries
uint32_t	virtual_payload_usage
uint32_t	virtual_payload_max
uint32_t	insert_count
uint32_t	known_received_count
uint16_t	num_entries
uint16_t	used_entries
uint16_t	pos
struct lws_buflist *	tx_bl
struct lws *	wsi_qpack_enc

lws_qpack_context

struct lws_qpack_context

Definition at line 77 of file lws-qpack.h.

Collaboration diagram for lws_qpack_context:

Data Fields
struct lws_qpack_dynamic_table	dyn_table
uint8_t	blocked

lws_qpack_stream_state

struct lws_qpack_stream_state

Definition at line 94 of file lws-qpack.h.

Collaboration diagram for lws_qpack_stream_state:

Data Fields
enum lws_qpack_dec_state	state
enum lws_qpack_dec_state	next_state
uint64_t	ric
uint64_t	base
uint64_t	int_val
uint8_t	int_shift
uint8_t	opcode
uint8_t	is_name
uint8_t	huff
uint16_t	huff_pos
uint64_t	str_len
uint64_t	str_pos
int	hdr_idx
char	name_buf[128]
size_t	name_pos
char	val_buf[4096]
size_t	val_pos

Macro Definition Documentation

LWS_QPACK_IGNORE_ENTRY

#define LWS_QPACK_IGNORE_ENTRY   0xff

Definition at line 32 of file lws-qpack.h.

Typedef Documentation

lws_qpack_header_cb

typedef int(* lws_qpack_header_cb) (void *user, int name_idx, const char *name, size_t name_len, const char *value, size_t value_len)

Definition at line 118 of file lws-qpack.h.

Enumeration Type Documentation

lws_qpack_dec_state

enum lws_qpack_dec_state

Enumerator
LQP_DEC_PREFIX_RIC
LQP_DEC_PREFIX_BASE
LQP_DEC_INSTRUCTION
LQP_DEC_INT
LQP_DEC_STR_LEN
LQP_DEC_STR_DATA
LQP_DEC_STR_DATA_HUFF
LQP_DEC_WAIT_STR_LEN
LQP_DEC_EMIT

Definition at line 82 of file lws-qpack.h.

                         {
        LQP_DEC_PREFIX_RIC = 0,
        LQP_DEC_PREFIX_BASE,
        LQP_DEC_INSTRUCTION,
        LQP_DEC_INT,
        LQP_DEC_STR_LEN,
        LQP_DEC_STR_DATA,
        LQP_DEC_STR_DATA_HUFF,
        LQP_DEC_WAIT_STR_LEN,
        LQP_DEC_EMIT
};

Function Documentation

lws_qpack_destroy_dynamic_header()

LWS_VISIBLE LWS_EXTERN void lws_qpack_destroy_dynamic_header

(

struct lws_qpack_context *

ctx

)

References LWS_EXTERN, and LWS_VISIBLE.

lws_qpack_decode_encoder_stream()

LWS_VISIBLE LWS_EXTERN int lws_qpack_decode_encoder_stream	(	struct lws_qpack_stream_state *	state,
		struct lws_qpack_context *	ctx,
		const unsigned char *	in,
		size_t	in_len )

References LWS_EXTERN, and LWS_VISIBLE.

lws_qpack_decode_header_block()

LWS_VISIBLE LWS_EXTERN int lws_qpack_decode_header_block	(	struct lws_qpack_stream_state *	state,
		struct lws_qpack_context *	ctx,
		const unsigned char *	in,
		size_t	in_len,
		lws_qpack_header_cb	cb,
		void *	user )

References LWS_EXTERN, and LWS_VISIBLE.

lws_qpack_find_static_index()

LWS_VISIBLE LWS_EXTERN int lws_qpack_find_static_index	(	int	lws_hdr_idx,
		const char *	value,
		int	value_len )

References LWS_EXTERN, and LWS_VISIBLE.

lws_qpack_get_static_token()

LWS_VISIBLE LWS_EXTERN int lws_qpack_get_static_token	(	int	index,
		int *	lws_hdr_idx,
		const char **	value )

References LWS_EXTERN, and LWS_VISIBLE.

lws_qpack_encode_static()

LWS_VISIBLE LWS_EXTERN int lws_qpack_encode_static	(	unsigned char *	buf,
		size_t	buf_len,
		int	index )

References LWS_EXTERN, and LWS_VISIBLE.

lws_qpack_encode_int()

LWS_VISIBLE LWS_EXTERN int lws_qpack_encode_int	(	unsigned char *	buf,
		size_t	buf_len,
		uint64_t	val,
		uint8_t	prefix_bits,
		uint8_t	prefix_mask )

References LWS_EXTERN, and LWS_VISIBLE.

lws_qpack_encode_string()

LWS_VISIBLE LWS_EXTERN int lws_qpack_encode_string	(	unsigned char *	buf,
		size_t	buf_len,
		const char *	str,
		size_t	len )

References LWS_EXTERN, and LWS_VISIBLE.

lws_qpack_encode_prefix()

LWS_VISIBLE LWS_EXTERN int lws_qpack_encode_prefix	(	unsigned char *	buf,
		size_t	buf_len,
		uint64_t	ric,
		uint64_t	base,
		uint64_t	max_entries )

References LWS_EXTERN, and LWS_VISIBLE.

lws_qpack_encode_literal_with_name_ref()

LWS_VISIBLE LWS_EXTERN int lws_qpack_encode_literal_with_name_ref	(	unsigned char *	buf,
		size_t	buf_len,
		int	index,
		const char *	val,
		size_t	val_len )

References LWS_EXTERN, and LWS_VISIBLE.

lws_qpack_encode_literal_with_literal_name()

LWS_VISIBLE LWS_EXTERN int lws_qpack_encode_literal_with_literal_name	(	unsigned char *	buf,
		size_t	buf_len,
		const char *	name,
		size_t	name_len,
		const char *	val,
		size_t	val_len )

References LWS_EXTERN, and LWS_VISIBLE.

lws_qpack_tx_encode_insert_name_ref()

LWS_VISIBLE LWS_EXTERN int lws_qpack_tx_encode_insert_name_ref	(	unsigned char *	buf,
		size_t	buf_len,
		int	is_static,
		int	index,
		const char *	val,
		size_t	val_len )

References LWS_EXTERN, and LWS_VISIBLE.

lws_qpack_tx_encode_insert_literal()

LWS_VISIBLE LWS_EXTERN int lws_qpack_tx_encode_insert_literal	(	unsigned char *	buf,
		size_t	buf_len,
		const char *	name,
		size_t	name_len,
		const char *	val,
		size_t	val_len )

References LWS_EXTERN, and LWS_VISIBLE.

lws_qpack_tx_encode_set_capacity()

LWS_VISIBLE LWS_EXTERN int lws_qpack_tx_encode_set_capacity	(	unsigned char *	buf,
		size_t	buf_len,
		uint32_t	capacity )

References LWS_EXTERN, and LWS_VISIBLE.

lws_qpack_dynamic_size()

LWS_VISIBLE LWS_EXTERN int lws_qpack_dynamic_size	(	struct lws_qpack_context *	ctx,
		int	size )

References LWS_EXTERN, and LWS_VISIBLE.

lws_qpack_tx_encode_dynamic_index()

LWS_VISIBLE LWS_EXTERN int lws_qpack_tx_encode_dynamic_index	(	unsigned char *	buf,
		size_t	buf_len,
		uint32_t	insert_index,
		uint32_t	base )

References LWS_EXTERN, and LWS_VISIBLE.

lws_qpack_tx_encode_dynamic_name_ref()

LWS_VISIBLE LWS_EXTERN int lws_qpack_tx_encode_dynamic_name_ref	(	unsigned char *	buf,
		size_t	buf_len,
		uint32_t	insert_index,
		uint32_t	base,
		const char *	val,
		size_t	val_len )

References LWS_EXTERN, and LWS_VISIBLE.

lws_create_h3_dummy_wsi()

LWS_VISIBLE LWS_EXTERN struct lws * lws_create_h3_dummy_wsi	(	struct lws_context *	ctx,
		struct lws_qpack_tx_encoder *	tx_enc )

References LWS_EXTERN, and LWS_VISIBLE.

lws_qpack_set_wsi_base_and_ric()

LWS_VISIBLE LWS_EXTERN void lws_qpack_set_wsi_base_and_ric	(	struct lws *	wsi,
		uint32_t	base,
		uint32_t	ric )

References LWS_EXTERN, and LWS_VISIBLE.

lws_destroy_h3_dummy_wsi()

LWS_VISIBLE LWS_EXTERN void lws_destroy_h3_dummy_wsi

(

struct lws *

wsi

)

References LWS_EXTERN, and LWS_VISIBLE.

lws_qpack_tx_encoder_destroy()

LWS_VISIBLE LWS_EXTERN void lws_qpack_tx_encoder_destroy

(

struct lws_qpack_tx_encoder *

enc

)

References LWS_EXTERN, and LWS_VISIBLE.

lws_qpack_huftable_decode()

LWS_VISIBLE LWS_EXTERN int lws_qpack_huftable_decode	(	int	pos,
		char	c )

References LWS_EXTERN, and LWS_VISIBLE.

lws_add_http3_header_by_name()

LWS_VISIBLE LWS_EXTERN int lws_add_http3_header_by_name	(	struct lws *	wsi,
		const unsigned char *	name,
		const unsigned char *	value,
		int	length,
		unsigned char **	p,
		unsigned char *	end )

References LWS_EXTERN, and LWS_VISIBLE.

lws_add_http3_header_by_token()

LWS_VISIBLE LWS_EXTERN int lws_add_http3_header_by_token	(	struct lws *	wsi,
		enum lws_token_indexes	token,
		const unsigned char *	value,
		int	length,
		unsigned char **	p,
		unsigned char *	end )

References LWS_EXTERN, and LWS_VISIBLE.

lws_add_http3_header_status()

LWS_VISIBLE LWS_EXTERN int lws_add_http3_header_status	(	struct lws *	wsi,
		unsigned int	code,
		unsigned char **	p,
		unsigned char *	end )