GRPC C++  1.26.0
Public Member Functions
grpc_impl::internal::ClientAsyncStreamingInterface Class Referenceabstract

Common interface for all client side asynchronous streaming. More...

#include <async_stream_impl.h>

Public Member Functions

virtual ~ClientAsyncStreamingInterface ()
 
virtual void StartCall (void *tag)=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 the initial metadata. More...
 
virtual void Finish (::grpc::Status *status, void *tag)=0
 Indicate that the stream is to be finished and request notification for when the call has been ended. More...
 

Detailed Description

Common interface for all client side asynchronous streaming.

Constructor & Destructor Documentation

◆ ~ClientAsyncStreamingInterface()

virtual grpc_impl::internal::ClientAsyncStreamingInterface::~ClientAsyncStreamingInterface ( )
inlinevirtual

Member Function Documentation

◆ Finish()

virtual void grpc_impl::internal::ClientAsyncStreamingInterface::Finish ( ::grpc::Status status,
void *  tag 
)
pure virtual

Indicate that the stream is to be finished and request notification for when the call has been ended.

Should not be used concurrently with other operations.

It is appropriate to call this method exactly once when both:

  • the client side has no more message to send (this can be declared implicitly by calling this method, or explicitly through an earlier call to the WritesDone method of the class in use, e.g. ClientAsyncWriterInterface::WritesDone or ClientAsyncReaderWriterInterface::WritesDone).
  • there are no more messages to be received from the server (this can be known implicitly by the calling code, or explicitly from an earlier call to AsyncReaderInterface::Read that yielded a failed result, e.g. cq->Next(&read_tag, &ok) filled in 'ok' with 'false').

The tag will be returned when either:

  • all incoming messages have been read and the server has returned a status.
  • the server has returned a non-OK status.
  • the call failed for some reason and the library generated a status.

Note that implementations of this method attempt to receive initial metadata from the server if initial metadata hasn't yet been received.

Parameters
[in]tagTag identifying this request.
[out]statusTo be updated with the operation status.

Implemented in grpc_impl::ClientAsyncReaderWriter< W, R >, grpc_impl::ClientAsyncWriter< W >, and grpc_impl::ClientAsyncReader< R >.

◆ ReadInitialMetadata()

virtual void grpc_impl::internal::ClientAsyncStreamingInterface::ReadInitialMetadata ( void *  tag)
pure virtual

Request notification of the reading of the 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 AsyncReaderInterface::Read method.

Parameters
[in]tagTag identifying this request.

Implemented in grpc_impl::ClientAsyncReaderWriter< W, R >, grpc_impl::ClientAsyncWriter< W >, and grpc_impl::ClientAsyncReader< R >.

◆ StartCall()

virtual void grpc_impl::internal::ClientAsyncStreamingInterface::StartCall ( void *  tag)
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::ClientAsyncReaderWriter< W, R >, grpc_impl::ClientAsyncWriter< W >, and grpc_impl::ClientAsyncReader< R >.


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