GRPC Core  9.0.0
Variables
message_compress_filter.cc File Reference
#include <grpc/support/port_platform.h>
#include <assert.h>
#include <string.h>
#include <grpc/compression.h>
#include <grpc/slice_buffer.h>
#include <grpc/support/alloc.h>
#include <grpc/support/log.h>
#include "src/core/ext/filters/http/message_compress/message_compress_filter.h"
#include "src/core/lib/channel/channel_args.h"
#include "src/core/lib/compression/algorithm_metadata.h"
#include "src/core/lib/compression/compression_args.h"
#include "src/core/lib/compression/compression_internal.h"
#include "src/core/lib/compression/message_compress.h"
#include "src/core/lib/gprpp/manual_constructor.h"
#include "src/core/lib/profiling/timers.h"
#include "src/core/lib/slice/slice_internal.h"
#include "src/core/lib/slice/slice_string_helpers.h"
#include "src/core/lib/surface/call.h"
#include "src/core/lib/transport/static_metadata.h"

Variables

const grpc_channel_filter grpc_message_compress_filter
 Compression filter for outgoing data. More...
 

Variable Documentation

◆ grpc_message_compress_filter

const grpc_channel_filter grpc_message_compress_filter
Initial value:
= {
compress_start_transport_stream_op_batch,
sizeof(call_data),
compress_init_call_elem,
compress_destroy_call_elem,
sizeof(channel_data),
compress_init_channel_elem,
compress_destroy_channel_elem,
"message_compress"}
void grpc_channel_next_get_info(grpc_channel_element *elem, const grpc_channel_info *channel_info)
Definition: channel_stack.cc:230
void grpc_call_stack_ignore_set_pollset_or_pollset_set(grpc_call_element *, grpc_polling_entity *)
Definition: channel_stack.cc:205
void grpc_channel_next_op(grpc_channel_element *elem, grpc_transport_op *op)
Definition: channel_stack.cc:236
struct connected_channel_channel_data channel_data
struct connected_channel_call_data call_data

Compression filter for outgoing data.

See <grpc/compression.h> for the available compression settings.

Compression settings may come from:

  • Channel configuration, as established at channel creation time.
  • The metadata accompanying the outgoing data to be compressed. This is taken as a request only. We may choose not to honor it. The metadata key is given by GRPC_COMPRESSION_REQUEST_ALGORITHM_MD_KEY.

Compression can be disabled for concrete messages (for instance in order to prevent CRIME/BEAST type attacks) by having the GRPC_WRITE_NO_COMPRESS set in the BEGIN_MESSAGE flags.

The attempted compression mechanism is added to the resulting initial metadata under the'grpc-encoding' key.

If compression is actually performed, BEGIN_MESSAGE's flag is modified to incorporate GRPC_WRITE_INTERNAL_COMPRESS. Otherwise, and regardless of the aforementioned 'grpc-encoding' metadata value, data will pass through uncompressed.