#include <async_stream.h>

Inheritance diagram for grpc::ServerAsyncReaderWriter< W, R >:

[legend]

Public Member Functions
void	Finish (const grpc::Status &status, void *tag) override

void	Read (R msg, void tag) override

void	SendInitialMetadata (void *tag) override

	ServerAsyncReaderWriter (grpc::ServerContext *ctx)

void	Write (const W &msg, grpc::WriteOptions options, void *tag) override

void	Write (const W &msg, void *tag) override

void	WriteAndFinish (const W &msg, grpc::WriteOptions options, const grpc::Status &status, void *tag) override

Public Member Functions inherited from grpc::internal::ServerAsyncStreamingInterface
virtual	~ServerAsyncStreamingInterface ()

Public Member Functions inherited from grpc::internal::AsyncWriterInterface< W >
void	WriteLast (const W &msg, grpc::WriteOptions options, void *tag)

virtual	~AsyncWriterInterface ()

Public Member Functions inherited from grpc::internal::AsyncReaderInterface< R >
virtual	~AsyncReaderInterface ()

Private Member Functions
void	BindCall (grpc::internal::Call *call) override

template<class T >
void	EnsureInitialMetadataSent (T *ops)

Friends
class	grpc::Server

Detailed Description

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

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

Definition at line 1010 of file grpcpp/impl/codegen/async_stream.h.

Constructor & Destructor Documentation

◆ ServerAsyncReaderWriter()

template<class W , class R >

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

inlineexplicit

Definition at line 1013 of file grpcpp/impl/codegen/async_stream.h.

Member Function Documentation

◆ BindCall()

template<class W , class R >

void grpc::ServerAsyncReaderWriter< W, R >::BindCall ( grpc::internal::Call * call )

inlineoverrideprivatevirtual

Implements grpc::internal::ServerAsyncStreamingInterface.

Definition at line 1103 of file grpcpp/impl/codegen/async_stream.h.

◆ EnsureInitialMetadataSent()

template<class W , class R >

template<class T >

void grpc::ServerAsyncReaderWriter< W, R >::EnsureInitialMetadataSent ( T * ops )

inlineprivate

Definition at line 1106 of file grpcpp/impl/codegen/async_stream.h.

◆ Finish()

template<class W , class R >

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

inlineoverridevirtual

See the ServerAsyncReaderWriterInterface.Finish method for semantics.

Implicit input parameter:

the ServerContext associated with this call is used for sending trailing (and initial if not already sent) metadata to the client.

Note: there are no restrictions are the code of status, it may be non-OK gRPC doesn't take ownership or a reference to status, so it is safe to to deallocate once Finish returns.

Implements grpc::ServerAsyncReaderWriterInterface< W, R >.

Definition at line 1092 of file grpcpp/impl/codegen/async_stream.h.

◆ Read()

template<class W , class R >

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

Definition at line 1036 of file grpcpp/impl/codegen/async_stream.h.

◆ SendInitialMetadata()

template<class W , class R >

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

Parameters

[in] tag Tag identifying this request.

Implements grpc::internal::ServerAsyncStreamingInterface.

Definition at line 1023 of file grpcpp/impl/codegen/async_stream.h.

◆ Write() [1/2]

template<class W , class R >

