File: nghttp2_submit_ping.rst

package info (click to toggle)
nghttp2 1.68.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, 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 (33 lines) | stat: -rw-r--r-- 1,029 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

nghttp2_submit_ping
===================

Synopsis
--------

*#include <nghttp2/nghttp2.h>*

.. function:: int nghttp2_submit_ping(nghttp2_session *session, uint8_t flags, const uint8_t *opaque_data)

    
    Submits PING frame.  You don't have to send PING back when you
    received PING frame.  The library automatically submits PING frame
    in this case.
    
    The *flags* is bitwise OR of 0 or more of the following value.
    
    * :enum:`nghttp2_flag.NGHTTP2_FLAG_ACK`
    
    Unless `nghttp2_option_set_no_auto_ping_ack()` is used, the *flags*
    should be :enum:`nghttp2_flag.NGHTTP2_FLAG_NONE`.
    
    If the *opaque_data* is non ``NULL``, then it should point to the 8
    bytes array of memory to specify opaque data to send with PING
    frame.  If the *opaque_data* is ``NULL``, zero-cleared 8 bytes will
    be sent as opaque data.
    
    This function returns 0 if it succeeds, or one of the following
    negative error codes:
    
    :enum:`nghttp2_error.NGHTTP2_ERR_NOMEM`
        Out of memory.