moq.c File Reference

Media Over QUIC (MoQ) stack. More...

#include <arpa/inet.h>
#include "internal/moq.h"
#include "internal/connection.h"
#include "internal/version.h"
#include "imquic/debug.h"

Include dependency graph for moq.c:

Macros
#define	IMQUIC_MOQ_LOG_VERB   IMQUIC_LOG_HUGE
#define	IMQUIC_MOQ_LOG_HUGE   IMQUIC_LOG_VERB
#define	IMQUIC_MOQ_REQUEST_ID_INCREMENT   2
#define	IMQUIC_MOQ_CHECK_ERR(cond, error, code, res, reason)
#define	IMQUIC_MOQ_PARSE_NAMESPACES(request, tns_num, i, error_message, last)
#define	IMQUIC_MOQ_PARSE_TRACKNAME(error_message, last)
#define	IMQUIC_MOQ_ADD_NAMESPACES(request)
#define	IMQUIC_MOQ_ADD_TRACKNAME(request)
#define	IMQUIC_MOQ_ADD_MESSAGE_TYPE(type)
#define	IMQUIC_MOQ_ADD_MESSAGE_LENGTH()

Functions
void	imquic_moq_init (void)
	Initialize the native MoQ stack at startup.
void	imquic_moq_deinit (void)
	Uninitialize the native MoQ stack.
void	imquic_moq_new_connection (imquic_connection *conn, void *user_data)
	Callback the core invokes when a new QUIC connection using MoQ is available.
void	imquic_moq_stream_incoming (imquic_connection *conn, uint64_t stream_id, uint8_t *bytes, uint64_t length, gboolean complete)
	Callback the core invokes when there's new incoming data on a STREAM.
void	imquic_moq_datagram_incoming (imquic_connection *conn, uint8_t *bytes, uint64_t length)
	Callback the core invokes when there's new incoming data on a DATAGRAM.
void	imquic_moq_reset_stream_incoming (imquic_connection *conn, uint64_t stream_id, uint64_t error_code)
	Callback the core invokes when there's an incoming RESET_STREAM.
void	imquic_moq_connection_gone (imquic_connection *conn)
	Callback the core invokes when an existing MoQ connection is not available anymore.
const char *	imquic_moq_error_code_str (imquic_moq_error_code code)
	Helper function to serialize to string the name of a imquic_moq_error_code value.
const char *	imquic_moq_request_error_code_str (imquic_moq_request_error_code code)
	Helper function to serialize to string the name of a imquic_moq_request_error_code value.
imquic_moq_legacy_error_code	imquic_moq_request_error_code_to_legacy (imquic_moq_version version, imquic_moq_request_error_code code)
	Helper to translate a new request error code passed by the user to a legacy error code, if serializing on an old version of MoQ.
imquic_moq_request_error_code	imquic_moq_request_error_code_from_legacy (imquic_moq_version version, imquic_moq_legacy_error_code code)
	Helper to translate a legacy error code parsed by the stack to a new request error code, if receiving from an old version of MoQ.
const char *	imquic_moq_pub_done_code_str (imquic_moq_pub_done_code code)
	Helper function to serialize to string the name of a imquic_moq_pub_done_code value.
const char *	imquic_moq_reset_stream_code_str (imquic_moq_reset_stream_code code)
	Helper function to serialize to string the name of a imquic_moq_reset_stream_code value.
const char *	imquic_moq_message_type_str (imquic_moq_message_type type, imquic_moq_version version)
	Helper function to serialize to string the name of a imquic_moq_message_type value.
gboolean	imquic_moq_is_datagram_message_type_valid (imquic_moq_version version, uint8_t type)
	Helper function to check if a type used for OBJECT_DATAGRAM or OBJECT_DATAGRAM_STATUS is valid.
uint8_t	imquic_moq_datagram_message_type_return (imquic_moq_version version, gboolean payload, gboolean ext, gboolean eog, gboolean oid, gboolean priority)
	Helper function to return the imquic_moq_datagram_message_type value for OBJECT_DATAGRAM or OBJECT_DATAGRAM_STATUS out of the individual properties.
void	imquic_moq_datagram_message_type_parse (imquic_moq_version version, uint8_t type, gboolean *payload, gboolean *ext, gboolean *eog, gboolean *oid, gboolean *priority, gboolean *violation)
	Helper function to parse a imquic_moq_datagram_message_type value for OBJECT_DATAGRAM or OBJECT_DATAGRAM_STATUS to the individual properties.
const char *	imquic_moq_datagram_message_type_str (uint8_t type, imquic_moq_version version)
	Helper function to serialize to string the name of a imquic_moq_datagram_message_type value.
gboolean	imquic_moq_is_data_message_type_valid (imquic_moq_version version, uint8_t type)
	Helper function to check if a type used for SUBRGOUP_HEADER is valid.
uint8_t	imquic_moq_data_message_type_from_subgroup_header (imquic_moq_version version, gboolean subgroup, gboolean sgid0, gboolean ext, gboolean eog, gboolean priority)
	Helper function to return the type to use for SUBRGOUP_HEADER out of the individual properties.
void	imquic_moq_data_message_type_to_subgroup_header (imquic_moq_version version, uint8_t type, gboolean *subgroup, gboolean *sgid0, gboolean *ext, gboolean *eog, gboolean *priority, gboolean *violation)
	Helper function to parse a type value for SUBRGOUP_HEADER to the individual properties.
const char *	imquic_moq_data_message_type_str (imquic_moq_data_message_type type, imquic_moq_version version)
	Helper function to serialize to string the name of a imquic_moq_data_message_type value.
imquic_moq_delivery	imquic_moq_data_message_type_to_delivery (imquic_moq_data_message_type type, imquic_moq_version version)
	Helper function to return the imquic_moq_delivery mode associated to a imquic_moq_data_message_type type.
gboolean	imquic_moq_is_fetch_serialization_flags_valid (imquic_moq_version version, uint64_t flags)
	Helper function to check if serialization flags used for FETCH are valid.
uint64_t	imquic_moq_generate_fetch_serialization_flags (imquic_moq_version version, imquic_moq_fetch_subgroup_type subgroup, gboolean oid, gboolean group, gboolean priority, gboolean ext, gboolean datagram, gboolean end_ne_range, gboolean end_uk_range)
	Helper function to return the serialization flags to use for FETCH out of the individual properties.
void	imquic_moq_parse_fetch_serialization_flags (imquic_moq_version version, uint64_t flags, imquic_moq_fetch_subgroup_type *subgroup, gboolean *oid, gboolean *group, gboolean *priority, gboolean *ext, gboolean *datagram, gboolean *end_ne_range, gboolean *end_uk_range, gboolean *violation)
	Helper function to parse serialozation flags for FETCH to the individual properties.
const char *	imquic_moq_setup_parameter_type_str (imquic_moq_setup_parameter_type type)
	Helper function to serialize to string the name of a imquic_moq_setup_parameter_type value.
const char *	imquic_moq_request_parameter_type_str (imquic_moq_request_parameter_type type, imquic_moq_version version)
	Helper function to serialize to string the name of a imquic_moq_request_parameter_type value.
const char *	imquic_moq_filter_type_str (imquic_moq_filter_type type)
	Helper function to serialize to string the name of a imquic_moq_filter_type value.
const char *	imquic_moq_group_order_str (imquic_moq_group_order type)
	Helper function to serialize to string the name of a imquic_moq_group_order value.
const char *	imquic_moq_subscribe_namespace_options_str (imquic_moq_subscribe_namespace_options type)
	Helper function to serialize to string the name of a imquic_moq_subscribe_namespace_options value.
const char *	imquic_moq_fetch_type_str (imquic_moq_fetch_type type)
	Helper function to serialize to string the name of a imquic_moq_fetch_type value.
const char *	imquic_moq_auth_token_alias_type_str (imquic_moq_auth_token_alias_type type)
	Helper function to serialize to string the name of a imquic_moq_auth_token_alias_type property.
size_t	imquic_moq_setup_parameters_serialize (imquic_moq_context *moq, imquic_moq_setup_parameters *parameters, uint8_t *bytes, size_t blen, uint8_t *params_num)
	Helper to serialize a imquic_moq_setup_parameters set to a buffer.
void	imquic_moq_request_parameters_init_defaults (imquic_moq_request_parameters *parameters)
	Helper method to initialize some defaults values (where applicable) for the supported parameters.
size_t	imquic_moq_request_parameters_serialize (imquic_moq_context *moq, imquic_moq_request_parameters *parameters, uint8_t *bytes, size_t blen, uint8_t *params_num)
	Helper to serialize a imquic_moq_request_parameters set to a buffer.
imquic_moq_subscription *	imquic_moq_subscription_create (uint64_t request_id, uint64_t track_alias)
	Helper to create a new subscription instance.
void	imquic_moq_subscription_destroy (imquic_moq_subscription *moq_sub)
	Destroy an existing MoQ subscription.
void	imquic_moq_stream_destroy (imquic_moq_stream *moq_stream)
	Destroy an existing MoQ stream.
int	imquic_moq_parse_message (imquic_moq_context *moq, uint64_t stream_id, uint8_t *bytes, size_t blen, gboolean complete, gboolean datagram)
	Parse an incoming MoQ message.
size_t	imquic_moq_parse_client_setup (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint8_t *error)
	Helper to parse a CLIENT_SETUP message.
size_t	imquic_moq_parse_server_setup (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint8_t *error)
	Helper to parse a SERVER_SETUP message.
size_t	imquic_moq_parse_max_request_id (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint8_t *error)
	Helper to parse a MAX_REQUEST_ID message.
size_t	imquic_moq_parse_requests_blocked (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint8_t *error)
	Helper to parse a REQUESTS_BLOCKED message.
size_t	imquic_moq_parse_request_ok (imquic_moq_context *moq, imquic_moq_stream *moq_stream, uint8_t *bytes, size_t blen, uint8_t *error)
	Helper to parse a REQUEST_OK message.
size_t	imquic_moq_parse_request_error (imquic_moq_context *moq, imquic_moq_stream *moq_stream, uint8_t *bytes, size_t blen, uint8_t *error)
	Helper to parse a REQUEST_ERROR message.
size_t	imquic_moq_parse_publish_namespace (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint8_t *error)
	Helper to parse a PUBLISH_NAMESPACE message.
size_t	imquic_moq_parse_publish_namespace_ok (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint8_t *error)
	Helper to parse a PUBLISH_NAMESPACE_OK message.
size_t	imquic_moq_parse_publish_namespace_error (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint8_t *error)
	Helper to parse a PUBLISH_NAMESPACE_ERROR message.
size_t	imquic_moq_parse_publish_namespace_done (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint8_t *error)
	Helper to parse a PUBLISH_NAMESPACE_DONE message.
size_t	imquic_moq_parse_publish_namespace_cancel (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint8_t *error)
	Helper to parse a PUBLISH_NAMESPACE_CANCEL message.
size_t	imquic_moq_parse_publish (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint8_t *error)
	Helper to parse a PUBLISH message.
size_t	imquic_moq_parse_publish_ok (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint8_t *error)
	Helper to parse a PUBLISH_OK message.
size_t	imquic_moq_parse_publish_error (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint8_t *error)
	Helper to parse a PUBLISH_ERROR message.
size_t	imquic_moq_parse_subscribe (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint8_t *error)
	Helper to parse a SUBSCRIBE message.
size_t	imquic_moq_parse_request_update (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint8_t *error)
	Helper to parse a REQUEST_UPDATE message.
size_t	imquic_moq_parse_subscribe_ok (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint8_t *error)
	Helper to parse a SUBSCRIBE_OK message.
size_t	imquic_moq_parse_subscribe_error (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint8_t *error)
	Helper to parse a SUBSCRIBE_ERROR message.
size_t	imquic_moq_parse_unsubscribe (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint8_t *error)
	Helper to parse an UNSUBSCRIBE message.
size_t	imquic_moq_parse_publish_done (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint8_t *error)
	Helper to parse a PUBLISH_DONE message.
size_t	imquic_moq_parse_subscribe_namespace (imquic_moq_context *moq, imquic_moq_stream *moq_stream, uint8_t *bytes, size_t blen, uint8_t *error)
	Helper to parse a SUBSCRIBE_NAMESPACE message.
size_t	imquic_moq_parse_subscribe_namespace_ok (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint8_t *error)
	Helper to parse a SUBSCRIBE_NAMESPACE_OK message.
size_t	imquic_moq_parse_subscribe_namespace_error (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint8_t *error)
	Helper to parse a SUBSCRIBE_NAMESPACE_ERROR message.
size_t	imquic_moq_parse_unsubscribe_namespace (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint8_t *error)
	Helper to parse an UNSUBSCRIBE_NAMESPACE message.
size_t	imquic_moq_parse_namespace (imquic_moq_context *moq, imquic_moq_stream *moq_stream, uint8_t *bytes, size_t blen, uint8_t *error)
	Helper to parse a NAMESPACE message.
size_t	imquic_moq_parse_namespace_done (imquic_moq_context *moq, imquic_moq_stream *moq_stream, uint8_t *bytes, size_t blen, uint8_t *error)
	Helper to parse a NAMESPACE_DONE message.
size_t	imquic_moq_parse_fetch (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint8_t *error)
	Helper to parse a FETCH message.
size_t	imquic_moq_parse_fetch_cancel (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint8_t *error)
	Helper to parse a FETCH_CANCEL message.
size_t	imquic_moq_parse_fetch_ok (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint8_t *error)
	Helper to parse a FETCH_OK message.
size_t	imquic_moq_parse_fetch_error (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint8_t *error)
	Helper to parse a FETCH_ERROR message.
size_t	imquic_moq_parse_track_status (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint8_t *error)
	Helper to parse a TRACK_STATUS message.
size_t	imquic_moq_parse_track_status_ok (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint8_t *error)
	Helper to parse a TRACK_STATUS_OK message.
size_t	imquic_moq_parse_track_status_error (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint8_t *error)
	Helper to parse a TRACK_STATUS_ERROR message.
size_t	imquic_moq_parse_object_datagram (imquic_moq_context *moq, uint8_t *bytes, size_t blen, imquic_moq_datagram_message_type dtype, uint8_t *error)
	Helper to parse an OBJECT_DATAGRAM message.
size_t	imquic_moq_parse_object_datagram_status (imquic_moq_context *moq, uint8_t *bytes, size_t blen, imquic_moq_datagram_message_type dtype, uint8_t *error)
	Helper to parse an OBJECT_DATAGRAM_STATUS message.
size_t	imquic_moq_parse_subgroup_header (imquic_moq_context *moq, imquic_moq_stream *moq_stream, uint8_t *bytes, size_t blen, imquic_moq_data_message_type dtype, uint8_t *error)
	Helper to parse a SUBGROUP_HEADER message.
int	imquic_moq_parse_subgroup_header_object (imquic_moq_context *moq, imquic_moq_stream *moq_stream, gboolean complete, uint8_t *error)
	Helper to parse a SUBGROUP_HEADER object.
size_t	imquic_moq_parse_fetch_header (imquic_moq_context *moq, imquic_moq_stream *moq_stream, uint8_t *bytes, size_t blen, uint8_t *error)
	Helper to parse a FETCH_HEADER message.
int	imquic_moq_parse_fetch_header_object (imquic_moq_context *moq, imquic_moq_stream *moq_stream, gboolean complete, uint8_t *error)
	Helper to parse a FETCH_HEADER object.
size_t	imquic_moq_parse_goaway (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint8_t *error)
	Helper to parse a GOAWAY message.
size_t	imquic_moq_add_client_setup (imquic_moq_context *moq, uint8_t *bytes, size_t blen, GList *supported_versions, imquic_moq_setup_parameters *parameters)
	Helper method to add a CLIENT_SETUP message to a buffer.
size_t	imquic_moq_add_server_setup (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint32_t version, imquic_moq_setup_parameters *parameters)
	Helper method to add a SERVER_SETUP message to a buffer.
size_t	imquic_moq_add_max_request_id (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint64_t max_request_id)
	Helper method to add a MAX_REQUEST_ID message to a buffer.
size_t	imquic_moq_add_requests_blocked (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint64_t max_request_id)
	Helper method to add a REQUESTS_BLOCKED message to a buffer.
size_t	imquic_moq_add_request_ok (imquic_moq_context *moq, imquic_moq_stream *moq_stream, uint8_t *bytes, size_t blen, uint64_t request_id, imquic_moq_request_parameters *parameters)
	Helper method to add a REQUEST_OK message to a buffer.
size_t	imquic_moq_add_request_error (imquic_moq_context *moq, imquic_moq_stream *moq_stream, uint8_t *bytes, size_t blen, uint64_t request_id, uint64_t error, const char *reason, uint64_t retry_interval)
	Helper method to add a REQUEST_ERROR message to a buffer.
size_t	imquic_moq_add_publish_namespace (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint64_t request_id, imquic_moq_namespace *track_namespace, imquic_moq_request_parameters *parameters)
	Helper method to add a PUBLISH_NAMESPACE message to a buffer.
size_t	imquic_moq_add_publish_namespace_ok (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint64_t request_id)
	Helper method to add a PUBLISH_NAMESPACE_OK message to a buffer.
size_t	imquic_moq_add_publish_namespace_error (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint64_t request_id, imquic_moq_request_error_code error, const char *reason)
	Helper method to add a PUBLISH_NAMESPACE_ERROR message to a buffer.
