grpc::ServerAsyncResponseWriter< W > Class Template Reference

Async server-side API for handling unary calls, where the single response message sent to the client is of type W. More...

#include <server_context.h>

Public Member Functions
	ServerAsyncResponseWriter (grpc::ServerContext *ctx)
void	SendInitialMetadata (void *tag) override
	See ServerAsyncStreamingInterface::SendInitialMetadata for semantics. More...
void	Finish (const W &msg, const grpc::Status &status, void *tag)
	Indicate that the stream is to be finished and request notification when the server has sent the appropriate signals to the client to end the call. More...
void	FinishWithError (const grpc::Status &status, void *tag)
	Indicate that the stream is to be finished with a non-OK status, and request notification for when the server has finished sending the appropriate signals to the client to end the call. More...

Detailed Description

template<class W>
class grpc::ServerAsyncResponseWriter< W >

Async server-side API for handling unary calls, where the single response message sent to the client is of type W.

Constructor & Destructor Documentation

ServerAsyncResponseWriter()

template<class W >

grpc::ServerAsyncResponseWriter< W >::ServerAsyncResponseWriter ( grpc::ServerContext *  ctx )

inlineexplicit

Member Function Documentation

Finish()

template<class W >

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

inline

Indicate that the stream is to be finished and request notification when the server has sent the appropriate signals to the client to end the call.

Should not be used concurrently with other operations.

Parameters

[in]	tag	Tag identifying this request.
[in]	status	To be sent to the client as the result of the call.
[in]	msg	Message to be sent to the client.

Side effect:

• also sends initial metadata if not already sent (using the ServerContext associated with this call).

Note: if status has a non-OK code, then msg will not be sent, and the client will receive only the status with possible trailing metadata.

gRPC doesn't take ownership or a reference to msg and status, so it is safe to deallocate them once the Finish operation is complete (i.e. a result arrives in the completion queue).

FinishWithError()

template<class W >

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

inline

Indicate that the stream is to be finished with a non-OK status, and request notification for when the server has finished sending the appropriate signals to the client to end the call.

Should not be used concurrently with other operations.

Parameters

[in]	tag	Tag identifying this request.
[in]	status	To be sent to the client as the result of the call. Note: status must have a non-OK code.

Side effect:

• also sends initial metadata if not already sent (using the ServerContext associated with this call).

gRPC doesn't take ownership or a reference to status, so it is safe to deallocate them once the Finish operation is complete (i.e. a result arrives in the completion queue).

SendInitialMetadata()

template<class W >

void grpc::ServerAsyncResponseWriter< W >::SendInitialMetadata ( void *  tag )

inlineoverride

See ServerAsyncStreamingInterface::SendInitialMetadata for semantics.

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

Parameters

[in]

tag

Tag identifying this request.

---

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

• include/grpcpp/server_context.h
• include/grpcpp/support/async_unary_call.h