GRPC C++  1.64.0
async_generic_service.h
Go to the documentation of this file.
1 //
2 //
3 // Copyright 2018 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_GENERIC_ASYNC_GENERIC_SERVICE_H
20 #define GRPCPP_GENERIC_ASYNC_GENERIC_SERVICE_H
21 
27 
28 struct grpc_server;
29 
30 namespace grpc {
31 
32 typedef ServerAsyncReaderWriter<ByteBuffer, ByteBuffer>
37 
38 class GenericServerContext final : public ServerContext {
39  public:
40  const std::string& method() const { return method_; }
41  const std::string& host() const { return host_; }
42 
43  private:
44  friend class ServerInterface;
45 
46  std::string method_;
47  std::string host_;
48 };
49 
50 // A generic service at the server side accepts all RPC methods and hosts. It is
51 // typically used in proxies. The generic service can be registered to a server
52 // which also has other services.
53 // Sample usage:
54 // ServerBuilder builder;
55 // auto cq = builder.AddCompletionQueue();
56 // AsyncGenericService generic_service;
57 // builder.RegisterAsyncGenericService(&generic_service);
58 // auto server = builder.BuildAndStart();
59 //
60 // // request a new call
61 // GenericServerContext context;
62 // GenericServerAsyncReaderWriter stream;
63 // generic_service.RequestCall(&context, &stream, cq.get(), cq.get(), tag);
64 //
65 // When tag is retrieved from cq->Next(), context.method() can be used to look
66 // at the method and the RPC can be handled accordingly.
67 class AsyncGenericService final {
68  public:
69  AsyncGenericService() : server_(nullptr) {}
70 
72  GenericServerAsyncReaderWriter* reader_writer,
73  grpc::CompletionQueue* call_cq,
74  grpc::ServerCompletionQueue* notification_cq, void* tag);
75 
76  private:
77  friend class grpc::Server;
78  grpc::Server* server_;
79 };
80 
85 
87  public:
88  const std::string& method() const { return method_; }
89  const std::string& host() const { return host_; }
90 
91  private:
92  friend class grpc::Server;
93 
94  std::string method_;
95  std::string host_;
96 };
97 
102  public:
105 
110  GenericCallbackServerContext* /*ctx*/) {
111  class Reactor : public ServerGenericBidiReactor {
112  public:
113  Reactor() { this->Finish(Status(StatusCode::UNIMPLEMENTED, "")); }
114  void OnDone() override { delete this; }
115  };
116  return new Reactor;
117  }
118 
119  private:
120  friend class grpc::Server;
121 
124  [this](grpc::CallbackServerContext* ctx) {
125  return CreateReactor(static_cast<GenericCallbackServerContext*>(ctx));
126  });
127  }
128 
129  grpc::Server* server_{nullptr};
130 };
131 
132 } // namespace grpc
133 
134 #endif // GRPCPP_GENERIC_ASYNC_GENERIC_SERVICE_H
grpc::ServerContext
A ServerContext or CallbackServerContext allows the code implementing a service handler to:
Definition: server_context.h:578
grpc::Server
Represents a gRPC server.
Definition: server.h:57
grpc
An Alarm posts the user-provided tag to its associated completion queue or invokes the user-provided ...
Definition: alarm.h:33
grpc::CallbackServerContext
Definition: server_context.h:618
grpc::ServerAsyncWriter
Async server-side API for doing server streaming RPCs, where the outgoing message stream from the ser...
Definition: server_context.h:58
grpc::GenericServerAsyncReader
ServerAsyncReader< ByteBuffer, ByteBuffer > GenericServerAsyncReader
Definition: async_generic_service.h:35
grpc::GenericServerAsyncResponseWriter
ServerAsyncResponseWriter< ByteBuffer > GenericServerAsyncResponseWriter
Definition: async_generic_service.h:34
grpc::AsyncGenericService::AsyncGenericService
AsyncGenericService()
Definition: async_generic_service.h:69
grpc::GenericCallbackServerContext::host
const std::string & host() const
Definition: async_generic_service.h:89
grpc::ServerBidiReactor
ServerBidiReactor is the interface for a bidirectional streaming RPC.
Definition: server_callback.h:195
grpc_server
struct grpc_server grpc_server
A server listens to some port and responds to request calls.
Definition: grpc_types.h:64
grpc::AsyncGenericService
Definition: async_generic_service.h:67
grpc::CallbackGenericService::CallbackGenericService
CallbackGenericService()
Definition: async_generic_service.h:103
grpc::GenericServerContext
Definition: async_generic_service.h:38
server_callback.h
grpc::ServerAsyncResponseWriter
Async server-side API for handling unary calls, where the single response message sent to the client ...
Definition: server_context.h:60
grpc::internal::CallbackBidiHandler
Definition: server_callback_handlers.h:677
grpc::UNIMPLEMENTED
@ UNIMPLEMENTED
Operation is not implemented or not supported/enabled in this service.
Definition: status_code_enum.h:117
byte_buffer.h
grpc::ServerCompletionQueue
A specific type of completion queue used by the processing of notifications by servers.
Definition: completion_queue.h:427
grpc::GenericCallbackServerContext
Definition: async_generic_service.h:86
server_callback_handlers.h
grpc::GenericCallbackServerContext::method
const std::string & method() const
Definition: async_generic_service.h:88
grpc::CompletionQueue
A thin wrapper around grpc_completion_queue (see src/core/lib/surface/completion_queue....
Definition: completion_queue.h:105
grpc::GenericServerAsyncReaderWriter
ServerAsyncReaderWriter< ByteBuffer, ByteBuffer > GenericServerAsyncReaderWriter
Definition: async_generic_service.h:33
grpc::GenericServerContext::host
const std::string & host() const
Definition: async_generic_service.h:41
grpc::ServerAsyncReader
Async server-side API for doing client-streaming RPCs, where the incoming message stream from the cli...
Definition: server_context.h:56
grpc::ServerAsyncReaderWriter
Async server-side API for doing bidirectional streaming RPCs, where the incoming message stream comin...
Definition: server_context.h:62
grpc::ServerInterface
Definition: server_interface.h:61
grpc::GenericServerAsyncWriter
ServerAsyncWriter< ByteBuffer > GenericServerAsyncWriter
Definition: async_generic_service.h:36
async_stream.h
grpc::CallbackGenericService::CreateReactor
virtual ServerGenericBidiReactor * CreateReactor(GenericCallbackServerContext *)
The "method handler" for the generic API.
Definition: async_generic_service.h:109
grpc::protobuf::util::Status
::absl::Status Status
Definition: config_protobuf.h:106
grpc::CallbackGenericService::~CallbackGenericService
virtual ~CallbackGenericService()
Definition: async_generic_service.h:104
grpc::GenericServerContext::method
const std::string & method() const
Definition: async_generic_service.h:40
grpc::AsyncGenericService::RequestCall
void RequestCall(GenericServerContext *ctx, GenericServerAsyncReaderWriter *reader_writer, grpc::CompletionQueue *call_cq, grpc::ServerCompletionQueue *notification_cq, void *tag)
grpc::CallbackGenericService
CallbackGenericService is the base class for generic services implemented using the callback API and ...
Definition: async_generic_service.h:101
port_platform.h