size_t	imquic_moq_add_publish_namespace_done (imquic_moq_context *moq, uint8_t *bytes, size_t blen, imquic_moq_namespace *track_namespace)
	Helper method to add a PUBLISH_NAMESPACE_DONE message to a buffer.
size_t	imquic_moq_add_publish_namespace_cancel (imquic_moq_context *moq, uint8_t *bytes, size_t blen, imquic_moq_namespace *track_namespace, imquic_moq_request_error_code error, const char *reason)
	Helper method to add aN PUBLISH_NAMESPACE_CANCEL message to a buffer.
size_t	imquic_moq_add_publish (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint64_t request_id, imquic_moq_namespace *track_namespace, imquic_moq_name *track_name, uint64_t track_alias, imquic_moq_request_parameters *parameters, GList *track_extensions)
	Helper to add a PUBLISH message to a buffer.
size_t	imquic_moq_add_publish_ok (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint64_t request_id, imquic_moq_request_parameters *parameters)
	Helper method to add a PUBLISH_OK message to a buffer.
size_t	imquic_moq_add_publish_error (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint64_t request_id, imquic_moq_request_error_code error, const char *reason)
	Helper method to add a PUBLISH_ERRROR message to a buffer.
size_t	imquic_moq_add_subscribe (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint64_t request_id, uint64_t track_alias, imquic_moq_namespace *track_namespace, imquic_moq_name *track_name, imquic_moq_request_parameters *parameters)
	Helper to add a SUBSCRIBE message to a buffer.
size_t	imquic_moq_add_request_update (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint64_t request_id, uint64_t sub_request_id, imquic_moq_request_parameters *parameters)
	Helper method to add a REQUEST_UPDATE message to a buffer.
size_t	imquic_moq_add_subscribe_ok (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint64_t request_id, uint64_t track_alias, imquic_moq_request_parameters *parameters, GList *track_extensions)
	Helper method to add a SUBSCRIBE_OK message to a buffer.
size_t	imquic_moq_add_subscribe_error (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint64_t request_id, imquic_moq_request_error_code error, const char *reason, uint64_t track_alias)
	Helper method to add a SUBSCRIBE_ERRROR message to a buffer.
size_t	imquic_moq_add_unsubscribe (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint64_t request_id)
	Helper method to add an UNSUBSCRIBE message to a buffer.
size_t	imquic_moq_add_publish_done (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint64_t request_id, imquic_moq_pub_done_code status, uint64_t streams_count, const char *reason)
	Helper method to add a PUBLISH_DONE message to a buffer.
size_t	imquic_moq_add_subscribe_namespace (imquic_moq_context *moq, imquic_moq_stream *moq_stream, uint8_t *bytes, size_t blen, uint64_t request_id, imquic_moq_namespace *track_namespace, imquic_moq_subscribe_namespace_options subscribe_options, imquic_moq_request_parameters *parameters)
	Helper to add a SUBSCRIBE_NAMESPACE message to a buffer.
size_t	imquic_moq_add_namespace (imquic_moq_context *moq, imquic_moq_stream *moq_stream, uint8_t *bytes, size_t blen, imquic_moq_namespace *track_namespace)
	Helper method to add a NAMESPACE_DONE message to a buffer.
size_t	imquic_moq_add_namespace_done (imquic_moq_context *moq, imquic_moq_stream *moq_stream, uint8_t *bytes, size_t blen, imquic_moq_namespace *track_namespace)
	Helper method to add a NAMESPACE_DONE message to a buffer.
size_t	imquic_moq_add_subscribe_namespace_ok (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint64_t request_id)
	Helper method to add a SUBSCRIBE_NAMESPACE_OK message to a buffer.
size_t	imquic_moq_add_subscribe_namespace_error (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint64_t request_id, imquic_moq_request_error_code error, const char *reason)
	Helper method to add a SUBSCRIBE_NAMESPACE_ERRROR message to a buffer.
size_t	imquic_moq_add_unsubscribe_namespace (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint64_t request_id, imquic_moq_namespace *track_namespace)
	Helper method to add an UNSUBSCRIBE_NAMESPACE message to a buffer.
size_t	imquic_moq_add_fetch (imquic_moq_context *moq, uint8_t *bytes, size_t blen, imquic_moq_fetch_type type, uint64_t request_id, uint64_t joining_request_id, uint64_t preceding_group_offset, imquic_moq_namespace *track_namespace, imquic_moq_name *track_name, imquic_moq_location_range *range, imquic_moq_request_parameters *parameters)
	Helper to add a FETCH message to a buffer.
size_t	imquic_moq_add_fetch_cancel (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint64_t request_id)
	Helper method to add an FETCH_CANCEL message to a buffer.
size_t	imquic_moq_add_fetch_ok (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint64_t request_id, uint8_t end_of_track, imquic_moq_location *end_location, imquic_moq_request_parameters *parameters, GList *track_extensions)
	Helper method to add a FETCH_OK message to a buffer.
size_t	imquic_moq_add_fetch_error (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint64_t request_id, imquic_moq_request_error_code error, const char *reason)
	Helper method to add a FETCH_ERRROR message to a buffer.
size_t	imquic_moq_add_track_status (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint64_t request_id, imquic_moq_namespace *track_namespace, imquic_moq_name *track_name, imquic_moq_request_parameters *parameters)
	Helper to add a TRACK_STATUS message to a buffer.
size_t	imquic_moq_add_track_status_ok (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint64_t request_id, uint64_t track_alias, imquic_moq_request_parameters *parameters)
	Helper method to add a TRACK_STATUS_OK message to a buffer.
size_t	imquic_moq_add_track_status_error (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint64_t request_id, imquic_moq_request_error_code error, const char *reason)
	Helper method to add a TRACK_STATUS_ERRROR message to a buffer.
size_t	imquic_moq_add_goaway (imquic_moq_context *moq, uint8_t *bytes, size_t blen, const char *new_session_uri)
	Helper method to add a GOAWAY message to a buffer.
size_t	imquic_moq_add_object_datagram (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint64_t request_id, uint64_t track_alias, uint64_t group_id, uint64_t object_id, uint64_t object_status, uint8_t priority, uint8_t *payload, size_t plen, uint8_t *extensions, size_t elen)
	Helper to add an OBJECT_DATAGRAM message to a buffer.
size_t	imquic_moq_add_object_datagram_status (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint64_t track_alias, uint64_t group_id, uint64_t object_id, uint8_t priority, uint64_t object_status, uint8_t *extensions, size_t elen)
	Helper to add an OBJECT_DATAGRAM_STATUS message to a buffer.
size_t	imquic_moq_add_subgroup_header (imquic_moq_context *moq, imquic_moq_stream *moq_stream, uint8_t *bytes, size_t blen, uint64_t request_id, uint64_t track_alias, uint64_t group_id, uint64_t subgroup_id, uint8_t priority)
	Helper to add a SUBGROUP_HEADER message to a buffer.
size_t	imquic_moq_add_subgroup_header_object (imquic_moq_context *moq, imquic_moq_stream *moq_stream, uint8_t *bytes, size_t blen, uint64_t object_id, uint64_t object_status, uint8_t *payload, size_t plen, uint8_t *extensions, size_t elen)
	Helper to add an object to a buffer, formatted as expected for SUBGROUP_HEADER objects (so not all IDs)
size_t	imquic_moq_add_fetch_header (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint64_t request_id)
	Helper to add a FETCH_HEADER message to a buffer.
size_t	imquic_moq_add_fetch_header_object (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint64_t flags, uint64_t group_id, uint64_t subgroup_id, uint64_t object_id, uint8_t priority, uint64_t object_status, uint8_t *payload, size_t plen, uint8_t *extensions, size_t elen)
	Helper to add an object to a buffer, formatted as expected for FETCH_HEADER objects (so not all IDs)
size_t	imquic_moq_add_object_extensions (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint8_t *extensions, size_t elen)
	Helper method to add object extensions to a buffer.
size_t	imquic_moq_parameter_add_int (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint64_t param, uint64_t prev, uint64_t number)
	Helper to add a MoQ (setup or subscribe) parameter with a numeric value to a buffer.
size_t	imquic_moq_parameter_add_data (imquic_moq_context *moq, uint8_t *bytes, size_t blen, uint64_t param, uint64_t prev, uint8_t *buf, size_t buflen)
	Helper to add a MoQ (setup or subscribe) parameter with generic data to a buffer.
size_t	imquic_moq_parse_setup_parameter (imquic_moq_context *moq, uint8_t *bytes, size_t blen, imquic_moq_setup_parameters *params, uint64_t *param_type, uint8_t *error)
	Helper method to parse a MoQ setup parameter.
size_t	imquic_moq_parse_request_parameter (imquic_moq_context *moq, uint8_t *bytes, size_t blen, imquic_moq_request_parameters *params, uint64_t *param_type, uint8_t *error)
	Helper method to parse a MoQ subscribe parameter.
imquic_moq_version	imquic_moq_get_version (imquic_connection *conn)
	Helper function to get the MoQ version associated with a connection.
int	imquic_moq_set_connection_auth (imquic_connection *conn, uint8_t *auth, size_t authlen)
	Method to provide credentials, as a client, on a new connection. If credentials need to provided, this must be done as soon as the connection is established, and before sending any MoQ message. A good place to do that is the callback fired when a new connection is available.
int	imquic_moq_set_max_request_id (imquic_connection *conn, uint64_t max_request_id)
	Helper function to set the Maximum Request ID a subscriber can send.
uint64_t	imquic_moq_get_next_request_id (imquic_connection *conn)
	Helper function to get the next Request ID we can use.
const char *	imquic_moq_get_remote_implementation (imquic_connection *conn)
	Helper function to return the MoQ implementation name as a string, if provided by the peer of this connection.
GList *	imquic_moq_parse_object_extensions (imquic_moq_version version, uint8_t *extensions, size_t elen)
	Helper mode to parse an extensions buffer to a GList of imquic_moq_object_extension.
size_t	imquic_moq_build_object_extensions (imquic_moq_version version, GList *extensions, uint8_t *bytes, size_t blen)
	Helper mode to craft an extensions buffer out of a GList of imquic_moq_object_extension.
int	imquic_moq_parse_auth_token (uint8_t *bytes, size_t blen, imquic_moq_auth_token *token)
	Helper mode to parse an auth token buffer to a imquic_moq_auth_token instance.
size_t	imquic_moq_build_auth_token (imquic_moq_auth_token *token, uint8_t *bytes, size_t blen)
	Helper mode to craft an auth token buffer out of a imquic_moq_auth_token instance.
int	imquic_moq_publish_namespace (imquic_connection *conn, uint64_t request_id, imquic_moq_namespace *tns, imquic_moq_request_parameters *parameters)
	Function to send a PUBLISH_NAMESPACE request.
int	imquic_moq_accept_publish_namespace (imquic_connection *conn, uint64_t request_id, imquic_moq_request_parameters *parameters)
	Function to accept an incoming PUBLISH_NAMESPACE request.
int	imquic_moq_reject_publish_namespace (imquic_connection *conn, uint64_t request_id, imquic_moq_request_error_code error_code, const char *reason, uint64_t retry_interval)
	Function to reject an incoming PUBLISH_NAMESPACE request.
int	imquic_moq_publish_namespace_done (imquic_connection *conn, imquic_moq_namespace *tns)
	Function to send a PUBLISH_NAMESPACE_DONE request.
int	imquic_moq_publish (imquic_connection *conn, uint64_t request_id, imquic_moq_namespace *tns, imquic_moq_name *tn, uint64_t track_alias, imquic_moq_request_parameters *parameters, GList *track_extensions)
	Function to send a PUBLISH request.
int	imquic_moq_accept_publish (imquic_connection *conn, uint64_t request_id, imquic_moq_request_parameters *parameters)
	Function to accept an incoming PUBLISH request.
int	imquic_moq_reject_publish (imquic_connection *conn, uint64_t request_id, imquic_moq_request_error_code error_code, const char *reason, uint64_t retry_interval)
	Function to reject an incoming PUBLISH request.
int	imquic_moq_subscribe (imquic_connection *conn, uint64_t request_id, uint64_t track_alias, imquic_moq_namespace *tns, imquic_moq_name *tn, imquic_moq_request_parameters *parameters)
	Function to send a SUBSCRIBE request.
int	imquic_moq_accept_subscribe (imquic_connection *conn, uint64_t request_id, uint64_t track_alias, imquic_moq_request_parameters *parameters, GList *track_extensions)
	Function to accept an incoming SUBSCRIBE request.
int	imquic_moq_reject_subscribe (imquic_connection *conn, uint64_t request_id, imquic_moq_request_error_code error_code, const char *reason, uint64_t track_alias, uint64_t retry_interval)
	Function to reject an incoming SUBSCRIBE request.
int	imquic_moq_update_request (imquic_connection *conn, uint64_t request_id, uint64_t sub_request_id, imquic_moq_request_parameters *parameters)
	Function to send a REQUEST_UPDATE request.
int	imquic_moq_accept_request_update (imquic_connection *conn, uint64_t request_id, imquic_moq_request_parameters *parameters)
	Function to accept an incoming REQUEST_UPDATE request.
int	imquic_moq_reject_request_update (imquic_connection *conn, uint64_t request_id, imquic_moq_request_error_code error_code, const char *reason, uint64_t retry_interval)
	Function to reject an incoming REQUEST_UPDATE request.
int	imquic_moq_unsubscribe (imquic_connection *conn, uint64_t request_id)
	Function to send a UNSUBSCRIBE request.
int	imquic_moq_publish_done (imquic_connection *conn, uint64_t request_id, imquic_moq_pub_done_code status_code, const char *reason)
	Function to send a PUBLISH_DONE request.
int	imquic_moq_subscribe_namespace (imquic_connection *conn, uint64_t request_id, imquic_moq_namespace *tns, imquic_moq_subscribe_namespace_options subscribe_options, imquic_moq_request_parameters *parameters)
	Function to send a SUBSCRIBE_NAMESPACE request.
int	imquic_moq_accept_subscribe_namespace (imquic_connection *conn, uint64_t request_id, imquic_moq_request_parameters *parameters)
	Function to accept an incoming SUBSCRIBE_NAMESPACE request.
int	imquic_moq_reject_subscribe_namespace (imquic_connection *conn, uint64_t request_id, imquic_moq_request_error_code error_code, const char *reason, uint64_t retry_interval)
	Function to reject an incoming SUBSCRIBE_NAMESPACE request.
int	imquic_moq_unsubscribe_namespace (imquic_connection *conn, uint64_t request_id, imquic_moq_namespace *tns)
	Function to send a UNSUBSCRIBE_NAMESPACE request.
int	imquic_moq_notify_namespace (imquic_connection *conn, uint64_t request_id, imquic_moq_namespace *tns)
	Function to send a NAMESPACE request.
int	imquic_moq_notify_namespace_done (imquic_connection *conn, uint64_t request_id, imquic_moq_namespace *tns)
	Function to send a NAMESPACE_DONE request.
int	imquic_moq_standalone_fetch (imquic_connection *conn, uint64_t request_id, imquic_moq_namespace *tns, imquic_moq_name *tn, imquic_moq_location_range *range, imquic_moq_request_parameters *parameters)
	Function to send a standalone FETCH request.
int	imquic_moq_joining_fetch (imquic_connection *conn, uint64_t request_id, uint64_t joining_request_id, gboolean absolute, uint64_t joining_start, imquic_moq_request_parameters *parameters)
	Function to send a joining FETCH request.
int	imquic_moq_accept_fetch (imquic_connection *conn, uint64_t request_id, imquic_moq_location *largest, imquic_moq_request_parameters *parameters, GList *track_extensions)
	Function to accept an incoming FETCH request.
int	imquic_moq_reject_fetch (imquic_connection *conn, uint64_t request_id, imquic_moq_request_error_code error_code, const char *reason, uint64_t retry_interval)
	Function to reject an incoming FETCH request.
int	imquic_moq_cancel_fetch (imquic_connection *conn, uint64_t request_id)
	Function to send a FETCH_CANCEL request.
int	imquic_moq_track_status (imquic_connection *conn, uint64_t request_id, imquic_moq_namespace *tns, imquic_moq_name *tn, imquic_moq_request_parameters *parameters)
	Function to send a TRACK_STATUS request.
int	imquic_moq_accept_track_status (imquic_connection *conn, uint64_t request_id, uint64_t track_alias, imquic_moq_request_parameters *parameters)
	Function to accept an incoming TRACK_STATUS request.
int	imquic_moq_reject_track_status (imquic_connection *conn, uint64_t request_id, imquic_moq_request_error_code error_code, const char *reason, uint64_t retry_interval)
	Function to reject an incoming TRACK_STATUS request.
int	imquic_moq_requests_blocked (imquic_connection *conn)
	Function to send a REQUESTS_BLOCKED request.
int	imquic_moq_goaway (imquic_connection *conn, const char *uri)
	Function to send a GOAWAY request.
int	imquic_moq_send_object (imquic_connection *conn, imquic_moq_object *object)
	Function to send a MoQ object.
json_t *	imquic_qlog_moq_message_prepare (const char *type)
	Helper to create a new QLOG MoQT message.
void	imquic_qlog_moq_message_add_namespace (json_t *message, imquic_moq_namespace *track_namespace, const char *name)
	Helper to add a stringified namespace tuple array to a message.
void	imquic_qlog_moq_message_add_track (json_t *message, imquic_moq_name *track_name)
	Helper to add a stringified track name to a message.
void	imquic_qlog_moq_message_add_setup_parameters (json_t *message, imquic_moq_setup_parameters *parameters, const char *name)
	Helper to add a stringified array of setup parameters to a message.
