gRPC: What is the recommended way to shut down an asynchronous server in C++?
TL;DR: You must call both grpc::Server::Shutdown()
and grpc::CompletionQueue::Shutdown()
(for each completion queue used in the service) to shut down cleanly.
If you call
cq_->Shutdown()
, the only observable effect is that subsequent calls toService::AsyncService::RequestFoo()
(the generated method for the correspondingFoo
RPC) fail with an assertion. From reading the documentation of the corresponding C API method (grpc_completion_queue_shutdown()
), it appears that it is illegal to add new work to the queue—i.e. by callingRequestFoo()
—so I added anis_shutdown_
member to my service wrapper classes (protected by a mutex) so that no enqueue attempts are made aftercq_->Shutdown()
is called. However, after doing this, the completion queue blocks indefinitely incq_->Next()
. None of the enqueued tags complete (with an error or otherwise).If instead you call
server_->Shutdown()
, all of the enqueued tags complete immediately (withok == false
). However, the completion queue continues to block indefinitely incq_->Next()
.
Calling both cq_->Shutdown()
(for each defined completion queue) and server_->Shutdown()
results in a clean shutdown.
One caveat: if you use grpc::ServerContext::AsyncNotifyWhenDone()
to register a tag for call cancellation, these will not be returned by cq_->Next()
if the server shuts down before the initial request is received for that call. You will need to be cautious with the memory management of the corresponding tag structure, if you want to avoid memory leaks.