quic.h File Reference

QUIC stack implementation (headers) More...

#include <sys/socket.h>
#include <glib.h>
#include "../imquic/imquic.h"
#include "connection.h"
#include "stream.h"
#include "utils.h"

Include dependency graph for quic.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	imquic_frame
	A serialized QUIC frame. More...
struct	imquic_packet
	Abstraction of a QUIC packet. More...
struct	imquic_sent_packet
	Info on a sent packet. More...

Typedefs
typedef enum imquic_long_packet_type	imquic_long_packet_type
	QUIC long packet types.
typedef enum imquic_frame_type	imquic_frame_type
	QUIC frame types.
typedef struct imquic_frame	imquic_frame
	A serialized QUIC frame.
typedef enum imquic_transport_parameter	imquic_transport_parameter
	QUIC transport parameters.
typedef struct imquic_packet	imquic_packet
	Abstraction of a QUIC packet.
typedef struct imquic_sent_packet	imquic_sent_packet
	Info on a sent packet.

Enumerations
enum	imquic_long_packet_type { IMQUIC_INITIAL = 0x00 , IMQUIC_0RTT = 0x01 , IMQUIC_HANDSHAKE = 0x02 , IMQUIC_RETRY = 0x03 }
	QUIC long packet types. More...
enum	imquic_frame_type {   IMQUIC_PADDING = 0x00 , IMQUIC_PING = 0x01 , IMQUIC_ACK = 0x02 , IMQUIC_ACK_WITH_ECN = 0x03 ,   IMQUIC_RESET_STREAM = 0x04 , IMQUIC_STOP_SENDING = 0x05 , IMQUIC_CRYPTO = 0x06 , IMQUIC_NEW_TOKEN = 0x07 ,   IMQUIC_STREAM = 0x08 , IMQUIC_STREAM_F = 0x09 , IMQUIC_STREAM_L = 0x0A , IMQUIC_STREAM_LF = 0x0B ,   IMQUIC_STREAM_O = 0x0C , IMQUIC_STREAM_OF = 0x0D , IMQUIC_STREAM_OL = 0x0E , IMQUIC_STREAM_OLF = 0x0F ,   IMQUIC_MAX_DATA = 0x10 , IMQUIC_MAX_STREAM_DATA = 0x11 , IMQUIC_MAX_STREAMS = 0x12 , IMQUIC_MAX_STREAMS_UNI = 0x13 ,   IMQUIC_DATA_BLOCKED = 0x14 , IMQUIC_STREAM_DATA_BLOCKED = 0x15 , IMQUIC_STREAMS_BLOCKED = 0x16 , IMQUIC_STREAMS_BLOCKED_UNI = 0x17 ,   IMQUIC_NEW_CONNECTION_ID = 0x18 , IMQUIC_RETIRE_CONNECTION_ID = 0x19 , IMQUIC_PATH_CHALLENGE = 0x1A , IMQUIC_PATH_RESPONSE = 0x1B ,   IMQUIC_CONNECTION_CLOSE = 0x1C , IMQUIC_CONNECTION_CLOSE_APP = 0x1D , IMQUIC_HANDSHAKE_DONE = 0x1E , IMQUIC_DATAGRAM = 0x30 ,   IMQUIC_DATAGRAM_L = 0x31 }
	QUIC frame types. More...
enum	imquic_transport_parameter {   IMQUIC_ORIGINAL_DESTINATION_CONNECTION_ID = 0x00 , IMQUIC_MAX_IDLE_TIMEOUT = 0x01 , IMQUIC_STATELESS_RESET_TOKEN = 0x02 , IMQUIC_MAX_UDP_PAYLOAD_SIZE = 0x03 ,   IMQUIC_INITIAL_MAX_DATA = 0x04 , IMQUIC_INITIAL_MAX_STREAM_DATA_BIDI_LOCAL = 0x05 , IMQUIC_INITIAL_MAX_STREAM_DATA_BIDI_REMOTE = 0x06 , IMQUIC_INITIAL_MAX_STREAM_DATA_UNI = 0x07 ,   IMQUIC_INITIAL_MAX_STREAMS_BIDI = 0x08 , IMQUIC_INITIAL_MAX_STREAMS_UNI = 0x09 , IMQUIC_ACK_DELAY_EXPONENT = 0x0A , IMQUIC_MAX_ACK_DELAY = 0x0B ,   IMQUIC_DISABLE_ACTIVE_MIGRATION = 0x0C , IMQUIC_PREFERRED_ADDRESS = 0x0D , IMQUIC_ACTIVE_CONNECTION_ID_LIMIT = 0x0E , IMQUIC_INITIAL_SOURCE_CONNECTION_ID = 0x0F ,   IMQUIC_RETRY_SOURCE_CONNECTION_ID = 0x10 , IMQUIC_MAX_DATAGRAM_FRAME_SIZE = 0x20 }
	QUIC transport parameters. More...

Functions
void	imquic_quic_init (void)
	Initialize the QUIC stack at startup.
void	imquic_quic_deinit (void)
	Uninitialize the QUIC stack.
void	imquic_quic_connection_add (imquic_connection *conn, imquic_connection_id *cid)
	Track a Connection ID and map it to a connection.
void	imquic_quic_connection_remove (imquic_connection_id *cid)
	Stop tracking a Connection ID associated to a connection.
const char *	imquic_long_packet_type_str (imquic_long_packet_type type)
	Helper function to serialize to string the name of a imquic_long_packet_type value.
const char *	imquic_frame_type_str (imquic_frame_type type)
	Helper function to serialize to string the name of a imquic_frame_type value.
imquic_frame *	imquic_frame_create (imquic_frame_type type, uint8_t *buffer, size_t size)
	Helper method to create a imquic_frame instance.
void	imquic_frame_destroy (imquic_frame *frame)
	Helper method to destroy an existing imquic_frame instance.
const char *	imquic_transport_parameter_str (imquic_transport_parameter param)
	Helper function to serialize to string the name of a imquic_transport_parameter value.
imquic_packet *	imquic_packet_create (void)
	Helper method to create a imquic_packet instance.
int	imquic_packet_long_init (imquic_packet *pkt, imquic_long_packet_type type, imquic_connection_id *src, imquic_connection_id *dest)
	Initialize a imquic_packet instance as a long header packet.
int	imquic_packet_short_init (imquic_packet *pkt, imquic_connection_id *dest)
	Initialize a imquic_packet instance as a short header packet.
void	imquic_packet_destroy (imquic_packet *pkt)
	Helper method to destroy an existing imquic_packet instance.
void	imquic_sent_packet_destroy (imquic_sent_packet *sent_pkt)
	Helper method to destroy an existing imquic_sent_packet instance.
gboolean	imquic_handle_event (imquic_connection *conn)
	Callback fired when the event loop has an event for a specific connection.
