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

Async client-side interface for bi-directional streaming, where the outgoing message stream going to the server has messages of type W, and the incoming message stream coming from the server has messages of type R. More...

#include <async_stream_impl.h>

Public Member Functions

void StartCall (void *tag) override
 Start the call that was set up by the constructor, but only if the constructor was invoked through the "Prepare" API which doesn't actually start the call. More...
 
void ReadInitialMetadata (void *tag) override
 See the ClientAsyncStreamingInterface.ReadInitialMetadata method for semantics of this method. 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 WritesDone (void *tag) override
 Signal the client is done with the writes (half-close the client stream). More...
 
void Finish (::grpc::Status *status, void *tag) override
 See the ClientAsyncStreamingInterface.Finish method for semantics. More...
 
- Public Member Functions inherited from grpc_impl::internal::ClientAsyncStreamingInterface
virtual ~ClientAsyncStreamingInterface ()
 
- 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 ()
 

Static Public Member Functions

static void operator delete (void *, std::size_t size)
 
static void operator delete (void *, void *)
 

Friends

class internal::ClientAsyncReaderWriterFactory< W, R >
 

Detailed Description

template<class W, class R>
class grpc_impl::ClientAsyncReaderWriter< W, R >

Async client-side interface for bi-directional streaming, where the outgoing message stream going to the server has messages of type W, and the incoming message stream coming from the server has messages of type R.

Member Function Documentation

◆ Finish()

template<class W , class R >
void grpc_impl::ClientAsyncReaderWriter< W, R >::Finish ( ::grpc::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 sent from the server.

Implements grpc_impl::internal::ClientAsyncStreamingInterface.

◆ operator delete() [1/2]

template<class W , class R >
static void grpc_impl::ClientAsyncReaderWriter< W, R >::operator delete ( void *  ,
std::size_t  size 
)
inlinestatic

◆ operator delete() [2/2]

template<class W , class R >
static void grpc_impl::ClientAsyncReaderWriter< W, R >::operator delete ( void *  ,
void *   
)
inlinestatic

◆ Read()

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

◆ ReadInitialMetadata()

template<class W , class R >
void grpc_impl::ClientAsyncReaderWriter< W, R >::ReadInitialMetadata ( void *  tag)
inlineoverridevirtual

See the ClientAsyncStreamingInterface.ReadInitialMetadata method for semantics of this method.

Side effect:

  • upon receiving initial metadata from the server, the ClientContext is updated with it, and then the receiving initial metadata can be accessed through this ClientContext.

Implements grpc_impl::internal::ClientAsyncStreamingInterface.

◆ StartCall()

template<class W , class R >
void grpc_impl::ClientAsyncReaderWriter< W, R >::StartCall ( void *  tag)
inlineoverridevirtual

Start the call that was set up by the constructor, but only if the constructor was invoked through the "Prepare" API which doesn't actually start the call.

Implements grpc_impl::internal::ClientAsyncStreamingInterface.

◆ Write() [1/2]

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

◆ WritesDone()

template<class W , class R >
void grpc_impl::ClientAsyncReaderWriter< W, R >::WritesDone ( void *  tag)
inlineoverridevirtual

Signal the client is done with the writes (half-close the client stream).

Thread-safe with respect to AsyncReaderInterface::Read

Parameters
[in]tagThe tag identifying the operation.

Implements grpc_impl::ClientAsyncReaderWriterInterface< W, R >.

Friends And Related Function Documentation

◆ internal::ClientAsyncReaderWriterFactory< W, R >

template<class W , class R >
friend class internal::ClientAsyncReaderWriterFactory< W, R >
friend

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