Async API on the client side for doing client-streaming RPCs, where the outgoing message stream going to the server contains messages of type W. More...

#include <async_stream.h>

Public Member Functions
void	ReadInitialMetadata (void *tag) override
	See the ClientAsyncStreamingInterface.ReadInitialMetadata method for semantics. More...

void	Write (const W &msg, void *tag) override
	Request the writing of msg with identifying tag tag. More...

void	Write (const W &msg, WriteOptions options, void *tag) override
	Request the writing of msg using WriteOptions options with identifying tag tag. More...

void	WritesDone (void *tag) override
	Signal the client is done with the writes (half-close the client stream). 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::AsyncWriterInterface< W >
virtual	~AsyncWriterInterface ()

void	WriteLast (const W &msg, WriteOptions options, void *tag)
	Request the writing of msg and coalesce it with the writing of trailing metadata, using WriteOptions options with identifying tag tag. More...

Static Public Member Functions
template<class R >
static ClientAsyncWriter *	Create (ChannelInterface channel, CompletionQueue cq, const RpcMethod &method, ClientContext context, R response, 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 W>
class grpc::ClientAsyncWriter< W >

Async API on the client side for doing client-streaming RPCs, where the outgoing message stream going to the server contains messages of type W.

Member Function Documentation

template<class W >

template<class R >

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

inlinestatic

Create a stream and write the first request out.

tag will be notified on cq when the call has been started (i.e. intitial metadata sent) 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. response will be filled in with the single expected response message from the server upon a successful call to the Finish method of this instance.

template<class W >

void grpc::ClientAsyncWriter< W >::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.
attempts to fill in the response parameter passed to this class's constructor with the server's response message.

Implements grpc::ClientAsyncStreamingInterface.

template<class W >

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

inlinestatic

template<class W >

void grpc::ClientAsyncWriter< W >::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.

template<class W >

void grpc::ClientAsyncWriter< W >::Write	(	const W &	msg,
		void *	tag
	)

inlineoverridevirtual

Request the writing of msg with identifying tag tag.

Only one write may be outstanding at any given time. This means that after calling Write, one must wait to receive tag from the completion queue BEFORE calling Write again. This is thread-safe with respect to AsyncReaderInterface::Read

Parameters

[in]	msg	The message to be written.
[in]	tag	The tag identifying the operation.

Implements grpc::AsyncWriterInterface< W >.

template<class W >

void grpc::ClientAsyncWriter< W >::Write	(	const W &	msg,
		WriteOptions	options,
		void *	tag
	)

inlineoverridevirtual

Request the writing of msg using WriteOptions options with identifying tag tag.

Only one write may be outstanding at any given time. This means that after calling Write, one must wait to receive tag from the completion queue BEFORE calling Write again. WriteOptions options is used to set the write options of this message. This is thread-safe with respect to AsyncReaderInterface::Read

Parameters