int	imquic_start_quic_client (imquic_network_endpoint *socket)
	Helper to start a new client endpoint, and so attempt a connection.
Parsing and processing QUIC messages
void	imquic_process_message (imquic_network_endpoint *socket, imquic_network_address *sender, uint8_t *quic, size_t bytes)
	Process incoming data from the network we've made aware of.
int	imquic_parse_packet (imquic_network_endpoint *socket, imquic_network_address *sender, imquic_connection **pconn, imquic_packet *pkt, uint8_t *quic, size_t bytes)
	Parse a QUIC packet from an incoming buffer and handle it.
void	imquic_check_incoming_crypto (imquic_connection *conn)
	Helper method to check if we received CRYPTO frames we need to go through, and in case pass them to the TLS stack for processing.
void	imquic_check_incoming_stream (imquic_connection *conn)
	Helper method to check if we received STREAM frames we need to go process, and handle ourselves or pass to the application layer.
Parsing QUIC frames
int	imquic_parse_frames (imquic_connection *conn, imquic_packet *pkt)
	Parse QUIC frames in a QUIC message payload.
size_t	imquic_payload_parse_ack (imquic_connection *conn, uint8_t *bytes, size_t blen, enum ssl_encryption_level_t level)
	Helper method to process an ACK frame.
size_t	imquic_payload_parse_reset_stream (imquic_connection *conn, uint8_t *bytes, size_t blen)
	Helper method to process a RESET_STREAM frame.
size_t	imquic_payload_parse_stop_sending (imquic_connection *conn, uint8_t *bytes, size_t blen)
	Helper method to process a STOP_SENDING frame.
size_t	imquic_payload_parse_crypto (imquic_connection *conn, uint8_t *bytes, size_t blen, enum ssl_encryption_level_t level)
	Helper method to process a CRYPTO frame, and in case add all chunks to the buffer associated with the related encryption level, so that it can be processed later.
size_t	imquic_payload_parse_new_token (imquic_connection *conn, uint8_t *bytes, size_t blen)
	Helper method to process a NEW_TOKEN frame.
size_t	imquic_payload_parse_stream (imquic_connection *conn, uint8_t *bytes, size_t blen)
	Helper method to process a STREAM frame, and handle it accordingly, e.g., by creating the stream locally (if previously unknown), update the associated buffer with the new data, update the state of the stream, and notify the stack using internal callbacks.
size_t	imquic_payload_parse_max_data (imquic_connection *conn, uint8_t *bytes, size_t blen)
	Helper method to process a MAX_DATA frame.
size_t	imquic_payload_parse_max_stream_data (imquic_connection *conn, uint8_t *bytes, size_t blen)
	Helper method to process a MAX_STREAM_DATA frame.
size_t	imquic_payload_parse_max_streams (imquic_connection *conn, uint8_t *bytes, size_t blen)
	Helper method to process a MAX_STREAMS frame.
size_t	imquic_payload_parse_data_blocked (imquic_connection *conn, uint8_t *bytes, size_t blen)
	Helper method to process a DATA_BLOCKED frame.
size_t	imquic_payload_parse_stream_data_blocked (imquic_connection *conn, uint8_t *bytes, size_t blen)
	Helper method to process a STREAM_DATA_BLOCKED frame.
size_t	imquic_payload_parse_streams_blocked (imquic_connection *conn, uint8_t *bytes, size_t blen)
	Helper method to process a STREAMS_BLOCKED frame.
size_t	imquic_payload_parse_new_connection_id (imquic_connection *conn, uint8_t *bytes, size_t blen)
	Helper method to process a NEW_CONNECTION_ID frame.
size_t	imquic_payload_parse_retire_connection_id (imquic_connection *conn, uint8_t *bytes, size_t blen)
	Helper method to process a RETIRE_CONNECTION_ID frame.
size_t	imquic_payload_parse_path_challenge (imquic_connection *conn, uint8_t *bytes, size_t blen)
	Helper method to process a PATH_CHALLENGE frame.
size_t	imquic_payload_parse_path_response (imquic_connection *conn, uint8_t *bytes, size_t blen)
	Helper method to process a PATH_RESPONSE frame.
size_t	imquic_payload_parse_connection_close (imquic_connection *conn, uint8_t *bytes, size_t blen)
	Helper method to process a CONNECTION_CLOSE frame, and handle it accordingly by closing the connection locally too.
size_t	imquic_payload_parse_datagram (imquic_connection *conn, uint8_t *bytes, size_t blen)
	Helper method to process a DATAGRAM frame, and notify the stack about it via internal callbacks.
Adding QUIC frames to a packet
size_t	imquic_payload_add_padding (uint8_t *bytes, size_t blen, size_t padding)
	Helper method to add a PADDING frame to a buffer.
size_t	imquic_payload_add_ping (uint8_t *bytes, size_t blen)
	Helper method to add a PING frame to a buffer.
size_t	imquic_payload_add_ack (uint8_t *bytes, size_t blen, GList *received, uint64_t delay, uint64_t *ecn_counts)
	Helper method to add a ACK frame to a buffer.
size_t	imquic_payload_add_reset_stream (uint8_t *bytes, size_t blen, uint64_t stream_id, uint64_t error_code, uint64_t final_size)
	Helper method to add a RESET_STREAM frame to a buffer.
size_t	imquic_payload_add_stop_sending (uint8_t *bytes, size_t blen, uint64_t stream_id, uint64_t error_code)
	Helper method to add a STOP_SENDING frame to a buffer.
size_t	imquic_payload_add_crypto (uint8_t *bytes, size_t blen, uint8_t *crypto, size_t crypto_offset, size_t crypto_length)
	Helper method to add a CRYPTO frame to a buffer.
size_t	imquic_payload_add_new_token (uint8_t *bytes, size_t blen, uint8_t *token, size_t token_length)
	Helper method to add a NEW_TOKEN frame to a buffer.
size_t	imquic_payload_add_stream (uint8_t *bytes, size_t blen, uint64_t stream_id, uint8_t *stream, size_t stream_offset, size_t stream_length, gboolean complete, gboolean last)
	Helper method to add a STREAM frame to a buffer.
size_t	imquic_payload_add_max_data (uint8_t *bytes, size_t blen, uint64_t max_data)
	Helper method to add a MAX_DATA frame to a buffer.
size_t	imquic_payload_add_max_stream_data (uint8_t *bytes, size_t blen, uint64_t stream_id, uint64_t max_data)
	Helper method to add a MAX_STREAM_DATA frame to a buffer.
size_t	imquic_payload_add_max_streams (uint8_t *bytes, size_t blen, gboolean bidirectional, uint64_t max_streams)
	Helper method to add a MAX_STREAMS frame to a buffer.
size_t	imquic_payload_add_data_blocked (uint8_t *bytes, size_t blen, uint64_t max_data)
	Helper method to add a DATA_BLOCKED frame to a buffer.
