serve_options.h

// neograph::grpc — how a built-in server runs.
//
// run_server, run_tool_server and run_checkpoint_server each start one gRPC
// server for one NeoGraph service. Without ServeOptions::credentials the
// server is insecure (no TLS, no authentication), the way it always was;
// ServeOptions::credentials takes the caller's server credentials, TLS and
// mutual TLS among them. Every built-in server also answers the standard
// health service, grpc.health.v1.Health: SERVING for the server ("") and for
// its service ("neograph.v1.GraphService", "neograph.v1.ToolService" or
// "neograph.v1.CheckpointService") while it accepts calls, NOT_SERVING once
// it begins to stop. The overloads that take ServeOptions can also be
// stopped and report the bound port. For authentication interceptors or more
// services on one port, register make_graph_service(), make_tool_service()
// or make_checkpoint_service() with your own grpc::ServerBuilder instead.
//
// Server reflection is the host's choice: link gRPC::grpc++_reflection and
// call grpc::reflection::InitProtoReflectionServerBuilderPlugin() once before
// the servers start. gRPC then adds it to every server of the process, the
// built-in ones included.
//
// Opt-in (NEOGRAPH_BUILD_GRPC). Whole header behind NEOGRAPH_HAVE_GRPC.
 
#pragma once
 
#ifdef NEOGRAPH_HAVE_GRPC
 
#include <chrono>
#include <cstddef>
#include <functional>
#include <memory>
#include <stop_token>
 
// Declared, not included: a program that only starts a server with the
// defaults needs no gRPC header beyond the ones of the service it serves.
namespace grpc {
class ServerCredentials;
}
 
namespace neograph::grpc {
 
struct ServeOptions {
    std::stop_token stop;
    std::chrono::milliseconds shutdown_grace{std::chrono::seconds(5)};
    std::function<void(int port)> on_serving;
    std::shared_ptr<::grpc::ServerCredentials> credentials;
    std::size_t max_receive_message_bytes = 0;
    std::size_t max_send_message_bytes = 0;
};
 
}  // namespace neograph::grpc
 
#endif  // NEOGRAPH_HAVE_GRPC