Public Member Functions | List of all members
grpc::ClientAsyncResponseReaderInterface< R > Class Template Referenceabstract

#include <async_unary_call.h>

Inheritance diagram for grpc::ClientAsyncResponseReaderInterface< R >:
Inheritance graph
[legend]

Public Member Functions

virtual void Finish (R *msg, grpc::Status *status, void *tag)=0
 
virtual void ReadInitialMetadata (void *tag)=0
 
virtual void StartCall ()=0
 
virtual ~ClientAsyncResponseReaderInterface ()
 

Detailed Description

template<class R>
class grpc::ClientAsyncResponseReaderInterface< R >

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

Definition at line 42 of file grpcpp/impl/codegen/async_unary_call.h.

Constructor & Destructor Documentation

◆ ~ClientAsyncResponseReaderInterface()

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

Definition at line 44 of file grpcpp/impl/codegen/async_unary_call.h.

Member Function Documentation

◆ Finish()

template<class R >
virtual void grpc::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.

◆ ReadInitialMetadata()

template<class R >
virtual void grpc::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.

◆ StartCall()

template<class R >
virtual void grpc::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


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


grpc
Author(s):
autogenerated on Fri May 16 2025 03:03:30