GRPC C++  1.0.0
channel.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 GRPCXX_CHANNEL_H
35 #define GRPCXX_CHANNEL_H
36 
37 #include <memory>
38 
39 #include <grpc++/impl/call.h>
43 #include <grpc/grpc.h>
44 
45 struct grpc_channel;
46 
47 namespace grpc {
50  public CallHook,
51  public std::enable_shared_from_this<Channel>,
52  private GrpcLibraryCodegen {
53  public:
54  ~Channel();
55 
58  grpc_connectivity_state GetState(bool try_to_connect) GRPC_OVERRIDE;
59 
60  private:
61  template <class InputMessage, class OutputMessage>
63  const RpcMethod& method,
64  ClientContext* context,
65  const InputMessage& request,
66  OutputMessage* result);
67  friend std::shared_ptr<Channel> CreateChannelInternal(
68  const grpc::string& host, grpc_channel* c_channel);
69  Channel(const grpc::string& host, grpc_channel* c_channel);
70 
71  Call CreateCall(const RpcMethod& method, ClientContext* context,
73  void PerformOpsOnCall(CallOpSetInterface* ops, Call* call) GRPC_OVERRIDE;
74  void* RegisterMethod(const char* method) GRPC_OVERRIDE;
75 
76  void NotifyOnStateChangeImpl(grpc_connectivity_state last_observed,
77  gpr_timespec deadline, CompletionQueue* cq,
78  void* tag) GRPC_OVERRIDE;
79  bool WaitForStateChangeImpl(grpc_connectivity_state last_observed,
80  gpr_timespec deadline) GRPC_OVERRIDE;
81 
82  const grpc::string host_;
83  grpc_channel* const c_channel_; // owned
84 };
85 
86 } // namespace grpc
87 
88 #endif // GRPCXX_CHANNEL_H
std::string string
Definition: config.h:118
struct grpc_channel grpc_channel
The Channel interface allows creation of Call objects.
Definition: grpc_types.h:54
An abstract collection of call ops, used to generate the grpc_call_op structure to pass down to the l...
Definition: call.h:563
grpc_connectivity_state GetState(bool try_to_connect) GRPC_OVERRIDE
Get the current channel state.
Classes that require gRPC to be initialized should inherit from this class.
Definition: grpc_library.h:53
Definition: client_context.h:154
grpc_connectivity_state
Connectivity state of a channel.
Definition: connectivity_state.h:42
friend std::shared_ptr< Channel > CreateChannelInternal(const grpc::string &host, grpc_channel *c_channel)
friend Status BlockingUnaryCall(ChannelInterface *channel, const RpcMethod &method, ClientContext *context, const InputMessage &request, OutputMessage *result)
Definition: client_unary_call.h:52
Definition: call.h:645
Definition: alarm.h:48
Codegen interface for grpc::Channel.
Definition: channel_interface.h:64
A thin wrapper around grpc_completion_queue (see / src/core/surface/completion_queue.h).
Definition: completion_queue.h:97
#define GRPC_FINAL
Definition: config.h:72
Definition: rpc_method.h:43
Did it work? If it didn&#39;t, why?
Definition: status.h:45
Definition: time.h:63
Channel and Server implement this to allow them to hook performing ops.
Definition: call_hook.h:43
#define GRPC_OVERRIDE
Definition: config.h:78
Channels represent a connection to an endpoint. Created by CreateChannel.
Definition: channel.h:49