aboutsummaryrefslogtreecommitdiffhomepage
path: root/include/grpc++/impl/call.h
blob: 20c60fc5455134dbf4a980845ee25bd120ad39fb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
/*
 *
 * Copyright 2014, Google Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

#ifndef __GRPCPP_CALL_H__
#define __GRPCPP_CALL_H__

#include <grpc/grpc.h>
#include <grpc++/status.h>
#include <grpc++/completion_queue.h>

#include <memory>
#include <map>

namespace google {
namespace protobuf {
class Message;
}  // namespace protobuf
}  // namespace google

struct grpc_call;
struct grpc_op;

namespace grpc {

class Call;

class CallOpBuffer : public CompletionQueueTag {
 public:
  CallOpBuffer() : return_tag_(this) {}
  ~CallOpBuffer();

  void Reset(void *next_return_tag);

  // Does not take ownership.
  void AddSendInitialMetadata(
      std::multimap<grpc::string, grpc::string> *metadata);
  void AddSendInitialMetadata(ClientContext *ctx);
  void AddRecvInitialMetadata(ClientContext *ctx);
  void AddSendMessage(const google::protobuf::Message &message);
  void AddRecvMessage(google::protobuf::Message *message);
  void AddClientSendClose();
  void AddClientRecvStatus(ClientContext *ctx, Status *status);
  void AddServerSendStatus(std::multimap<grpc::string, grpc::string> *metadata,
                           const Status &status);
  void AddServerRecvClose(bool *cancelled);

  // INTERNAL API:

  // Convert to an array of grpc_op elements
  void FillOps(grpc_op *ops, size_t *nops);

  // Called by completion queue just prior to returning from Next() or Pluck()
  bool FinalizeResult(void **tag, bool *status) override;

  bool got_message = false;

 private:
  void *return_tag_ = nullptr;
  // Send initial metadata
  bool send_initial_metadata_ = false;
  size_t initial_metadata_count_ = 0;
  grpc_metadata *initial_metadata_ = nullptr;
  // Recv initial metadta
  std::multimap<grpc::string, grpc::string> *recv_initial_metadata_ = nullptr;
  grpc_metadata_array recv_initial_metadata_arr_ = {0, 0, nullptr};
  // Send message
  const google::protobuf::Message *send_message_ = nullptr;
  grpc_byte_buffer *send_message_buf_ = nullptr;
  // Recv message
  google::protobuf::Message *recv_message_ = nullptr;
  grpc_byte_buffer *recv_message_buf_ = nullptr;
  // Client send close
  bool client_send_close_ = false;
  // Client recv status
  std::multimap<grpc::string, grpc::string> *recv_trailing_metadata_ = nullptr;
  Status *recv_status_ = nullptr;
  grpc_metadata_array recv_trailing_metadata_arr_ = {0, 0, nullptr};
  grpc_status_code status_code_ = GRPC_STATUS_OK;
  char *status_details_ = nullptr;
  size_t status_details_capacity_ = 0;
  // Server send status
  const Status *send_status_ = nullptr;
  size_t trailing_metadata_count_ = 0;
  grpc_metadata *trailing_metadata_ = nullptr;
  int cancelled_buf_;
  bool *recv_closed_ = nullptr;
};

// Channel and Server implement this to allow them to hook performing ops
class CallHook {
 public:
  virtual ~CallHook() {}
  virtual void PerformOpsOnCall(CallOpBuffer *ops, Call *call) = 0;
};

// Straightforward wrapping of the C call object
class Call final {
 public:
  /* call is owned by the caller */
  Call(grpc_call *call, CallHook *call_hook_, CompletionQueue *cq);

  void PerformOps(CallOpBuffer *buffer);

  grpc_call *call() { return call_; }
  CompletionQueue *cq() { return cq_; }

 private:
  CallHook *call_hook_;
  CompletionQueue *cq_;
  grpc_call *call_;
};

}  // namespace grpc

#endif  // __GRPCPP_CALL_INTERFACE_H__