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/compression.h>
25 #include <grpc/slice.h>
26
27 #include "src/core/lib/gpr/useful.h"
28
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32
33 typedef enum {
34 GRPC_MESSAGE_COMPRESS_NONE = 0,
35 GRPC_MESSAGE_COMPRESS_DEFLATE,
36 GRPC_MESSAGE_COMPRESS_GZIP,
37 /* TODO(ctiller): snappy */
38 GRPC_MESSAGE_COMPRESS_ALGORITHMS_COUNT
39 } grpc_message_compression_algorithm;
40
41 /** Stream compression algorithms supported by gRPC */
42 typedef enum {
43 GRPC_STREAM_COMPRESS_NONE = 0,
44 GRPC_STREAM_COMPRESS_GZIP,
45 GRPC_STREAM_COMPRESS_ALGORITHMS_COUNT
46 } grpc_stream_compression_algorithm;
47
48 /* Interfaces performing transformation between compression algorithms and
49 * levels. */
50
51 grpc_message_compression_algorithm
52 grpc_compression_algorithm_to_message_compression_algorithm(
53 grpc_compression_algorithm algo);
54
55 grpc_stream_compression_algorithm
56 grpc_compression_algorithm_to_stream_compression_algorithm(
57 grpc_compression_algorithm algo);
58
59 uint32_t grpc_compression_bitset_to_message_bitset(uint32_t bitset);
60
61 uint32_t grpc_compression_bitset_to_stream_bitset(uint32_t bitset);
62
63 uint32_t grpc_compression_bitset_from_message_stream_compression_bitset(
64 uint32_t message_bitset, uint32_t stream_bitset);
65
66 int grpc_compression_algorithm_from_message_stream_compression_algorithm(
67 grpc_compression_algorithm* algorithm,
68 grpc_message_compression_algorithm message_algorithm,
69 grpc_stream_compression_algorithm stream_algorithm);
70
71 /* Interfaces for message compression. */
72
73 int grpc_message_compression_algorithm_name(
74 grpc_message_compression_algorithm algorithm, const char** name);
75
76 grpc_message_compression_algorithm grpc_message_compression_algorithm_for_level(
77 grpc_compression_level level, uint32_t accepted_encodings);
78
79 int grpc_message_compression_algorithm_parse(
80 grpc_slice value, grpc_message_compression_algorithm* algorithm);
81
82 /* Interfaces for stream compression. */
83
84 int grpc_stream_compression_algorithm_parse(
85 grpc_slice value, grpc_stream_compression_algorithm* algorithm);
86
87 #ifdef __cplusplus
88 }
89 #endif
90
grpc_compression_options_is_algorithm_enabled_internal(const grpc_compression_options * opts,grpc_compression_algorithm algorithm)91 inline int grpc_compression_options_is_algorithm_enabled_internal(
92 const grpc_compression_options* opts,
93 grpc_compression_algorithm algorithm) {
94 return GPR_BITGET(opts->enabled_algorithms_bitset, algorithm);
95 }
96
97 #endif /* GRPC_CORE_LIB_COMPRESSION_COMPRESSION_INTERNAL_H */
98