diff options
author | Vijay Pai <vpai@google.com> | 2018-12-18 22:43:49 -0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-12-18 22:43:49 -0800 |
commit | 8cd1c0e379dda453ad544dcde529c97265179f1b (patch) | |
tree | 3c83e27e6bdede473b238da68e52bc7cda2b2b9b /include/grpcpp/impl/codegen/server_interceptor.h | |
parent | 5763add7c9ede9664946212bf2980723376d7b5f (diff) | |
parent | cfe08f35f30d272a8f2e851fb9e069498b264f5f (diff) |
Merge pull request #17552 from vjpai/interceptor_comments
Document purpose and validity of interception API
Diffstat (limited to 'include/grpcpp/impl/codegen/server_interceptor.h')
-rw-r--r-- | include/grpcpp/impl/codegen/server_interceptor.h | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/include/grpcpp/impl/codegen/server_interceptor.h b/include/grpcpp/impl/codegen/server_interceptor.h index 8652ec5c64..3e71b3fc55 100644 --- a/include/grpcpp/impl/codegen/server_interceptor.h +++ b/include/grpcpp/impl/codegen/server_interceptor.h @@ -51,19 +51,33 @@ class ServerInterceptorFactoryInterface { virtual Interceptor* CreateServerInterceptor(ServerRpcInfo* info) = 0; }; +/// ServerRpcInfo represents the state of a particular RPC as it +/// appears to an interceptor. It is created and owned by the library and +/// passed to the CreateServerInterceptor method of the application's +/// ServerInterceptorFactoryInterface implementation class ServerRpcInfo { public: + /// Type categorizes RPCs by unary or streaming type enum class Type { UNARY, CLIENT_STREAMING, SERVER_STREAMING, BIDI_STREAMING }; ~ServerRpcInfo(){}; + // Delete all copy and move constructors and assignments ServerRpcInfo(const ServerRpcInfo&) = delete; + ServerRpcInfo& operator=(const ServerRpcInfo&) = delete; ServerRpcInfo(ServerRpcInfo&&) = delete; ServerRpcInfo& operator=(ServerRpcInfo&&) = delete; // Getter methods + + /// Return the fully-specified method name const char* method() const { return method_; } + + /// Return the type of the RPC (unary or a streaming flavor) Type type() const { return type_; } + + /// Return a pointer to the underlying ServerContext structure associated + /// with the RPC to support features that apply to it grpc::ServerContext* server_context() { return ctx_; } private: |