File: nghttp2_submit_priority_update.rst

package info (click to toggle)
nghttp2 1.68.0-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 15,592 kB
  • sloc: ansic: 104,233; cpp: 55,792; ruby: 30,108; yacc: 7,083; sh: 4,643; makefile: 1,506; python: 806
file content (42 lines) | stat: -rw-r--r-- 1,453 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

nghttp2_submit_priority_update
==============================

Synopsis
--------

*#include <nghttp2/nghttp2.h>*

.. function:: 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)

    
    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.