size_t	imquic_payload_add_stream_data_blocked (uint8_t *bytes, size_t blen, uint64_t stream_id, uint64_t max_data)
	Helper method to add a STREAM_DATA_BLOCKED frame to a buffer.
size_t	imquic_payload_add_streams_blocked (uint8_t *bytes, size_t blen, uint64_t max_streams)
	Helper method to add a STREAMS_BLOCKED frame to a buffer.
size_t	imquic_payload_add_new_connection_id (uint8_t *bytes, size_t blen, uint64_t seqnum, uint64_t retire_prior_to, imquic_connection_id *cid, uint8_t *reset_token)
	Helper method to add a NEW_CONNECTION_ID frame to a buffer.
size_t	imquic_payload_add_retire_connection_id (uint8_t *bytes, size_t blen, uint64_t seqnum)
	Helper method to add a RETIRE_CONNECTION_ID frame to a buffer.
size_t	imquic_payload_add_path_challenge (uint8_t *bytes, size_t blen, uint8_t *data)
	Helper method to add a PATH_CHALLENGE frame to a buffer.
size_t	imquic_payload_add_path_response (uint8_t *bytes, size_t blen, uint8_t *data)
	Helper method to add a PATH_RESPONSE frame to a buffer.
size_t	imquic_payload_add_connection_close (uint8_t *bytes, size_t blen, imquic_error_code error_code, imquic_frame_type frame_type, const char *reason)
	Helper method to add a CONNECTION_CLOSE frame to a buffer.
size_t	imquic_payload_add_handshake_done (uint8_t *bytes, size_t blen)
	Helper method to add a HANDSHAKE_DONE frame to a buffer.
size_t	imquic_payload_add_datagram (uint8_t *bytes, size_t blen, uint8_t *datagram, size_t datagram_length, gboolean last)
	Helper method to add a DATAGRAM frame to a buffer.
Adding QUIC transport parameters to a buffer
size_t	imquic_transport_parameter_add_novalue (uint8_t *bytes, size_t blen, imquic_transport_parameter param)
	Helper to add a QUIC transport parameter with no value to a buffer.
size_t	imquic_transport_parameter_add_int (uint8_t *bytes, size_t blen, imquic_transport_parameter param, uint64_t number)
	Helper to add a QUIC transport parameter with a numeric value to a buffer.
size_t	imquic_transport_parameter_add_data (uint8_t *bytes, size_t blen, imquic_transport_parameter param, uint8_t *buf, size_t buflen)
	Helper to add a QUIC transport parameter with generic data to a buffer.
size_t	imquic_transport_parameter_add_connection_id (uint8_t *bytes, size_t blen, imquic_transport_parameter param, imquic_connection_id *cid)
	Helper to add a QUIC transport parameter with a Connection ID to a buffer.
Parsing QUIC transport parameters
int	imquic_parse_transport_parameters (imquic_connection *conn, uint8_t *bytes, size_t blen)
	Helper to parse a buffer containing QUIC transport parameters, and update the associated imquic_connection instance accordingly.
Sending QUIC messages
int	imquic_send_ack (imquic_connection *conn, enum ssl_encryption_level_t level, imquic_connection_id *src, imquic_connection_id *dest)
	Helper method to generate a packet containing an ACK and send it.
int	imquic_send_pending_crypto (imquic_connection *conn, imquic_connection_id *src, imquic_connection_id *dest)
	Helper method to generate one or more packets containing one or more CRYPTO frames and send them.
int	imquic_send_keepalive (imquic_connection *conn, imquic_connection_id *dest)
	Helper method to generate a packet containing a PING and send it.
int	imquic_send_pending_stream (imquic_connection *conn, imquic_connection_id *dest)
	Helper method to generate one or more packets containing one or more STREAM frames and send them.
int	imquic_send_pending_datagram (imquic_connection *conn, imquic_connection_id *dest)
	Helper method to generate one or more packets containing one or more DATAGRAM frames and send them.
int	imquic_send_close_connection (imquic_connection *conn, imquic_error_code error_code, imquic_frame_type frame_type, const char *reason)
	Helper method to generate a packet containing a CONNECTION_CLOSE and send it.
int	imquic_serialize_packet (imquic_connection *conn, imquic_packet *pkt)
	Serialize an imquic packet object to a QUIC packet ready to be sent, taking care of header protection and encryption as well.
int	imquic_send_packet (imquic_connection *conn, imquic_packet *pkt)
	Send a QUIC packet to the peer.
int	imquic_retransmit_packet (imquic_connection *conn, imquic_sent_packet *sent_pkt)
	Retransmit a previously sent packet.

Detailed Description

QUIC stack implementation (headers)

Author

Lorenzo Miniero loren.nosp@m.zo@m.nosp@m.eetec.nosp@m.ho.c.nosp@m.om

Copyright

MIT License

Implementation of the QUIC stack itself. This is where message parsing and building is implemented, including connection establishment and (mostly) state management.

Typedef Documentation

imquic_frame

typedef struct imquic_frame imquic_frame

A serialized QUIC frame.

Note

This is only used as part of imquic_packet instances to reconstruct messages with important frames we need to retransmit

imquic_frame_type

typedef enum imquic_frame_type imquic_frame_type

QUIC frame types.

imquic_long_packet_type

typedef enum imquic_long_packet_type imquic_long_packet_type

QUIC long packet types.

Note

We don't support 0-RTT and Retry tey, at the moment

imquic_packet

typedef struct imquic_packet imquic_packet

Abstraction of a QUIC packet.

imquic_sent_packet

typedef struct imquic_sent_packet imquic_sent_packet

Info on a sent packet.

Note

This is only used to retrieve info on a sent packet when parsing an ACK

imquic_transport_parameter

typedef enum imquic_transport_parameter imquic_transport_parameter

QUIC transport parameters.

Enumeration Type Documentation

imquic_frame_type

enum imquic_frame_type

QUIC frame types.

Enumerator
IMQUIC_PADDING
IMQUIC_PING
IMQUIC_ACK
IMQUIC_ACK_WITH_ECN
IMQUIC_RESET_STREAM
IMQUIC_STOP_SENDING
IMQUIC_CRYPTO
IMQUIC_NEW_TOKEN
IMQUIC_STREAM
IMQUIC_STREAM_F
IMQUIC_STREAM_L
IMQUIC_STREAM_LF
IMQUIC_STREAM_O
IMQUIC_STREAM_OF
IMQUIC_STREAM_OL
IMQUIC_STREAM_OLF
IMQUIC_MAX_DATA
IMQUIC_MAX_STREAM_DATA
IMQUIC_MAX_STREAMS
IMQUIC_MAX_STREAMS_UNI
IMQUIC_DATA_BLOCKED
IMQUIC_STREAM_DATA_BLOCKED
IMQUIC_STREAMS_BLOCKED
IMQUIC_STREAMS_BLOCKED_UNI
IMQUIC_NEW_CONNECTION_ID
IMQUIC_RETIRE_CONNECTION_ID
IMQUIC_PATH_CHALLENGE
IMQUIC_PATH_RESPONSE
IMQUIC_CONNECTION_CLOSE
IMQUIC_CONNECTION_CLOSE_APP
IMQUIC_HANDSHAKE_DONE
IMQUIC_DATAGRAM
IMQUIC_DATAGRAM_L

