A class to represent a flow-controlled server-side streaming call. More...
#include <sync_stream.h>
Public Member Functions | |
| void | SendInitialMetadata () override |
| Block to send initial metadata to client. More... | |
| bool | NextMessageSize (uint32_t *sz) override |
| Get an upper bound on the request message size from the client. More... | |
| bool | Read (RequestType *request) override |
| Read a message of type R into msg. More... | |
| bool | Write (const ResponseType &response, grpc::WriteOptions options) override |
| Block to write msg to the stream with WriteOptions options. More... | |
 Public Member Functions inherited from grpc::internal::ServerStreamingInterface | |
| virtual | ~ServerStreamingInterface () |
| Public Member Functions inherited from grpc::internal::WriterInterface< ResponseType > | |
| virtual | ~WriterInterface () |
| bool | Write (const ResponseType &msg) |
| Block to write msg to the stream with default write options. More... | |
| void | WriteLast (const ResponseType &msg, grpc::WriteOptions options) |
| Write msg and coalesce it with the writing of trailing metadata, using WriteOptions options. More... | |
| Public Member Functions inherited from grpc::internal::ReaderInterface< RequestType > | |
| virtual | ~ReaderInterface () |
Friends | |
| class | internal::TemplatedBidiStreamingHandler< ServerSplitStreamer< RequestType, ResponseType >, false > |
Detailed Description
template<class RequestType, class ResponseType>
class grpc::ServerSplitStreamer< RequestType, ResponseType >
A class to represent a flow-controlled server-side streaming call.
This is something of a hybrid between server-side and bidi streaming. This is invoked through a server-side streaming call on the client side, but the server responds to it as though it were a bidi streaming call that must first have exactly 1 Read and then any number of Writes.
Member Function Documentation
◆ NextMessageSize()
|
inlineoverridevirtual |
Get an upper bound on the request message size from the client.
Implements grpc::internal::ReaderInterface< RequestType >.
◆ Read()
|
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 ReaderInterface::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.
Implements grpc::internal::ReaderInterface< RequestType >.
◆ SendInitialMetadata()
|
inlineoverridevirtual |
Block to send initial metadata to client.
Implicit input parameter:
- the ServerContext associated with this call will be used for sending initial metadata.
Implements grpc::internal::ServerStreamingInterface.
◆ Write()
|
inlineoverridevirtual |
Block to write msg to the stream with WriteOptions options.
This is thread-safe with respect to ReaderInterface::Read
- Parameters
-
msg The message to be written to the stream. options The WriteOptions affecting the write operation.
- Returns
- true on success, false when the stream has been closed.
Implements grpc::internal::WriterInterface< ResponseType >.
Friends And Related Function Documentation
◆ internal::TemplatedBidiStreamingHandler< ServerSplitStreamer< RequestType, ResponseType >, false >
|
friend |
The documentation for this class was generated from the following file:
- include/grpcpp/support/sync_stream.h
