GRPC C++  1.24.0
Public Member Functions
grpc::WriteOptions Class Reference

Per-message write options. More...

#include <call_op_set.h>

Public Member Functions

 WriteOptions ()
 
 WriteOptions (const WriteOptions &other)
 
WriteOptionsoperator= (const WriteOptions &other)=default
 Default assignment operator. More...
 
void Clear ()
 Clear all flags. More...
 
uint32_t flags () const
 Returns raw flags bitset. More...
 
WriteOptionsset_no_compression ()
 Sets flag for the disabling of compression for the next message write. More...
 
WriteOptionsclear_no_compression ()
 Clears flag for the disabling of compression for the next message write. More...
 
bool get_no_compression () const
 Get value for the flag indicating whether compression for the next message write is forcefully disabled. More...
 
WriteOptionsset_buffer_hint ()
 Sets flag indicating that the write may be buffered and need not go out on the wire immediately. More...
 
WriteOptionsclear_buffer_hint ()
 Clears flag indicating that the write may be buffered and need not go out on the wire immediately. More...
 
bool get_buffer_hint () const
 Get value for the flag indicating that the write may be buffered and need not go out on the wire immediately. More...
 
WriteOptionsset_corked ()
 corked bit: aliases set_buffer_hint currently, with the intent that set_buffer_hint will be removed in the future More...
 
WriteOptionsclear_corked ()
 
bool is_corked () const
 
WriteOptionsset_last_message ()
 last-message bit: indicates this is the last message in a stream client-side: makes Write the equivalent of performing Write, WritesDone in a single step server-side: hold the Write until the service handler returns (sync api) or until Finish is called (async api) More...
 
WriteOptionsclear_last_message ()
 Clears flag indicating that this is the last message in a stream, disabling coalescing. More...
 
WriteOptionsset_write_through ()
 Guarantee that all bytes have been written to the socket before completing this write (usually writes are completed when they pass flow control). More...
 
bool is_write_through () const
 
bool is_last_message () const
 Get value for the flag indicating that this is the last message, and should be coalesced with trailing metadata. More...
 

Detailed Description

Per-message write options.

Constructor & Destructor Documentation

◆ WriteOptions() [1/2]

grpc::WriteOptions::WriteOptions ( )
inline

◆ WriteOptions() [2/2]

grpc::WriteOptions::WriteOptions ( const WriteOptions other)
inline

Member Function Documentation

◆ Clear()

void grpc::WriteOptions::Clear ( )
inline

Clear all flags.

◆ clear_buffer_hint()

WriteOptions& grpc::WriteOptions::clear_buffer_hint ( )
inline

Clears flag indicating that the write may be buffered and need not go out on the wire immediately.

See also
GRPC_WRITE_BUFFER_HINT

◆ clear_corked()

WriteOptions& grpc::WriteOptions::clear_corked ( )
inline

◆ clear_last_message()

WriteOptions& grpc::WriteOptions::clear_last_message ( )
inline

Clears flag indicating that this is the last message in a stream, disabling coalescing.

◆ clear_no_compression()

WriteOptions& grpc::WriteOptions::clear_no_compression ( )
inline

Clears flag for the disabling of compression for the next message write.

See also
GRPC_WRITE_NO_COMPRESS

◆ flags()

uint32_t grpc::WriteOptions::flags ( ) const
inline

Returns raw flags bitset.

◆ get_buffer_hint()

bool grpc::WriteOptions::get_buffer_hint ( ) const
inline

Get value for the flag indicating that the write may be buffered and need not go out on the wire immediately.

See also
GRPC_WRITE_BUFFER_HINT

◆ get_no_compression()

bool grpc::WriteOptions::get_no_compression ( ) const
inline

Get value for the flag indicating whether compression for the next message write is forcefully disabled.

See also
GRPC_WRITE_NO_COMPRESS

◆ is_corked()

bool grpc::WriteOptions::is_corked ( ) const
inline

◆ is_last_message()

bool grpc::WriteOptions::is_last_message ( ) const
inline

Get value for the flag indicating that this is the last message, and should be coalesced with trailing metadata.

See also
GRPC_WRITE_LAST_MESSAGE

◆ is_write_through()

bool grpc::WriteOptions::is_write_through ( ) const
inline

◆ operator=()

WriteOptions& grpc::WriteOptions::operator= ( const WriteOptions other)
default

Default assignment operator.

◆ set_buffer_hint()

WriteOptions& grpc::WriteOptions::set_buffer_hint ( )
inline

Sets flag indicating that the write may be buffered and need not go out on the wire immediately.

See also
GRPC_WRITE_BUFFER_HINT

◆ set_corked()

WriteOptions& grpc::WriteOptions::set_corked ( )
inline

corked bit: aliases set_buffer_hint currently, with the intent that set_buffer_hint will be removed in the future

◆ set_last_message()

WriteOptions& grpc::WriteOptions::set_last_message ( )
inline

last-message bit: indicates this is the last message in a stream client-side: makes Write the equivalent of performing Write, WritesDone in a single step server-side: hold the Write until the service handler returns (sync api) or until Finish is called (async api)

◆ set_no_compression()

WriteOptions& grpc::WriteOptions::set_no_compression ( )
inline

Sets flag for the disabling of compression for the next message write.

See also
GRPC_WRITE_NO_COMPRESS

◆ set_write_through()

WriteOptions& grpc::WriteOptions::set_write_through ( )
inline

Guarantee that all bytes have been written to the socket before completing this write (usually writes are completed when they pass flow control).


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