imquic_long_packet_type

enum imquic_long_packet_type

QUIC long packet types.

Note

We don't support 0-RTT and Retry tey, at the moment

Enumerator
IMQUIC_INITIAL
IMQUIC_0RTT
IMQUIC_HANDSHAKE
IMQUIC_RETRY

imquic_transport_parameter

enum imquic_transport_parameter

QUIC transport parameters.

Enumerator
IMQUIC_ORIGINAL_DESTINATION_CONNECTION_ID
IMQUIC_MAX_IDLE_TIMEOUT
IMQUIC_STATELESS_RESET_TOKEN
IMQUIC_MAX_UDP_PAYLOAD_SIZE
IMQUIC_INITIAL_MAX_DATA
IMQUIC_INITIAL_MAX_STREAM_DATA_BIDI_LOCAL
IMQUIC_INITIAL_MAX_STREAM_DATA_BIDI_REMOTE
IMQUIC_INITIAL_MAX_STREAM_DATA_UNI
IMQUIC_INITIAL_MAX_STREAMS_BIDI
IMQUIC_INITIAL_MAX_STREAMS_UNI
IMQUIC_ACK_DELAY_EXPONENT
IMQUIC_MAX_ACK_DELAY
IMQUIC_DISABLE_ACTIVE_MIGRATION
IMQUIC_PREFERRED_ADDRESS
IMQUIC_ACTIVE_CONNECTION_ID_LIMIT
IMQUIC_INITIAL_SOURCE_CONNECTION_ID
IMQUIC_RETRY_SOURCE_CONNECTION_ID
IMQUIC_MAX_DATAGRAM_FRAME_SIZE

Function Documentation

imquic_check_incoming_crypto()

void imquic_check_incoming_crypto

(

imquic_connection *

conn

)

Helper method to check if we received CRYPTO frames we need to go through, and in case pass them to the TLS stack for processing.

Parameters

conn	The imquic_connection to check

imquic_check_incoming_stream()

void imquic_check_incoming_stream

(

imquic_connection *

conn

)

Helper method to check if we received STREAM frames we need to go process, and handle ourselves or pass to the application layer.

Parameters

conn	The imquic_connection to check

imquic_frame_create()

imquic_frame * imquic_frame_create	(	imquic_frame_type	type,
		uint8_t *	buffer,
		size_t	size )

Helper method to create a imquic_frame instance.

Parameters

type	The type of frame
buffer	The content of the frame
size	The size of the frame

Returns

A pointer to a imquic_frame instance, if successful, or NULL otherwise

imquic_frame_destroy()

void imquic_frame_destroy

(

imquic_frame *

frame

)

Helper method to destroy an existing imquic_frame instance.

Parameters

frame

The imquic_frame instanceto destroy

imquic_frame_type_str()

const char * imquic_frame_type_str

(

imquic_frame_type

type

)

Helper function to serialize to string the name of a imquic_frame_type value.

Parameters

type	The imquic_frame_type value

Returns

The type name as a string, if valid, or NULL otherwise

imquic_handle_event()

gboolean imquic_handle_event

(

imquic_connection *

conn

)

Callback fired when the event loop has an event for a specific connection.

Note

At the moment, this is used as a way to use the event loop to check if/when we have stuff to send (e.g., ACKs, data, etc.).

Parameters

conn	The imquic_connection instance the event is for

Returns

G_SOURCE_CONTINUE if the event should be fired again in the future, G_SOURCE_REMOVE otherwise

imquic_long_packet_type_str()

const char * imquic_long_packet_type_str

(

imquic_long_packet_type

type

)

Helper function to serialize to string the name of a imquic_long_packet_type value.

Parameters

type	The imquic_long_packet_type value

Returns

The type name as a string, if valid, or NULL otherwise

imquic_packet_create()

imquic_packet * imquic_packet_create

(

void

)

Helper method to create a imquic_packet instance.

Returns

A pointer to a imquic_packet instance, if successful, or NULL otherwise

imquic_packet_destroy()

void imquic_packet_destroy

(

imquic_packet *

pkt

)

Helper method to destroy an existing imquic_packet instance.

Parameters

pkt	The imquic_packet instance to destroy

imquic_packet_long_init()

int imquic_packet_long_init	(	imquic_packet *	pkt,
		imquic_long_packet_type	type,
		imquic_connection_id *	src,
		imquic_connection_id *	dest )

Initialize a imquic_packet instance as a long header packet.

Parameters

pkt	The imquic_packet instance to initialize
type	The imquic_long_packet_type type of long header packet (e.g., Initial)
src	The Source Connection ID to put in the packet, if any
dest	The Destination Connection ID to put in the packet, if any

Returns

0 in case of success, or a negative integer otherwise

imquic_packet_short_init()

int imquic_packet_short_init	(	imquic_packet *	pkt,
		imquic_connection_id *	dest )

Initialize a imquic_packet instance as a short header packet.

Parameters

pkt	The imquic_packet instance to initialize
dest	The Destination Connection ID to put in the packet, if any

Returns

0 in case of success, or a negative integer otherwise

imquic_parse_frames()

int imquic_parse_frames	(	imquic_connection *	conn,
		imquic_packet *	pkt )

Parse QUIC frames in a QUIC message payload.

Note

The state of the connection will be updated as the message is parsed, as some frames will trigger a change of state, while others will fill some buffers that we may need to process later.

Parameters

conn	The imquic_connection that received the message
pkt	The imquic_packet containing the payload to process returns 0 in case of success, a negative integer otherwise

imquic_parse_packet()

int imquic_parse_packet	(	imquic_network_endpoint *	socket,
		imquic_network_address *	sender,
		imquic_connection **	pconn,
		imquic_packet *	pkt,
		uint8_t *	quic,
		size_t	bytes )

Parse a QUIC packet from an incoming buffer and handle it.

Note

Considering a UDP message may contain more than one QUIC message, this function returns the size of the QUIC message it finds at the beginning of the buffer, so that, in case there's still more data to process, the caller can call the function again after shifting the pointer.

Parameters

[in]	socket	The endpoint that received the QUIC packet
[in]	sender	The network address of who sent this packet
[out]	pconn	After parsing the packet, this will be filled with the imquic_connection associated with it
[out]	pkt	The imquic_packet instance to write the result of the parsing to
[in]	quic	The buffer containing the QUIC packet
[in]	bytes	Size of the buffer containing the QUIC packet

