blob: 5af97947270d471cbe8cfa21370cb3b3ea32eee5 [file] [log] [blame]
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -08001/*
2 *
Craig Tiller06059952015-02-18 08:34:56 -08003 * Copyright 2015, Google Inc.
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -08004 * 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
Nicolas "Pixel" Noble1ff52d52015-03-01 05:24:36 +010034#ifndef GRPC_INTERNAL_CORE_CHANNEL_CLIENT_CHANNEL_H
35#define GRPC_INTERNAL_CORE_CHANNEL_CLIENT_CHANNEL_H
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -080036
37#include "src/core/channel/channel_stack.h"
Craig Tillerf5f17122015-06-25 08:47:26 -070038#include "src/core/client_config/resolver.h"
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -080039
40/* A client channel is a channel that begins disconnected, and can connect
41 to some endpoint on demand. If that endpoint disconnects, it will be
42 connected to again later.
43
44 Calls on a disconnected client channel are queued until a connection is
45 established. */
46
47extern const grpc_channel_filter grpc_client_channel_filter;
48
49/* post-construction initializer to let the client channel know which
50 transport setup it should cancel upon destruction, or initiate when it needs
51 a connection */
Craig Tiller1be70cc2015-09-22 10:45:28 -070052void grpc_client_channel_set_resolver (grpc_exec_ctx * exec_ctx, grpc_channel_stack * channel_stack, grpc_resolver * resolver);
Nicolas Nobleb7ebd3b2014-11-26 16:33:03 -080053
Craig Tiller1be70cc2015-09-22 10:45:28 -070054grpc_connectivity_state grpc_client_channel_check_connectivity_state (grpc_exec_ctx * exec_ctx, grpc_channel_element * elem, int try_to_connect);
Craig Tiller48cb07c2015-07-15 16:16:15 -070055
Craig Tiller1be70cc2015-09-22 10:45:28 -070056void grpc_client_channel_watch_connectivity_state (grpc_exec_ctx * exec_ctx, grpc_channel_element * elem, grpc_connectivity_state * state, grpc_closure * on_complete);
Craig Tiller48cb07c2015-07-15 16:16:15 -070057
Craig Tiller45724b32015-09-22 10:42:19 -070058grpc_pollset_set *grpc_client_channel_get_connecting_pollset_set (grpc_channel_element * elem);
Craig Tiller1ada6ad2015-07-16 16:19:14 -070059
Craig Tiller1be70cc2015-09-22 10:45:28 -070060void grpc_client_channel_add_interested_party (grpc_exec_ctx * exec_ctx, grpc_channel_element * channel, grpc_pollset * pollset);
61void grpc_client_channel_del_interested_party (grpc_exec_ctx * exec_ctx, grpc_channel_element * channel, grpc_pollset * pollset);
Craig Tiller1ada6ad2015-07-16 16:19:14 -070062
Craig Tiller079a11b2015-06-30 10:07:15 -070063#endif /* GRPC_INTERNAL_CORE_CHANNEL_CLIENT_CHANNEL_H */