void	imquic_qlog_moq_message_add_request_parameters (json_t *message, imquic_moq_version version, imquic_moq_request_parameters *parameters, const char *name)
	Helper to add a stringified array of subscribe parameters to a message.
void	imquic_qlog_moq_message_add_extensions (json_t *message, GList *extensions, const char *name)
	Helper to add a stringified array of extension headers to a message.
void	imquic_moq_qlog_control_message_created (imquic_qlog *qlog, uint64_t stream_id, uint8_t *bytes, size_t length, json_t *message)
	Add a control_message_created event.
void	imquic_moq_qlog_control_message_parsed (imquic_qlog *qlog, uint64_t stream_id, uint8_t *bytes, size_t length, json_t *message)
	Add a control_message_parsed event.
void	imquic_moq_qlog_stream_type_set (imquic_qlog *qlog, gboolean local, uint64_t stream_id, const char *type)
	Add a stream_type_set event.
void	imquic_moq_qlog_object_datagram_created (imquic_qlog *qlog, imquic_moq_object *object)
	Add a object_datagram_created event.
void	imquic_moq_qlog_object_datagram_parsed (imquic_qlog *qlog, imquic_moq_object *object)
	Add a object_datagram_parsed event.
void	imquic_moq_qlog_object_datagram_status_created (imquic_qlog *qlog, imquic_moq_object *object)
	Add a object_datagram_status_created event.
void	imquic_moq_qlog_object_datagram_status_parsed (imquic_qlog *qlog, imquic_moq_object *object)
	Add a object_datagram_status_parsed event.
void	imquic_moq_qlog_subgroup_header_created (imquic_qlog *qlog, imquic_moq_stream *stream, uint8_t *bytes, size_t length)
	Add a subgroup_header_created event.
void	imquic_moq_qlog_subgroup_header_parsed (imquic_qlog *qlog, imquic_moq_stream *stream, uint8_t *bytes, size_t length)
	Add a subgroup_header_parsed event.
void	imquic_moq_qlog_subgroup_object_created (imquic_qlog *qlog, uint64_t stream_id, imquic_moq_object *object)
	Add a subgroup_object_created event.
void	imquic_moq_qlog_subgroup_object_parsed (imquic_qlog *qlog, uint64_t stream_id, imquic_moq_object *object)
	Add a subgroup_object_parsed event.
void	imquic_moq_qlog_fetch_header_created (imquic_qlog *qlog, imquic_moq_stream *stream, uint8_t *bytes, size_t length)
	Add a fetch_header_created event.
void	imquic_moq_qlog_fetch_header_parsed (imquic_qlog *qlog, imquic_moq_stream *stream, uint8_t *bytes, size_t length)
	Add a fetch_header_parsed event.
void	imquic_moq_qlog_fetch_object_created (imquic_qlog *qlog, uint64_t stream_id, imquic_moq_object *object)
	Add a fetch_object_created event.
void	imquic_moq_qlog_fetch_object_parsed (imquic_qlog *qlog, uint64_t stream_id, imquic_moq_object *object)
	Add a fetch_object_parsed event.

Detailed Description

Media Over QUIC (MoQ) stack.

Author

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

Copyright

MIT License

Implementation of the Media Over QUIC (MoQ) stack as part of the library itself. At the time of writing, this implements (most of) versions from -06 to to -14 of the protocol.

Note

This is the internal implementation of MoQ in the library. You're still free to only use imquic as the underlying QUIC/WebTransport library, and take care of the MoQ implementation on your own instead: in order to do that, use the generic imquic client/server creation utilities, rather than the MoQ specific ones.

Macro Definition Documentation

IMQUIC_MOQ_ADD_MESSAGE_LENGTH

#define IMQUIC_MOQ_ADD_MESSAGE_LENGTH

(

)

Value:

        do { \
                uint16_t clen = offset - len_offset - 2; \
                clen = htons(clen); \
                memcpy(&bytes[len_offset], &clen, 2); \
        } while(0)

IMQUIC_MOQ_ADD_MESSAGE_TYPE

#define IMQUIC_MOQ_ADD_MESSAGE_TYPE

(

type

)

Value:

        do { \
                offset = imquic_write_varint(type, bytes, blen); \
                len_offset = offset; \
                offset += 2; \
        } while(0)

IMQUIC_MOQ_ADD_NAMESPACES

#define IMQUIC_MOQ_ADD_NAMESPACES

(

request

)

Value:

        do { \
                uint64_t tns_num = 0; \
                imquic_moq_namespace *temp = track_namespace; \
                while(temp) { \
                        if(temp->length > 0 && temp->buffer == NULL) { \
                                IMQUIC_LOG(IMQUIC_LOG_ERR, "[%s][MoQ] Can't add MoQ %s: invalid arguments\n", \
                                        imquic_get_connection_name(moq->conn), imquic_moq_message_type_str(request, moq->version)); \
                                return 0; \
                        } \
                        tns_num++; \
                        temp = temp->next; \
                } \
                if((tns_num == 0 && request != IMQUIC_MOQ_NAMESPACE && request != IMQUIC_MOQ_NAMESPACE_DONE) || tns_num > 32) { \
                        IMQUIC_LOG(IMQUIC_LOG_ERR, "[%s][MoQ] Can't add MoQ %s: invalid number of tuples\n", \
                                imquic_get_connection_name(moq->conn), imquic_moq_message_type_str(request, moq->version)); \
                        return 0; \
                } \
                offset += imquic_write_varint(tns_num, &bytes[offset], blen-offset); \
                temp = track_namespace; \
                while(temp) { \
                        offset += imquic_write_varint(temp->length, &bytes[offset], blen-offset); \
                        if(temp->length > 0) { \
                                memcpy(&bytes[offset], temp->buffer, temp->length); \
                                offset += temp->length; \
                        } \
                        temp = temp->next; \
                } \
        } while(0)

IMQUIC_MOQ_ADD_TRACKNAME

#define IMQUIC_MOQ_ADD_TRACKNAME

(

request

)

Value:

        do { \
                if(track_name->length > 4096) { \
                        IMQUIC_LOG(IMQUIC_LOG_ERR, "[%s][MoQ] Can't add MoQ %s: invalid track name length\n", \
                                imquic_get_connection_name(moq->conn), imquic_moq_message_type_str(request, moq->version)); \
                        return 0; \
                } \
                offset += imquic_write_varint(track_name->length, &bytes[offset], blen-offset); \
                if(track_name->length > 0) { \
                        memcpy(&bytes[offset], track_name->buffer, track_name->length); \
                        offset += track_name->length; \
                } \
        } while(0)

IMQUIC_MOQ_CHECK_ERR

#define IMQUIC_MOQ_CHECK_ERR	(		cond,
			error,
			code,
			res,
			reason )

Value:

        if(cond) { \
                IMQUIC_LOG(IMQUIC_LOG_ERR, "%s\n", reason); \
                if(error) \
                        *(uint8_t *)error = code; \
                return res; \
        }

IMQUIC_MOQ_LOG_HUGE

#define IMQUIC_MOQ_LOG_HUGE   IMQUIC_LOG_VERB

IMQUIC_MOQ_LOG_VERB

#define IMQUIC_MOQ_LOG_VERB   IMQUIC_LOG_HUGE

IMQUIC_MOQ_PARSE_NAMESPACES

#define IMQUIC_MOQ_PARSE_NAMESPACES	(		request,
			tns_num,
			i,
			error_message,
			last )

Value:

        do { \
                tns_num = imquic_read_varint(&bytes[offset], blen-offset, &length); \
                IMQUIC_MOQ_CHECK_ERR(length == 0 || (tns_num > 0 && length >= blen-offset), NULL, 0, 0, error_message); \
                IMQUIC_MOQ_CHECK_ERR((tns_num == 0 && request != IMQUIC_MOQ_NAMESPACE && request != IMQUIC_MOQ_NAMESPACE_DONE) || tns_num > 32, error, IMQUIC_MOQ_PROTOCOL_VIOLATION, 0, "Invalid number of namespaces"); \
                offset += length; \
                uint64_t total_len = 0; \
                i = 0; \
                for(i = 0; i < tns_num; i++) { \
                        IMQUIC_MOQ_CHECK_ERR(blen-offset == 0, NULL, 0, 0, error_message); \
                        uint64_t tns_len = imquic_read_varint(&bytes[offset], blen-offset, &length); \
                        IMQUIC_MOQ_CHECK_ERR(length == 0 || length >= blen-offset, NULL, 0, 0, error_message); \
                        IMQUIC_MOQ_CHECK_ERR(tns_len == 0, error, IMQUIC_MOQ_PROTOCOL_VIOLATION, 0, "Invalid track namespace field length"); \
                        offset += length; \
                        if(last && (i == tns_num - 1)) { \
                                IMQUIC_MOQ_CHECK_ERR(tns_len > blen-offset, NULL, 0, 0, error_message); \
                        } else { \
                                IMQUIC_MOQ_CHECK_ERR(tns_len >= blen-offset, NULL, 0, 0, error_message); \
                        } \
                        IMQUIC_LOG(IMQUIC_MOQ_LOG_HUGE, "[%s][MoQ]  -- Track Namespace (%"SCNu64" bytes)\n", \
                                imquic_get_connection_name(moq->conn), tns_len); \
                        IMQUIC_LOG(IMQUIC_MOQ_LOG_HUGE, "[%s][MoQ]  -- -- %.*s\n", \
                                imquic_get_connection_name(moq->conn), (int)tns_len, &bytes[offset]); \
                        tns[i].length = tns_len; \
                        tns[i].buffer = tns_len ? &bytes[offset] : NULL; \
                        tns[i].next = (i == tns_num - 1) ? NULL : (i < 31 ? &tns[i+1] : NULL); \
                        offset += tns_len; \
                        total_len += tns_len; \
                } \
                IMQUIC_MOQ_CHECK_ERR(total_len > 4096, error, IMQUIC_MOQ_PROTOCOL_VIOLATION, 0, "Invalid track namespace length"); \
        } while(0)

IMQUIC_MOQ_PARSE_TRACKNAME

#define IMQUIC_MOQ_PARSE_TRACKNAME	(		error_message,
			last )

Value:

        do { \
                uint64_t tn_len = imquic_read_varint(&bytes[offset], blen-offset, &length); \
                if(last) { \
                        IMQUIC_MOQ_CHECK_ERR(length == 0 || length > blen-offset, NULL, 0, 0, error_message); \
                } else { \
                        IMQUIC_MOQ_CHECK_ERR(length == 0 || length >= blen-offset, NULL, 0, 0, error_message); \
                } \
                IMQUIC_MOQ_CHECK_ERR(tn_len > 4096, error, IMQUIC_MOQ_PROTOCOL_VIOLATION, 0, "Invalid track name length"); \
                offset += length; \
                IMQUIC_MOQ_CHECK_ERR(tn_len > blen-offset, NULL, 0, 0, error_message); \
                IMQUIC_LOG(IMQUIC_MOQ_LOG_HUGE, "[%s][MoQ]  -- Track Name (%"SCNu64" bytes)\n", \
                        imquic_get_connection_name(moq->conn), tn_len); \
                IMQUIC_LOG(IMQUIC_MOQ_LOG_HUGE, "[%s][MoQ]  -- -- %.*s\n", \
                        imquic_get_connection_name(moq->conn), (int)tn_len, &bytes[offset]); \
                tn.length = tn_len; \
                tn.buffer = tn_len ? &bytes[offset] : NULL; \
                offset += tn_len; \
        } while(0)

IMQUIC_MOQ_REQUEST_ID_INCREMENT

#define IMQUIC_MOQ_REQUEST_ID_INCREMENT   2

Function Documentation

imquic_moq_accept_fetch()

int imquic_moq_accept_fetch	(	imquic_connection *	conn,
		uint64_t	request_id,
		imquic_moq_location *	largest,
		imquic_moq_request_parameters *	parameters,
		GList *	track_extensions )

Function to accept an incoming FETCH request.

Parameters

conn	The imquic_connection to send the request on
request_id	The unique request_id value associated to the subscription to accept
largest	The largest group/object IDs
parameters	The parameters to add to the request
track_extensions	List of track extensions to add, if any (added in v16)

Returns

0 in case of success, a negative integer otherwise

imquic_moq_accept_publish()

int imquic_moq_accept_publish	(	imquic_connection *	conn,
		uint64_t	request_id,
		imquic_moq_request_parameters *	parameters )

Function to accept an incoming PUBLISH request.

Parameters

conn	The imquic_connection to send the request on
request_id	The unique request_id value associated to the subscription to accept
parameters	The parameters to add to the request

Returns

0 in case of success, a negative integer otherwise

imquic_moq_accept_publish_namespace()

int imquic_moq_accept_publish_namespace	(	imquic_connection *	conn,
		uint64_t	request_id,
		imquic_moq_request_parameters *	parameters )

Function to accept an incoming PUBLISH_NAMESPACE request.

Parameters

conn	The imquic_connection to send the request on
request_id	The request ID of the original PUBLISH_NAMESPACE request
parameters	The parameters to add to the request (ignored before v15)

Returns

0 in case of success, a negative integer otherwise

imquic_moq_accept_request_update()

int imquic_moq_accept_request_update	(	imquic_connection *	conn,
		uint64_t	request_id,
		imquic_moq_request_parameters *	parameters )

Function to accept an incoming REQUEST_UPDATE request.

Note

This acknowledgement was only added in v15, which means it will be a no-action if you try to send it when negotiating an older version

Parameters

conn	The imquic_connection to send the request on
request_id	The request ID of the original REQUEST_UPDATE request
parameters	The parameters to add to the request

Returns

0 in case of success, a negative integer otherwise

imquic_moq_accept_subscribe()

int imquic_moq_accept_subscribe	(	imquic_connection *	conn,
		uint64_t	request_id,
		uint64_t	track_alias,
		imquic_moq_request_parameters *	parameters,
		GList *	track_extensions )

Function to accept an incoming SUBSCRIBE request.

Parameters

conn	The imquic_connection to send the request on
request_id	The unique request_id value associated to the subscription to accept
track_alias	The unique track_alias value associated to the subscription to accept (ignored before v12)
parameters	The parameters to add to the request
track_extensions	List of track extensions to add, if any (added in v16)

Returns

0 in case of success, a negative integer otherwise

imquic_moq_accept_subscribe_namespace()

int imquic_moq_accept_subscribe_namespace	(	imquic_connection *	conn,
		uint64_t	request_id,
		imquic_moq_request_parameters *	parameters )

Function to accept an incoming SUBSCRIBE_NAMESPACE request.

Parameters

conn	The imquic_connection to send the request on
request_id	The request ID of the original SUBSCRIBE_NAMESPACE request
parameters	The parameters to add to the request (ignored before v15)

Returns

0 in case of success, a negative integer otherwise

imquic_moq_accept_track_status()

int imquic_moq_accept_track_status	(	imquic_connection *	conn,
		uint64_t	request_id,
		uint64_t	track_alias,
		imquic_moq_request_parameters *	parameters )

Function to accept an incoming TRACK_STATUS request.

Note

Due to considerable changes between v12 and v13 on TRACK_STATUS , support for this request is disabled in versions earlier than v13.

Parameters

conn	The imquic_connection to send the request on
request_id	The unique request_id value associated to the subscription to query
track_alias	The unique track_alias value associated to the subscription to query (ignored after v15)
parameters	The parameters to add to the request

Returns

0 in case of success, a negative integer otherwise

imquic_moq_add_client_setup()

size_t imquic_moq_add_client_setup	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		GList *	supported_versions,
		imquic_moq_setup_parameters *	parameters )

Helper method to add a CLIENT_SETUP message to a buffer.

Parameters

moq	The imquic_moq_context generating the message
bytes	The buffer to add the message to
blen	The size of the buffer
supported_versions	List of supported versions
parameters	The setup parameters to send

Returns

The size of the generated message, if successful, or 0 otherwise

imquic_moq_add_fetch()

size_t imquic_moq_add_fetch	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		imquic_moq_fetch_type	type,
		uint64_t	request_id,
		uint64_t	joining_request_id,
		uint64_t	preceding_group_offset,
		imquic_moq_namespace *	track_namespace,
		imquic_moq_name *	track_name,
		imquic_moq_location_range *	range,
		imquic_moq_request_parameters *	parameters )

Helper to add a FETCH message to a buffer.

Parameters

moq	The imquic_moq_context generating the message
bytes	The buffer to add the message to
blen	The size of the buffer
type	The FETCH type
request_id	The request ID to put in the message
joining_request_id	The joining request ID to put in the message, if any
preceding_group_offset	The preceding group offset for joining fetches, if any
track_namespace	The namespace to put in the message
track_name	The track name to put in the message
range	The Start/End Locations to put in the message
parameters	The parameters to add, if any

Returns

The size of the generated message, if successful, or 0 otherwise

imquic_moq_add_fetch_cancel()

size_t imquic_moq_add_fetch_cancel	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint64_t	request_id )

Helper method to add an FETCH_CANCEL message to a buffer.

Parameters

moq	The imquic_moq_context generating the message
bytes	The buffer to add the message to
blen	The size of the buffer
request_id	The request ID to put in the message

Returns

The size of the generated message, if successful, or 0 otherwise

imquic_moq_add_fetch_error()

size_t imquic_moq_add_fetch_error	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint64_t	request_id,
		imquic_moq_request_error_code	error,
		const char *	reason )

