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
channel_args.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_INTERNAL_CORE_CHANNEL_CHANNEL_ARGS_H
35 #define GRPC_INTERNAL_CORE_CHANNEL_CHANNEL_ARGS_H
36
37 #include <grpc/compression.h>
38 #include <grpc/grpc.h>
39
40 /* Copy some arguments */
41 grpc_channel_args *grpc_channel_args_copy(const grpc_channel_args *src);
42
45 grpc_channel_args *grpc_channel_args_copy_and_add(const grpc_channel_args *src,
46 const grpc_arg *to_add,
47 size_t num_to_add);
48
50 grpc_channel_args *grpc_channel_args_merge(const grpc_channel_args *a,
51 const grpc_channel_args *b);
52
54 void grpc_channel_args_destroy(grpc_channel_args *a);
55
58 int grpc_channel_args_is_census_enabled(const grpc_channel_args *a);
59
61 grpc_compression_algorithm grpc_channel_args_get_compression_algorithm(
62 const grpc_channel_args *a);
63
67 grpc_channel_args *grpc_channel_args_set_compression_algorithm(
68 grpc_channel_args *a, grpc_compression_algorithm algorithm);
69
70 #endif /* GRPC_INTERNAL_CORE_CHANNEL_CHANNEL_ARGS_H */
grpc_channel_args_destroy
void grpc_channel_args_destroy(grpc_channel_args *a)
Destroy arguments created by grpc_channel_args_copy.
Definition: channel_args.c:95
compression.h
grpc_compression_algorithm
grpc_compression_algorithm
Definition: compression.h:45
grpc_channel_args
An array of arguments that can be passed around.
Definition: grpc.h:113
grpc_channel_args_set_compression_algorithm
grpc_channel_args * grpc_channel_args_set_compression_algorithm(grpc_channel_args *a, grpc_compression_algorithm algorithm)
Returns a channel arg instance with compression enabled.
Definition: channel_args.c:141
grpc_arg
A single argument...
Definition: grpc.h:91
grpc_channel_args_copy_and_add
grpc_channel_args * grpc_channel_args_copy_and_add(const grpc_channel_args *src, const grpc_arg *to_add, size_t num_to_add)
Copy some arguments and add the to_add parameter in the end.
Definition: channel_args.c:64
grpc_channel_args_copy
grpc_channel_args * grpc_channel_args_copy(const grpc_channel_args *src)
Definition: channel_args.c:86
grpc_channel_args_merge
grpc_channel_args * grpc_channel_args_merge(const grpc_channel_args *a, const grpc_channel_args *b)
Copy args from a then args from b into a new channel args.
Definition: channel_args.c:90
grpc_channel_args_is_census_enabled
int grpc_channel_args_is_census_enabled(const grpc_channel_args *a)
Reads census_enabled settings from channel args.
Definition: channel_args.c:116
grpc.h
grpc_channel_args_get_compression_algorithm
grpc_compression_algorithm grpc_channel_args_get_compression_algorithm(const grpc_channel_args *a)
Returns the compression algorithm set in a.
Definition: channel_args.c:127