grpc::WriteOptions Class Reference

Per-message write options. More...

#include <call_op_set.h>

Public Member Functions
void	Clear ()
	Clear all flags. More...
WriteOptions &	clear_buffer_hint ()
WriteOptions &	clear_corked ()
WriteOptions &	clear_last_message ()
WriteOptions &	clear_no_compression ()
WriteOptions &	clear_write_through ()
uint32_t	flags () const
	Returns raw flags bitset. More...
bool	get_buffer_hint () const
bool	get_no_compression () const
bool	is_corked () const
bool	is_last_message () const
bool	is_write_through () const
WriteOptions &	set_buffer_hint ()
WriteOptions &	set_corked ()
WriteOptions &	set_last_message ()
WriteOptions &	set_no_compression ()
WriteOptions &	set_write_through ()
	WriteOptions ()

Private Member Functions
void	ClearBit (const uint32_t mask)
bool	GetBit (const uint32_t mask) const
void	SetBit (const uint32_t mask)

Private Attributes
uint32_t	flags_
bool	last_message_

Detailed Description

Per-message write options.

Definition at line 81 of file call_op_set.h.

Constructor & Destructor Documentation

WriteOptions()

grpc::WriteOptions::WriteOptions ( )

inline

Definition at line 83 of file call_op_set.h.

Member Function Documentation

Clear()

void grpc::WriteOptions::Clear ( )

inline

Clear all flags.

Definition at line 86 of file call_op_set.h.

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

Definition at line 128 of file call_op_set.h.

clear_corked()

WriteOptions& grpc::WriteOptions::clear_corked ( )

inline

Definition at line 146 of file call_op_set.h.

clear_last_message()

WriteOptions& grpc::WriteOptions::clear_last_message ( )

inline

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

Definition at line 165 of file call_op_set.h.

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

Definition at line 102 of file call_op_set.h.

clear_write_through()

WriteOptions& grpc::WriteOptions::clear_write_through ( )

inline

Definition at line 183 of file call_op_set.h.

ClearBit()

void grpc::WriteOptions::ClearBit ( const uint32_t  mask )

inlineprivate

Definition at line 193 of file call_op_set.h.

flags()

uint32_t grpc::WriteOptions::flags ( ) const

inline

Returns raw flags bitset.

Definition at line 89 of file call_op_set.h.

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

Definition at line 137 of file call_op_set.h.

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

Definition at line 111 of file call_op_set.h.

GetBit()

bool grpc::WriteOptions::GetBit ( const uint32_t  mask ) const

inlineprivate

Definition at line 195 of file call_op_set.h.

is_corked()

bool grpc::WriteOptions::is_corked ( ) const

inline

Definition at line 151 of file call_op_set.h.

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

Definition at line 174 of file call_op_set.h.

is_write_through()

bool grpc::WriteOptions::is_write_through ( ) const

inline

Definition at line 188 of file call_op_set.h.

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

Definition at line 119 of file call_op_set.h.

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

Definition at line 141 of file call_op_set.h.

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)

Definition at line 158 of file call_op_set.h.

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

Definition at line 94 of file call_op_set.h.

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).

Definition at line 178 of file call_op_set.h.

SetBit()

void grpc::WriteOptions::SetBit ( const uint32_t  mask )

inlineprivate

Definition at line 191 of file call_op_set.h.

Member Data Documentation

flags_

uint32_t grpc::WriteOptions::flags_

private

Definition at line 197 of file call_op_set.h.

last_message_

bool grpc::WriteOptions::last_message_

private

Definition at line 198 of file call_op_set.h.

---

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

• call_op_set.h