GRPC C++  1.24.0
Public Member Functions
grpc_impl::ClientAsyncResponseReaderInterface< R > Class Template Referenceabstract

An interface relevant for async client side unary RPCs (which send one request message to a server and receive one response message). More...

#include <async_unary_call_impl.h>

Public Member Functions

virtual ~ClientAsyncResponseReaderInterface ()
 
virtual void StartCall ()=0
 Start the call that was set up by the constructor, but only if the constructor was invoked through the "Prepare" API which doesn't actually start the call. More...
 
virtual void ReadInitialMetadata (void *tag)=0
 Request notification of the reading of initial metadata. More...
 
virtual void Finish (R *msg, ::grpc::Status *status, void *tag)=0
 Request to receive the server's response msg and final status for the call, and to notify tag on this call's completion queue when finished. More...
 

Detailed Description

template<class R>
class grpc_impl::ClientAsyncResponseReaderInterface< R >

An interface relevant for async client side unary RPCs (which send one request message to a server and receive one response message).

Constructor & Destructor Documentation

◆ ~ClientAsyncResponseReaderInterface()

template<class R >
virtual grpc_impl::ClientAsyncResponseReaderInterface< R >::~ClientAsyncResponseReaderInterface ( )
inlinevirtual

Member Function Documentation

◆ Finish()

template<class R >
virtual void grpc_impl::ClientAsyncResponseReaderInterface< R >::Finish ( R *  msg,
::grpc::Status status,
void *  tag 
)
pure virtual

Request to receive the server's response msg and final status for the call, and to notify tag on this call's completion queue when finished.

This function will return when either:

  • when the server's response message and status have been received.
  • when the server has returned a non-OK status (no message expected in this case).
  • when the call failed for some reason and the library generated a non-OK status.
Parameters
[in]tagTag identifying this request.
[out]statusTo be updated with the operation status.
[out]msgTo be filled in with the server's response message.

Implemented in grpc_impl::ClientAsyncResponseReader< R >.

◆ ReadInitialMetadata()

template<class R >
virtual void grpc_impl::ClientAsyncResponseReaderInterface< R >::ReadInitialMetadata ( void *  tag)
pure virtual

Request notification of the reading of initial metadata.

Completion will be notified by tag on the associated completion queue. This call is optional, but if it is used, it cannot be used concurrently with or after the Finish method.

Parameters
[in]tagTag identifying this request.

Implemented in grpc_impl::ClientAsyncResponseReader< R >.

◆ StartCall()

template<class R >
virtual void grpc_impl::ClientAsyncResponseReaderInterface< R >::StartCall ( )
pure virtual

Start the call that was set up by the constructor, but only if the constructor was invoked through the "Prepare" API which doesn't actually start the call.

Implemented in grpc_impl::ClientAsyncResponseReader< R >.


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