Helper method to add a FETCH_ERRROR message to a buffer.

Parameters

moq	The imquic_moq_context generating the message
bytes	The buffer to add the message to
blen	The size of the buffer
request_id	The request ID to put in the message
error	Error code associated to the message
reason	Verbose description of the error, if any

Returns

The size of the generated message, if successful, or 0 otherwise

imquic_moq_add_fetch_header()

size_t imquic_moq_add_fetch_header	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint64_t	request_id )

Helper to add a FETCH_HEADER message to a buffer.

Note

This will create a new STREAM and send the header: after that, imquic_moq_add_fetch_header_object is used to send all objects that belong to this track.

Parameters

moq	The imquic_moq_context generating the message
bytes	The buffer to add the message to
blen	The size of the buffer
request_id	The request ID to put in the message

Returns

The size of the generated message, if successful, or 0 otherwise

imquic_moq_add_fetch_header_object()

size_t imquic_moq_add_fetch_header_object	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint64_t	flags,
		uint64_t	group_id,
		uint64_t	subgroup_id,
		uint64_t	object_id,
		uint8_t	priority,
		uint64_t	object_status,
		uint8_t *	payload,
		size_t	plen,
		uint8_t *	extensions,
		size_t	elen )

Helper to add an object to a buffer, formatted as expected for FETCH_HEADER objects (so not all IDs)

Parameters

moq	The imquic_moq_context generating the object
bytes	The buffer to add the object to
blen	The size of the buffer
flags	The serialization flags (added in v15)
group_id	The group ID
subgroup_id	The subgroup ID
object_id	The object ID
priority	The publisher priority to put in the message
object_status	The object status (only added if the payload length is 0)
payload	The buffer containing the payload of the object
plen	The size of the payload buffer
extensions	The buffer containing the object extensions, if any
elen	The size of the object extensions buffer

Returns

The size of the generated object, if successful, or 0 otherwise

imquic_moq_add_fetch_ok()

size_t imquic_moq_add_fetch_ok	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint64_t	request_id,
		uint8_t	end_of_track,
		imquic_moq_location *	end_location,
		imquic_moq_request_parameters *	parameters,
		GList *	track_extensions )

Helper method to add a FETCH_OK message to a buffer.

Parameters

moq	The imquic_moq_context generating the message
bytes	The buffer to add the message to
blen	The size of the buffer
request_id	The request ID to put in the message
end_of_track	Whether all objects have been published
end_location	End location to add to the message, if needed
parameters	The parameters to add, if any
track_extensions	List of track extensions to add, if any (added in v16)

Returns

The size of the generated message, if successful, or 0 otherwise

imquic_moq_add_goaway()

size_t imquic_moq_add_goaway	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		const char *	new_session_uri )

Helper method to add a GOAWAY message to a buffer.

Parameters

moq	The imquic_moq_context generating the message
bytes	The buffer to add the message to
blen	The size of the buffer
new_session_uri	New uri value to put in the message, if any

Returns

The size of the generated message, if successful, or 0 otherwise

imquic_moq_add_max_request_id()

size_t imquic_moq_add_max_request_id	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint64_t	max_request_id )

Helper method to add a MAX_REQUEST_ID message to a buffer.

Parameters

moq	The imquic_moq_context generating the message
bytes	The buffer to add the message to
blen	The size of the buffer
max_request_id	Maximum request ID to put in the message

Returns

The size of the generated message, if successful, or 0 otherwise

imquic_moq_add_namespace()

size_t imquic_moq_add_namespace	(	imquic_moq_context *	moq,
		imquic_moq_stream *	moq_stream,
		uint8_t *	bytes,
		size_t	blen,
		imquic_moq_namespace *	track_namespace_suffix )

Helper method to add a NAMESPACE_DONE message to a buffer.

Parameters

moq	The imquic_moq_context generating the message
moq_stream	The imquic_moq_stream instance the message is for
bytes	The buffer to add the message to
blen	The size of the buffer
track_namespace_suffix	Namespace suffix that is advertised

Returns

The size of the generated message, if successful, or 0 otherwise

imquic_moq_add_namespace_done()

size_t imquic_moq_add_namespace_done	(	imquic_moq_context *	moq,
		imquic_moq_stream *	moq_stream,
		uint8_t *	bytes,
		size_t	blen,
		imquic_moq_namespace *	track_namespace_suffix )

Helper method to add a NAMESPACE_DONE message to a buffer.

Parameters

moq	The imquic_moq_context generating the message
moq_stream	The imquic_moq_stream instance the message is for
bytes	The buffer to add the message to
blen	The size of the buffer
track_namespace_suffix	Namespace suffix that is done

Returns

The size of the generated message, if successful, or 0 otherwise

imquic_moq_add_object_datagram()

size_t imquic_moq_add_object_datagram	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint64_t	request_id,
		uint64_t	track_alias,
		uint64_t	group_id,
		uint64_t	object_id,
		uint64_t	object_status,
		uint8_t	priority,
		uint8_t *	payload,
		size_t	plen,
		uint8_t *	extensions,
		size_t	elen )

Helper to add an OBJECT_DATAGRAM message to a buffer.

Note

This assumes the connection negotiated DATAGRAM support

Parameters

moq	The imquic_moq_context generating the message
bytes	The buffer to add the message to
blen	The size of the buffer
request_id	The request ID to put in the message
track_alias	The track alias to put in the message
group_id	The group ID to put in the message
object_id	The object ID to put in the message
object_status	The object status (only added if the payload length is 0)
priority	The publisher priority to put in the message
payload	The buffer containing the payload of the object
plen	The size of the payload buffer
extensions	The buffer containing the object extensions, if any
elen	The size of the object extensions buffer

Returns

The size of the generated message, if successful, or 0 otherwise

imquic_moq_add_object_datagram_status()

size_t imquic_moq_add_object_datagram_status	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint64_t	track_alias,
		uint64_t	group_id,
		uint64_t	object_id,
		uint8_t	priority,
		uint64_t	object_status,
		uint8_t *	extensions,
		size_t	elen )

Helper to add an OBJECT_DATAGRAM_STATUS message to a buffer.

Note

This assumes the connection negotiated DATAGRAM support

Parameters

moq	The imquic_moq_context generating the message
bytes	The buffer to add the message to
blen	The size of the buffer
track_alias	The track alias to put in the message
group_id	The group ID to put in the message
object_id	The object ID to put in the message
priority	The publisher priority to put in the message
object_status	The object status (only added if the payload length is 0)
extensions	The buffer containing the object extensions, if any
elen	The size of the object extensions buffer

Returns

The size of the generated message, if successful, or 0 otherwise

imquic_moq_add_object_extensions()

size_t imquic_moq_add_object_extensions	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint8_t *	extensions,
		size_t	elen )

Helper method to add object extensions to a buffer.

Parameters

moq	The imquic_moq_context generating the message
bytes	The buffer to add the extensions to
blen	The size of the buffer
extensions	The buffer containing the object extensions, if any
elen	The size of the object extensions buffer

Returns

The size of the generated extensions block, if successful, or 0 otherwise

imquic_moq_add_publish()

size_t imquic_moq_add_publish	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint64_t	request_id,
		imquic_moq_namespace *	track_namespace,
		imquic_moq_name *	track_name,
		uint64_t	track_alias,
		imquic_moq_request_parameters *	parameters,
		GList *	track_extensions )

Helper to add a PUBLISH message to a buffer.

Parameters

moq	The imquic_moq_context generating the message
bytes	The buffer to add the message to
blen	The size of the buffer
request_id	The request ID to put in the message
track_namespace	The namespace to put in the message
track_name	The track name to put in the message
track_alias	The track alias to put in the message
parameters	The parameters to add, if any
track_extensions	List of track extensions to add, if any (added in v16)

Returns

The size of the generated message, if successful, or 0 otherwise

imquic_moq_add_publish_done()

size_t imquic_moq_add_publish_done	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint64_t	request_id,
		imquic_moq_pub_done_code	status,
		uint64_t	streams_count,
		const char *	reason )

Helper method to add a PUBLISH_DONE message to a buffer.

Parameters

moq	The imquic_moq_context generating the message
bytes	The buffer to add the message to
blen	The size of the buffer
request_id	The request ID to put in the message
status	The status of the subscrption
streams_count	The streams count
reason	Verbose description of the status

Returns

The size of the generated message, if successful, or 0 otherwise

imquic_moq_add_publish_error()

size_t imquic_moq_add_publish_error	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint64_t	request_id,
		imquic_moq_request_error_code	error,
		const char *	reason )

Helper method to add a PUBLISH_ERRROR message to a buffer.

Parameters

moq	The imquic_moq_context generating the message
bytes	The buffer to add the message to
blen	The size of the buffer
request_id	The request ID to put in the message
error	Error code associated to the message
reason	Verbose description of the error, if any

Returns

The size of the generated message, if successful, or 0 otherwise

imquic_moq_add_publish_namespace()

size_t imquic_moq_add_publish_namespace	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint64_t	request_id,
		imquic_moq_namespace *	track_namespace,
		imquic_moq_request_parameters *	parameters )

Helper method to add a PUBLISH_NAMESPACE message to a buffer.

Parameters

moq	The imquic_moq_context generating the message
bytes	The buffer to add the message to
blen	The size of the buffer
request_id	The request ID to put in the message
track_namespace	Namespace to publish_namespace
parameters	The parameters to add, if any

Returns

The size of the generated message, if successful, or 0 otherwise

imquic_moq_add_publish_namespace_cancel()

size_t imquic_moq_add_publish_namespace_cancel	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		imquic_moq_namespace *	track_namespace,
		imquic_moq_request_error_code	error,
		const char *	reason )

Helper method to add aN PUBLISH_NAMESPACE_CANCEL message to a buffer.

Parameters

moq	The imquic_moq_context generating the message
bytes	The buffer to add the message to
blen	The size of the buffer
track_namespace	Namespace for which to cancel the publish_namespacement
error	Error code associated to the message
reason	Verbose description of the error, if any

Returns

The size of the generated message, if successful, or 0 otherwise

imquic_moq_add_publish_namespace_done()

size_t imquic_moq_add_publish_namespace_done	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		imquic_moq_namespace *	track_namespace )

Helper method to add a PUBLISH_NAMESPACE_DONE message to a buffer.

Parameters

moq	The imquic_moq_context generating the message
bytes	The buffer to add the message to
blen	The size of the buffer
track_namespace	Namespace to publish_namespace_done

Returns

The size of the generated message, if successful, or 0 otherwise

imquic_moq_add_publish_namespace_error()

size_t imquic_moq_add_publish_namespace_error	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint64_t	request_id,
		imquic_moq_request_error_code	error,
		const char *	reason )

Helper method to add a PUBLISH_NAMESPACE_ERROR message to a buffer.

Parameters

moq	The imquic_moq_context generating the message
bytes	The buffer to add the message to
blen	The size of the buffer
request_id	The request ID to put in the message
error	Error code associated to the message
reason	Verbose description of the error, if any

Returns

The size of the generated message, if successful, or 0 otherwise

imquic_moq_add_publish_namespace_ok()

size_t imquic_moq_add_publish_namespace_ok	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint64_t	request_id )

Helper method to add a PUBLISH_NAMESPACE_OK message to a buffer.

Parameters

moq	The imquic_moq_context generating the message
bytes	The buffer to add the message to
blen	The size of the buffer
request_id	The request ID to put in the message

Returns

The size of the generated message, if successful, or 0 otherwise

imquic_moq_add_publish_ok()

size_t imquic_moq_add_publish_ok	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint64_t	request_id,
		imquic_moq_request_parameters *	parameters )

Helper method to add a PUBLISH_OK message to a buffer.

Parameters

moq	The imquic_moq_context generating the message
bytes	The buffer to add the message to
blen	The size of the buffer
request_id	The request ID to put in the message
parameters	The parameters to add, if any

Returns

The size of the generated message, if successful, or 0 otherwise

imquic_moq_add_request_error()

size_t imquic_moq_add_request_error	(	imquic_moq_context *	moq,
		imquic_moq_stream *	moq_stream,
		uint8_t *	bytes,
		size_t	blen,
		uint64_t	request_id,
		uint64_t	error,
		const char *	reason,
		uint64_t	retry_interval )

Helper method to add a REQUEST_ERROR message to a buffer.

Note

This message was only added in v15, and consolidates all error messages that existed until then

Parameters

moq	The imquic_moq_context generating the message
moq_stream	The imquic_moq_stream instance the message is for
bytes	The buffer to add the message to
blen	The size of the buffer
request_id	The request ID to put in the message
error	Error code associated to the message
reason	Verbose description of the error, if any
retry_interval	Retry interval in ms (added in v16, ignored otherwise)

Returns

The size of the generated message, if successful, or 0 otherwise

imquic_moq_add_request_ok()

size_t imquic_moq_add_request_ok	(	imquic_moq_context *	moq,
		imquic_moq_stream *	moq_stream,
		uint8_t *	bytes,
		size_t	blen,
		uint64_t	request_id,
		imquic_moq_request_parameters *	parameters )

Helper method to add a REQUEST_OK message to a buffer.

Note

This message was only added in v15, and consolidates most OK messages that existed until then

Parameters

moq	The imquic_moq_context generating the message
moq_stream	The imquic_moq_stream instance the message is for
bytes	The buffer to add the message to
blen	The size of the buffer
request_id	The request ID to put in the message
parameters	The parameters to add, if any

Returns

The size of the generated message, if successful, or 0 otherwise

imquic_moq_add_request_update()

size_t imquic_moq_add_request_update	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint64_t	request_id,
		uint64_t	sub_request_id,
		imquic_moq_request_parameters *	parameters )

Helper method to add a REQUEST_UPDATE message to a buffer.

Parameters

moq	The imquic_moq_context generating the message
bytes	The buffer to add the message to
blen	The size of the buffer
request_id	The request ID to put in the message
sub_request_id	The subscription request ID to put in the message (ignored before v14)
parameters	The parameters to add, if any

Returns

The size of the generated message, if successful, or 0 otherwise

imquic_moq_add_requests_blocked()

size_t imquic_moq_add_requests_blocked	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint64_t	max_request_id )

Helper method to add a REQUESTS_BLOCKED message to a buffer.

Parameters

moq	The imquic_moq_context generating the message
bytes	The buffer to add the message to
blen	The size of the buffer
max_request_id	Maximum request ID to put in the message

Returns

The size of the generated message, if successful, or 0 otherwise

imquic_moq_add_server_setup()

size_t imquic_moq_add_server_setup	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint32_t	version,
		imquic_moq_setup_parameters *	parameters )

Helper method to add a SERVER_SETUP message to a buffer.

Parameters

moq	The imquic_moq_context generating the message
bytes	The buffer to add the message to
blen	The size of the buffer
version	Negotiated version
parameters	The setup parameters to send

Returns

The size of the generated message, if successful, or 0 otherwise

imquic_moq_add_subgroup_header()

size_t imquic_moq_add_subgroup_header	(	imquic_moq_context *	moq,
		imquic_moq_stream *	moq_stream,
		uint8_t *	bytes,
		size_t	blen,
		uint64_t	request_id,
		uint64_t	track_alias,
		uint64_t	group_id,
		uint64_t	subgroup_id,
		uint8_t	priority )

Helper to add a SUBGROUP_HEADER message to a buffer.

Note

This will create a new STREAM and send the header: after that, imquic_moq_add_stream_header_subgroup_object is used to send all objects that belong to this subgroup.

Parameters

moq	The imquic_moq_context generating the message
moq_stream	The imquic_moq_stream instance the message is for
bytes	The buffer to add the message to
blen	The size of the buffer
request_id	The request ID to put in the message
track_alias	The track alias to put in the message
group_id	The group ID to put in the message
subgroup_id	The subgroup ID to put in the message
priority	The publisher priority to put in the message

Returns

The size of the generated message, if successful, or 0 otherwise

imquic_moq_add_subgroup_header_object()

size_t imquic_moq_add_subgroup_header_object	(	imquic_moq_context *	moq,
		imquic_moq_stream *	moq_stream,
		uint8_t *	bytes,
		size_t	blen,
		uint64_t	object_id,
		uint64_t	object_status,
		uint8_t *	payload,
		size_t	plen,
		uint8_t *	extensions,
		size_t	elen )

Helper to add an object to a buffer, formatted as expected for SUBGROUP_HEADER objects (so not all IDs)

Parameters

moq	The imquic_moq_context generating the object
moq_stream	The imquic_moq_context instance the object is for
bytes	The buffer to add the object to
blen	The size of the buffer
object_id	The object ID
object_status	The object status (only added if the payload length is 0)
payload	The buffer containing the payload of the object
plen	The size of the payload buffer
extensions	The buffer containing the object extensions, if any
elen	The size of the object extensions buffer

Returns

The size of the generated object, if successful, or 0 otherwise

imquic_moq_add_subscribe()

size_t imquic_moq_add_subscribe	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint64_t	request_id,
		uint64_t	track_alias,
		imquic_moq_namespace *	track_namespace,
		imquic_moq_name *	track_name,
		imquic_moq_request_parameters *	parameters )

Helper to add a SUBSCRIBE message to a buffer.

Parameters

moq	The imquic_moq_context generating the message
bytes	The buffer to add the message to
blen	The size of the buffer
request_id	The request ID to put in the message
track_alias	The track alias to put in the message
track_namespace	The namespace to put in the message
track_name	The track name to put in the message
parameters	The parameters to add, if any

Returns

The size of the generated message, if successful, or 0 otherwise

