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

Your opinion will help to improve our service

Leave a feedback >

Table of Contents

• Detailed Description
• Public Member Functions
• Constructor & Destructor Documentation
• StreamReadFuture()
• ~StreamReadFuture()
• Member Function Documentation
• Get()
• IsReady()
• operator=()

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

Detailed Description

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

StreamReadFuture for waiting a single read response from stream.

Definition at line 22 of file stream_read_future.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 RawStream >

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

noexcept

Definition at line 70 of file stream_read_future.hpp.

~StreamReadFuture()

template<typename RawStream >

ugrpc::client::StreamReadFuture< RawStream >::~StreamReadFuture

(

)

Definition at line 86 of file stream_read_future.hpp.

Member Function Documentation

Get()

template<typename RawStream >

bool ugrpc::client::StreamReadFuture< RawStream >::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 94 of file stream_read_future.hpp.

IsReady()

template<typename RawStream >

bool ugrpc::client::StreamReadFuture< RawStream >::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 115 of file stream_read_future.hpp.

operator=()

template<typename RawStream >

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

noexcept

Definition at line 75 of file stream_read_future.hpp.

---

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

• userver/ugrpc/client/stream_read_future.hpp