GRPC C++  1.24.0
Data Structures | Public Member Functions | Protected Member Functions | Friends
grpc::ServerInterface Class Referenceabstract

#include <server_interface.h>

Data Structures

class  BaseAsyncRequest
 
class  experimental_registration_interface
 NOTE: class experimental_registration_interface is not part of the public API of this class TODO(vjpai): Move these contents to public API when no longer experimental. More...
 
class  GenericAsyncRequest
 
class  NoPayloadAsyncRequest
 
class  PayloadAsyncRequest
 
class  RegisteredAsyncRequest
 RegisteredAsyncRequest is not part of the C++ API. More...
 

Public Member Functions

virtual ~ServerInterface ()
 
template<class T >
void Shutdown (const T &deadline)
 Shutdown does the following things: More...
 
void Shutdown ()
 Shutdown the server without a deadline and forced cancellation. More...
 
virtual void Wait ()=0
 Block waiting for all work to complete. More...
 
- Public Member Functions inherited from grpc::internal::CallHook
virtual ~CallHook ()
 

Protected Member Functions

virtual bool RegisterService (const grpc::string *host, Service *service)=0
 Register a service. More...
 
virtual void RegisterAsyncGenericService (AsyncGenericService *service)=0
 Register a generic service. More...
 
virtual experimental_registration_interfaceexperimental_registration ()
 NOTE: The function experimental_registration() is not stable public API. More...
 
virtual int AddListeningPort (const grpc::string &addr, grpc_impl::ServerCredentials *creds)=0
 Tries to bind server to the given addr. More...
 
virtual void Start (::grpc_impl::ServerCompletionQueue **cqs, size_t num_cqs)=0
 Start the server. More...
 
virtual void ShutdownInternal (gpr_timespec deadline)=0
 
virtual int max_receive_message_size () const =0
 
virtual grpc_serverserver ()=0
 
virtual void PerformOpsOnCall (internal::CallOpSetInterface *ops, internal::Call *call)=0
 
template<class Message >
void RequestAsyncCall (internal::RpcServiceMethod *method, ::grpc_impl::ServerContext *context, internal::ServerAsyncStreamingInterface *stream, ::grpc_impl::CompletionQueue *call_cq, ::grpc_impl::ServerCompletionQueue *notification_cq, void *tag, Message *message)
 
void RequestAsyncCall (internal::RpcServiceMethod *method, ::grpc_impl::ServerContext *context, internal::ServerAsyncStreamingInterface *stream, ::grpc_impl::CompletionQueue *call_cq, ::grpc_impl::ServerCompletionQueue *notification_cq, void *tag)
 
void RequestAsyncGenericCall (GenericServerContext *context, internal::ServerAsyncStreamingInterface *stream, ::grpc_impl::CompletionQueue *call_cq, ::grpc_impl::ServerCompletionQueue *notification_cq, void *tag)
 

Friends

class ::grpc::Service
 

Constructor & Destructor Documentation

◆ ~ServerInterface()

virtual grpc::ServerInterface::~ServerInterface ( )
inlinevirtual

Member Function Documentation

◆ AddListeningPort()

virtual int grpc::ServerInterface::AddListeningPort ( const grpc::string addr,
grpc_impl::ServerCredentials creds 
)
protectedpure virtual

Tries to bind server to the given addr.

It can be invoked multiple times.

Parameters
addrThe address to try to bind to the server (eg, localhost:1234, 192.168.1.1:31416, [::1]:27182, etc.). creds The credentials associated with the server.
Returns
bound port number on success, 0 on failure.
Warning
It's an error to call this method on an already started server.

Implemented in grpc_impl::Server.

◆ experimental_registration()

virtual experimental_registration_interface* grpc::ServerInterface::experimental_registration ( )
inlineprotectedvirtual

NOTE: The function experimental_registration() is not stable public API.

It is a view to the experimental components of this class. It may be changed or removed at any time. May not be abstract since this is a post-1.0 API addition

◆ max_receive_message_size()

virtual int grpc::ServerInterface::max_receive_message_size ( ) const
protectedpure virtual

◆ PerformOpsOnCall()

virtual void grpc::ServerInterface::PerformOpsOnCall ( internal::CallOpSetInterface ops,
internal::Call call 
)
protectedpure virtual

◆ RegisterAsyncGenericService()

