|
|
@@ -634,7 +634,11 @@ typedef enum {
|
|
|
* The ORIGIN frame, which is defined by `RFC 8336
|
|
|
* <https://tools.ietf.org/html/rfc8336>`_.
|
|
|
*/
|
|
|
- NGHTTP2_ORIGIN = 0x0c
|
|
|
+ NGHTTP2_ORIGIN = 0x0c,
|
|
|
+ /**
|
|
|
+ * The PRIORITY_UPDATE frame, which is defined by :rfc:`9218`.
|
|
|
+ */
|
|
|
+ NGHTTP2_PRIORITY_UPDATE = 0x10
|
|
|
} nghttp2_frame_type;
|
|
|
|
|
|
/**
|
|
|
@@ -703,7 +707,11 @@ typedef enum {
|
|
|
* SETTINGS_ENABLE_CONNECT_PROTOCOL
|
|
|
* (`RFC 8441 <https://tools.ietf.org/html/rfc8441>`_)
|
|
|
*/
|
|
|
- NGHTTP2_SETTINGS_ENABLE_CONNECT_PROTOCOL = 0x08
|
|
|
+ NGHTTP2_SETTINGS_ENABLE_CONNECT_PROTOCOL = 0x08,
|
|
|
+ /**
|
|
|
+ * SETTINGS_NO_RFC7540_PRIORITIES (:rfc:`9218`)
|
|
|
+ */
|
|
|
+ NGHTTP2_SETTINGS_NO_RFC7540_PRIORITIES = 0x09
|
|
|
} nghttp2_settings_id;
|
|
|
/* Note: If we add SETTINGS, update the capacity of
|
|
|
NGHTTP2_INBOUND_NUM_IV as well */
|
|
|
@@ -2693,6 +2701,11 @@ nghttp2_option_set_max_deflate_dynamic_table_size(nghttp2_option *option,
|
|
|
* This option prevents the library from retaining closed streams to
|
|
|
* maintain the priority tree. If this option is set to nonzero,
|
|
|
* applications can discard closed stream completely to save memory.
|
|
|
+ *
|
|
|
+ * If
|
|
|
+ * :enum:`nghttp2_settings_id.NGHTTP2_SETTINGS_NO_RFC7540_PRIORITIES`
|
|
|
+ * of value of 1 is submitted via `nghttp2_submit_settings()`, any
|
|
|
+ * closed streams are not retained regardless of this option.
|
|
|
*/
|
|
|
NGHTTP2_EXTERN void nghttp2_option_set_no_closed_streams(nghttp2_option *option,
|
|
|
int val);
|
|
|
@@ -2719,6 +2732,24 @@ NGHTTP2_EXTERN void nghttp2_option_set_max_outbound_ack(nghttp2_option *option,
|
|
|
NGHTTP2_EXTERN void nghttp2_option_set_max_settings(nghttp2_option *option,
|
|
|
size_t val);
|
|
|
|
|
|
+/**
|
|
|
+ * @function
|
|
|
+ *
|
|
|
+ * This option, if set to nonzero, allows server to fallback to
|
|
|
+ * :rfc:`7540` priorities if SETTINGS_NO_RFC7540_PRIORITIES was not
|
|
|
+ * received from client, and server submitted
|
|
|
+ * :enum:`nghttp2_settings_id.NGHTTP2_SETTINGS_NO_RFC7540_PRIORITIES`
|
|
|
+ * = 1 via `nghttp2_submit_settings()`. Most of the advanced
|
|
|
+ * functionality for RFC 7540 priorities are still disabled. This
|
|
|
+ * fallback only enables the minimal feature set of RFC 7540
|
|
|
+ * priorities to deal with priority signaling from client.
|
|
|
+ *
|
|
|
+ * Client session ignores this option.
|
|
|
+ */
|
|
|
+NGHTTP2_EXTERN void
|
|
|
+nghttp2_option_set_server_fallback_rfc7540_priorities(nghttp2_option *option,
|
|
|
+ int val);
|
|
|
+
|
|
|
/**
|
|
|
* @function
|
|
|
*
|
|
|
@@ -3589,6 +3620,11 @@ NGHTTP2_EXTERN int nghttp2_session_consume_stream(nghttp2_session *session,
|
|
|
* found, we use default priority instead of given |pri_spec|. That
|
|
|
* is make stream depend on root stream with weight 16.
|
|
|
*
|
|
|
+ * If
|
|
|
+ * :enum:`nghttp2_settings_id.NGHTTP2_SETTINGS_NO_RFC7540_PRIORITIES`
|
|
|
+ * of value of 1 is submitted via `nghttp2_submit_settings()`, this
|
|
|
+ * function does nothing and returns 0.
|
|
|
+ *
|
|
|
* This function returns 0 if it succeeds, or one of the following
|
|
|
* negative error codes:
|
|
|
*
|
|
|
@@ -3632,6 +3668,11 @@ nghttp2_session_change_stream_priority(nghttp2_session *session,
|
|
|
* found, we use default priority instead of given |pri_spec|. That
|
|
|
* is make stream depend on root stream with weight 16.
|
|
|
*
|
|
|
+ * If
|
|
|
+ * :enum:`nghttp2_settings_id.NGHTTP2_SETTINGS_NO_RFC7540_PRIORITIES`
|
|
|
+ * of value of 1 is submitted via `nghttp2_submit_settings()`, this
|
|
|
+ * function does nothing and returns 0.
|
|
|
+ *
|
|
|
* This function returns 0 if it succeeds, or one of the following
|
|
|
* negative error codes:
|
|
|
*
|
|
|
@@ -3837,6 +3878,11 @@ nghttp2_priority_spec_check_default(const nghttp2_priority_spec *pri_spec);
|
|
|
* :macro:`NGHTTP2_MAX_WEIGHT`, it becomes
|
|
|
* :macro:`NGHTTP2_MAX_WEIGHT`.
|
|
|
*
|
|
|
+ * If
|
|
|
+ * :enum:`nghttp2_settings_id.NGHTTP2_SETTINGS_NO_RFC7540_PRIORITIES`
|
|
|
+ * of value of 1 is received by a remote endpoint, |pri_spec| is
|
|
|
+ * ignored, and treated as if ``NULL`` is specified.
|
|
|
+ *
|
|
|
* The |nva| is an array of name/value pair :type:`nghttp2_nv` with
|
|
|
* |nvlen| elements. The application is responsible to include
|
|
|
* required pseudo-header fields (header field whose name starts with
|
|
|
@@ -4057,6 +4103,11 @@ NGHTTP2_EXTERN int nghttp2_submit_trailer(nghttp2_session *session,
|
|
|
* :macro:`NGHTTP2_MIN_WEIGHT`. If it is strictly greater than
|
|
|
* :macro:`NGHTTP2_MAX_WEIGHT`, it becomes :macro:`NGHTTP2_MAX_WEIGHT`.
|
|
|
*
|
|
|
+ * If
|
|
|
+ * :enum:`nghttp2_settings_id.NGHTTP2_SETTINGS_NO_RFC7540_PRIORITIES`
|
|
|
+ * of value of 1 is received by a remote endpoint, |pri_spec| is
|
|
|
+ * ignored, and treated as if ``NULL`` is specified.
|
|
|
+ *
|
|
|
* The |nva| is an array of name/value pair :type:`nghttp2_nv` with
|
|
|
* |nvlen| elements. The application is responsible to include
|
|
|
* required pseudo-header fields (header field whose name starts with
|
|
|
@@ -4184,6 +4235,11 @@ NGHTTP2_EXTERN int nghttp2_submit_data(nghttp2_session *session, uint8_t flags,
|
|
|
* :macro:`NGHTTP2_MAX_WEIGHT`, it becomes
|
|
|
* :macro:`NGHTTP2_MAX_WEIGHT`.
|
|
|
*
|
|
|
+ * If
|
|
|
+ * :enum:`nghttp2_settings_id.NGHTTP2_SETTINGS_NO_RFC7540_PRIORITIES`
|
|
|
+ * of value of 1 is received by a remote endpoint, this function does
|
|
|
+ * nothing and returns 0.
|
|
|
+ *
|
|
|
* This function returns 0 if it succeeds, or one of the following
|
|
|
* negative error codes:
|
|
|
*
|
|
|
@@ -4198,6 +4254,61 @@ nghttp2_submit_priority(nghttp2_session *session, uint8_t flags,
|
|
|
int32_t stream_id,
|
|
|
const nghttp2_priority_spec *pri_spec);
|
|
|
|
|
|
+/**
|
|
|
+ * @macro
|
|
|
+ *
|
|
|
+ * :macro:`NGHTTP2_EXTPRI_DEFAULT_URGENCY` is the default urgency
|
|
|
+ * level for :rfc:`9218` extensible priorities.
|
|
|
+ */
|
|
|
+#define NGHTTP2_EXTPRI_DEFAULT_URGENCY 3
|
|
|
+
|
|
|
+/**
|
|
|
+ * @macro
|
|
|
+ *
|
|
|
+ * :macro:`NGHTTP2_EXTPRI_URGENCY_HIGH` is the highest urgency level
|
|
|
+ * for :rfc:`9218` extensible priorities.
|
|
|
+ */
|
|
|
+#define NGHTTP2_EXTPRI_URGENCY_HIGH 0
|
|
|
+
|
|
|
+/**
|
|
|
+ * @macro
|
|
|
+ *
|
|
|
+ * :macro:`NGHTTP2_EXTPRI_URGENCY_LOW` is the lowest urgency level for
|
|
|
+ * :rfc:`9218` extensible priorities.
|
|
|
+ */
|
|
|
+#define NGHTTP2_EXTPRI_URGENCY_LOW 7
|
|
|
+
|
|
|
+/**
|
|
|
+ * @macro
|
|
|
+ *
|
|
|
+ * :macro:`NGHTTP2_EXTPRI_URGENCY_LEVELS` is the number of urgency
|
|
|
+ * levels for :rfc:`9218` extensible priorities.
|
|
|
+ */
|
|
|
+#define NGHTTP2_EXTPRI_URGENCY_LEVELS (NGHTTP2_EXTPRI_URGENCY_LOW + 1)
|
|
|
+
|
|
|
+/**
|
|
|
+ * @struct
|
|
|
+ *
|
|
|
+ * :type:`nghttp2_extpri` is :rfc:`9218` extensible priorities
|
|
|
+ * specification for a stream.
|
|
|
+ */
|
|
|
+typedef struct nghttp2_extpri {
|
|
|
+ /**
|
|
|
+ * :member:`urgency` is the urgency of a stream, it must be in
|
|
|
+ * [:macro:`NGHTTP2_EXTPRI_URGENCY_HIGH`,
|
|
|
+ * :macro:`NGHTTP2_EXTPRI_URGENCY_LOW`], inclusive, and 0 is the
|
|
|
+ * highest urgency.
|
|
|
+ */
|
|
|
+ uint32_t urgency;
|
|
|
+ /**
|
|
|
+ * :member:`inc` indicates that a content can be processed
|
|
|
+ * incrementally or not. If inc is 0, it cannot be processed
|
|
|
+ * incrementally. If inc is 1, it can be processed incrementally.
|
|
|
+ * Other value is not permitted.
|
|
|
+ */
|
|
|
+ int inc;
|
|
|
+} nghttp2_extpri;
|
|
|
+
|
|
|
/**
|
|
|
* @function
|
|
|
*
|
|
|
@@ -4722,6 +4833,108 @@ NGHTTP2_EXTERN int nghttp2_submit_origin(nghttp2_session *session,
|
|
|
const nghttp2_origin_entry *ov,
|
|
|
size_t nov);
|
|
|
|
|
|
+/**
|
|
|
+ * @struct
|
|
|
+ *
|
|
|
+ * The payload of PRIORITY_UPDATE frame. PRIORITY_UPDATE frame is a
|
|
|
+ * non-critical extension to HTTP/2. If this frame is received, and
|
|
|
+ * `nghttp2_option_set_user_recv_extension_type()` is not set, and
|
|
|
+ * `nghttp2_option_set_builtin_recv_extension_type()` is set for
|
|
|
+ * :enum:`nghttp2_frame_type.NGHTTP2_PRIORITY_UPDATE`,
|
|
|
+ * ``nghttp2_extension.payload`` will point to this struct.
|
|
|
+ *
|
|
|
+ * It has the following members:
|
|
|
+ */
|
|
|
+typedef struct {
|
|
|
+ /**
|
|
|
+ * The stream ID of the stream whose priority is updated.
|
|
|
+ */
|
|
|
+ int32_t stream_id;
|
|
|
+ /**
|
|
|
+ * The pointer to Priority field value. It is not necessarily
|
|
|
+ * NULL-terminated.
|
|
|
+ */
|
|
|
+ uint8_t *field_value;
|
|
|
+ /**
|
|
|
+ * The length of the :member:`field_value`.
|
|
|
+ */
|
|
|
+ size_t field_value_len;
|
|
|
+} nghttp2_ext_priority_update;
|
|
|
+
|
|
|
+/**
|
|
|
+ * @function
|
|
|
+ *
|
|
|
+ * Submits PRIORITY_UPDATE frame.
|
|
|
+ *
|
|
|
+ * PRIORITY_UPDATE frame is a non-critical extension to HTTP/2, and
|
|
|
+ * defined in :rfc:`9218#section-7.1`.
|
|
|
+ *
|
|
|
+ * The |flags| is currently ignored and should be
|
|
|
+ * :enum:`nghttp2_flag.NGHTTP2_FLAG_NONE`.
|
|
|
+ *
|
|
|
+ * The |stream_id| is the ID of stream which is prioritized. The
|
|
|
+ * |field_value| points to the Priority field value. The
|
|
|
+ * |field_value_len| is the length of the Priority field value.
|
|
|
+ *
|
|
|
+ * If this function is called by server,
|
|
|
+ * :enum:`nghttp2_error.NGHTTP2_ERR_INVALID_STATE` is returned.
|
|
|
+ *
|
|
|
+ * If
|
|
|
+ * :enum:`nghttp2_settings_id.NGHTTP2_SETTINGS_NO_RFC7540_PRIORITIES`
|
|
|
+ * of value of 0 is received by a remote endpoint (or it is omitted),
|
|
|
+ * this function does nothing and returns 0.
|
|
|
+ *
|
|
|
+ * This function returns 0 if it succeeds, or one of the following
|
|
|
+ * negative error codes:
|
|
|
+ *
|
|
|
+ * :enum:`nghttp2_error.NGHTTP2_ERR_NOMEM`
|
|
|
+ * Out of memory
|
|
|
+ * :enum:`nghttp2_error.NGHTTP2_ERR_INVALID_STATE`
|
|
|
+ * The function is called from server side session
|
|
|
+ * :enum:`nghttp2_error.NGHTTP2_ERR_INVALID_ARGUMENT`
|
|
|
+ * The |field_value_len| is larger than 16380; or |stream_id| is
|
|
|
+ * 0.
|
|
|
+ */
|
|
|
+NGHTTP2_EXTERN int nghttp2_submit_priority_update(nghttp2_session *session,
|
|
|
+ uint8_t flags,
|
|
|
+ int32_t stream_id,
|
|
|
+ const uint8_t *field_value,
|
|
|
+ size_t field_value_len);
|
|
|
+
|
|
|
+/**
|
|
|
+ * @function
|
|
|
+ *
|
|
|
+ * Changes the priority of the existing stream denoted by |stream_id|.
|
|
|
+ * The new priority is |extpri|. This function is meant to be used by
|
|
|
+ * server for :rfc:`9218` extensible prioritization scheme.
|
|
|
+ *
|
|
|
+ * If |session| is initialized as client, this function returns
|
|
|
+ * :enum:`nghttp2_error.NGHTTP2_ERR_INVALID_STATE`. For client, use
|
|
|
+ * `nghttp2_submit_priority_update()` instead.
|
|
|
+ *
|
|
|
+ * If :member:`extpri->urgency <nghttp2_extpri.urgency>` is out of
|
|
|
+ * bound, it is set to :macro:`NGHTTP2_EXTPRI_URGENCY_LOW`.
|
|
|
+ *
|
|
|
+ * If |ignore_client_signal| is nonzero, server starts to ignore
|
|
|
+ * client priority signals for this stream.
|
|
|
+ *
|
|
|
+ * If
|
|
|
+ * :enum:`nghttp2_settings_id.NGHTTP2_SETTINGS_NO_RFC7540_PRIORITIES`
|
|
|
+ * of value of 1 is not submitted via `nghttp2_submit_settings()`,
|
|
|
+ * this function does nothing and returns 0.
|
|
|
+ *
|
|
|
+ * :enum:`nghttp2_error.NGHTTP2_ERR_NOMEM`
|
|
|
+ * Out of memory.
|
|
|
+ * :enum:`nghttp2_error.NGHTTP2_ERR_INVALID_STATE`
|
|
|
+ * The |session| is initialized as client.
|
|
|
+ * :enum:`nghttp2_error.NGHTTP2_ERR_INVALID_ARGUMENT`
|
|
|
+ * |stream_id| is zero; or a stream denoted by |stream_id| is not
|
|
|
+ * found.
|
|
|
+ */
|
|
|
+NGHTTP2_EXTERN int nghttp2_session_change_extpri_stream_priority(
|
|
|
+ nghttp2_session *session, int32_t stream_id, const nghttp2_extpri *extpri,
|
|
|
+ int ignore_client_signal);
|
|
|
+
|
|
|
/**
|
|
|
* @function
|
|
|
*
|
robot-contrib