grpc::ServerAsyncReader< W, R > Class Template Reference

Async server-side API for doing client-streaming RPCs, where the incoming message stream from the client has messages of type R, and the single response message sent from the server is type W. More...

#include <async_stream.h>

Public Member Functions
	ServerAsyncReader (ServerContext *ctx)
void	SendInitialMetadata (void *tag) override
	See ServerAsyncStreamingInterface::SendInitialMetadata for semantics. More...
void	Read (R *msg, void *tag) override
	Read a message of type R into msg. More...
void	Finish (const W &msg, const Status &status, void *tag) override
	See the ServerAsyncReaderInterface.Read method for semantics. More...
void	FinishWithError (const Status &status, void *tag) override
	See the ServerAsyncReaderInterface.Read method for semantics. More...
Public Member Functions inherited from grpc::internal::ServerAsyncStreamingInterface
virtual	~ServerAsyncStreamingInterface ()
Public Member Functions inherited from grpc::internal::AsyncReaderInterface< R >
virtual	~AsyncReaderInterface ()

Detailed Description

template<class W, class R>
class grpc::ServerAsyncReader< W, R >

Async server-side API for doing client-streaming RPCs, where the incoming message stream from the client has messages of type R, and the single response message sent from the server is type W.

Constructor & Destructor Documentation

ServerAsyncReader()

template<class W , class R >

grpc::ServerAsyncReader< W, R >::ServerAsyncReader ( ServerContext *  ctx )

inlineexplicit

Member Function Documentation

Finish()

template<class W , class R >

void grpc::ServerAsyncReader< W, R >::Finish ( const W &  msg, const Status &  status, void *  tag  )

inlineoverridevirtual

See the ServerAsyncReaderInterface.Read method for semantics.

Side effect:

• also sends initial metadata if not alreay sent.
• uses the ServerContext associated with this call to send possible initial and trailing metadata.

Note: msg is not sent if status has a non-OK code.

Implements grpc::ServerAsyncReaderInterface< W, R >.

FinishWithError()

template<class W , class R >

void grpc::ServerAsyncReader< W, R >::FinishWithError ( const Status &  status, void *  tag  )

inlineoverridevirtual

See the ServerAsyncReaderInterface.Read method for semantics.

Side effect:

• also sends initial metadata if not alreay sent.
• uses the ServerContext associated with this call to send possible initial and trailing metadata.

Implements grpc::ServerAsyncReaderInterface< W, R >.

Read()

template<class W , class R >

void grpc::ServerAsyncReader< W, 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::internal::AsyncReaderInterface< R >.

SendInitialMetadata()

template<class W , class R >

void grpc::ServerAsyncReader< W, R >::SendInitialMetadata ( void *  tag )

inlineoverridevirtual

See ServerAsyncStreamingInterface::SendInitialMetadata for semantics.

Implicit input parameter:

• The initial metadata that will be sent to the client from this op will be taken from the ServerContext associated with the call.

Implements grpc::internal::ServerAsyncStreamingInterface.

---

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

• include/grpcpp/impl/codegen/async_stream.h