grpc_proto_structs::client::Writer< StructsRequest, StructsResponse > Class Template Reference

#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::Writer< StructsRequest, StructsResponse >

proto-struct based Writer adapter.

Definition at line 61 of file stream.hpp.

Public Types
using	ProtobufResponse = proto_structs::traits::CompatibleMessageType<StructsResponse>
using	ProtobufRequest = proto_structs::traits::CompatibleMessageType<StructsRequest>
using	ProtobufWriter = ugrpc::client::Writer<ProtobufRequest, ProtobufResponse>

Public Member Functions
	Writer (ProtobufWriter &&writer)
	Writer (Writer &&)=default
Writer &	operator= (Writer &&)=default
bool	Write (StructsRequest &&request)
	Write the next outgoing message.
bool	WriteCopy (const StructsRequest &request)
	Write the next outgoing message.
void	WriteAndCheck (StructsRequest &&request)
	Write the next outgoing message and check result.
void	WriteCopyAndCheck (const StructsRequest &request)
	Write the next outgoing message and check result.
StructsResponse	Finish ()
	Complete the RPC successfully.
ugrpc::client::CallContext &	GetContext ()
	Get call context, useful e.g. for accessing metadata.
const ugrpc::client::CallContext &	GetContext () const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Member Typedef Documentation

ProtobufRequest

template<typename StructsRequest, typename StructsResponse>

using grpc_proto_structs::client::Writer< StructsRequest, StructsResponse >::ProtobufRequest = proto_structs::traits::CompatibleMessageType<StructsRequest>

Definition at line 64 of file stream.hpp.

ProtobufResponse

template<typename StructsRequest, typename StructsResponse>

using grpc_proto_structs::client::Writer< StructsRequest, StructsResponse >::ProtobufResponse = proto_structs::traits::CompatibleMessageType<StructsResponse>

Definition at line 63 of file stream.hpp.

ProtobufWriter

template<typename StructsRequest, typename StructsResponse>

using grpc_proto_structs::client::Writer< StructsRequest, StructsResponse >::ProtobufWriter = ugrpc::client::Writer<ProtobufRequest, ProtobufResponse>

Definition at line 66 of file stream.hpp.

Constructor & Destructor Documentation

Writer()

template<typename StructsRequest, typename StructsResponse>

grpc_proto_structs::client::Writer< StructsRequest, StructsResponse >::Writer ( ProtobufWriter< StructsRequest, StructsResponse > && writer )

inlineexplicit

Definition at line 68 of file stream.hpp.

Member Function Documentation

Finish()

template<typename StructsRequest, typename StructsResponse>

StructsResponse grpc_proto_structs::client::Writer< StructsRequest, StructsResponse >::Finish ( )

inline

Complete the RPC successfully.

Definition at line 100 of file stream.hpp.

GetContext() [1/2]

template<typename StructsRequest, typename StructsResponse>

ugrpc::client::CallContext & grpc_proto_structs::client::Writer< StructsRequest, StructsResponse >::GetContext ( )

inline

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

Definition at line 103 of file stream.hpp.

GetContext() [2/2]

template<typename StructsRequest, typename StructsResponse>

const ugrpc::client::CallContext & grpc_proto_structs::client::Writer< 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.

Definition at line 106 of file stream.hpp.

Write()

template<typename StructsRequest, typename StructsResponse>

bool grpc_proto_structs::client::Writer< StructsRequest, StructsResponse >::Write ( StructsRequest && request )

inlinenodiscard

Write the next outgoing message.

Note

This version may move some fields from the request.

Definition at line 77 of file stream.hpp.

WriteAndCheck()

template<typename StructsRequest, typename StructsResponse>

void grpc_proto_structs::client::Writer< StructsRequest, StructsResponse >::WriteAndCheck ( StructsRequest && request )

inline

Write the next outgoing message and check result.

Note

This version may move some fields from the request.

Definition at line 89 of file stream.hpp.

WriteCopy()

template<typename StructsRequest, typename StructsResponse>

bool grpc_proto_structs::client::Writer< StructsRequest, StructsResponse >::WriteCopy ( const StructsRequest & request )

inlinenodiscard

Write the next outgoing message.

Note

This version preserves the original request object by copying necessary data.

Definition at line 83 of file stream.hpp.

WriteCopyAndCheck()

template<typename StructsRequest, typename StructsResponse>

void grpc_proto_structs::client::Writer< StructsRequest, StructsResponse >::WriteCopyAndCheck ( const StructsRequest & request )

inline

Write the next outgoing message and check result.

Note

This version preserves the original request object by copying necessary data.

Definition at line 95 of file stream.hpp.

---

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

• /data/code/userver/libraries/grpc-proto-structs/include/userver/grpc-proto-structs/client/stream.hpp