Returns

The size of the parsed packet, if successfuk, or a negative integer otherwise

imquic_parse_transport_parameters()

int imquic_parse_transport_parameters	(	imquic_connection *	conn,
		uint8_t *	bytes,
		size_t	blen )

Helper to parse a buffer containing QUIC transport parameters, and update the associated imquic_connection instance accordingly.

Parameters

conn	The imquic_connection instance to update with the peer parameters
bytes	The buffer containing the QUIC transport parameters
blen	The size of the buffer to parse

Returns

0 in case of success, a negative integer otherwise

imquic_payload_add_ack()

size_t imquic_payload_add_ack	(	uint8_t *	bytes,
		size_t	blen,
		GList *	received,
		uint64_t	delay,
		uint64_t *	ecn_counts )

Helper method to add a ACK frame to a buffer.

Parameters

bytes	Buffer to add the frame to
blen	Size of the buffer
received	The list of packets we did receive
delay	The value to put in the delay part of the frame
ecn_counts	Array of three ECN-related properties to put in the frame, if any

Returns

The size of the frame, if successful, or 0 otherwise

imquic_payload_add_connection_close()

size_t imquic_payload_add_connection_close	(	uint8_t *	bytes,
		size_t	blen,
		imquic_error_code	error_code,
		imquic_frame_type	frame_type,
		const char *	reason )

Helper method to add a CONNECTION_CLOSE frame to a buffer.

Parameters

bytes	Buffer to add the frame to
blen	Size of the buffer
error_code	Error code to report in the frame
frame_type	The frame type that caused the connection to be closed
reason	A verbose description of the error, if any

Returns

The size of the frame, if successful, or 0 otherwise

imquic_payload_add_crypto()

size_t imquic_payload_add_crypto	(	uint8_t *	bytes,
		size_t	blen,
		uint8_t *	crypto,
		size_t	crypto_offset,
		size_t	crypto_length )

Helper method to add a CRYPTO frame to a buffer.

Parameters

bytes	Buffer to add the frame to
blen	Size of the buffer
crypto	Buffer containing the TLS data to send
crypto_offset	Offset this TLS data is at, relatively to the whole CRYPTO exchange
crypto_length	Size of the TLS data buffer

Returns

The size of the frame, if successful, or 0 otherwise

imquic_payload_add_data_blocked()

size_t imquic_payload_add_data_blocked	(	uint8_t *	bytes,
		size_t	blen,
		uint64_t	max_data )

Helper method to add a DATA_BLOCKED frame to a buffer.

Parameters

bytes	Buffer to add the frame to
blen	Size of the buffer
max_data	The limit at which the blocking occurred

Returns

The size of the frame, if successful, or 0 otherwise

imquic_payload_add_datagram()

size_t imquic_payload_add_datagram	(	uint8_t *	bytes,
		size_t	blen,
		uint8_t *	datagram,
		size_t	datagram_length,
		gboolean	last )

Helper method to add a DATAGRAM frame to a buffer.

Parameters

bytes	Buffer to add the frame to
blen	Size of the buffer
datagram	Buffer containing the datagram data to send
datagram_length	Size of the datagram data buffer
last	Whether this is the last frame in the packet, and so we can omit the Length field

Returns

The size of the frame, if successful, or 0 otherwise

imquic_payload_add_handshake_done()

size_t imquic_payload_add_handshake_done	(	uint8_t *	bytes,
		size_t	blen )

Helper method to add a HANDSHAKE_DONE frame to a buffer.

Parameters

bytes	Buffer to add the frame to
blen	Size of the buffer

Returns

The size of the frame, if successful, or 0 otherwise

imquic_payload_add_max_data()

size_t imquic_payload_add_max_data	(	uint8_t *	bytes,
		size_t	blen,
		uint64_t	max_data )

Helper method to add a MAX_DATA frame to a buffer.

Parameters

bytes	Buffer to add the frame to
blen	Size of the buffer
max_data	The new value to report

Returns

The size of the frame, if successful, or 0 otherwise

imquic_payload_add_max_stream_data()

size_t imquic_payload_add_max_stream_data	(	uint8_t *	bytes,
		size_t	blen,
		uint64_t	stream_id,
		uint64_t	max_data )

Helper method to add a MAX_STREAM_DATA frame to a buffer.

Parameters

bytes	Buffer to add the frame to
blen	Size of the buffer
stream_id	ID of the stream this new limit applies to
max_data	The new value to report

Returns

The size of the frame, if successful, or 0 otherwise

imquic_payload_add_max_streams()

size_t imquic_payload_add_max_streams	(	uint8_t *	bytes,
		size_t	blen,
		gboolean	bidirectional,
		uint64_t	max_streams )

Helper method to add a MAX_STREAMS frame to a buffer.

Parameters

bytes	Buffer to add the frame to
blen	Size of the buffer
bidirectional	Whether this impacts bidirectional or unidirectional streams
max_streams	The new value to report

Returns

The size of the frame, if successful, or 0 otherwise

imquic_payload_add_new_connection_id()

size_t imquic_payload_add_new_connection_id	(	uint8_t *	bytes,
		size_t	blen,
		uint64_t	seqnum,
		uint64_t	retire_prior_to,
		imquic_connection_id *	cid,
		uint8_t *	reset_token )

Helper method to add a NEW_CONNECTION_ID frame to a buffer.

Parameters

bytes	Buffer to add the frame to
blen	Size of the buffer
seqnum	Sequence number of the Connection ID
retire_prior_to	Connection IDs that should be retired
cid	The Connection ID value
reset_token	Stateless reset token

Returns

The size of the frame, if successful, or 0 otherwise

imquic_payload_add_new_token()

size_t imquic_payload_add_new_token	(	uint8_t *	bytes,
		size_t	blen,
		uint8_t *	token,
		size_t	token_length )

Helper method to add a NEW_TOKEN frame to a buffer.

Parameters

bytes	Buffer to add the frame to
blen	Size of the buffer
token	Buffer containing the token to add
token_length	Size of the token buffer

Returns

The size of the frame, if successful, or 0 otherwise

imquic_payload_add_padding()

size_t imquic_payload_add_padding	(	uint8_t *	bytes,
		size_t	blen,
		size_t	padding )

Helper method to add a PADDING frame to a buffer.

Parameters

bytes	Buffer to add the frame to
blen	Size of the buffer
padding	How many bytes of padding to add

Returns

The size of the frame, if successful, or 0 otherwise

imquic_payload_add_path_challenge()

size_t imquic_payload_add_path_challenge	(	uint8_t *	bytes,
		size_t	blen,
		uint8_t *	data )

Helper method to add a PATH_CHALLENGE frame to a buffer.

Parameters

bytes	Buffer to add the frame to
blen	Size of the buffer
data	Data to send as part of the challenge

