GRPC C++  1.24.0
Public Member Functions | Friends
grpc_impl::ServerAsyncReaderWriter< W, R > Class Template Referencefinal

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. More...

#include <async_stream_impl.h>

Public Member Functions

 ServerAsyncReaderWriter (::grpc_impl::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 Write (const W &msg, void *tag) override
 Request the writing of msg with identifying tag tag. More...
 
void Write (const W &msg, ::grpc::WriteOptions options, void *tag) override
 Request the writing of msg using WriteOptions options with identifying tag tag. More...
 
void WriteAndFinish (const W &msg, ::grpc::WriteOptions options, const ::grpc::Status &status, void *tag) override
 See the ServerAsyncReaderWriterInterface.WriteAndFinish method for semantics. More...
 
void Finish (const ::grpc::Status &status, void *tag) override
 See the ServerAsyncReaderWriterInterface.Finish method for semantics. More...
 
- Public Member Functions inherited from grpc::internal::ServerAsyncStreamingInterface
virtual ~ServerAsyncStreamingInterface ()
 
- Public Member Functions inherited from grpc_impl::internal::AsyncWriterInterface< W >
virtual ~AsyncWriterInterface ()
 
void WriteLast (const W &msg, ::grpc::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...
 
- Public Member Functions inherited from grpc_impl::internal::AsyncReaderInterface< R >
virtual ~AsyncReaderInterface ()
 

Friends

class ::grpc_impl::Server
 

Detailed Description

template<class W, class R>
class grpc_impl::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.

Constructor & Destructor Documentation

◆ ServerAsyncReaderWriter()

template<class W , class R >
grpc_impl::ServerAsyncReaderWriter< W, R >::ServerAsyncReaderWriter ( ::grpc_impl::ServerContext ctx)
inlineexplicit

Member Function Documentation

◆ Finish()

template<class W , class R >
void grpc_impl::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_impl::ServerAsyncReaderWriterInterface< W, R >.

◆ Read()

template<class W , class R >
void grpc_impl::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]msgWhere to eventually store the read message.
[in]tagThe 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_impl::internal::AsyncReaderInterface< R >.

◆ SendInitialMetadata()

template<class W , class R >
void grpc_impl::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]tagTag identifying this request.

Implements grpc::internal::ServerAsyncStreamingInterface.

◆ Write() [1/2]

template<class W , class R >
void grpc_impl::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]msgThe message to be written.
[in]tagThe tag identifying the operation.

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

◆ Write() [2/2]

template<class W , class R >
void grpc_impl::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]msgThe message to be written.
[in]optionsThe WriteOptions to be used to write this message.
[in]tagThe tag identifying the operation.

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

◆ WriteAndFinish()

template<class W , class R >
void grpc_impl::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_impl::ServerAsyncReaderWriterInterface< W, R >.

Friends And Related Function Documentation

◆ ::grpc_impl::Server

template<class W , class R >
friend class ::grpc_impl::Server
friend

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