imquic_moq_add_subscribe_error()

size_t imquic_moq_add_subscribe_error	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint64_t	request_id,
		imquic_moq_request_error_code	error,
		const char *	reason,
		uint64_t	track_alias )

Helper method to add a SUBSCRIBE_ERRROR message to a buffer.

Parameters

moq	The imquic_moq_context generating the message
bytes	The buffer to add the message to
blen	The size of the buffer
request_id	The request ID to put in the message
error	Error code associated to the message
reason	Verbose description of the error, if any
track_alias	The track alias to put in the message (ignored starting from v12)

Returns

The size of the generated message, if successful, or 0 otherwise

imquic_moq_add_subscribe_namespace()

size_t imquic_moq_add_subscribe_namespace	(	imquic_moq_context *	moq,
		imquic_moq_stream *	moq_stream,
		uint8_t *	bytes,
		size_t	blen,
		uint64_t	request_id,
		imquic_moq_namespace *	track_namespace,
		imquic_moq_subscribe_namespace_options	subscribe_options,
		imquic_moq_request_parameters *	parameters )

Helper to add a SUBSCRIBE_NAMESPACE message to a buffer.

Parameters

moq	The imquic_moq_context generating the message
moq_stream	The imquic_moq_stream instance the message is for
bytes	The buffer to add the message to
blen	The size of the buffer
request_id	The request ID to put in the message
track_namespace	The namespace to put in the message
subscribe_options	The subscribe options to put in the message (added in v16)
parameters	The parameters to add, if any

Returns

The size of the generated message, if successful, or 0 otherwise

imquic_moq_add_subscribe_namespace_error()

size_t imquic_moq_add_subscribe_namespace_error	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint64_t	request_id,
		imquic_moq_request_error_code	error,
		const char *	reason )

Helper method to add a SUBSCRIBE_NAMESPACE_ERRROR message to a buffer.

Parameters

moq	The imquic_moq_context generating the message
bytes	The buffer to add the message to
blen	The size of the buffer
request_id	The request ID to put in the message
error	Error code associated to the message
reason	Verbose description of the error, if any

Returns

The size of the generated message, if successful, or 0 otherwise

imquic_moq_add_subscribe_namespace_ok()

size_t imquic_moq_add_subscribe_namespace_ok	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint64_t	request_id )

Helper method to add a SUBSCRIBE_NAMESPACE_OK message to a buffer.

Parameters

moq	The imquic_moq_context generating the message
bytes	The buffer to add the message to
blen	The size of the buffer
request_id	The request ID to put in the message

Returns

The size of the generated message, if successful, or 0 otherwise

imquic_moq_add_subscribe_ok()

size_t imquic_moq_add_subscribe_ok	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint64_t	request_id,
		uint64_t	track_alias,
		imquic_moq_request_parameters *	parameters,
		GList *	track_extensions )

Helper method to add a SUBSCRIBE_OK message to a buffer.

Parameters

moq	The imquic_moq_context generating the message
bytes	The buffer to add the message to
blen	The size of the buffer
request_id	The request ID to put in the message
track_alias	The track alias to put in the message (ignored before v12)
parameters	The parameters to add, if any
track_extensions	List of track extensions to add, if any (added in v16)

Returns

The size of the generated message, if successful, or 0 otherwise

imquic_moq_add_track_status()

size_t imquic_moq_add_track_status	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint64_t	request_id,
		imquic_moq_namespace *	track_namespace,
		imquic_moq_name *	track_name,
		imquic_moq_request_parameters *	parameters )

Helper to add a TRACK_STATUS message to a buffer.

Parameters

moq	The imquic_moq_context generating the message
bytes	The buffer to add the message to
blen	The size of the buffer
request_id	The request ID to put in the message
track_namespace	The namespace to put in the message
track_name	The track name to put in the message
parameters	The parameters to add, if any

Returns

The size of the generated message, if successful, or 0 otherwise

imquic_moq_add_track_status_error()

size_t imquic_moq_add_track_status_error	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint64_t	request_id,
		imquic_moq_request_error_code	error,
		const char *	reason )

Helper method to add a TRACK_STATUS_ERRROR message to a buffer.

Parameters

moq	The imquic_moq_context generating the message
bytes	The buffer to add the message to
blen	The size of the buffer
request_id	The request ID to put in the message
error	Error code associated to the message
reason	Verbose description of the error, if any

Returns

The size of the generated message, if successful, or 0 otherwise

imquic_moq_add_track_status_ok()

size_t imquic_moq_add_track_status_ok	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint64_t	request_id,
		uint64_t	track_alias,
		imquic_moq_request_parameters *	parameters )

Helper method to add a TRACK_STATUS_OK message to a buffer.

Parameters

moq	The imquic_moq_context generating the message
bytes	The buffer to add the message to
blen	The size of the buffer
request_id	The request ID to put in the message
track_alias	The track alias to put in the message
parameters	The parameters to add, if any

Returns

The size of the generated message, if successful, or 0 otherwise

imquic_moq_add_unsubscribe()

size_t imquic_moq_add_unsubscribe	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint64_t	request_id )

Helper method to add an UNSUBSCRIBE message to a buffer.

Parameters

moq	The imquic_moq_context generating the message
bytes	The buffer to add the message to
blen	The size of the buffer
request_id	The request ID to put in the message

Returns

The size of the generated message, if successful, or 0 otherwise

imquic_moq_add_unsubscribe_namespace()

size_t imquic_moq_add_unsubscribe_namespace	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint64_t	request_id,
		imquic_moq_namespace *	track_namespace )

Helper method to add an UNSUBSCRIBE_NAMESPACE message to a buffer.

Parameters

moq	The imquic_moq_context generating the message
bytes	The buffer to add the message to
blen	The size of the buffer
request_id	The request ID to put in the message (added in v15)
track_namespace	The namespace to put in the message (ignored starting from v15)

Returns

The size of the generated message, if successful, or 0 otherwise

imquic_moq_auth_token_alias_type_str()

const char * imquic_moq_auth_token_alias_type_str

(

imquic_moq_auth_token_alias_type

type

)

Helper function to serialize to string the name of a imquic_moq_auth_token_alias_type property.

Parameters

type	The imquic_moq_auth_token_alias_type property

Returns

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

imquic_moq_build_auth_token()

size_t imquic_moq_build_auth_token	(	imquic_moq_auth_token *	token,
		uint8_t *	bytes,
		size_t	blen )

Helper mode to craft an auth token buffer out of a imquic_moq_auth_token instance.

Parameters

[in]	token	The imquic_moq_auth_token instance to serialize
[out]	bytes	The buffer to write the auth token to
[in]	blen	The size of the buffer to write to

Returns

How many bytes were written, if successful

imquic_moq_build_object_extensions()

size_t imquic_moq_build_object_extensions	(	imquic_moq_version	version,
		GList *	extensions,
		uint8_t *	bytes,
		size_t	blen )

Helper mode to craft an extensions buffer out of a GList of imquic_moq_object_extension.

Parameters

[in]	version	The version of the connection
[in]	extensions	The list of extensions to serialize
[out]	bytes	The buffer to write the extensions data to
[in]	blen	The size of the buffer to write to

Returns

How many bytes were written, if successful

imquic_moq_cancel_fetch()

int imquic_moq_cancel_fetch	(	imquic_connection *	conn,
		uint64_t	request_id )

Function to send a FETCH_CANCEL request.

Parameters

conn	The imquic_connection to send the request on
request_id	The unique request_id value associated to the subscription to cancel_fetch from

Returns

0 in case of success, a negative integer otherwise

imquic_moq_connection_gone()

void imquic_moq_connection_gone

(

imquic_connection *

conn

)

Callback the core invokes when an existing MoQ connection is not available anymore.

Parameters

conn	The imquic_connection instance that is now gone

imquic_moq_data_message_type_from_subgroup_header()

uint8_t imquic_moq_data_message_type_from_subgroup_header	(	imquic_moq_version	version,
		gboolean	subgroup,
		gboolean	sgid0,
		gboolean	ext,
		gboolean	eog,
		gboolean	priority )

Helper function to return the type to use for SUBRGOUP_HEADER out of the individual properties.

Parameters

[in]	version	The version of the connection
[in]	subgroup	Whether the Subgroup ID field is present
[in]	sgid0	Whether the default value of Subgroup ID is 0, in case the field is missing
[in]	ext	Whether there are extensions
[in]	eog	Whether there is an End of Group
[in]	priority	Whether there is a Publisher Priority (added in v15)

Returns

The type as a bitmask flag

imquic_moq_data_message_type_str()

const char * imquic_moq_data_message_type_str	(	imquic_moq_data_message_type	type,
		imquic_moq_version	version )

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

Parameters

type	The imquic_data_moq_message_type value
version	The version of the connection

Returns

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

imquic_moq_data_message_type_to_delivery()

imquic_moq_delivery imquic_moq_data_message_type_to_delivery	(	imquic_moq_data_message_type	type,
		imquic_moq_version	version )

Helper function to return the imquic_moq_delivery mode associated to a imquic_moq_data_message_type type.

Parameters

type	The imquic_data_moq_message_type value
version	The version of the connection

Returns

The associated imquic_moq_delivery mode, if successful, or -1 otherwise

imquic_moq_data_message_type_to_subgroup_header()

void imquic_moq_data_message_type_to_subgroup_header	(	imquic_moq_version	version,
		uint8_t	type,
		gboolean *	subgroup,
		gboolean *	sgid0,
		gboolean *	ext,
		gboolean *	eog,
		gboolean *	priority,
		gboolean *	violation )

Helper function to parse a type value for SUBRGOUP_HEADER to the individual properties.

Parameters

[in]	version	The version of the connection
[in]	type	The type to parse
[out]	subgroup	Output variable to write whether the Subgroup ID field is present
[out]	sgid0	Output variable to write whether the default value of Subgroup ID is 0, in case the field is missing
[out]	ext	Output variable to write whether there are extensions
[out]	eog	Output variable to write whether there is an End of Group
[out]	priority	Output variable to write whether there is a Publisher Priority (added in v15)
[out]	violation	Whether the type has bits set that really shouldn't

imquic_moq_datagram_incoming()

void imquic_moq_datagram_incoming	(	imquic_connection *	conn,
		uint8_t *	bytes,
		uint64_t	length )

Callback the core invokes when there's new incoming data on a DATAGRAM.

Parameters

conn	The imquic_connection instance for which new DATAGRAM data is available
bytes	The new data that is available
length	Size of the new data

imquic_moq_datagram_message_type_parse()

void imquic_moq_datagram_message_type_parse	(	imquic_moq_version	version,
		uint8_t	type,
		gboolean *	payload,
		gboolean *	ext,
		gboolean *	eog,
		gboolean *	oid,
		gboolean *	priority,
		gboolean *	violation )

Helper function to parse a imquic_moq_datagram_message_type value for OBJECT_DATAGRAM or OBJECT_DATAGRAM_STATUS to the individual properties.

Parameters

[in]	version	The version of the connection
[in]	type	The type to parse
[out]	payload	Output variable to write whether there is a payload
[out]	ext	Output variable to write whether there are extensions
[out]	eog	Output variable to write whether there is an End of Group
[out]	oid	Output variable to write whether there is an Object ID (ignored before v14)
[out]	priority	Output variable to write whether there is a Publisher Priority (added in v15)
[out]	violation	Whether the type has bits set that really shouldn't

imquic_moq_datagram_message_type_return()

uint8_t imquic_moq_datagram_message_type_return	(	imquic_moq_version	version,
		gboolean	payload,
		gboolean	ext,
		gboolean	eog,
		gboolean	oid,
		gboolean	priority )

Helper function to return the imquic_moq_datagram_message_type value for OBJECT_DATAGRAM or OBJECT_DATAGRAM_STATUS out of the individual properties.

Parameters

version	The version of the connection
payload	Whether there is a payload
ext	Whether there are extensions
eog	Whether there is an End of Group
oid	Whether there is an Object ID (ignored before v14)
priority	Whether there is a Publisher Priority (ignored before v15)

Returns

The type as a bitmask flag

imquic_moq_datagram_message_type_str()

const char * imquic_moq_datagram_message_type_str	(	uint8_t	type,
		imquic_moq_version	version )

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

Parameters

type	The type value
version	The version of the connection

Returns

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

imquic_moq_deinit()

void imquic_moq_deinit

(

void

)

Uninitialize the native MoQ stack.

imquic_moq_error_code_str()

const char * imquic_moq_error_code_str

(

imquic_moq_error_code

code

)

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

Parameters

code	The imquic_moq_error_code value

Returns

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

imquic_moq_fetch_type_str()

const char * imquic_moq_fetch_type_str

(

imquic_moq_fetch_type

type

)

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

Parameters

type	The imquic_moq_fetch_type value

Returns

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

imquic_moq_filter_type_str()

const char * imquic_moq_filter_type_str

(

imquic_moq_filter_type

type

)

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

Parameters

type	The imquic_moq_filter_type value

Returns

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

imquic_moq_generate_fetch_serialization_flags()

uint64_t imquic_moq_generate_fetch_serialization_flags	(	imquic_moq_version	version,
		imquic_moq_fetch_subgroup_type	subgroup,
		gboolean	oid,
		gboolean	group,
		gboolean	priority,
		gboolean	ext,
		gboolean	datagram,
		gboolean	end_ne_range,
		gboolean	end_uk_range )

Helper function to return the serialization flags to use for FETCH out of the individual properties.

Parameters

[in]	version	The version of the connection
[in]	subgroup	The type of subgroup
[in]	oid	Whether the Object ID field is present
[in]	group	Whether the Group ID field is present
[in]	priority	Whether the Publisher field is present
[in]	ext	Whether there are extensions
[in]	datagram	Whether the forwarding preference is Datagram
[in]	end_ne_range	Whether this is the end of a non-existent range (ignores all other properties)
[in]	end_uk_range	Whether this is the end of an unknown range (ignores all other properties)

Returns

The serialization flags as an integer

imquic_moq_get_next_request_id()

uint64_t imquic_moq_get_next_request_id

(

imquic_connection *

conn

)

Helper function to get the next Request ID we can use.

Parameters

conn	The imquic_connection to query

Returns

The next Request ID

imquic_moq_get_remote_implementation()

const char * imquic_moq_get_remote_implementation

(

imquic_connection *

conn

)

Helper function to return the MoQ implementation name as a string, if provided by the peer of this connection.

Note

The string is owned by the library, so if you'll need to rely on it externally in your application, you should duplicate it yourself

Parameters

conn	The imquic_connection to query

Returns

The name of the MoQ implementation, if available, or NULL otherwise

imquic_moq_get_version()

imquic_moq_version imquic_moq_get_version

(

imquic_connection *

conn

)

Helper function to get the MoQ version associated with a connection.

Parameters

conn	The imquic_connection to query

Returns

The imquic_moq_version value

imquic_moq_goaway()

int imquic_moq_goaway	(	imquic_connection *	conn,
		const char *	uri )

Function to send a GOAWAY request.

Parameters

conn	The imquic_connection to send the request on
uri	Where the client can connect to continue the session

Returns

0 in case of success, a negative integer otherwise

imquic_moq_group_order_str()

const char * imquic_moq_group_order_str

(

imquic_moq_group_order

type

)

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

Parameters

type	The imquic_moq_group_order value

Returns

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

imquic_moq_init()

void imquic_moq_init

(

void

)

Initialize the native MoQ stack at startup.

imquic_moq_is_data_message_type_valid()

gboolean imquic_moq_is_data_message_type_valid	(	imquic_moq_version	version,
		uint8_t	type )

Helper function to check if a type used for SUBRGOUP_HEADER is valid.

Parameters

[in]	version	The version of the connection
[in]	type	The type to parse

Returns

TRUE if the type is valid, FALSE otherwise

imquic_moq_is_datagram_message_type_valid()

gboolean imquic_moq_is_datagram_message_type_valid	(	imquic_moq_version	version,
		uint8_t	type )

Helper function to check if a type used for OBJECT_DATAGRAM or OBJECT_DATAGRAM_STATUS is valid.

Parameters

[in]	version	The version of the connection
[in]	type	The type to parse

Returns

TRUE if the type is valid, FALSE otherwise

imquic_moq_is_fetch_serialization_flags_valid()

gboolean imquic_moq_is_fetch_serialization_flags_valid	(	imquic_moq_version	version,
		uint64_t	flags )

Helper function to check if serialization flags used for FETCH are valid.

Parameters

[in]	version	The version of the connection
[in]	flags	The flags to parse

Returns

TRUE if the type is valid, FALSE otherwise

imquic_moq_joining_fetch()

int imquic_moq_joining_fetch	(	imquic_connection *	conn,
		uint64_t	request_id,
		uint64_t	joining_request_id,
		gboolean	absolute,
		uint64_t	joining_start,
		imquic_moq_request_parameters *	parameters )

Function to send a joining FETCH request.

Parameters

conn	The imquic_connection to send the request on
request_id	A unique numeric identifier to associate to this subscription
joining_request_id	Existing subscription to join
absolute	Whether this is an absolute or relative joining FETCH
joining_start	How many groups to retrieve before the current one, for relative joins, or starting group ID for absolute joins
parameters	The parameters to add to the request

Returns

0 in case of success, a negative integer otherwise

imquic_moq_message_type_str()

const char * imquic_moq_message_type_str	(	imquic_moq_message_type	type,
		imquic_moq_version	version )

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

Parameters

type	The imquic_moq_message_type value
version	The version of the connection

Returns

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

