blob: 3db8cb6c8e8b764fabb164f9dab5b1645f4362cb [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
34#ifndef __GRPC_INTERNAL_CHANNEL_CLIENT_CHANNEL_H__
35#define __GRPC_INTERNAL_CHANNEL_CLIENT_CHANNEL_H__
36
37#include "src/core/channel/channel_stack.h"
38
39/* A client channel is a channel that begins disconnected, and can connect
40 to some endpoint on demand. If that endpoint disconnects, it will be
41 connected to again later.
42
43 Calls on a disconnected client channel are queued until a connection is
44 established. */
45
46extern const grpc_channel_filter grpc_client_channel_filter;
47
48/* post-construction initializer to let the client channel know which
49 transport setup it should cancel upon destruction, or initiate when it needs
50 a connection */
51void grpc_client_channel_set_transport_setup(grpc_channel_stack *channel_stack,
52 grpc_transport_setup *setup);
53
54/* grpc_transport_setup_callback for binding new transports into a client
55 channel - user_data should be the channel stack containing the client
56 channel */
57grpc_transport_setup_result grpc_client_channel_transport_setup_complete(
58 grpc_channel_stack *channel_stack, grpc_transport *transport,
59 grpc_channel_filter const **channel_filters, size_t num_channel_filters,
60 grpc_mdctx *mdctx);
61
Craig Tiller06059952015-02-18 08:34:56 -080062#endif /* __GRPC_INTERNAL_CHANNEL_CLIENT_CHANNEL_H__ */