void grpc::ServerAsyncReaderWriter< W, R >::Write	(	const W &	msg,
		grpc::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

gRPC doesn't take ownership or a reference to msg, so it is safe to to deallocate once Write returns.

Parameters

[in]	msg	The message to be written.
[in]	options	The WriteOptions to be used to write this message.
[in]	tag	The tag identifying the operation.

Implements grpc::internal::AsyncWriterInterface< W >.

Definition at line 1050 of file grpcpp/impl/codegen/async_stream.h.

◆ Write() [2/2]

template<class W , class R >

void grpc::ServerAsyncReaderWriter< W, R >::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

gRPC doesn't take ownership or a reference to msg, so it is safe to to deallocate once Write returns.

Parameters

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

Implements grpc::internal::AsyncWriterInterface< W >.

Definition at line 1042 of file grpcpp/impl/codegen/async_stream.h.

◆ WriteAndFinish()

template<class W , class R >

void grpc::ServerAsyncReaderWriter< W, R >::WriteAndFinish	(	const W &	msg,
		grpc::WriteOptions	options,
		const grpc::Status &	status,
		void *	tag
	)

inlineoverridevirtual

See the ServerAsyncReaderWriterInterface.WriteAndFinish method for semantics.

Implicit input parameter:

the ServerContext associated with this call is used for sending trailing (and initial) metadata to the client.

Note: status must have an OK code. gRPC doesn't take ownership or a reference to msg and status, so it is safe to deallocate once WriteAndFinish returns.

Implements grpc::ServerAsyncReaderWriterInterface< W, R >.

Definition at line 1071 of file grpcpp/impl/codegen/async_stream.h.

Friends And Related Function Documentation

◆ grpc::Server

template<class W , class R >

friend class grpc::Server

friend

Definition at line 1101 of file grpcpp/impl/codegen/async_stream.h.

Member Data Documentation

◆ call_

template<class W , class R >

grpc::internal::Call grpc::ServerAsyncReaderWriter< W, R >::call_

private

Definition at line 1117 of file grpcpp/impl/codegen/async_stream.h.

◆ ctx_

template<class W , class R >

grpc::ServerContext* grpc::ServerAsyncReaderWriter< W, R >::ctx_

private

Definition at line 1118 of file grpcpp/impl/codegen/async_stream.h.

◆ finish_ops_

template<class W , class R >

grpc::internal::CallOpSet<grpc::internal::CallOpSendInitialMetadata, grpc::internal::CallOpServerSendStatus> grpc::ServerAsyncReaderWriter< W, R >::finish_ops_

private

Definition at line 1128 of file grpcpp/impl/codegen/async_stream.h.

◆ meta_ops_

template<class W , class R >

grpc::internal::CallOpSet<grpc::internal::CallOpSendInitialMetadata> grpc::ServerAsyncReaderWriter< W, R >::meta_ops_

private

Definition at line 1120 of file grpcpp/impl/codegen/async_stream.h.

◆ read_ops_

template<class W , class R >

grpc::internal::CallOpSet<grpc::internal::CallOpRecvMessage<R> > grpc::ServerAsyncReaderWriter< W, R >::read_ops_

private

Definition at line 1121 of file grpcpp/impl/codegen/async_stream.h.

◆ write_ops_

template<class W , class R >

grpc::internal::CallOpSet<grpc::internal::CallOpSendInitialMetadata, grpc::internal::CallOpSendMessage, grpc::internal::CallOpServerSendStatus> grpc::ServerAsyncReaderWriter< W, R >::write_ops_

private

Definition at line 1125 of file grpcpp/impl/codegen/async_stream.h.

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

grpcpp/impl/codegen/async_stream.h

Private Attributes
grpc::internal::Call	call_

grpc::ServerContext *	ctx_

grpc::internal::CallOpSet< grpc::internal::CallOpSendInitialMetadata, grpc::internal::CallOpServerSendStatus >	finish_ops_

grpc::internal::CallOpSet< grpc::internal::CallOpSendInitialMetadata >	meta_ops_

grpc::internal::CallOpSet< grpc::internal::CallOpRecvMessage< R > >	read_ops_

grpc::internal::CallOpSet< grpc::internal::CallOpSendInitialMetadata, grpc::internal::CallOpSendMessage, grpc::internal::CallOpServerSendStatus >	write_ops_

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

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

Constructor & Destructor Documentation

◆ ServerAsyncReaderWriter()

Member Function Documentation

◆ BindCall()

◆ EnsureInitialMetadataSent()

◆ Finish()

◆ Read()

◆ SendInitialMetadata()

◆ Write() [1/2]

◆ Write() [2/2]

◆ WriteAndFinish()

Friends And Related Function Documentation

◆ grpc::Server

Member Data Documentation

◆ call_

◆ ctx_

◆ finish_ops_

◆ meta_ops_

◆ read_ops_

◆ write_ops_

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