GRPC Core 0.10.0.0

- Main Page
- Data Structures
- Files

- File List
- Globals

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros 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
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40
42 #define GRPC_COMPRESSION_ALGORITHM_ARG "grpc.compression_algorithm"
43
44 /* The various compression algorithms supported by GRPC */
45 typedef enum {
46 GRPC_COMPRESS_NONE = 0,
47 GRPC_COMPRESS_DEFLATE,
48 GRPC_COMPRESS_GZIP,
49 /* TODO(ctiller): snappy */
50 GRPC_COMPRESS_ALGORITHMS_COUNT
51 } grpc_compression_algorithm;
52
53 typedef enum {
54 GRPC_COMPRESS_LEVEL_NONE = 0,
55 GRPC_COMPRESS_LEVEL_LOW,
56 GRPC_COMPRESS_LEVEL_MED,
57 GRPC_COMPRESS_LEVEL_HIGH,
58 GRPC_COMPRESS_LEVEL_COUNT
59 } grpc_compression_level;
60
63 int grpc_compression_algorithm_parse(const char *name,
64 grpc_compression_algorithm *algorithm);
65
68 int grpc_compression_algorithm_name(grpc_compression_algorithm algorithm,
69 char **name);
70
74 grpc_compression_level grpc_compression_level_for_algorithm(
75 grpc_compression_algorithm algorithm);
76
80 grpc_compression_algorithm grpc_compression_algorithm_for_level(
81 grpc_compression_level level);
82
83 #ifdef __cplusplus
84 }
85 #endif
86
87 #endif /* GRPC_COMPRESSION_H */
GRPC_COMPRESS_ALGORITHMS_COUNT
Definition: compression.h:50
grpc_compression_algorithm
grpc_compression_algorithm
Definition: compression.h:45
GRPC_COMPRESS_GZIP
Definition: compression.h:48
grpc_compression_algorithm_parse
int grpc_compression_algorithm_parse(const char *name, grpc_compression_algorithm *algorithm)
Parses name as a grpc_compression_algorithm instance, updating algorithm.
GRPC_COMPRESS_DEFLATE
Definition: compression.h:47
GRPC_COMPRESS_LEVEL_NONE
Definition: compression.h:54
GRPC_COMPRESS_LEVEL_LOW
Definition: compression.h:55
grpc_compression_level_for_algorithm
grpc_compression_level grpc_compression_level_for_algorithm(grpc_compression_algorithm algorithm)
Returns the compression level corresponding to algorithm.
grpc_compression_level
grpc_compression_level
Definition: compression.h:53
GRPC_COMPRESS_NONE
Definition: compression.h:46
GRPC_COMPRESS_LEVEL_MED
Definition: compression.h:56
grpc_compression_algorithm_name
int grpc_compression_algorithm_name(grpc_compression_algorithm algorithm, char **name)
Updates name with the encoding name corresponding to a valid algorithm.
GRPC_COMPRESS_LEVEL_COUNT
Definition: compression.h:58
grpc_compression_algorithm_for_level
grpc_compression_algorithm grpc_compression_algorithm_for_level(grpc_compression_level level)
Returns the compression algorithm corresponding to level.
GRPC_COMPRESS_LEVEL_HIGH
Definition: compression.h:57