Returns

The size of the frame, if successful, or 0 otherwise

imquic_payload_add_path_response()

size_t imquic_payload_add_path_response	(	uint8_t *	bytes,
		size_t	blen,
		uint8_t *	data )

Helper method to add a PATH_RESPONSE frame to a buffer.

Parameters

bytes	Buffer to add the frame to
blen	Size of the buffer
data	Data to send as part of the response

Returns

The size of the frame, if successful, or 0 otherwise

imquic_payload_add_ping()

size_t imquic_payload_add_ping	(	uint8_t *	bytes,
		size_t	blen )

Helper method to add a PING frame to a buffer.

Parameters

bytes	Buffer to add the frame to
blen	Size of the buffer

Returns

The size of the frame, if successful, or 0 otherwise

imquic_payload_add_reset_stream()

size_t imquic_payload_add_reset_stream	(	uint8_t *	bytes,
		size_t	blen,
		uint64_t	stream_id,
		uint64_t	error_code,
		uint64_t	final_size )

Helper method to add a RESET_STREAM frame to a buffer.

Parameters

bytes	Buffer to add the frame to
blen	Size of the buffer
stream_id	ID of the stream to reset
error_code	Error code to report in the frame
final_size	Final size to report in the frame

Returns

The size of the frame, if successful, or 0 otherwise

imquic_payload_add_retire_connection_id()

size_t imquic_payload_add_retire_connection_id	(	uint8_t *	bytes,
		size_t	blen,
		uint64_t	seqnum )

Helper method to add a RETIRE_CONNECTION_ID frame to a buffer.

Parameters

bytes	Buffer to add the frame to
blen	Size of the buffer
seqnum	Sequence number of the Connection ID to retire

Returns

The size of the frame, if successful, or 0 otherwise

imquic_payload_add_stop_sending()

size_t imquic_payload_add_stop_sending	(	uint8_t *	bytes,
		size_t	blen,
		uint64_t	stream_id,
		uint64_t	error_code )

Helper method to add a STOP_SENDING frame to a buffer.

Parameters

bytes	Buffer to add the frame to
blen	Size of the buffer
stream_id	ID of the stream whose sending must stop
error_code	Error code to report in the frame

Returns

The size of the frame, if successful, or 0 otherwise

imquic_payload_add_stream()

size_t imquic_payload_add_stream	(	uint8_t *	bytes,
		size_t	blen,
		uint64_t	stream_id,
		uint8_t *	stream,
		size_t	stream_offset,
		size_t	stream_length,
		gboolean	complete,
		gboolean	last )

Helper method to add a STREAM frame to a buffer.

Parameters

bytes	Buffer to add the frame to
blen	Size of the buffer
stream_id	ID of the stream this data belongs to
stream	Buffer containing the stream data to send
stream_offset	Offset this stream data is at, relatively to the whole STREAM exchange
stream_length	Size of the stream data buffer
complete	Whether this data marks the end of the STREAM in this direction
last	Whether this is the last frame in the packet, and so we can omit the Length field

Returns

The size of the frame, if successful, or 0 otherwise

imquic_payload_add_stream_data_blocked()

size_t imquic_payload_add_stream_data_blocked	(	uint8_t *	bytes,
		size_t	blen,
		uint64_t	stream_id,
		uint64_t	max_data )

Helper method to add a STREAM_DATA_BLOCKED frame to a buffer.

Parameters

bytes	Buffer to add the frame to
blen	Size of the buffer
stream_id	ID of the stream that has been blocked
max_data	The limit at which the blocking occurred

Returns

The size of the frame, if successful, or 0 otherwise

imquic_payload_add_streams_blocked()

size_t imquic_payload_add_streams_blocked	(	uint8_t *	bytes,
		size_t	blen,
		uint64_t	max_streams )

Helper method to add a STREAMS_BLOCKED frame to a buffer.

Parameters

bytes	Buffer to add the frame to
blen	Size of the buffer
max_streams	The limit at which the blocking occurred

Returns

The size of the frame, if successful, or 0 otherwise

imquic_payload_parse_ack()

size_t imquic_payload_parse_ack	(	imquic_connection *	conn,
		uint8_t *	bytes,
		size_t	blen,
		enum ssl_encryption_level_t	level )

Helper method to process an ACK frame.

Parameters

conn	The imquic_connection that received the message
bytes	Buffer containing the frame
blen	Size of the buffer containing the frame
level	Encryption level of the packet containing this frame

Returns

The size of the frame, if successful, or 0 otherwise

imquic_payload_parse_connection_close()

size_t imquic_payload_parse_connection_close	(	imquic_connection *	conn,
		uint8_t *	bytes,
		size_t	blen )

Helper method to process a CONNECTION_CLOSE frame, and handle it accordingly by closing the connection locally too.

Parameters

conn	The imquic_connection that received the message
bytes	Buffer containing the frame
blen	Size of the buffer containing the frame

Returns

The size of the frame, if successful, or 0 otherwise

imquic_payload_parse_crypto()

size_t imquic_payload_parse_crypto	(	imquic_connection *	conn,
		uint8_t *	bytes,
		size_t	blen,
		enum ssl_encryption_level_t	level )

Helper method to process a CRYPTO frame, and in case add all chunks to the buffer associated with the related encryption level, so that it can be processed later.

Parameters

conn	The imquic_connection that received the message
bytes	Buffer containing the frame
blen	Size of the buffer containing the frame
level	Encryption level of the packet containing this frame

Returns

The size of the frame, if successful, or 0 otherwise

imquic_payload_parse_data_blocked()

size_t imquic_payload_parse_data_blocked	(	imquic_connection *	conn,
		uint8_t *	bytes,
		size_t	blen )

Helper method to process a DATA_BLOCKED frame.

Parameters

conn	The imquic_connection that received the message
bytes	Buffer containing the frame
blen	Size of the buffer containing the frame

Returns

The size of the frame, if successful, or 0 otherwise

imquic_payload_parse_datagram()

size_t imquic_payload_parse_datagram	(	imquic_connection *	conn,
		uint8_t *	bytes,
		size_t	blen )

Helper method to process a DATAGRAM frame, and notify the stack about it via internal callbacks.

Parameters

conn	The imquic_connection that received the message
bytes	Buffer containing the frame
blen	Size of the buffer containing the frame

Returns

The size of the frame, if successful, or 0 otherwise

imquic_payload_parse_max_data()

size_t imquic_payload_parse_max_data	(	imquic_connection *	conn,
		uint8_t *	bytes,
		size_t	blen )

Helper method to process a MAX_DATA frame.

Parameters

conn	The imquic_connection that received the message
bytes	Buffer containing the frame
blen	Size of the buffer containing the frame

Returns

The size of the frame, if successful, or 0 otherwise

imquic_payload_parse_max_stream_data()