imquic_moq_new_connection()

void imquic_moq_new_connection	(	imquic_connection *	conn,
		void *	user_data )

Callback the core invokes when a new QUIC connection using MoQ is available.

Parameters

conn	The imquic_connection instance that is now available
user_data	Optional user data the user/application may have associated to the endpoint this connection belongs to

imquic_moq_notify_namespace()

int imquic_moq_notify_namespace	(	imquic_connection *	conn,
		uint64_t	request_id,
		imquic_moq_namespace *	tns )

Function to send a NAMESPACE request.

Note

This was added in v16, and while the request itself doesn't contain the request ID, we use it to find the subscription and use the right STREAM Notice the method expects the full track namespace: the stack will strip the prefix itself, before sending the actual message.

Parameters

conn	The imquic_connection to send the request on
request_id	The request ID of the original SUBSCRIBE_NAMESPACE request
tns	The imquic_moq_namespace namespace this request refers to

Returns

0 in case of success, a negative integer otherwise

imquic_moq_notify_namespace_done()

int imquic_moq_notify_namespace_done	(	imquic_connection *	conn,
		uint64_t	request_id,
		imquic_moq_namespace *	tns )

Function to send a NAMESPACE_DONE request.

Note

This was added in v16, and while the request itself doesn't contain the request ID, we use it to find the subscription and use the right STREAM. Notice the method expects the full track namespace: the stack will strip the prefix itself, before sending the actual message.

Parameters

conn	The imquic_connection to send the request on
request_id	The request ID of the original SUBSCRIBE_NAMESPACE request
tns	The imquic_moq_namespace namespace this request refers to

Returns

0 in case of success, a negative integer otherwise

imquic_moq_parameter_add_data()

size_t imquic_moq_parameter_add_data	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint64_t	param,
		uint64_t	prev,
		uint8_t *	buf,
		size_t	buflen )

Helper to add a MoQ (setup or subscribe) parameter with generic data to a buffer.

Parameters

moq	The imquic_moq_context instance the parameter is for
bytes	Buffer to add the parameter to
blen	Size of the buffer
param	ID of the parameter to add
prev	ID of the previously added parameter, if we're delta-encoding
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_moq_parameter_add_int()

size_t imquic_moq_parameter_add_int	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint64_t	param,
		uint64_t	prev,
		uint64_t	number )

Helper to add a MoQ (setup or subscribe) parameter with a numeric value to a buffer.

Parameters

moq	The imquic_moq_context instance the parameter is for
bytes	Buffer to add the parameter to
blen	Size of the buffer
param	ID of the parameter to add
prev	ID of the previously added parameter, if we're delta-encoding
number	The numeric value of the parameter to add

Returns

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

imquic_moq_parse_auth_token()

int imquic_moq_parse_auth_token	(	uint8_t *	bytes,
		size_t	blen,
		imquic_moq_auth_token *	token )

Helper mode to parse an auth token buffer to a imquic_moq_auth_token instance.

Note

The buffer in the value property will point to data in the original bytes buffer, which means that no allocation will be performed by this method. If you need to store the token value somewhere, it's up to you to copy it before bytes is invalidated by the application

Parameters

[in]	bytes	The buffer containing the auth token data
[in]	blen	The size of the buffer containing the auth token data data
[out]	token	The imquic_moq_auth_token to put the parsed token info to

Returns

0 in case of success, or a negative integer otherwise

imquic_moq_parse_client_setup()

size_t imquic_moq_parse_client_setup	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint8_t *	error )

Helper to parse a CLIENT_SETUP message.

Parameters

[in]	moq	The imquic_moq_context instance the message is for
[in]	bytes	The buffer containing the message to parse
[in]	blen	Size of the buffer to parse
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

The size of the parsed message, if successful, or 0 otherwise

imquic_moq_parse_fetch()

size_t imquic_moq_parse_fetch	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint8_t *	error )

Helper to parse a FETCH message.

Parameters

[in]	moq	The imquic_moq_context instance the message is for
[in]	bytes	The buffer containing the message to parse
[in]	blen	Size of the buffer to parse
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

The size of the parsed message, if successful, or 0 otherwise

imquic_moq_parse_fetch_cancel()

size_t imquic_moq_parse_fetch_cancel	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint8_t *	error )

Helper to parse a FETCH_CANCEL message.

Parameters

[in]	moq	The imquic_moq_context instance the message is for
[in]	bytes	The buffer containing the message to parse
[in]	blen	Size of the buffer to parse
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

The size of the parsed message, if successful, or 0 otherwise

imquic_moq_parse_fetch_error()

size_t imquic_moq_parse_fetch_error	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint8_t *	error )

Helper to parse a FETCH_ERROR message.

Parameters

[in]	moq	The imquic_moq_context instance the message is for
[in]	bytes	The buffer containing the message to parse
[in]	blen	Size of the buffer to parse
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

The size of the parsed message, if successful, or 0 otherwise

imquic_moq_parse_fetch_header()

size_t imquic_moq_parse_fetch_header	(	imquic_moq_context *	moq,
		imquic_moq_stream *	moq_stream,
		uint8_t *	bytes,
		size_t	blen,
		uint8_t *	error )

Helper to parse a FETCH_HEADER message.

Parameters

[in]	moq	The imquic_moq_context instance the message is for
[in]	moq_stream	The imquic_moq_stream instance the object is from
[in]	bytes	The buffer containing the message to parse
[in]	blen	Size of the buffer to parse
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

The size of the parsed message, if successful, or 0 otherwise

imquic_moq_parse_fetch_header_object()

int imquic_moq_parse_fetch_header_object	(	imquic_moq_context *	moq,
		imquic_moq_stream *	moq_stream,
		gboolean	complete,
		uint8_t *	error )

Helper to parse a FETCH_HEADER object.

Note

A negative response doesn't mean there's an error, but just that the object isn't complete yet and we need to wait for more data.

Parameters

[in]	moq	The imquic_moq_context instance the object is for
[in]	moq_stream	The imquic_moq_stream instance the object is from
[in]	complete	Whether this data marks the completion of the QUIC stream it came from
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

0 in case of success, or a negative integer otherwise

imquic_moq_parse_fetch_ok()

size_t imquic_moq_parse_fetch_ok	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint8_t *	error )

Helper to parse a FETCH_OK message.

Parameters

[in]	moq	The imquic_moq_context instance the message is for
[in]	bytes	The buffer containing the message to parse
[in]	blen	Size of the buffer to parse
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

The size of the parsed message, if successful, or 0 otherwise

imquic_moq_parse_fetch_serialization_flags()

void imquic_moq_parse_fetch_serialization_flags	(	imquic_moq_version	version,
		uint64_t	flags,
		imquic_moq_fetch_subgroup_type *	subgroup,
		gboolean *	oid,
		gboolean *	group,
		gboolean *	priority,
		gboolean *	ext,
		gboolean *	datagram,
		gboolean *	end_ne_range,
		gboolean *	end_uk_range,
		gboolean *	violation )

Helper function to parse serialozation flags for FETCH to the individual properties.

Parameters

[in]	version	The version of the connection
[in]	flags	The serialization flags to parse
[out]	subgroup	Output variable to write the type of subgroup
[out]	oid	Output variable to write whether the Object ID field is present
[out]	group	Output variable to write whether the Group ID field is present
[out]	priority	Output variable to write whether there is a Publisher Priority (added in v15)
[out]	ext	Output variable to write whether there are extensions
[out]	datagram	Output variable to write whether the forwarding preference is Datagram
[out]	end_ne_range	Output variable to write whether this is the end of a non-existent range
[out]	end_uk_range	Output variable to write whether this is the end of an unknown range
[out]	violation	Whether the type has bits set that really shouldn't

imquic_moq_parse_goaway()

size_t imquic_moq_parse_goaway	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint8_t *	error )

Helper to parse a GOAWAY message.

Parameters

[in]	moq	The imquic_moq_context instance the message is for
[in]	bytes	The buffer containing the message to parse
[in]	blen	Size of the buffer to parse
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

The size of the parsed message, if successful, or 0 otherwise

imquic_moq_parse_max_request_id()

size_t imquic_moq_parse_max_request_id	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint8_t *	error )

Helper to parse a MAX_REQUEST_ID message.

Parameters

[in]	moq	The imquic_moq_context instance the message is for
[in]	bytes	The buffer containing the message to parse
[in]	blen	Size of the buffer to parse
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

The size of the parsed message, if successful, or 0 otherwise

imquic_moq_parse_message()

int imquic_moq_parse_message	(	imquic_moq_context *	moq,
		uint64_t	stream_id,
		uint8_t *	bytes,
		size_t	blen,
		gboolean	complete,
		gboolean	datagram )

Parse an incoming MoQ message.

Note

This will iterate on a buffer, trying to parse as many messages as possible in a sequential way. In case a message is incomplete (e.g., because we're still waiting on STREAM data), we move back to the beginning of the buffer and return, waiting for more data to arrive.

Parameters

moq	The imquic_moq_context instance the message is for
stream_id	The QUIC stream ID the message came from
bytes	The buffer containing the message to parse
blen	Size of the buffer to parse
complete	Whether this data marks the completion of the QUIC stream it came from
datagram	Whether this is not coming from a STREAM but a DATAGRAM

Returns

0 in case of success, or a negative integer otherwise

imquic_moq_parse_namespace()

size_t imquic_moq_parse_namespace	(	imquic_moq_context *	moq,
		imquic_moq_stream *	moq_stream,
		uint8_t *	bytes,
		size_t	blen,
		uint8_t *	error )

Helper to parse a NAMESPACE message.

Note

This method was added in v16, to notify namespaces on a dedicated STREAM

Parameters

[in]	moq	The imquic_moq_context instance the message is for
[in]	moq_stream	The imquic_moq_stream instance the message came from
[in]	bytes	The buffer containing the message to parse
[in]	blen	Size of the buffer to parse
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

The size of the parsed message, if successful, or 0 otherwise

imquic_moq_parse_namespace_done()

size_t imquic_moq_parse_namespace_done	(	imquic_moq_context *	moq,
		imquic_moq_stream *	moq_stream,
		uint8_t *	bytes,
		size_t	blen,
		uint8_t *	error )

Helper to parse a NAMESPACE_DONE message.

Note

This method was added in v16, to notify namespaces on a dedicated STREAM

Parameters

[in]	moq	The imquic_moq_context instance the message is for
[in]	moq_stream	The imquic_moq_stream instance the message came from
[in]	bytes	The buffer containing the message to parse
[in]	blen	Size of the buffer to parse
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

The size of the parsed message, if successful, or 0 otherwise

imquic_moq_parse_object_datagram()

size_t imquic_moq_parse_object_datagram	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		imquic_moq_datagram_message_type	dtype,
		uint8_t *	error )

Helper to parse an OBJECT_DATAGRAM message.

Parameters

[in]	moq	The imquic_moq_context instance the message is for
[in]	bytes	The buffer containing the message to parse
[in]	blen	Size of the buffer to parse
[in]	dtype	Type of OBJECT_DATAGRAM
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

The size of the parsed message, if successful, or 0 otherwise

imquic_moq_parse_object_datagram_status()

size_t imquic_moq_parse_object_datagram_status	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		imquic_moq_datagram_message_type	dtype,
		uint8_t *	error )

Helper to parse an OBJECT_DATAGRAM_STATUS message.

Parameters

[in]	moq	The imquic_moq_context instance the message is for
[in]	bytes	The buffer containing the message to parse
[in]	blen	Size of the buffer to parse
[in]	dtype	Type of OBJECT_DATAGRAM_STATUS
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

The size of the parsed message, if successful, or 0 otherwise

imquic_moq_parse_object_extensions()

GList * imquic_moq_parse_object_extensions	(	imquic_moq_version	version,
		uint8_t *	extensions,
		size_t	elen )

Helper mode to parse an extensions buffer to a GList of imquic_moq_object_extension.

Note

The caller owns the list, and is responsible of freeing it and its content

Parameters

version	The version of the connection
extensions	The buffer containing the extensions data
elen	The size of the buffer containing the extensions data

Returns

A GList instance containing a set of imquic_moq_object_extension, if successful, or NULL if no extensions were found

imquic_moq_parse_publish()

size_t imquic_moq_parse_publish	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint8_t *	error )

Helper to parse a PUBLISH message.

Parameters

[in]	moq	The imquic_moq_context instance the message is for
[in]	bytes	The buffer containing the message to parse
[in]	blen	Size of the buffer to parse
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

The size of the parsed message, if successful, or 0 otherwise

imquic_moq_parse_publish_done()

size_t imquic_moq_parse_publish_done	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint8_t *	error )

Helper to parse a PUBLISH_DONE message.

Parameters

[in]	moq	The imquic_moq_context instance the message is for
[in]	bytes	The buffer containing the message to parse
[in]	blen	Size of the buffer to parse
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

The size of the parsed message, if successful, or 0 otherwise

imquic_moq_parse_publish_error()

size_t imquic_moq_parse_publish_error	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint8_t *	error )

Helper to parse a PUBLISH_ERROR message.

Parameters

[in]	moq	The imquic_moq_context instance the message is for
[in]	bytes	The buffer containing the message to parse
[in]	blen	Size of the buffer to parse
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

The size of the parsed message, if successful, or 0 otherwise

imquic_moq_parse_publish_namespace()

size_t imquic_moq_parse_publish_namespace	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint8_t *	error )

Helper to parse a PUBLISH_NAMESPACE message.

Parameters

[in]	moq	The imquic_moq_context instance the message is for
[in]	bytes	The buffer containing the message to parse
[in]	blen	Size of the buffer to parse
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

The size of the parsed message, if successful, or 0 otherwise

imquic_moq_parse_publish_namespace_cancel()

size_t imquic_moq_parse_publish_namespace_cancel	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint8_t *	error )

Helper to parse a PUBLISH_NAMESPACE_CANCEL message.

Parameters

[in]	moq	The imquic_moq_context instance the message is for
[in]	bytes	The buffer containing the message to parse
[in]	blen	Size of the buffer to parse
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

The size of the parsed message, if successful, or 0 otherwise

imquic_moq_parse_publish_namespace_done()

size_t imquic_moq_parse_publish_namespace_done	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint8_t *	error )

Helper to parse a PUBLISH_NAMESPACE_DONE message.

Parameters

[in]	moq	The imquic_moq_context instance the message is for
[in]	bytes	The buffer containing the message to parse
[in]	blen	Size of the buffer to parse
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

The size of the parsed message, if successful, or 0 otherwise

imquic_moq_parse_publish_namespace_error()

size_t imquic_moq_parse_publish_namespace_error	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint8_t *	error )

Helper to parse a PUBLISH_NAMESPACE_ERROR message.

Parameters

[in]	moq	The imquic_moq_context instance the message is for
[in]	bytes	The buffer containing the message to parse
[in]	blen	Size of the buffer to parse
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

The size of the parsed message, if successful, or 0 otherwise

imquic_moq_parse_publish_namespace_ok()

size_t imquic_moq_parse_publish_namespace_ok	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint8_t *	error )

Helper to parse a PUBLISH_NAMESPACE_OK message.

Parameters

[in]	moq	The imquic_moq_context instance the message is for
[in]	bytes	The buffer containing the message to parse
[in]	blen	Size of the buffer to parse
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

The size of the parsed message, if successful, or 0 otherwise

imquic_moq_parse_publish_ok()

size_t imquic_moq_parse_publish_ok	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint8_t *	error )

Helper to parse a PUBLISH_OK message.

Parameters

[in]	moq	The imquic_moq_context instance the message is for
[in]	bytes	The buffer containing the message to parse
[in]	blen	Size of the buffer to parse
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

The size of the parsed message, if successful, or 0 otherwise

imquic_moq_parse_request_error()

size_t imquic_moq_parse_request_error	(	imquic_moq_context *	moq,
		imquic_moq_stream *	moq_stream,
		uint8_t *	bytes,
		size_t	blen,
		uint8_t *	error )

Helper to parse a REQUEST_ERROR message.

Note

This message was only added in v15, and consolidates all error messages that existed until then. It will automatically trigger the right callback, by checking what the original request was for

Parameters

[in]	moq	The imquic_moq_context instance the message is for
[in]	moq_stream	The imquic_moq_stream instance the message came from (ignored before v16, only needed for namespaces)
[in]	bytes	The buffer containing the message to parse
[in]	blen	Size of the buffer to parse
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

The size of the parsed message, if successful, or 0 otherwise

imquic_moq_parse_request_ok()

size_t imquic_moq_parse_request_ok	(	imquic_moq_context *	moq,
		imquic_moq_stream *	moq_stream,
		uint8_t *	bytes,
		size_t	blen,
		uint8_t *	error )

Helper to parse a REQUEST_OK message.

Note

This message was only added in v15, and consolidates most OK messages that existed until then. It will automatically trigger the right callback, by checking what the original request was for

Parameters

[in]	moq	The imquic_moq_context instance the message is for
[in]	moq_stream	The imquic_moq_stream instance the message came from (ignored before v16, only needed for namespaces)
[in]	bytes	The buffer containing the message to parse
[in]	blen	Size of the buffer to parse
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

The size of the parsed message, if successful, or 0 otherwise

imquic_moq_parse_request_parameter()

size_t imquic_moq_parse_request_parameter	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		imquic_moq_request_parameters *	params,
		uint64_t *	param_type,
		uint8_t *	error )

Helper method to parse a MoQ subscribe parameter.

Note

This method does nothing at the moment

Parameters

