legacy-libs/grpc/deps/grpc/src/core/lib/compression/compression_internal.h

   1 /*
   2  *
   3  * Copyright 2017 gRPC authors.
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  */
  18
  19 #ifndef GRPC_CORE_LIB_COMPRESSION_COMPRESSION_INTERNAL_H
  20 #define GRPC_CORE_LIB_COMPRESSION_COMPRESSION_INTERNAL_H
  21
  22 #include <grpc/support/port_platform.h>
  23
  24 #include <grpc/impl/codegen/compression_types.h>
  25
  26 #include "src/core/lib/gpr/useful.h"
  27
  28 #ifdef __cplusplus
  29 extern "C" {
  30 #endif
  31
  32 typedef enum {
  33   GRPC_MESSAGE_COMPRESS_NONE = 0,
  34   GRPC_MESSAGE_COMPRESS_DEFLATE,
  35   GRPC_MESSAGE_COMPRESS_GZIP,
  36   /* TODO(ctiller): snappy */
  37   GRPC_MESSAGE_COMPRESS_ALGORITHMS_COUNT
  38 } grpc_message_compression_algorithm;
  39
  40 /** Stream compression algorithms supported by gRPC */
  41 typedef enum {
  42   GRPC_STREAM_COMPRESS_NONE = 0,
  43   GRPC_STREAM_COMPRESS_GZIP,
  44   GRPC_STREAM_COMPRESS_ALGORITHMS_COUNT
  45 } grpc_stream_compression_algorithm;
  46
  47 /* Interfaces performing transformation between compression algorithms and
  48  * levels. */
  49
  50 grpc_message_compression_algorithm
  51 grpc_compression_algorithm_to_message_compression_algorithm(
  52     grpc_compression_algorithm algo);
  53
  54 grpc_stream_compression_algorithm
  55 grpc_compression_algorithm_to_stream_compression_algorithm(
  56     grpc_compression_algorithm algo);
  57
  58 uint32_t grpc_compression_bitset_to_message_bitset(uint32_t bitset);
  59
  60 uint32_t grpc_compression_bitset_to_stream_bitset(uint32_t bitset);
  61
  62 uint32_t grpc_compression_bitset_from_message_stream_compression_bitset(
  63     uint32_t message_bitset, uint32_t stream_bitset);
  64
  65 int grpc_compression_algorithm_from_message_stream_compression_algorithm(
  66     grpc_compression_algorithm* algorithm,
  67     grpc_message_compression_algorithm message_algorithm,
  68     grpc_stream_compression_algorithm stream_algorithm);
  69
  70 /* Interfaces for message compression. */
  71
  72 int grpc_message_compression_algorithm_name(
  73     grpc_message_compression_algorithm algorithm, const char** name);
  74
  75 grpc_message_compression_algorithm grpc_message_compression_algorithm_for_level(
  76     grpc_compression_level level, uint32_t accepted_encodings);
  77
  78 int grpc_message_compression_algorithm_parse(
  79     grpc_slice value, grpc_message_compression_algorithm* algorithm);
  80
  81 /* Interfaces for stream compression. */
  82
  83 int grpc_stream_compression_algorithm_parse(
  84     grpc_slice value, grpc_stream_compression_algorithm* algorithm);
  85
  86 #ifdef __cplusplus
  87 }
  88 #endif
  89
  90 inline int grpc_compression_options_is_algorithm_enabled_internal(
  91     const grpc_compression_options* opts,
  92     grpc_compression_algorithm algorithm) {
  93   return GPR_BITGET(opts->enabled_algorithms_bitset, algorithm);
  94 }
  95
  96 #endif /* GRPC_CORE_LIB_COMPRESSION_COMPRESSION_INTERNAL_H */