Common interface for all synchronous client side streaming. More...
#include <sync_stream.h>
Inheritance diagram for grpc::internal::ClientStreamingInterface:
Public Member Functions | |
| virtual grpc::Status | Finish ()=0 |
| virtual | ~ClientStreamingInterface () |
Detailed Description
Common interface for all synchronous client side streaming.
Definition at line 36 of file grpcpp/impl/codegen/sync_stream.h.
Constructor & Destructor Documentation
◆ ~ClientStreamingInterface()
|
inlinevirtual |
Definition at line 38 of file grpcpp/impl/codegen/sync_stream.h.
Member Function Documentation
◆ Finish()
|
pure virtual |
Block waiting until the stream finishes and a final status of the call is available.
It is appropriate to call this method exactly once when both:
- the calling code (client-side) has no more message to send (this can be declared implicitly by calling this method, or explicitly through an earlier call to WritesDone method of the class in use, e.g. ClientWriterInterface::WritesDone or ClientReaderWriterInterface::WritesDone).
- there are no more messages to be received from the server (which can be known implicitly, or explicitly from an earlier call to ReaderInterface::Read that returned "false").
This function will return either:
- when all incoming messages have been read and the server has returned status.
- when the server has returned a non-OK status.
- OR when the call failed for some reason and the library generated a status.
Return values:
- Status contains the status code, message and details for the call
- the ClientContext associated with this call is updated with possible trailing metadata sent from the server.
The documentation for this class was generated from the following file: