GRPC C++  1.3.0
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Friends
grpc::ServerAsyncReaderWriter< W, R > Class Template Referencefinal

#include <async_stream.h>

Public Member Functions

 ServerAsyncReaderWriter (ServerContext *ctx)
 
void SendInitialMetadata (void *tag) override
 
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, WriteOptions options, void *tag) override
 Request the writing of msg using WriteOptions options with identifying tag tag. More...
 
void WriteAndFinish (const W &msg, WriteOptions options, const Status &status, void *tag) override
 Request the writing of msg and coalesce it with trailing metadata which contains status, using WriteOptions options with identifying tag tag. More...
 
void Finish (const Status &status, void *tag) override
 
- Public Member Functions inherited from grpc::ServerAsyncStreamingInterface
virtual ~ServerAsyncStreamingInterface ()
 
- Public Member Functions inherited from grpc::AsyncWriterInterface< W >
virtual ~AsyncWriterInterface ()
 
void WriteLast (const W &msg, 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::AsyncReaderInterface< R >
virtual ~AsyncReaderInterface ()
 

Friends

class ::grpc::Server
 

Constructor & Destructor Documentation

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

Member Function Documentation

template<class W , class R >
void grpc::ServerAsyncReaderWriter< W, R >::Finish ( const Status status,
void *  tag 
)
inlineoverridevirtual
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 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.

Implements grpc::AsyncReaderInterface< R >.

template<class W , class R >
void grpc::ServerAsyncReaderWriter< W, R >::SendInitialMetadata ( void *  tag)
inlineoverridevirtual
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 Read

Parameters
[in]msgThe message to be written.
[in]tagThe tag identifying the operation.

Implements grpc::AsyncWriterInterface< W >.

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

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::AsyncWriterInterface< W >.

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

Request the writing of msg and coalesce it with trailing metadata which contains status, using WriteOptions options with identifying tag tag.

WriteAndFinish is equivalent of performing WriteLast and Finish in a single step.

Parameters
[in]msgThe message to be written.
[in]optionsThe WriteOptions to be used to write this message.
[in]statusThe Status that server returns to client.
[in]tagThe tag identifying the operation.

Implements grpc::ServerAsyncReaderWriterInterface< W, R >.

Friends And Related Function Documentation

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

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