GRPC Core  4.0.0
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
compression.h
Go to the documentation of this file.
1 /*
2  *
3  * Copyright 2015, Google Inc.
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are
8  * met:
9  *
10  * * Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  * * Redistributions in binary form must reproduce the above
13  * copyright notice, this list of conditions and the following disclaimer
14  * in the documentation and/or other materials provided with the
15  * distribution.
16  * * Neither the name of Google Inc. nor the names of its
17  * contributors may be used to endorse or promote products derived from
18  * this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  *
32  */
33 
34 #ifndef GRPC_COMPRESSION_H
35 #define GRPC_COMPRESSION_H
36 
38 
39 #include <stdlib.h>
40 
42 #include <grpc/slice.h>
43 
44 #ifdef __cplusplus
45 extern "C" {
46 #endif
47 
52  grpc_slice value, grpc_compression_algorithm *algorithm);
53 
58  grpc_compression_algorithm algorithm, char **name);
59 
65  grpc_compression_level level, uint32_t accepted_encodings);
66 
68 
72 
76 
80 
81 #ifdef __cplusplus
82 }
83 #endif
84 
85 #endif /* GRPC_COMPRESSION_H */
GRPCAPI void grpc_compression_options_init(grpc_compression_options *opts)
Definition: compression_types.h:91
GRPCAPI grpc_compression_algorithm grpc_compression_algorithm_for_level(grpc_compression_level level, uint32_t accepted_encodings)
Returns the compression algorithm corresponding to level for the compression algorithms encoded in th...
GRPCAPI void grpc_compression_options_enable_algorithm(grpc_compression_options *opts, grpc_compression_algorithm algorithm)
Mark algorithm as enabled in opts.
A grpc_slice s, if initialized, represents the byte range s.bytes[0..s.length-1]. ...
Definition: slice.h:91
grpc_compression_level
Compression levels allow a party with knowledge of its peer's accepted encodings to request compressi...
Definition: compression_types.h:83
GRPCAPI void grpc_compression_options_disable_algorithm(grpc_compression_options *opts, grpc_compression_algorithm algorithm)
Mark algorithm as disabled in opts.
grpc_compression_algorithm
The various compression algorithms supported by gRPC.
Definition: compression_types.h:71
GRPCAPI int grpc_compression_options_is_algorithm_enabled(const grpc_compression_options *opts, grpc_compression_algorithm algorithm)
Returns true if algorithm is marked as enabled in opts.
#define GRPCAPI
Definition: port_platform.h:420
GRPCAPI int grpc_compression_algorithm_name(grpc_compression_algorithm algorithm, char **name)
Updates name with the encoding name corresponding to a valid algorithm.
GRPCAPI int grpc_compression_algorithm_parse(grpc_slice value, grpc_compression_algorithm *algorithm)
Parses the first name_length bytes of name as a grpc_compression_algorithm instance, updating algorithm.