size_t imquic_payload_parse_max_stream_data	(	imquic_connection *	conn,
		uint8_t *	bytes,
		size_t	blen )

Helper method to process a MAX_STREAM_DATA frame.

Parameters

conn	The imquic_connection that received the message
bytes	Buffer containing the frame
blen	Size of the buffer containing the frame

Returns

The size of the frame, if successful, or 0 otherwise

imquic_payload_parse_max_streams()

size_t imquic_payload_parse_max_streams	(	imquic_connection *	conn,
		uint8_t *	bytes,
		size_t	blen )

Helper method to process a MAX_STREAMS frame.

Parameters

conn	The imquic_connection that received the message
bytes	Buffer containing the frame
blen	Size of the buffer containing the frame

Returns

The size of the frame, if successful, or 0 otherwise

imquic_payload_parse_new_connection_id()

size_t imquic_payload_parse_new_connection_id	(	imquic_connection *	conn,
		uint8_t *	bytes,
		size_t	blen )

Helper method to process a NEW_CONNECTION_ID frame.

Parameters

conn	The imquic_connection that received the message
bytes	Buffer containing the frame
blen	Size of the buffer containing the frame

Returns

The size of the frame, if successful, or 0 otherwise

imquic_payload_parse_new_token()

size_t imquic_payload_parse_new_token	(	imquic_connection *	conn,
		uint8_t *	bytes,
		size_t	blen )

Helper method to process a NEW_TOKEN frame.

Parameters

conn	The imquic_connection that received the message
bytes	Buffer containing the frame
blen	Size of the buffer containing the frame

Returns

The size of the frame, if successful, or 0 otherwise

imquic_payload_parse_path_challenge()

size_t imquic_payload_parse_path_challenge	(	imquic_connection *	conn,
		uint8_t *	bytes,
		size_t	blen )

Helper method to process a PATH_CHALLENGE frame.

Parameters

conn	The imquic_connection that received the message
bytes	Buffer containing the frame
blen	Size of the buffer containing the frame

Returns

The size of the frame, if successful, or 0 otherwise

imquic_payload_parse_path_response()

size_t imquic_payload_parse_path_response	(	imquic_connection *	conn,
		uint8_t *	bytes,
		size_t	blen )

Helper method to process a PATH_RESPONSE frame.

Parameters

conn	The imquic_connection that received the message
bytes	Buffer containing the frame
blen	Size of the buffer containing the frame

Returns

The size of the frame, if successful, or 0 otherwise

imquic_payload_parse_reset_stream()

size_t imquic_payload_parse_reset_stream	(	imquic_connection *	conn,
		uint8_t *	bytes,
		size_t	blen )

Helper method to process a RESET_STREAM frame.

Parameters

conn	The imquic_connection that received the message
bytes	Buffer containing the frame
blen	Size of the buffer containing the frame

Returns

The size of the frame, if successful, or 0 otherwise

imquic_payload_parse_retire_connection_id()

size_t imquic_payload_parse_retire_connection_id	(	imquic_connection *	conn,
		uint8_t *	bytes,
		size_t	blen )

Helper method to process a RETIRE_CONNECTION_ID frame.

Parameters

conn	The imquic_connection that received the message
bytes	Buffer containing the frame
blen	Size of the buffer containing the frame

Returns

The size of the frame, if successful, or 0 otherwise

imquic_payload_parse_stop_sending()

size_t imquic_payload_parse_stop_sending	(	imquic_connection *	conn,
		uint8_t *	bytes,
		size_t	blen )

Helper method to process a STOP_SENDING frame.

Parameters

conn	The imquic_connection that received the message
bytes	Buffer containing the frame
blen	Size of the buffer containing the frame

Returns

The size of the frame, if successful, or 0 otherwise

imquic_payload_parse_stream()

size_t imquic_payload_parse_stream	(	imquic_connection *	conn,
		uint8_t *	bytes,
		size_t	blen )

Helper method to process a STREAM frame, and handle it accordingly, e.g., by creating the stream locally (if previously unknown), update the associated buffer with the new data, update the state of the stream, and notify the stack using internal callbacks.

Parameters

conn	The imquic_connection that received the message
bytes	Buffer containing the frame
blen	Size of the buffer containing the frame

Returns

The size of the frame, if successful, or 0 otherwise

imquic_payload_parse_stream_data_blocked()

size_t imquic_payload_parse_stream_data_blocked	(	imquic_connection *	conn,
		uint8_t *	bytes,
		size_t	blen )

Helper method to process a STREAM_DATA_BLOCKED frame.

Parameters

conn	The imquic_connection that received the message
bytes	Buffer containing the frame
blen	Size of the buffer containing the frame

Returns

The size of the frame, if successful, or 0 otherwise

imquic_payload_parse_streams_blocked()

size_t imquic_payload_parse_streams_blocked	(	imquic_connection *	conn,
		uint8_t *	bytes,
		size_t	blen )

Helper method to process a STREAMS_BLOCKED frame.

Parameters

conn	The imquic_connection that received the message
bytes	Buffer containing the frame
blen	Size of the buffer containing the frame

Returns

The size of the frame, if successful, or 0 otherwise

imquic_process_message()

void imquic_process_message	(	imquic_network_endpoint *	socket,
		imquic_network_address *	sender,
		uint8_t *	quic,
		size_t	bytes )

Process incoming data from the network we've made aware of.

Note

A client or server endpoint will receive data regularly: it's this function's responsability to traverse the buffers that are received, to parse one or more messages that may be in a UDP message using potentially multiple calls to imquic_parse_packet.

Parameters

[in]	socket	The endpoint that received the data
[in]	sender	The network address of who sent this data
[in]	quic	The buffer containing the data
[in]	bytes	Size of the buffer containing the data

imquic_quic_connection_add()

void imquic_quic_connection_add	(	imquic_connection *	conn,
		imquic_connection_id *	cid )

Track a Connection ID and map it to a connection.

Note

This will add a reference to the connections

Parameters

conn	The imquic_connection instance the ID is associated with
cid	The imquic_connection_id Connection ID instance

imquic_quic_connection_remove()

void imquic_quic_connection_remove

(

imquic_connection_id *

cid

)

Stop tracking a Connection ID associated to a connection.

Note

This will unref the connection, if a mapping exists

Parameters

cid	The imquic_connection_id Connection ID instance

imquic_quic_deinit()

void imquic_quic_deinit

(

void

)

Uninitialize the QUIC stack.

imquic_quic_init()

void imquic_quic_init

(

void

)

Initialize the QUIC stack at startup.

imquic_retransmit_packet()

int imquic_retransmit_packet	(	imquic_connection *	conn,
		imquic_sent_packet *	sent_pkt )

Retransmit a previously sent packet.

Parameters

conn	The imquic_connection to retransmit the message on
sent_pkt	The imquic_sent_packet containing the packet to retransmit

