ugrpc::client::StreamReadFuture< RPC > Class Template Reference

#include <userver/ugrpc/client/rpc.hpp>

Detailed Description

template<typename RPC>
class ugrpc::client::StreamReadFuture< RPC >

StreamReadFuture for waiting a single read response from stream.

Definition at line 100 of file rpc.hpp.

Public Member Functions
	StreamReadFuture (StreamReadFuture &&other) noexcept
StreamReadFuture &	operator= (StreamReadFuture &&other) noexcept
	StreamReadFuture (const StreamReadFuture &)=delete
StreamReadFuture &	operator= (const StreamReadFuture &)=delete
bool	Get ()
	Await response.
bool	IsReady () const noexcept
	Checks if the asynchronous call has completed Note, that once user gets result, IsReady should not be called.

Constructor & Destructor Documentation

StreamReadFuture()

template<typename RPC >

ugrpc::client::StreamReadFuture< RPC >::StreamReadFuture ( StreamReadFuture< RPC > && other )

noexcept

Definition at line 441 of file rpc.hpp.

~StreamReadFuture()

template<typename RPC >

ugrpc::client::StreamReadFuture< RPC >::~StreamReadFuture

(

)

Definition at line 459 of file rpc.hpp.

Member Function Documentation

Get()

template<typename RPC >

bool ugrpc::client::StreamReadFuture< RPC >::Get

(

)

Await response.

Upon completion the result is available in response that was specified when initiating the asynchronous read

Get should not be called multiple times for the same StreamReadFuture.

Exceptions

ugrpc::client::RpcError	on an RPC error
ugrpc::client::RpcCancelledError	on task cancellation

Definition at line 475 of file rpc.hpp.

IsReady()

template<typename RPC >

bool ugrpc::client::StreamReadFuture< RPC >::IsReady ( ) const

noexcept

Checks if the asynchronous call has completed Note, that once user gets result, IsReady should not be called.

Returns

true if result ready

Definition at line 494 of file rpc.hpp.

operator=()

template<typename RPC >

StreamReadFuture< RPC > & ugrpc::client::StreamReadFuture< RPC >::operator= ( StreamReadFuture< RPC > && other )

noexcept

Definition at line 448 of file rpc.hpp.

---

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

• userver/ugrpc/client/rpc.hpp