aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/libs/nghttp2/lib/nghttp2_callbacks.h
blob: b78557c8ca02bb4d05bd5d8d1fe9023bc4782895 (plain) (blame)
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
/* 
 * nghttp2 - HTTP/2 C Library 
 * 
 * Copyright (c) 2014 Tatsuhiro Tsujikawa 
 * 
 * Permission is hereby granted, free of charge, to any person obtaining 
 * a copy of this software and associated documentation files (the 
 * "Software"), to deal in the Software without restriction, including 
 * without limitation the rights to use, copy, modify, merge, publish, 
 * distribute, sublicense, and/or sell copies of the Software, and to 
 * permit persons to whom the Software is furnished to do so, subject to 
 * the following conditions: 
 * 
 * The above copyright notice and this permission notice shall be 
 * included in all copies or substantial portions of the Software. 
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE 
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION 
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 
 */ 
#ifndef NGHTTP2_CALLBACKS_H 
#define NGHTTP2_CALLBACKS_H 
 
#ifdef HAVE_CONFIG_H 
#  include <config.h>
#endif /* HAVE_CONFIG_H */ 
 
#include <nghttp2/nghttp2.h> 
 
/* 
 * Callback functions. 
 */ 
struct nghttp2_session_callbacks { 
  /** 
   * Callback function invoked when the session wants to send data to 
   * the remote peer.  This callback is not necessary if the 
   * application uses solely `nghttp2_session_mem_send()` to serialize 
   * data to transmit. 
   */ 
  nghttp2_send_callback send_callback; 
  /** 
   * Callback function invoked when the session wants to receive data 
   * from the remote peer.  This callback is not necessary if the 
   * application uses solely `nghttp2_session_mem_recv()` to process 
   * received data. 
   */ 
  nghttp2_recv_callback recv_callback; 
  /** 
   * Callback function invoked by `nghttp2_session_recv()` when a 
   * frame is received. 
   */ 
  nghttp2_on_frame_recv_callback on_frame_recv_callback; 
  /** 
   * Callback function invoked by `nghttp2_session_recv()` when an 
   * invalid non-DATA frame is received. 
   */ 
  nghttp2_on_invalid_frame_recv_callback on_invalid_frame_recv_callback; 
  /** 
   * Callback function invoked when a chunk of data in DATA frame is 
   * received. 
   */ 
  nghttp2_on_data_chunk_recv_callback on_data_chunk_recv_callback; 
  /** 
   * Callback function invoked before a non-DATA frame is sent. 
   */ 
  nghttp2_before_frame_send_callback before_frame_send_callback; 
  /** 
   * Callback function invoked after a frame is sent. 
   */ 
  nghttp2_on_frame_send_callback on_frame_send_callback; 
  /** 
   * The callback function invoked when a non-DATA frame is not sent 
   * because of an error. 
   */ 
  nghttp2_on_frame_not_send_callback on_frame_not_send_callback; 
  /** 
   * Callback function invoked when the stream is closed. 
   */ 
  nghttp2_on_stream_close_callback on_stream_close_callback; 
  /** 
   * Callback function invoked when the reception of header block in 
   * HEADERS or PUSH_PROMISE is started. 
   */ 
  nghttp2_on_begin_headers_callback on_begin_headers_callback; 
  /** 
   * Callback function invoked when a header name/value pair is 
   * received. 
   */ 
  nghttp2_on_header_callback on_header_callback; 
  nghttp2_on_header_callback2 on_header_callback2; 
  /** 
   * Callback function invoked when a invalid header name/value pair 
   * is received which is silently ignored if these callbacks are not 
   * set. 
   */ 
  nghttp2_on_invalid_header_callback on_invalid_header_callback; 
  nghttp2_on_invalid_header_callback2 on_invalid_header_callback2; 
  /** 
   * Callback function invoked when the library asks application how 
   * many padding bytes are required for the transmission of the given 
   * frame. 
   */ 
  nghttp2_select_padding_callback select_padding_callback; 
  /** 
   * The callback function used to determine the length allowed in 
   * `nghttp2_data_source_read_callback()` 
   */ 
  nghttp2_data_source_read_length_callback read_length_callback; 
  /** 
   * Sets callback function invoked when a frame header is received. 
   */ 
  nghttp2_on_begin_frame_callback on_begin_frame_callback; 
  nghttp2_send_data_callback send_data_callback; 
  nghttp2_pack_extension_callback pack_extension_callback; 
  nghttp2_unpack_extension_callback unpack_extension_callback; 
  nghttp2_on_extension_chunk_recv_callback on_extension_chunk_recv_callback; 
  nghttp2_error_callback error_callback; 
  nghttp2_error_callback2 error_callback2; 
}; 
 
#endif /* NGHTTP2_CALLBACKS_H */