From 30ced5d09f01ca8a92e517f189b3bbcba40ee688 Mon Sep 17 00:00:00 2001 From: yang-g Date: Tue, 12 Dec 2017 11:45:32 -0800 Subject: Add comments for AsyncGenericService --- include/grpc++/generic/async_generic_service.h | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) (limited to 'include/grpc++') diff --git a/include/grpc++/generic/async_generic_service.h b/include/grpc++/generic/async_generic_service.h index cd9a65e3cb..b1ea4f3909 100644 --- a/include/grpc++/generic/async_generic_service.h +++ b/include/grpc++/generic/async_generic_service.h @@ -42,6 +42,23 @@ class GenericServerContext final : public ServerContext { grpc::string host_; }; +// A generic service at the server side accepts all RPC methods and hosts. It is +// typically used in proxies. The generic service can be registered to a server +// which also has other services. +// Sample usage: +// ServerBuilder builder; +// auto cq = builder.AddCompletionQueue(); +// AsyncGenericService generic_service; +// builder.RegisterAsyncGeneicService(&generic_service); +// auto server = builder.BuildAndStart(); +// +// // request a new call +// GenericServerContext context; +// GenericAsyncReaderWriter stream; +// generic_service.RequestCall(&context, &stream, cq.get(), cq.get(), tag); +// +// When tag is retrieved from cq->Next(), context.method() can be used to look +// at the method and the RPC can be handled accordingly. class AsyncGenericService final { public: AsyncGenericService() : server_(nullptr) {} -- cgit v1.2.3