[in]	moq	The imquic_moq_context instance to update with the new parameter
[in]	bytes	Buffer containing the parameter to parse
[in]	blen	Size of the buffer to parse
[out]	params	imquic_moq_request_parameters instance to put the parsed parameter in
[out]	param_type	Type of the parsed parameter, needed for delta-decoding
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

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

imquic_moq_parse_request_update()

size_t imquic_moq_parse_request_update	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint8_t *	error )

Helper to parse a REQUEST_UPDATE message.

Parameters

[in]	moq	The imquic_moq_context instance the message is for
[in]	bytes	The buffer containing the message to parse
[in]	blen	Size of the buffer to parse
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

The size of the parsed message, if successful, or 0 otherwise

imquic_moq_parse_requests_blocked()

size_t imquic_moq_parse_requests_blocked	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint8_t *	error )

Helper to parse a REQUESTS_BLOCKED message.

Parameters

[in]	moq	The imquic_moq_context instance the message is for
[in]	bytes	The buffer containing the message to parse
[in]	blen	Size of the buffer to parse
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

The size of the parsed message, if successful, or 0 otherwise

imquic_moq_parse_server_setup()

size_t imquic_moq_parse_server_setup	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint8_t *	error )

Helper to parse a SERVER_SETUP message.

Parameters

[in]	moq	The imquic_moq_context instance the message is for
[in]	bytes	The buffer containing the message to parse
[in]	blen	Size of the buffer to parse
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

The size of the parsed message, if successful, or 0 otherwise

imquic_moq_parse_setup_parameter()

size_t imquic_moq_parse_setup_parameter	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		imquic_moq_setup_parameters *	params,
		uint64_t *	param_type,
		uint8_t *	error )

Helper method to parse a MoQ setup parameter.

Note

This method does nothing at the moment

Parameters

[in]	moq	The imquic_moq_context instance to update with the new parameter
[in]	bytes	Buffer containing the parameter to parse
[in]	blen	Size of the buffer to parse
[out]	params	imquic_moq_setup_parameters instance to put the parsed parameter in
[out]	param_type	Type of the parsed parameter, needed for delta-decoding
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

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

imquic_moq_parse_subgroup_header()

size_t imquic_moq_parse_subgroup_header	(	imquic_moq_context *	moq,
		imquic_moq_stream *	moq_stream,
		uint8_t *	bytes,
		size_t	blen,
		imquic_moq_data_message_type	dtype,
		uint8_t *	error )

Helper to parse a SUBGROUP_HEADER message.

Parameters

[in]	moq	The imquic_moq_context instance the message is for
[in]	moq_stream	The imquic_moq_stream instance the message came from
[in]	bytes	The buffer containing the message to parse
[in]	blen	Size of the buffer to parse
[in]	dtype	Type of SUBGROUP_HEADER
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

The size of the parsed message, if successful, or 0 otherwise

imquic_moq_parse_subgroup_header_object()

int imquic_moq_parse_subgroup_header_object	(	imquic_moq_context *	moq,
		imquic_moq_stream *	moq_stream,
		gboolean	complete,
		uint8_t *	error )

Helper to parse a SUBGROUP_HEADER object.

Note

A negative response doesn't mean there's an error, but just that the object isn't complete yet and we need to wait for more data.

Parameters

[in]	moq	The imquic_moq_context instance the object is for
[in]	moq_stream	The imquic_moq_stream instance the object is from
[in]	complete	Whether this data marks the completion of the QUIC stream it came from
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

0 in case of success, or a negative integer otherwise

imquic_moq_parse_subscribe()

size_t imquic_moq_parse_subscribe	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint8_t *	error )

Helper to parse a SUBSCRIBE message.

Parameters

[in]	moq	The imquic_moq_context instance the message is for
[in]	bytes	The buffer containing the message to parse
[in]	blen	Size of the buffer to parse
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

The size of the parsed message, if successful, or 0 otherwise

imquic_moq_parse_subscribe_error()

size_t imquic_moq_parse_subscribe_error	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint8_t *	error )

Helper to parse a SUBSCRIBE_ERROR message.

Parameters

[in]	moq	The imquic_moq_context instance the message is for
[in]	bytes	The buffer containing the message to parse
[in]	blen	Size of the buffer to parse
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

The size of the parsed message, if successful, or 0 otherwise

imquic_moq_parse_subscribe_namespace()

size_t imquic_moq_parse_subscribe_namespace	(	imquic_moq_context *	moq,
		imquic_moq_stream *	moq_stream,
		uint8_t *	bytes,
		size_t	blen,
		uint8_t *	error )

Helper to parse a SUBSCRIBE_NAMESPACE message.

Parameters

[in]	moq	The imquic_moq_context instance the message is for
[in]	moq_stream	The imquic_moq_stream instance the message came from (ignored before v16)
[in]	bytes	The buffer containing the message to parse
[in]	blen	Size of the buffer to parse
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

The size of the parsed message, if successful, or 0 otherwise

imquic_moq_parse_subscribe_namespace_error()

size_t imquic_moq_parse_subscribe_namespace_error	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint8_t *	error )

Helper to parse a SUBSCRIBE_NAMESPACE_ERROR message.

Parameters

[in]	moq	The imquic_moq_context instance the message is for
[in]	bytes	The buffer containing the message to parse
[in]	blen	Size of the buffer to parse
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

The size of the parsed message, if successful, or 0 otherwise

imquic_moq_parse_subscribe_namespace_ok()

size_t imquic_moq_parse_subscribe_namespace_ok	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint8_t *	error )

Helper to parse a SUBSCRIBE_NAMESPACE_OK message.

Parameters

[in]	moq	The imquic_moq_context instance the message is for
[in]	bytes	The buffer containing the message to parse
[in]	blen	Size of the buffer to parse
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

The size of the parsed message, if successful, or 0 otherwise

imquic_moq_parse_subscribe_ok()

size_t imquic_moq_parse_subscribe_ok	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint8_t *	error )

Helper to parse a SUBSCRIBE_OK message.

Parameters

[in]	moq	The imquic_moq_context instance the message is for
[in]	bytes	The buffer containing the message to parse
[in]	blen	Size of the buffer to parse
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

The size of the parsed message, if successful, or 0 otherwise

imquic_moq_parse_track_status()

size_t imquic_moq_parse_track_status	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint8_t *	error )

Helper to parse a TRACK_STATUS message.

Parameters

[in]	moq	The imquic_moq_context instance the message is for
[in]	bytes	The buffer containing the message to parse
[in]	blen	Size of the buffer to parse
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

The size of the parsed message, if successful, or 0 otherwise

imquic_moq_parse_track_status_error()

size_t imquic_moq_parse_track_status_error	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint8_t *	error )

Helper to parse a TRACK_STATUS_ERROR message.

Parameters

[in]	moq	The imquic_moq_context instance the message is for
[in]	bytes	The buffer containing the message to parse
[in]	blen	Size of the buffer to parse
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

The size of the parsed message, if successful, or 0 otherwise

imquic_moq_parse_track_status_ok()

size_t imquic_moq_parse_track_status_ok	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint8_t *	error )

Helper to parse a TRACK_STATUS_OK message.

Parameters

[in]	moq	The imquic_moq_context instance the message is for
[in]	bytes	The buffer containing the message to parse
[in]	blen	Size of the buffer to parse
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

The size of the parsed message, if successful, or 0 otherwise

imquic_moq_parse_unsubscribe()

size_t imquic_moq_parse_unsubscribe	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint8_t *	error )

Helper to parse an UNSUBSCRIBE message.

Parameters

[in]	moq	The imquic_moq_context instance the message is for
[in]	bytes	The buffer containing the message to parse
[in]	blen	Size of the buffer to parse
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

The size of the parsed message, if successful, or 0 otherwise

imquic_moq_parse_unsubscribe_namespace()

size_t imquic_moq_parse_unsubscribe_namespace	(	imquic_moq_context *	moq,
		uint8_t *	bytes,
		size_t	blen,
		uint8_t *	error )

Helper to parse an UNSUBSCRIBE_NAMESPACE message.

Parameters

[in]	moq	The imquic_moq_context instance the message is for
[in]	bytes	The buffer containing the message to parse
[in]	blen	Size of the buffer to parse
[out]	error	In/out property, initialized to 0 and set to something else in case of parsing errors

Returns

The size of the parsed message, if successful, or 0 otherwise

imquic_moq_pub_done_code_str()

const char * imquic_moq_pub_done_code_str

(

imquic_moq_pub_done_code

code

)

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

Parameters

code	The imquic_moq_pub_done_code value

Returns

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

imquic_moq_publish()

int imquic_moq_publish	(	imquic_connection *	conn,
		uint64_t	request_id,
		imquic_moq_namespace *	tns,
		imquic_moq_name *	tn,
		uint64_t	track_alias,
		imquic_moq_request_parameters *	parameters,
		GList *	track_extensions )

Function to send a PUBLISH request.

Parameters

conn	The imquic_connection to send the request on
request_id	A unique request ID to associate to this subscription
tns	The imquic_moq_namespace namespace the track to publish to belongs to
tn	The imquic_moq_name track name to publish to
track_alias	A unique numeric identifier to associate to the track in this subscription
parameters	The parameters to add to the request
track_extensions	List of track extensions to add, if any (added in v16)

Returns

0 in case of success, a negative integer otherwise

imquic_moq_publish_done()

int imquic_moq_publish_done	(	imquic_connection *	conn,
		uint64_t	request_id,
		imquic_moq_pub_done_code	status_code,
		const char *	reason )

Function to send a PUBLISH_DONE request.

Note

The streams count is handled by the library internally

Parameters

conn	The imquic_connection to send the request on
request_id	The unique request_id value associated to the subscription that's now done
status_code	The status code
reason	A reason phrase, if needed

Returns

0 in case of success, a negative integer otherwise

imquic_moq_publish_namespace()

int imquic_moq_publish_namespace	(	imquic_connection *	conn,
		uint64_t	request_id,
		imquic_moq_namespace *	tns,
		imquic_moq_request_parameters *	parameters )

Function to send a PUBLISH_NAMESPACE request.

Parameters

conn	The imquic_connection to send the request on
request_id	A unique request ID
tns	The imquic_moq_namespace namespace to publish_namespace
parameters	The parameters to add to the request

Returns

0 in case of success, a negative integer otherwise

imquic_moq_publish_namespace_done()

int imquic_moq_publish_namespace_done	(	imquic_connection *	conn,
		imquic_moq_namespace *	tns )

Function to send a PUBLISH_NAMESPACE_DONE request.

Parameters

conn	The imquic_connection to send the request on
tns	The imquic_moq_namespace namespace to publish_namespace_done

Returns

0 in case of success, a negative integer otherwise

imquic_moq_qlog_control_message_created()

void imquic_moq_qlog_control_message_created	(	imquic_qlog *	qlog,
		uint64_t	stream_id,
		uint8_t *	bytes,
		size_t	length,
		json_t *	message )

Add a control_message_created event.

Parameters

qlog	The imquic_qlog instance to add the event to
stream_id	The Stream ID used for this message
bytes	The content of the message
length	The length of the message
message	The message content

imquic_moq_qlog_control_message_parsed()

void imquic_moq_qlog_control_message_parsed	(	imquic_qlog *	qlog,
		uint64_t	stream_id,
		uint8_t *	bytes,
		size_t	length,
		json_t *	message )

Add a control_message_parsed event.

Parameters

qlog	The imquic_qlog instance to add the event to
stream_id	The Stream ID used for this message
bytes	The content of the message
length	The length of the message
message	The message content

imquic_moq_qlog_fetch_header_created()

void imquic_moq_qlog_fetch_header_created	(	imquic_qlog *	qlog,
		imquic_moq_stream *	stream,
		uint8_t *	bytes,
		size_t	length )

Add a fetch_header_created event.

Parameters

qlog	The imquic_qlog instance to add the event to
stream	The stream used for this header
bytes	The content of the message
length	The length of the message

imquic_moq_qlog_fetch_header_parsed()

void imquic_moq_qlog_fetch_header_parsed	(	imquic_qlog *	qlog,
		imquic_moq_stream *	stream,
		uint8_t *	bytes,
		size_t	length )

Add a fetch_header_parsed event.

Parameters

qlog	The imquic_qlog instance to add the event to
stream	The stream used for this header
bytes	The content of the message
length	The length of the message

imquic_moq_qlog_fetch_object_created()

void imquic_moq_qlog_fetch_object_created	(	imquic_qlog *	qlog,
		uint64_t	stream_id,
		imquic_moq_object *	object )

Add a fetch_object_created event.

Parameters

qlog	The imquic_qlog instance to add the event to
stream_id	The Stream ID used for this object
object	The object instance

imquic_moq_qlog_fetch_object_parsed()

void imquic_moq_qlog_fetch_object_parsed	(	imquic_qlog *	qlog,
		uint64_t	stream_id,
		imquic_moq_object *	object )

Add a fetch_object_parsed event.

Parameters

qlog	The imquic_qlog instance to add the event to
stream_id	The Stream ID used for this object
object	The object instance

imquic_moq_qlog_object_datagram_created()

void imquic_moq_qlog_object_datagram_created	(	imquic_qlog *	qlog,
		imquic_moq_object *	object )

Add a object_datagram_created event.

Parameters

qlog	The imquic_qlog instance to add the event to
object	The object instance

imquic_moq_qlog_object_datagram_parsed()

void imquic_moq_qlog_object_datagram_parsed	(	imquic_qlog *	qlog,
		imquic_moq_object *	object )

Add a object_datagram_parsed event.

Parameters

qlog	The imquic_qlog instance to add the event to
object	The object instance

imquic_moq_qlog_object_datagram_status_created()

void imquic_moq_qlog_object_datagram_status_created	(	imquic_qlog *	qlog,
		imquic_moq_object *	object )

Add a object_datagram_status_created event.

Parameters

qlog	The imquic_qlog instance to add the event to
object	The object instance

imquic_moq_qlog_object_datagram_status_parsed()

void imquic_moq_qlog_object_datagram_status_parsed	(	imquic_qlog *	qlog,
		imquic_moq_object *	object )

Add a object_datagram_status_parsed event.

Parameters

qlog	The imquic_qlog instance to add the event to
object	The object instance

imquic_moq_qlog_stream_type_set()

void imquic_moq_qlog_stream_type_set	(	imquic_qlog *	qlog,
		gboolean	local,
		uint64_t	stream_id,
		const char *	type )

Add a stream_type_set event.

Parameters

qlog	The imquic_qlog instance to add the event to
local	Whether this is a local or remote stream
stream_id	The Stream ID used for this message
type	The stream type

imquic_moq_qlog_subgroup_header_created()

void imquic_moq_qlog_subgroup_header_created	(	imquic_qlog *	qlog,
		imquic_moq_stream *	stream,
		uint8_t *	bytes,
		size_t	length )

Add a subgroup_header_created event.

Parameters

qlog	The imquic_qlog instance to add the event to
stream	The stream used for this header
bytes	The content of the message
length	The length of the message

imquic_moq_qlog_subgroup_header_parsed()

void imquic_moq_qlog_subgroup_header_parsed	(	imquic_qlog *	qlog,
		imquic_moq_stream *	stream,
		uint8_t *	bytes,
		size_t	length )

Add a subgroup_header_parsed event.

Parameters

qlog	The imquic_qlog instance to add the event to
stream	The stream used for this header
bytes	The content of the message
length	The length of the message

imquic_moq_qlog_subgroup_object_created()

void imquic_moq_qlog_subgroup_object_created	(	imquic_qlog *	qlog,
		uint64_t	stream_id,
		imquic_moq_object *	object )

Add a subgroup_object_created event.

Parameters

qlog	The imquic_qlog instance to add the event to
stream_id	The Stream ID used for this object
object	The object instance

imquic_moq_qlog_subgroup_object_parsed()

void imquic_moq_qlog_subgroup_object_parsed	(	imquic_qlog *	qlog,
		uint64_t	stream_id,
		imquic_moq_object *	object )

Add a subgroup_object_parsed event.

Parameters

qlog	The imquic_qlog instance to add the event to
stream_id	The Stream ID used for this object
object	The object instance

imquic_moq_reject_fetch()

int imquic_moq_reject_fetch	(	imquic_connection *	conn,
		uint64_t	request_id,
		imquic_moq_request_error_code	error_code,
		const char *	reason,
		uint64_t	retry_interval )

Function to reject an incoming FETCH request.

Parameters

conn	The imquic_connection to send the request on
request_id	The unique request_id value associated to the subscription to reject
error_code	The error code to send back
reason	A string representation of the error, if needed
retry_interval	Retry interval in ms (added in v16, ignored otherwise)

Returns

0 in case of success, a negative integer otherwise

imquic_moq_reject_publish()

int imquic_moq_reject_publish	(	imquic_connection *	conn,
		uint64_t	request_id,
		imquic_moq_request_error_code	error_code,
		const char *	reason,
		uint64_t	retry_interval )

Function to reject an incoming PUBLISH request.

Parameters

conn	The imquic_connection to send the request on
request_id	The unique request_id value associated to the subscription to reject
error_code	The error code to send back
reason	A string representation of the error, if needed
retry_interval	Retry interval in ms (added in v16, ignored otherwise)

Returns

0 in case of success, a negative integer otherwise

imquic_moq_reject_publish_namespace()

int imquic_moq_reject_publish_namespace	(	imquic_connection *	conn,
		uint64_t	request_id,
		imquic_moq_request_error_code	error_code,
		const char *	reason,
		uint64_t	retry_interval )

