grpc::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
template<class W >
	ClientReader (ChannelInterface *channel, const RpcMethod &method, ClientContext *context, const W &request)
	Block to create a stream and write the initial metadata and request out. More...
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...
Status	Finish () override
	See the ClientStreamingInterface.Finish method for semantics. More...
Public Member Functions inherited from grpc::ClientStreamingInterface
virtual	~ClientStreamingInterface ()
Public Member Functions inherited from grpc::ReaderInterface< R >
virtual	~ReaderInterface ()

Detailed Description

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

Constructor & Destructor Documentation

template<class R >

template<class W >

grpc::ClientReader< R >::ClientReader ( ChannelInterface *  channel, const RpcMethod &  method, ClientContext *  context, const W &  request  )

inline

Block to create a stream and write the initial metadata and request out.

Note that context will be used to fill in custom initial metadata used to send to the server when starting the call.

Member Function Documentation

template<class R >

Status grpc::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::ClientStreamingInterface.

template<class R >

bool grpc::ClientReader< R >::NextMessageSize ( uint32_t *  sz )

inlineoverridevirtual

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

Implements grpc::ReaderInterface< R >.

template<class R >

bool grpc::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::ReaderInterface< R >.

template<class R >

void grpc::ClientReader< R >::WaitForInitialMetadata ( )

inlineoverridevirtual

See the ClientStreamingInterface.WaitForInitialMetadata method for semantics.

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

status ignored

Implements grpc::ClientReaderInterface< R >.

---

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

• include/grpc++/impl/codegen/channel_interface.h
• include/grpc++/impl/codegen/sync_stream.h