GRPC C++  1.32.0
client_unary_call.h
Go to the documentation of this file.
1 /*
2  *
3  * Copyright 2015 gRPC authors.
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  */
18 
19 #ifndef GRPCPP_IMPL_CODEGEN_CLIENT_UNARY_CALL_H
20 #define GRPCPP_IMPL_CODEGEN_CLIENT_UNARY_CALL_H
21 
27 
28 namespace grpc {
29 
30 class ClientContext;
31 namespace internal {
32 class RpcMethod;
34 template <class InputMessage, class OutputMessage>
36  grpc::ClientContext* context,
37  const InputMessage& request, OutputMessage* result) {
39  channel, method, context, request, result)
40  .status();
41 }
42 
43 template <class InputMessage, class OutputMessage>
44 class BlockingUnaryCallImpl {
45  public:
47  grpc::ClientContext* context,
48  const InputMessage& request, OutputMessage* result) {
51  nullptr}); // Pluckable completion queue
52  ::grpc::internal::Call call(channel->CreateCall(method, context, &cq));
56  ops;
57  status_ = ops.SendMessagePtr(&request);
58  if (!status_.ok()) {
59  return;
60  }
61  ops.SendInitialMetadata(&context->send_initial_metadata_,
62  context->initial_metadata_flags());
63  ops.RecvInitialMetadata(context);
64  ops.RecvMessage(result);
65  ops.AllowNoMessage();
66  ops.ClientSendClose();
67  ops.ClientRecvStatus(context, &status_);
68  call.PerformOps(&ops);
69  cq.Pluck(&ops);
70  // Some of the ops might fail. If the ops fail in the core layer, status
71  // would reflect the error. But, if the ops fail in the C++ layer, the
72  // status would still be the same as the one returned by gRPC Core. This can
73  // happen if deserialization of the message fails.
74  // TODO(yashykt): If deserialization fails, but the status received is OK,
75  // then it might be a good idea to change the status to something better
76  // than StatusCode::UNIMPLEMENTED to reflect this.
77  if (!ops.got_message && status_.ok()) {
79  "No message returned for unary request");
80  }
81  }
82  Status status() { return status_; }
83 
84  private:
85  Status status_;
86 };
87 
88 } // namespace internal
89 } // namespace grpc
90 
91 #endif // GRPCPP_IMPL_CODEGEN_CLIENT_UNARY_CALL_H
grpc::internal::CallOpRecvInitialMetadata
Definition: call_op_set.h:720
grpc::internal::CallOpClientSendClose
Definition: call_op_set.h:618
grpc
This header provides an object that reads bytes directly from a grpc::ByteBuffer, via the ZeroCopyInp...
Definition: alarm.h:24
grpc::internal::CallOpSet
Primary implementation of CallOpSetInterface.
Definition: call_op_set.h:850
status.h
grpc::internal::CallOpSendMessage
Definition: call_op_set.h:287
config.h
grpc::internal::BlockingUnaryCallImpl
Definition: channel_interface.h:70
grpc::internal::Call
Straightforward wrapping of the C call object.
Definition: call.h:35
core_codegen_interface.h
grpc::internal::CallOpSendInitialMetadata
Definition: call_op_set.h:217
grpc::Status::ok
bool ok() const
Is the status OK?
Definition: status.h:118
grpc::Status
Did it work? If it didn't, why?
Definition: status.h:31
GRPC_CQ_DEFAULT_POLLING
@ GRPC_CQ_DEFAULT_POLLING
The completion queue will have an associated pollset and there is no restriction on the type of file ...
Definition: grpc_types.h:710
grpc::internal::BlockingUnaryCall
Status BlockingUnaryCall(ChannelInterface *channel, const RpcMethod &method, grpc::ClientContext *context, const InputMessage &request, OutputMessage *result)
Wrapper that performs a blocking unary call.
Definition: client_unary_call.h:35
grpc::ClientContext
A ClientContext allows the person implementing a service client to:
Definition: client_context.h:195
grpc::ChannelInterface
Codegen interface for grpc::Channel.
Definition: channel_interface.h:74
GRPC_CQ_PLUCK
@ GRPC_CQ_PLUCK
Events are popped out by calling grpc_completion_queue_pluck() API ONLY.
Definition: grpc_types.h:730
grpc_completion_queue_attributes
Definition: grpc_types.h:761
grpc::internal::BlockingUnaryCallImpl::BlockingUnaryCallImpl
BlockingUnaryCallImpl(ChannelInterface *channel, const RpcMethod &method, grpc::ClientContext *context, const InputMessage &request, OutputMessage *result)
Definition: client_unary_call.h:46
grpc::protobuf::util::Status
::google::protobuf::util::Status Status
Definition: config_protobuf.h:90
grpc::UNIMPLEMENTED
@ UNIMPLEMENTED
Operation is not implemented or not supported/enabled in this service.
Definition: status_code_enum.h:115
channel_interface.h
GRPC_CQ_CURRENT_VERSION
#define GRPC_CQ_CURRENT_VERSION
Definition: grpc_types.h:759
call.h
grpc::internal::CallOpClientRecvStatus
Definition: call_op_set.h:768
grpc::CompletionQueue
A thin wrapper around grpc_completion_queue (see src/core/lib/surface/completion_queue....
Definition: completion_queue.h:99
grpc::internal::CallOpRecvMessage
Definition: byte_buffer.h:58
grpc::internal::RpcMethod
Descriptor of an RPC method.
Definition: rpc_method.h:29
grpc::internal::BlockingUnaryCallImpl::status
Status status()
Definition: client_unary_call.h:82