GRPC Core  9.0.0
compression_internal.h
Go to the documentation of this file.
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 
23 
25 
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
32 typedef enum {
36  /* TODO(ctiller): snappy */
39 
41 typedef enum {
46 
47 /* Interfaces performing transformation between compression algorithms and
48  * levels. */
49 
53 
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 
63  uint32_t message_bitset, uint32_t stream_bitset);
64 
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 
73  grpc_message_compression_algorithm algorithm, const char** name);
74 
76  grpc_compression_level level, uint32_t accepted_encodings);
77 
80 
81 /* Interfaces for stream compression. */
82 
85 
86 #ifdef __cplusplus
87 }
88 #endif
89 
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 */
grpc_message_compression_algorithm
Definition: compression_internal.h:32
@ GRPC_MESSAGE_COMPRESS_NONE
Definition: compression_internal.h:33
@ GRPC_MESSAGE_COMPRESS_DEFLATE
Definition: compression_internal.h:34
@ GRPC_MESSAGE_COMPRESS_GZIP
Definition: compression_internal.h:35
@ GRPC_MESSAGE_COMPRESS_ALGORITHMS_COUNT
Definition: compression_internal.h:37
int grpc_message_compression_algorithm_name(grpc_message_compression_algorithm algorithm, const char **name)
Definition: compression_internal.cc:171
int grpc_compression_algorithm_from_message_stream_compression_algorithm(grpc_compression_algorithm *algorithm, grpc_message_compression_algorithm message_algorithm, grpc_stream_compression_algorithm stream_algorithm)
Definition: compression_internal.cc:129
grpc_message_compression_algorithm grpc_message_compression_algorithm_for_level(grpc_compression_level level, uint32_t accepted_encodings)
Definition: compression_internal.cc:194
grpc_stream_compression_algorithm
Stream compression algorithms supported by gRPC.
Definition: compression_internal.h:41
@ GRPC_STREAM_COMPRESS_GZIP
Definition: compression_internal.h:43
@ GRPC_STREAM_COMPRESS_NONE
Definition: compression_internal.h:42
@ GRPC_STREAM_COMPRESS_ALGORITHMS_COUNT
Definition: compression_internal.h:44
grpc_message_compression_algorithm grpc_compression_algorithm_to_message_compression_algorithm(grpc_compression_algorithm algo)
Definition: compression_internal.cc:86
int grpc_stream_compression_algorithm_parse(grpc_slice value, grpc_stream_compression_algorithm *algorithm)
Definition: compression_internal.cc:268
grpc_stream_compression_algorithm grpc_compression_algorithm_to_stream_compression_algorithm(grpc_compression_algorithm algo)
Definition: compression_internal.cc:99
int grpc_message_compression_algorithm_parse(grpc_slice value, grpc_message_compression_algorithm *algorithm)
Definition: compression_internal.cc:249
uint32_t grpc_compression_bitset_to_stream_bitset(uint32_t bitset)
Definition: compression_internal.cc:113
uint32_t grpc_compression_bitset_to_message_bitset(uint32_t bitset)
Definition: compression_internal.cc:109
int grpc_compression_options_is_algorithm_enabled_internal(const grpc_compression_options *opts, grpc_compression_algorithm algorithm)
Definition: compression_internal.h:90
uint32_t grpc_compression_bitset_from_message_stream_compression_bitset(uint32_t message_bitset, uint32_t stream_bitset)
Definition: compression_internal.cc:121
grpc_compression_level
Compression levels allow a party with knowledge of its peer's accepted encodings to request compressi...
Definition: compression_types.h:71
grpc_compression_algorithm
The various compression algorithms supported by gRPC (not sorted by compression level)
Definition: compression_types.h:57
Definition: compression_types.h:79
uint32_t enabled_algorithms_bitset
All algs are enabled by default.
Definition: compression_types.h:83
A grpc_slice s, if initialized, represents the byte range s.bytes[0..s.length-1].
Definition: slice.h:60
#define GPR_BITGET(i, n)
Get the n-th bit of i.
Definition: useful.h:47