grpc::WriteOptions Class Reference

Per-message write options. More...

#include <call_op_set.h>

Public Member Functions
	WriteOptions ()
void	Clear ()
	Clear all flags. More...
uint32_t	flags () const
	Returns raw flags bitset. More...
WriteOptions &	set_no_compression ()
	Sets flag for the disabling of compression for the next message write. More...
WriteOptions &	clear_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...
WriteOptions &	set_buffer_hint ()
	Sets flag indicating that the write may be buffered and need not go out on the wire immediately. More...
WriteOptions &	clear_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...
WriteOptions &	set_corked ()
	corked bit: aliases set_buffer_hint currently, with the intent that set_buffer_hint will be removed in the future More...
WriteOptions &	clear_corked ()
bool	is_corked () const
WriteOptions &	set_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...
WriteOptions &	clear_last_message ()
	Clears flag indicating that this is the last message in a stream, disabling coalescing. More...
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...
WriteOptions &	set_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...
WriteOptions &	clear_write_through ()
bool	is_write_through () const

Detailed Description

Per-message write options.

Constructor & Destructor Documentation

WriteOptions()

grpc::WriteOptions::WriteOptions ( )

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

clear_write_through()

WriteOptions& grpc::WriteOptions::clear_write_through ( )

inline

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

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:

• include/grpcpp/impl/call_op_set.h