Function to reject an incoming PUBLISH_NAMESPACE request.

Parameters

conn	The imquic_connection to send the request on
request_id	The request ID of the original PUBLISH_NAMESPACE request
error_code	The error code to send back
reason	A string representation of the error, if needed
retry_interval	Retry interval in ms (added in v16, ignored otherwise)

Returns

0 in case of success, a negative integer otherwise

imquic_moq_reject_request_update()

int imquic_moq_reject_request_update	(	imquic_connection *	conn,
		uint64_t	request_id,
		imquic_moq_request_error_code	error_code,
		const char *	reason,
		uint64_t	retry_interval )

Function to reject an incoming REQUEST_UPDATE request.

Note

This error response was only added in v15, which means it will be a no-action if you try to send it when negotiating an older version

Parameters

conn	The imquic_connection to send the request on
request_id	The unique request_id value associated to the subscription to reject
error_code	The error code to send back
reason	A string representation of the error, if needed
retry_interval	Retry interval in ms (added in v16, ignored otherwise)

Returns

0 in case of success, a negative integer otherwise

imquic_moq_reject_subscribe()

int imquic_moq_reject_subscribe	(	imquic_connection *	conn,
		uint64_t	request_id,
		imquic_moq_request_error_code	error_code,
		const char *	reason,
		uint64_t	track_alias,
		uint64_t	retry_interval )

Function to reject an incoming SUBSCRIBE request.

Parameters

conn	The imquic_connection to send the request on
request_id	The unique request_id value associated to the subscription to reject
error_code	The error code to send back
reason	A string representation of the error, if needed
track_alias	The unique track_alias value associated to the subscription to reject (ignored starting from v12)
retry_interval	Retry interval in ms (added in v16, ignored otherwise)

Returns

0 in case of success, a negative integer otherwise

imquic_moq_reject_subscribe_namespace()

int imquic_moq_reject_subscribe_namespace	(	imquic_connection *	conn,
		uint64_t	request_id,
		imquic_moq_request_error_code	error_code,
		const char *	reason,
		uint64_t	retry_interval )

Function to reject an incoming SUBSCRIBE_NAMESPACE request.

Parameters

conn	The imquic_connection to send the request on
request_id	The request ID of the original SUBSCRIBE_NAMESPACE request
error_code	The error code to send back
reason	A string representation of the error, if needed
retry_interval	Retry interval in ms (added in v16, ignored otherwise)

Returns

0 in case of success, a negative integer otherwise

imquic_moq_reject_track_status()

int imquic_moq_reject_track_status	(	imquic_connection *	conn,
		uint64_t	request_id,
		imquic_moq_request_error_code	error_code,
		const char *	reason,
		uint64_t	retry_interval )

Function to reject an incoming TRACK_STATUS request.

Note

Due to considerable changes between v12 and v13 on TRACK_STATUS , support for this request is disabled in versions earlier than v13

Parameters

conn	The imquic_connection to send the request on
request_id	The unique request_id value associated to the subscription to reject
error_code	The error code to send back
reason	A string representation of the error, if needed
retry_interval	Retry interval in ms (added in v16, ignored otherwise)

Returns

0 in case of success, a negative integer otherwise

imquic_moq_request_error_code_from_legacy()

imquic_moq_request_error_code imquic_moq_request_error_code_from_legacy	(	imquic_moq_version	version,
		imquic_moq_legacy_error_code	code )

Helper to translate a legacy error code parsed by the stack to a new request error code, if receiving from an old version of MoQ.

Parameters

version	The version this connection is using
code	The legacy error code

Returns

The associated new request error code, if available, or a generic internal error otherwise

imquic_moq_request_error_code_str()

const char * imquic_moq_request_error_code_str

(

imquic_moq_request_error_code

code

)

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

Parameters

code	The imquic_moq_request_error_code value

Returns

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

imquic_moq_request_error_code_to_legacy()

imquic_moq_legacy_error_code imquic_moq_request_error_code_to_legacy	(	imquic_moq_version	version,
		imquic_moq_request_error_code	code )

Helper to translate a new request error code passed by the user to a legacy error code, if serializing on an old version of MoQ.

Parameters

version	The version this connection is using
code	The new request error code

Returns

The associated legacy error code, if available, or a generic internal error otherwise

imquic_moq_request_parameter_type_str()

const char * imquic_moq_request_parameter_type_str	(	imquic_moq_request_parameter_type	type,
		imquic_moq_version	version )

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

Parameters

type	The imquic_moq_request_parameter_type value
version	The version of the connection

Returns

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

imquic_moq_request_parameters_init_defaults()

void imquic_moq_request_parameters_init_defaults

(

imquic_moq_request_parameters *

parameters

)

Helper method to initialize some defaults values (where applicable) for the supported parameters.

Note

This doesn't set any of the 'set' properties to TRUE, it simply sets some defaults values for some properties (e.g., 128 for priority)

Parameters

parameters

The imquic_moq_request_parameters to initialize

imquic_moq_request_parameters_serialize()

size_t imquic_moq_request_parameters_serialize	(	imquic_moq_context *	moq,
		imquic_moq_request_parameters *	parameters,
		uint8_t *	bytes,
		size_t	blen,
		uint8_t *	params_num )

Helper to serialize a imquic_moq_request_parameters set to a buffer.

Parameters

[in]	moq	The imquic_moq_context instance the parameter is for
[in]	parameters	The imquic_moq_request_parameters to serialize
[out]	bytes	The buffer to add paramerers to
[in]	blen	The size of the buffer
[out]	params_num	The number of parameters added to the buffer

Returns

The size of the serialized parameters, if successful, or 0 otherwise

imquic_moq_requests_blocked()

int imquic_moq_requests_blocked

(

imquic_connection *

conn

)

Function to send a REQUESTS_BLOCKED request.

Parameters

conn	The imquic_connection to send the request on

Returns

0 in case of success, a negative integer otherwise

imquic_moq_reset_stream_code_str()

const char * imquic_moq_reset_stream_code_str

(

imquic_moq_reset_stream_code

code

)

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

Parameters

code	The imquic_moq_reset_stream_code value

Returns

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

imquic_moq_reset_stream_incoming()

void imquic_moq_reset_stream_incoming	(	imquic_connection *	conn,
		uint64_t	stream_id,
		uint64_t	error_code )

Callback the core invokes when there's an incoming RESET_STREAM.

Parameters

conn	The imquic_connection instance for which new RESET_STREAM is available
stream_id	The ID of the stream that was reset
error_code	The error code that was received

imquic_moq_send_object()

int imquic_moq_send_object	(	imquic_connection *	conn,
		imquic_moq_object *	object )

Function to send a MoQ object.

Note

Depending on the delivery mode, to close the stream set the end_of_stream property to TRUE in the object. There's no need to do that when using OBJECT_STREAM or OBJECT_DATAGRAM . You can also close the stream when you don't have any object to send: just set the relevant properties (e.g., request_id, group_id and subgroup_id) without any payload, and the stack will find the right stream to close it.

Parameters

conn	The imquic_connection to send the object on
object	The imquic_moq_object object to send, including all relevant identifiers and the payload

Returns

0 in case of success, a negative integer otherwise

imquic_moq_set_connection_auth()

int imquic_moq_set_connection_auth	(	imquic_connection *	conn,
		uint8_t *	auth,
		size_t	authlen )

Method to provide credentials, as a client, on a new connection. If credentials need to provided, this must be done as soon as the connection is established, and before sending any MoQ message. A good place to do that is the callback fired when a new connection is available.

Note

The method only copies the pointer and not the data, so it's the 'sapplication responsibility to ensure the data addressed by the pointer will be valid when accessed.

Parameters

conn	The imquic_connection to set the version on
auth	The authentication info, if any
authlen	The size of the authentication info, if any

Returns

0 in case of success, a negative integer otherwise

imquic_moq_set_max_request_id()

int imquic_moq_set_max_request_id	(	imquic_connection *	conn,
		uint64_t	max_request_id )

Helper function to set the Maximum Request ID a subscriber can send.

Note

If invoked before the MoQ connection setup, it will be put in the setup parameter, otherwise it's sent in a MAX_REQUEST_ID request. Notice that whatever is passed to the request will be decremented by 1, as per the specification, meaning you cannot pass 0 as a value here

Parameters

conn	The imquic_connection to update
max_request_id	The Maximum Request ID to enforce

Returns

0 in case of success, a negative integer otherwise

imquic_moq_setup_parameter_type_str()

const char * imquic_moq_setup_parameter_type_str

(

imquic_moq_setup_parameter_type

type

)

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

Parameters

type	The imquic_moq_setup_parameter_type value

Returns

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

imquic_moq_setup_parameters_serialize()

size_t imquic_moq_setup_parameters_serialize	(	imquic_moq_context *	moq,
		imquic_moq_setup_parameters *	parameters,
		uint8_t *	bytes,
		size_t	blen,
		uint8_t *	params_num )

Helper to serialize a imquic_moq_setup_parameters set to a buffer.

Parameters

[in]	moq	The imquic_moq_context instance the parameter is for
[in]	parameters	The imquic_moq_setup_parameters to serialize
[out]	bytes	The buffer to add paramerers to
[in]	blen	The size of the buffer
[out]	params_num	The number of parameters added to the buffer

Returns

The size of the serialized parameters, if successful, or 0 otherwise

imquic_moq_standalone_fetch()

int imquic_moq_standalone_fetch	(	imquic_connection *	conn,
		uint64_t	request_id,
		imquic_moq_namespace *	tns,
		imquic_moq_name *	tn,
		imquic_moq_location_range *	range,
		imquic_moq_request_parameters *	parameters )

Function to send a standalone FETCH request.

Parameters

conn	The imquic_connection to send the request on
request_id	A unique numeric identifier to associate to this subscription
tns	The imquic_moq_namespace namespace the track to fetch to belongs to
tn	The imquic_moq_name track name to fetch to
range	The range of groups/objects to fetch
parameters	The parameters to add to the request

Returns

0 in case of success, a negative integer otherwise

imquic_moq_stream_destroy()

void imquic_moq_stream_destroy

(

imquic_moq_stream *

moq_stream

)

Destroy an existing MoQ stream.

Parameters

moq_stream

MoQ stream to destroy

imquic_moq_stream_incoming()

void imquic_moq_stream_incoming	(	imquic_connection *	conn,
		uint64_t	stream_id,
		uint8_t *	bytes,
		uint64_t	length,
		gboolean	complete )

Callback the core invokes when there's new incoming data on a STREAM.

Parameters

conn	The imquic_connection instance for which new STREAM data is available
stream_id	The QUIC Stream ID for which new data is available
bytes	The new data that is available
length	Size of the new data
complete	Whether this data marks the end of this STREAM

imquic_moq_subscribe()

int imquic_moq_subscribe	(	imquic_connection *	conn,
		uint64_t	request_id,
		uint64_t	track_alias,
		imquic_moq_namespace *	tns,
		imquic_moq_name *	tn,
		imquic_moq_request_parameters *	parameters )

Function to send a SUBSCRIBE request.

Parameters

conn	The imquic_connection to send the request on
request_id	A unique request ID to associate to this subscription
track_alias	A unique numeric identifier to associate to the track in this subscription (ignored starting from v12)
tns	The imquic_moq_namespace namespace the track to subscribe to belongs to
tn	The imquic_moq_name track name to subscribe to
parameters	The parameters to add to the request

Returns

0 in case of success, a negative integer otherwise

imquic_moq_subscribe_namespace()

int imquic_moq_subscribe_namespace	(	imquic_connection *	conn,
		uint64_t	request_id,
		imquic_moq_namespace *	tns,
		imquic_moq_subscribe_namespace_options	subscribe_options,
		imquic_moq_request_parameters *	parameters )

Function to send a SUBSCRIBE_NAMESPACE request.

Parameters

conn	The imquic_connection to send the request on
request_id	A unique request ID
tns	The imquic_moq_namespace namespace the track to subscribe to belongs to
subscribe_options	The subscribe options to add to the request (added in v16, ignored otherwise)
parameters	The parameters to add to the request

Returns

0 in case of success, a negative integer otherwise

imquic_moq_subscribe_namespace_options_str()

const char * imquic_moq_subscribe_namespace_options_str

(

imquic_moq_subscribe_namespace_options

type

)

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

Parameters

type	The imquic_moq_subscribe_namespace_options value

Returns

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

imquic_moq_subscription_create()

imquic_moq_subscription * imquic_moq_subscription_create	(	uint64_t	request_id,
		uint64_t	track_alias )

Helper to create a new subscription instance.

Parameters

request_id	The request ID
track_alias	The track alias

Returns

A pointer to a imquic_moq_subscription, if successful, or NULL otherwise

imquic_moq_subscription_destroy()

void imquic_moq_subscription_destroy

(

imquic_moq_subscription *

moq_sub

)

Destroy an existing MoQ subscription.

Parameters

moq_sub

MoQ subscription to destroy

imquic_moq_track_status()

int imquic_moq_track_status	(	imquic_connection *	conn,
		uint64_t	request_id,
		imquic_moq_namespace *	tns,
		imquic_moq_name *	tn,
		imquic_moq_request_parameters *	parameters )

Function to send a TRACK_STATUS request.

Note

Due to considerable changes between v12 and v13 on TRACK_STATUS , support for this request is disabled in versions earlier than v13.

Parameters

conn	The imquic_connection to send the request on
request_id	A unique request ID to associate to this request
tns	The imquic_moq_namespace namespace the track to track_status to belongs to
tn	The imquic_moq_name track name to track_status to
parameters	The parameters to add to the request

Returns

0 in case of success, a negative integer otherwise

imquic_moq_unsubscribe()

int imquic_moq_unsubscribe	(	imquic_connection *	conn,
		uint64_t	request_id )

Function to send a UNSUBSCRIBE request.

Parameters

conn	The imquic_connection to send the request on
request_id	The unique request_id value associated to the subscription to unsubscribe from

Returns

0 in case of success, a negative integer otherwise

imquic_moq_unsubscribe_namespace()

int imquic_moq_unsubscribe_namespace	(	imquic_connection *	conn,
		uint64_t	request_id,
		imquic_moq_namespace *	tns )

Function to send a UNSUBSCRIBE_NAMESPACE request.

Note

Starting in v16, this doesn't actually send a request, but simply closes the bidirectional STREAM that was created for the subscription

Parameters

conn	The imquic_connection to send the request on
request_id	The request ID of the original SUBSCRIBE_NAMESPACE request (added in v15, ignored otherwise)
tns	The imquic_moq_namespace namespace to unsubscribe notifications from (deprecated in v15)

Returns

0 in case of success, a negative integer otherwise

imquic_moq_update_request()

int imquic_moq_update_request	(	imquic_connection *	conn,
		uint64_t	request_id,
		uint64_t	sub_request_id,
		imquic_moq_request_parameters *	parameters )

Function to send a REQUEST_UPDATE request.

Note

Version 14 of the draft introduced a new "Subscription Request ID", which means the meaning of request_id will change depending on which version the connection is using.

Parameters

conn	The imquic_connection to send the request on
request_id	Unique request_id value (before v14, this is associated to the subscription to update)
sub_request_id	Unique request_id value associated to the subscription to update (ignored before v14)
parameters	The parameters to add to the request

Returns

0 in case of success, a negative integer otherwise

imquic_qlog_moq_message_add_extensions()

void imquic_qlog_moq_message_add_extensions	(	json_t *	message,
		GList *	extensions,
		const char *	name )

Helper to add a stringified array of extension headers to a message.

Parameters

message	The message object to update
extensions	The list of extensions to convert
name	The name the array should have in the message object

imquic_qlog_moq_message_add_namespace()

void imquic_qlog_moq_message_add_namespace	(	json_t *	message,
		imquic_moq_namespace *	track_namespace,
		const char *	name )

Helper to add a stringified namespace tuple array to a message.

Note

This automatically fills in the track_namespace property

Parameters

message	The message object to update
track_namespace	The namespace to serialize to an array
name	The name the array should have in the message object

imquic_qlog_moq_message_add_request_parameters()

void imquic_qlog_moq_message_add_request_parameters	(	json_t *	message,
		imquic_moq_version	version,
		imquic_moq_request_parameters *	parameters,
		const char *	name )

Helper to add a stringified array of subscribe parameters to a message.

Note

This automatically fills in a property with the specified name

Parameters

message	The message object to update
version	The version of the MoQ connection this message belongs to
parameters	The subscribe parameters to convert
name	The name the array should have in the message object

imquic_qlog_moq_message_add_setup_parameters()

void imquic_qlog_moq_message_add_setup_parameters	(	json_t *	message,
		imquic_moq_setup_parameters *	parameters,
		const char *	name )

Helper to add a stringified array of setup parameters to a message.

Note

This automatically fills in a property with the specified name

Parameters

message	The message object to update
parameters	The setup parameters to convert
name	The name the array should have in the message object

imquic_qlog_moq_message_add_track()

void imquic_qlog_moq_message_add_track	(	json_t *	message,
		imquic_moq_name *	track_name )

Helper to add a stringified track name to a message.

Note

This automatically fills in the track_name property

Parameters

message	The message object to update
track_name	The track name to add

imquic_qlog_moq_message_prepare()

json_t * imquic_qlog_moq_message_prepare

(

const char *

type

)

Helper to create a new QLOG MoQT message.

Note

This automatically fills in the type property

Parameters

type	The name of the message

Returns

A message instance to fill in before using it it, if successful, or NULL otherwise