Returns

0 in case of success, or a negative integer otherwise

imquic_send_ack()

int imquic_send_ack	(	imquic_connection *	conn,
		enum ssl_encryption_level_t	level,
		imquic_connection_id *	src,
		imquic_connection_id *	dest )

Helper method to generate a packet containing an ACK and send it.

Note

This may include a few other frames too, in case the stack thinks they're needed

Parameters

conn	The imquic_connection to send the message on
level	The encryption level at which the message should be sent
src	The source Connection ID, if any
dest	The destinatiob Connection ID, if any

Returns

0 in case of success, or a negative integer otherwise

imquic_send_close_connection()

int imquic_send_close_connection	(	imquic_connection *	conn,
		imquic_error_code	error_code,
		imquic_frame_type	frame_type,
		const char *	reason )

Helper method to generate a packet containing a CONNECTION_CLOSE and send it.

Note

This may include a few other frames too, in case the stack thinks they're neede

Parameters

conn	The imquic_connection to send the message on
error_code	Error code to report in the frame
frame_type	The frame type that caused the connection to be closed
reason	A verbose description of the error, if any

Returns

0 in case of success, or a negative integer otherwise

imquic_send_keepalive()

int imquic_send_keepalive	(	imquic_connection *	conn,
		imquic_connection_id *	dest )

Helper method to generate a packet containing a PING and send it.

Note

This may include a few other frames too, in case the stack thinks they're neede

Parameters

conn	The imquic_connection to send the message on
dest	The destinatiob Connection ID, if any

Returns

0 in case of success, or a negative integer otherwise

imquic_send_packet()

int imquic_send_packet	(	imquic_connection *	conn,
		imquic_packet *	pkt )

Send a QUIC packet to the peer.

Note

The imquic_packet instance should not be accessed after this call, as it will either be freed (not needed anymore), or stored in a map in case we need to retransmit it later if ACKs tell us to

Parameters

conn	The imquic_connection to send the message on
pkt	The imquic_packet containing the packet to send

Returns

0 in case of success, or a negative integer otherwise

imquic_send_pending_crypto()

int imquic_send_pending_crypto	(	imquic_connection *	conn,
		imquic_connection_id *	src,
		imquic_connection_id *	dest )

Helper method to generate one or more packets containing one or more CRYPTO frames and send them.

Note

This may include a few other frames too, in case the stack thinks they're needed

Parameters

conn	The imquic_connection to send the message(s) on
src	The source Connection ID, if any
dest	The destinatiob Connection ID, if any

Returns

0 in case of success, or a negative integer otherwise

imquic_send_pending_datagram()

int imquic_send_pending_datagram	(	imquic_connection *	conn,
		imquic_connection_id *	dest )

Helper method to generate one or more packets containing one or more DATAGRAM frames and send them.

Note

This may include a few other frames too, in case the stack thinks they're neede

Parameters

conn	The imquic_connection to send the message(s) on
dest	The destinatiob Connection ID, if any

Returns

0 in case of success, or a negative integer otherwise

imquic_send_pending_stream()

int imquic_send_pending_stream	(	imquic_connection *	conn,
		imquic_connection_id *	dest )

Helper method to generate one or more packets containing one or more STREAM frames and send them.

Note

This may include a few other frames too, in case the stack thinks they're neede

Parameters

conn	The imquic_connection to send the message(s) on
dest	The destinatiob Connection ID, if any

Returns

0 in case of success, or a negative integer otherwise

imquic_sent_packet_destroy()

void imquic_sent_packet_destroy

(

imquic_sent_packet *

sent_pkt

)

Helper method to destroy an existing imquic_sent_packet instance.

Parameters

sent_pkt

The imquic_sent_packet instance to destroy

imquic_serialize_packet()

int imquic_serialize_packet	(	imquic_connection *	conn,
		imquic_packet *	pkt )

Serialize an imquic packet object to a QUIC packet ready to be sent, taking care of header protection and encryption as well.

Parameters

conn	The imquic_connection to serialize the packet for
pkt	The imquic_packet containing the packet to serialize

Returns

0 in case of success, or a negative integer otherwise

imquic_start_quic_client()

int imquic_start_quic_client

(

imquic_network_endpoint *

socket

)

Helper to start a new client endpoint, and so attempt a connection.

Note

This is not a blocking method: it will only kickstart the connection process, but it will not wait for it to succeed or fail. There will be asynchronous callbacks fired to handle those events instead.

Parameters

socket

The network endpoint to start the connection from

Returns

0 in case of success, a negative integer otherwise

imquic_transport_parameter_add_connection_id()

size_t imquic_transport_parameter_add_connection_id	(	uint8_t *	bytes,
		size_t	blen,
		imquic_transport_parameter	param,
		imquic_connection_id *	cid )

Helper to add a QUIC transport parameter with a Connection ID to a buffer.

Parameters

bytes	Buffer to add the transport parameter to
blen	Size of the buffer
param	ID of the parameter to add
cid	The Connection ID value of the parameter to add

Returns

The size of the parameter, if successful, or 0 otherwise

imquic_transport_parameter_add_data()

size_t imquic_transport_parameter_add_data	(	uint8_t *	bytes,
		size_t	blen,
		imquic_transport_parameter	param,
		uint8_t *	buf,
		size_t	buflen )

Helper to add a QUIC transport parameter with generic data to a buffer.

Parameters

bytes	Buffer to add the transport parameter to
blen	Size of the buffer
param	ID of the parameter to add
buf	The data acting as a value for the parameter to add
buflen	The size of the data value

Returns

The size of the parameter, if successful, or 0 otherwise

imquic_transport_parameter_add_int()

size_t imquic_transport_parameter_add_int	(	uint8_t *	bytes,
		size_t	blen,
		imquic_transport_parameter	param,
		uint64_t	number )

Helper to add a QUIC transport parameter with a numeric value to a buffer.

Parameters

bytes	Buffer to add the transport parameter to
blen	Size of the buffer
param	ID of the parameter to add
number	The numeric value of the parameter to add

Returns

The size of the parameter, if successful, or 0 otherwise

imquic_transport_parameter_add_novalue()

size_t imquic_transport_parameter_add_novalue	(	uint8_t *	bytes,
		size_t	blen,
		imquic_transport_parameter	param )

Helper to add a QUIC transport parameter with no value to a buffer.

Parameters

bytes	Buffer to add the transport parameter to
blen	Size of the buffer
param	ID of the parameter to add

Returns

The size of the parameter, if successful, or 0 otherwise

imquic_transport_parameter_str()

const char * imquic_transport_parameter_str

(

imquic_transport_parameter

param

)

Helper function to serialize to string the name of a imquic_transport_parameter value.

Parameters

param

The imquic_transport_parameter value

Returns

The param name as a string, if valid, or NULL otherwise