grpc::ClientAsyncReader< R > Class Template Reference

Async client-side API for doing server-streaming RPCs, where the incoming message stream coming from the server has messages of type R. More...

#include <async_stream.h>

Public Member Functions
void	ReadInitialMetadata (void *tag) override
	See the ClientAsyncStreamingInterface.ReadInitialMetadata method for semantics. More...
void	Read (R *msg, void *tag) override
	Read a message of type R into msg. More...
void	Finish (Status *status, void *tag) override
	See the ClientAsyncStreamingInterface.Finish method for semantics. More...
Public Member Functions inherited from grpc::ClientAsyncStreamingInterface
virtual	~ClientAsyncStreamingInterface ()
Public Member Functions inherited from grpc::AsyncReaderInterface< R >
virtual	~AsyncReaderInterface ()

Static Public Member Functions
template<class W >
static ClientAsyncReader *	Create (ChannelInterface *channel, CompletionQueue *cq, const RpcMethod &method, ClientContext *context, const W &request, void *tag)
	Create a stream and write the first request out. More...
static void	operator delete (void *ptr, std::size_t size)

Detailed Description

template<class R>
class grpc::ClientAsyncReader< R >

Async client-side API for doing server-streaming RPCs, where the incoming message stream coming from the server has messages of type R.

Member Function Documentation

template<class R >

template<class W >

static ClientAsyncReader* grpc::ClientAsyncReader< R >::Create ( ChannelInterface *  channel, CompletionQueue *  cq, const RpcMethod &  method, ClientContext *  context, const W &  request, void *  tag  )

inlinestatic

Create a stream and write the first request out.

tag will be notified on cq when the call has been started and request has been written out. Note that context will be used to fill in custom initial metadata used to send to the server when starting the call.

template<class R >

void grpc::ClientAsyncReader< R >::Finish ( Status *  status, void *  tag  )

inlineoverridevirtual

See the ClientAsyncStreamingInterface.Finish method for semantics.

Side effect:

• the ClientContext associated with this call is updated with possible initial and trailing metadata received from the server.

Implements grpc::ClientAsyncStreamingInterface.

template<class R >

static void grpc::ClientAsyncReader< R >::operator delete ( void *  ptr, std::size_t  size  )

inlinestatic

template<class R >

void grpc::ClientAsyncReader< R >::Read ( R *  msg, void *  tag  )

inlineoverridevirtual

Read a message of type R into msg.

Completion will be notified by tag on the associated completion queue. This is thread-safe with respect to Write or WritesDone methods. It should not be called concurrently with other streaming APIs on the same stream. It is not meaningful to call it concurrently with another AsyncReaderInterface::Read on the same stream since reads on the same stream are delivered in order.

Parameters

[out]	msg	Where to eventually store the read message.
[in]	tag	The tag identifying the operation.

Side effect: note that this method attempt to receive initial metadata for a stream if it hasn't yet been received.

Implements grpc::AsyncReaderInterface< R >.

template<class R >

void grpc::ClientAsyncReader< R >::ReadInitialMetadata ( void *  tag )

inlineoverridevirtual

See the ClientAsyncStreamingInterface.ReadInitialMetadata method for semantics.

Side effect:

• upon receiving initial metadata from the server, the ClientContext associated with this call is updated, and the calling code can access the received metadata through the ClientContext.

Implements grpc::ClientAsyncStreamingInterface.

---

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

• include/grpc++/impl/codegen/async_stream.h