src/cpp/server/server_rpc_handler.cc

/*
 *
 * 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.
 *
 */

#include "src/cpp/server/server_rpc_handler.h"

#include <grpc/support/log.h>
#include "src/cpp/server/server_context_impl.h"
#include "src/cpp/stream/stream_context.h"
#include <grpc++/async_server_context.h>
#include <grpc++/impl/rpc_service_method.h>

namespace grpc {

ServerRpcHandler::ServerRpcHandler(AsyncServerContext* async_server_context,
                                   RpcServiceMethod* method)
    : async_server_context_(async_server_context), method_(method) {}

void ServerRpcHandler::StartRpc() {
  if (method_ == nullptr) {
    // Method not supported, finish the rpc with error.
    // TODO(rocking): do we need to call read to consume the request?
    FinishRpc(Status(StatusCode::UNIMPLEMENTED, "No such method."));
    return;
  }

  ServerContextImpl user_context(async_server_context_->absolute_deadline());

  if (method_->method_type() == RpcMethod::NORMAL_RPC) {
    // Start the rpc on this dedicated completion queue.
    async_server_context_->Accept(cq_.cq());

    // Allocate request and response.
    std::unique_ptr<google::protobuf::Message> request(
        method_->AllocateRequestProto());
    std::unique_ptr<google::protobuf::Message> response(
        method_->AllocateResponseProto());

    // Read request
    async_server_context_->StartRead(request.get());
    auto type = WaitForNextEvent();
    GPR_ASSERT(type == CompletionQueue::SERVER_READ_OK);

    // Run the application's rpc handler
    MethodHandler* handler = method_->handler();
    Status status = handler->RunHandler(MethodHandler::HandlerParameter(
        &user_context, request.get(), response.get()));

    if (status.IsOk()) {
      // Send the response if we get an ok status.
      async_server_context_->StartWrite(*response, 0);
      type = WaitForNextEvent();
      if (type != CompletionQueue::SERVER_WRITE_OK) {
        status = Status(StatusCode::INTERNAL, "Error writing response.");
      }
    }

    FinishRpc(status);
  } else {
    // Allocate request and response.
    // TODO(yangg) maybe not allocate both when not needed?
    std::unique_ptr<google::protobuf::Message> request(
        method_->AllocateRequestProto());
    std::unique_ptr<google::protobuf::Message> response(
        method_->AllocateResponseProto());

    StreamContext stream_context(*method_, async_server_context_->call(),
                                 cq_.cq(), request.get(), response.get());

    // Run the application's rpc handler
    MethodHandler* handler = method_->handler();
    Status status = handler->RunHandler(MethodHandler::HandlerParameter(
        &user_context, request.get(), response.get(), &stream_context));
    if (status.IsOk() &&
        method_->method_type() == RpcMethod::CLIENT_STREAMING) {
      stream_context.Write(response.get(), false);
    }
    // TODO(yangg) Do we need to consider the status in stream_context?
    FinishRpc(status);
  }
}

CompletionQueue::CompletionType ServerRpcHandler::WaitForNextEvent() {
  void* tag = nullptr;
  CompletionQueue::CompletionType type = cq_.Next(&tag);
  if (type != CompletionQueue::QUEUE_CLOSED &&
      type != CompletionQueue::RPC_END) {
    GPR_ASSERT(static_cast<AsyncServerContext*>(tag) ==
               async_server_context_.get());
  }
  return type;
}

void ServerRpcHandler::FinishRpc(const Status& status) {
  async_server_context_->StartWriteStatus(status);
  CompletionQueue::CompletionType type;

  // HALFCLOSE_OK and RPC_END events come in either order.
  type = WaitForNextEvent();
  GPR_ASSERT(type == CompletionQueue::HALFCLOSE_OK ||
             type == CompletionQueue::RPC_END);
  type = WaitForNextEvent();
  GPR_ASSERT(type == CompletionQueue::HALFCLOSE_OK ||
             type == CompletionQueue::RPC_END);

  cq_.Shutdown();
  type = WaitForNextEvent();
  GPR_ASSERT(type == CompletionQueue::QUEUE_CLOSED);
}

}  // namespace grpc