virtual void grpc::ServerInterface::RegisterAsyncGenericService ( AsyncGenericService service)
protectedpure virtual

Register a generic service.

This call does not take ownership of the service. The service must exist for the lifetime of the Server instance.

◆ RegisterService()

virtual bool grpc::ServerInterface::RegisterService ( const grpc::string host,
Service service 
)
protectedpure virtual

Register a service.

This call does not take ownership of the service. The service must exist for the lifetime of the Server instance.

Implemented in grpc_impl::Server.

◆ RequestAsyncCall() [1/2]

template<class Message >
void grpc::ServerInterface::RequestAsyncCall ( internal::RpcServiceMethod method,
::grpc_impl::ServerContext context,
internal::ServerAsyncStreamingInterface stream,
::grpc_impl::CompletionQueue call_cq,
::grpc_impl::ServerCompletionQueue notification_cq,
void *  tag,
Message *  message 
)
inlineprotected

◆ RequestAsyncCall() [2/2]

void grpc::ServerInterface::RequestAsyncCall ( internal::RpcServiceMethod method,
::grpc_impl::ServerContext context,
internal::ServerAsyncStreamingInterface stream,
::grpc_impl::CompletionQueue call_cq,
::grpc_impl::ServerCompletionQueue notification_cq,
void *  tag 
)
inlineprotected

◆ RequestAsyncGenericCall()

void grpc::ServerInterface::RequestAsyncGenericCall ( GenericServerContext context,
internal::ServerAsyncStreamingInterface stream,
::grpc_impl::CompletionQueue call_cq,
::grpc_impl::ServerCompletionQueue notification_cq,
void *  tag 
)
inlineprotected

◆ server()

virtual grpc_server* grpc::ServerInterface::server ( )
protectedpure virtual

Implemented in grpc_impl::Server.

◆ Shutdown() [1/2]

template<class T >
void grpc::ServerInterface::Shutdown ( const T &  deadline)
inline

Shutdown does the following things:

  1. Shutdown the server: deactivate all listening ports, mark it in "shutdown mode" so that further call Request's or incoming RPC matches are no longer allowed. Also return all Request'ed-but-not-yet-active calls as failed (!ok). This refers to calls that have been requested at the server by the server-side library or application code but that have not yet been matched to incoming RPCs from the client. Note that this would even include default calls added automatically by the gRPC C++ API without the user's input (e.g., "Unimplemented RPC method")
  2. Block until all rpc method handlers invoked automatically by the sync API finish.
  3. If all pending calls complete (and all their operations are retrieved by Next) before deadline expires, this finishes gracefully. Otherwise, forcefully cancel all pending calls associated with the server after deadline expires. In the case of the sync API, if the RPC function for a streaming call has already been started and takes a week to complete, the RPC function won't be forcefully terminated (since that would leave state corrupt and incomplete) and the method handler will just keep running (which will prevent the server from completing the "join" operation that it needs to do at shutdown time).

All completion queue associated with the server (for example, for async serving) must be shutdown after this method has returned: See ServerBuilder::AddCompletionQueue for details. They must also be drained (by repeated Next) after being shutdown.

Parameters
deadlineHow long to wait until pending rpcs are forcefully terminated.

◆ Shutdown() [2/2]

void grpc::ServerInterface::Shutdown ( )
inline

Shutdown the server without a deadline and forced cancellation.

All completion queue associated with the server (for example, for async serving) must be shutdown after this method has returned: See ServerBuilder::AddCompletionQueue for details.

◆ ShutdownInternal()

virtual void grpc::ServerInterface::ShutdownInternal ( gpr_timespec  deadline)
protectedpure virtual

◆ Start()

virtual void grpc::ServerInterface::Start ( ::grpc_impl::ServerCompletionQueue **  cqs,
size_t  num_cqs 
)
protectedpure virtual

Start the server.

Parameters
cqsCompletion queues for handling asynchronous services. The caller is required to keep all completion queues live until the server is destroyed.
num_cqsHow many completion queues does cqs hold.

◆ Wait()

virtual void grpc::ServerInterface::Wait ( )
pure virtual

Block waiting for all work to complete.

Warning
The server must be either shutting down or some other thread must call Shutdown for this function to ever return.

Implemented in grpc_impl::Server.

Friends And Related Function Documentation

◆ ::grpc::Service

friend class ::grpc::Service
friend

The documentation for this class was generated from the following file: