GRPC C++  1.24.0
Public Member Functions | Friends
grpc_impl::ClientReader< R > Class Template Reference

Synchronous (blocking) client-side API for doing server-streaming RPCs, where the stream of messages coming from the server has messages of type R. More...

#include <channel_interface.h>

Public Member Functions

void WaitForInitialMetadata () override
 See the ClientStreamingInterface.WaitForInitialMetadata method for semantics. More...
 
bool NextMessageSize (uint32_t *sz) override
 Get an upper bound on the next message size available for reading on this stream. More...
 
bool Read (R *msg) override
 See the ReaderInterface.Read method for semantics. More...
 
::grpc::Status Finish () override
 See the ClientStreamingInterface.Finish method for semantics. More...
 
- Public Member Functions inherited from grpc_impl::internal::ClientStreamingInterface
virtual ~ClientStreamingInterface ()
 
- Public Member Functions inherited from grpc_impl::internal::ReaderInterface< R >
virtual ~ReaderInterface ()
 

Friends

class internal::ClientReaderFactory< R >
 

Detailed Description

template<class R>
class grpc_impl::ClientReader< R >

Synchronous (blocking) client-side API for doing server-streaming RPCs, where the stream of messages coming from the server has messages of type R.

Member Function Documentation

◆ Finish()

template<class R>
::grpc::Status grpc_impl::ClientReader< R >::Finish ( )
inlineoverridevirtual

See the ClientStreamingInterface.Finish method for semantics.

Side effect: The ClientContext associated with this call is updated with possible metadata received from the server.

Implements grpc_impl::internal::ClientStreamingInterface.

◆ NextMessageSize()

template<class R>
bool grpc_impl::ClientReader< R >::NextMessageSize ( uint32_t *  sz)
inlineoverridevirtual

Get an upper bound on the next message size available for reading on this stream.

Implements grpc_impl::internal::ReaderInterface< R >.

◆ Read()

template<class R>
bool grpc_impl::ClientReader< R >::Read ( R *  msg)
inlineoverridevirtual

See the ReaderInterface.Read method for semantics.

Side effect: This also receives initial metadata from the server, if not already received (if initial metadata is received, it can be then accessed through the ClientContext associated with this call).

Implements grpc_impl::internal::ReaderInterface< R >.

◆ WaitForInitialMetadata()

template<class R>
void grpc_impl::ClientReader< R >::WaitForInitialMetadata ( )
inlineoverridevirtual

See the ClientStreamingInterface.WaitForInitialMetadata method for semantics.

Once complete, the initial metadata read from the server will be accessible through the ClientContext used to construct this object.

status ignored

Implements grpc_impl::ClientReaderInterface< R >.

Friends And Related Function Documentation

◆ internal::ClientReaderFactory< R >

template<class R>
friend class internal::ClientReaderFactory< R >
friend

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