From 0c2f1626c0082ab91aed27f77bbe01008d878db2 Mon Sep 17 00:00:00 2001 From: David Garcia Quintas Date: Fri, 17 Jul 2015 15:36:22 -0700 Subject: [PATCH] Moved docs from .c to .h for compress_filter --- src/core/channel/compress_filter.c | 20 -------------------- src/core/channel/compress_filter.h | 24 +++++++++++++++++++----- 2 files changed, 19 insertions(+), 25 deletions(-) diff --git a/src/core/channel/compress_filter.c b/src/core/channel/compress_filter.c index 3d85ed41c5c..14cb3da62da 100644 --- a/src/core/channel/compress_filter.c +++ b/src/core/channel/compress_filter.c @@ -31,26 +31,6 @@ * */ -/** Compression filter for outgoing data. - * - * 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 \a GRPC_COMPRESS_REQUEST_ALGORITHM_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. */ - #include #include diff --git a/src/core/channel/compress_filter.h b/src/core/channel/compress_filter.h index 8d9c3ba697d..0694e2c1dd9 100644 --- a/src/core/channel/compress_filter.h +++ b/src/core/channel/compress_filter.h @@ -38,14 +38,28 @@ #define GRPC_COMPRESS_REQUEST_ALGORITHM_KEY "internal:grpc-encoding-request" -/** Message-level compression filter. +/** Compression filter for outgoing data. * * See for the available compression settings. * - * grpc_op instances of type GRPC_OP_SEND_MESSAGE can have the bit specified by - * the GRPC_WRITE_NO_COMPRESS mask in order to disable compression in an - * otherwise compressed channel. - * */ + * 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 \a GRPC_COMPRESS_REQUEST_ALGORITHM_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. */ + extern const grpc_channel_filter grpc_compress_filter; #endif /* GRPC_INTERNAL_CORE_CHANNEL_COMPRESS_FILTER_H */