mirror of
https://gitee.com/openharmony/third_party_nghttp2
synced 2024-11-23 16:00:07 +00:00
9eff511c5e
To avoid buffer copy in nghttp2_data_source_read_callback, this commit introduces NGHTTP2_DATA_FLAG_NO_COPY and nghttp2_send_data_callback. By using NGHTTP2_DATA_FLAG_NO_COPY in nghttp2_data_source_read_callback, application can avoid to copy application data to given buffer. Instead, application has to implement nghttp2_send_data_callback to send complete DATA frame by itself. We see noticeable performance increase in nghttpd and tiny-nghttpd using this new feature. On the other hand, nghttpx does not show such difference, probably because buffer copy is not bottleneck. Using nghttp2_send_data_callback adds complexity, so it is recommended to measure the performance to see whether this extra complexity worth it.
113 lines
3.9 KiB
C
113 lines
3.9 KiB
C
/*
|
|
* 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;
|
|
/**
|
|
* 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;
|
|
};
|
|
|
|
#endif /* NGHTTP2_CALLBACKS_H */
|