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