1/*
2 *
3 * Copyright 2015 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_COMPRESSION_H
20#define GRPC_COMPRESSION_H
21
22#include <grpc/impl/codegen/port_platform.h>
23
24#include <stdlib.h>
25
26#include <grpc/impl/codegen/compression_types.h>
27#include <grpc/slice.h>
28
29#ifdef __cplusplus
30extern "C" {
31#endif
32
33/** Return if an algorithm is message compression algorithm. */
34GRPCAPI int grpc_compression_algorithm_is_message(
35 grpc_compression_algorithm algorithm);
36
37/** Return if an algorithm is stream compression algorithm. */
38GRPCAPI int grpc_compression_algorithm_is_stream(
39 grpc_compression_algorithm algorithm);
40
41/** Parses the \a slice as a grpc_compression_algorithm instance and updating \a
42 * algorithm. Returns 1 upon success, 0 otherwise. */
43GRPCAPI int grpc_compression_algorithm_parse(
44 grpc_slice value, grpc_compression_algorithm* algorithm);
45
46/** Updates \a name with the encoding name corresponding to a valid \a
47 * algorithm. Note that \a name is statically allocated and must *not* be freed.
48 * Returns 1 upon success, 0 otherwise. */
49GRPCAPI int grpc_compression_algorithm_name(
50 grpc_compression_algorithm algorithm, const char** name);
51
52/** Returns the compression algorithm corresponding to \a level for the
53 * compression algorithms encoded in the \a accepted_encodings bitset.*/
54GRPCAPI grpc_compression_algorithm grpc_compression_algorithm_for_level(
55 grpc_compression_level level, uint32_t accepted_encodings);
56
57GRPCAPI void grpc_compression_options_init(grpc_compression_options* opts);
58
59/** Mark \a algorithm as enabled in \a opts. */
60GRPCAPI void grpc_compression_options_enable_algorithm(
61 grpc_compression_options* opts, grpc_compression_algorithm algorithm);
62
63/** Mark \a algorithm as disabled in \a opts. */
64GRPCAPI void grpc_compression_options_disable_algorithm(
65 grpc_compression_options* opts, grpc_compression_algorithm algorithm);
66
67/** Returns true if \a algorithm is marked as enabled in \a opts. */
68GRPCAPI int grpc_compression_options_is_algorithm_enabled(
69 const grpc_compression_options* opts, grpc_compression_algorithm algorithm);
70
71#ifdef __cplusplus
72}
73#endif
74
75#endif /* GRPC_COMPRESSION_H */
76

source code of include/grpc/compression.h