userver: grpc_proto_structs::client::ReaderWriter< StructsRequest, StructsResponse > Class Template Reference
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
grpc_proto_structs::client::ReaderWriter< StructsRequest, StructsResponse > Class Template Referencefinal

#include </data/code/userver/libraries/grpc-proto-structs/include/userver/grpc-proto-structs/client/stream.hpp>

Detailed Description

template<typename StructsRequest, typename StructsResponse>
class grpc_proto_structs::client::ReaderWriter< StructsRequest, StructsResponse >

proto-struct based ReaderWriter adapter.

Definition at line 106 of file stream.hpp.

Public Types

using ProtobufResponse = proto_structs::traits::CompatibleMessageType<StructsResponse>
 
using ProtobufRequest = proto_structs::traits::CompatibleMessageType<StructsRequest>
 
using ProtobufReaderWriter = ugrpc::client::ReaderWriter<ProtobufRequest, ProtobufResponse>
 

Public Member Functions

 ReaderWriter (ProtobufReaderWriter &&reader_writer)
 
 ReaderWriter (ReaderWriter &&)=default
 
ReaderWriter & operator= (ReaderWriter &&)=default
 
std::optional< StructsResponse > Read ()
 Await and read the next incoming message.
 
StreamReadFuture< StructsResponse > ReadAsync ()
 Return future to read next incoming result.
 
bool Write (const StructsRequest &request)
 Write the next outgoing message.
 
bool Write (StructsRequest &&request)
 Write the next outgoing message.
 
void WriteAndCheck (const StructsRequest &request)
 Write the next outgoing message and check result.
 
void WriteAndCheck (StructsRequest &&request)
 Write the next outgoing message and check result.
 
bool WritesDone ()
 Announce end-of-output to the server.
 
ugrpc::client::CallContext & GetContext ()
 Get call context, useful e.g. for accessing metadata.
 
const ugrpc::client::CallContext & GetContext () const
 

Member Typedef Documentation

◆ ProtobufReaderWriter

template<typename StructsRequest, typename StructsResponse>
using grpc_proto_structs::client::ReaderWriter< StructsRequest, StructsResponse >::ProtobufReaderWriter = ugrpc::client::ReaderWriter<ProtobufRequest, ProtobufResponse>

Definition at line 111 of file stream.hpp.

◆ ProtobufRequest

template<typename StructsRequest, typename StructsResponse>
using grpc_proto_structs::client::ReaderWriter< StructsRequest, StructsResponse >::ProtobufRequest = proto_structs::traits::CompatibleMessageType<StructsRequest>

Definition at line 109 of file stream.hpp.

◆ ProtobufResponse

template<typename StructsRequest, typename StructsResponse>
using grpc_proto_structs::client::ReaderWriter< StructsRequest, StructsResponse >::ProtobufResponse = proto_structs::traits::CompatibleMessageType<StructsResponse>

Definition at line 108 of file stream.hpp.

Constructor & Destructor Documentation

◆ ReaderWriter()

template<typename StructsRequest, typename StructsResponse>
grpc_proto_structs::client::ReaderWriter< StructsRequest, StructsResponse >::ReaderWriter ( ProtobufReaderWriter< StructsRequest, StructsResponse > && reader_writer)
inlineexplicit

Definition at line 113 of file stream.hpp.

Member Function Documentation

◆ GetContext() [1/2]

template<typename StructsRequest, typename StructsResponse>
ugrpc::client::CallContext & grpc_proto_structs::client::ReaderWriter< StructsRequest, StructsResponse >::GetContext ( )
inline

Get call context, useful e.g. for accessing metadata.

See also
ugrpc::client::ReaderWriter::GetContext.

Definition at line 170 of file stream.hpp.

◆ GetContext() [2/2]

template<typename StructsRequest, typename StructsResponse>
const ugrpc::client::CallContext & grpc_proto_structs::client::ReaderWriter< StructsRequest, StructsResponse >::GetContext ( ) const
inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

See also
ugrpc::client::ReaderWriter::GetContext.

Definition at line 175 of file stream.hpp.

◆ Read()

template<typename StructsRequest, typename StructsResponse>
std::optional< StructsResponse > grpc_proto_structs::client::ReaderWriter< StructsRequest, StructsResponse >::Read ( )
inlinenodiscard

Await and read the next incoming message.

See also
ugrpc::client::ReaderWriter::Read.

Definition at line 121 of file stream.hpp.

◆ ReadAsync()

template<typename StructsRequest, typename StructsResponse>
StreamReadFuture< StructsResponse > grpc_proto_structs::client::ReaderWriter< StructsRequest, StructsResponse >::ReadAsync ( )
inline

Return future to read next incoming result.

Definition at line 132 of file stream.hpp.

◆ Write() [1/2]

template<typename StructsRequest, typename StructsResponse>
bool grpc_proto_structs::client::ReaderWriter< StructsRequest, StructsResponse >::Write ( const StructsRequest & request)
inlinenodiscard

Write the next outgoing message.

See also
ugrpc::client::ReaderWriter::Write.

Definition at line 137 of file stream.hpp.

◆ Write() [2/2]

template<typename StructsRequest, typename StructsResponse>
bool grpc_proto_structs::client::ReaderWriter< StructsRequest, StructsResponse >::Write ( StructsRequest && request)
inlinenodiscard

Write the next outgoing message.

See also
ugrpc::client::ReaderWriter::Write.

Definition at line 144 of file stream.hpp.

◆ WriteAndCheck() [1/2]

template<typename StructsRequest, typename StructsResponse>
void grpc_proto_structs::client::ReaderWriter< StructsRequest, StructsResponse >::WriteAndCheck ( const StructsRequest & request)
inline

Write the next outgoing message and check result.

See also
ugrpc::client::ReaderWriter::WriteAndCheck.

Definition at line 151 of file stream.hpp.

◆ WriteAndCheck() [2/2]

template<typename StructsRequest, typename StructsResponse>
void grpc_proto_structs::client::ReaderWriter< StructsRequest, StructsResponse >::WriteAndCheck ( StructsRequest && request)
inline

Write the next outgoing message and check result.

See also
ugrpc::client::ReaderWriter::WriteAndCheck.

Definition at line 158 of file stream.hpp.

◆ WritesDone()

template<typename StructsRequest, typename StructsResponse>
bool grpc_proto_structs::client::ReaderWriter< StructsRequest, StructsResponse >::WritesDone ( )
inlinenodiscard

Announce end-of-output to the server.

See also
ugrpc::client::ReaderWriter::WritesDone.

Definition at line 165 of file stream.hpp.

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