userver: engine::io::WritableBase Class Reference
⚠️ This is the documentation for an old userver version. Click here to switch to the latest version.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages Concepts
engine::io::WritableBase Class Referenceabstract

#include <userver/engine/io/common.hpp>

Detailed Description

Interface for writable streams

Definition at line 63 of file common.hpp.

+ Inheritance diagram for engine::io::WritableBase:

Public Member Functions

virtual bool WaitWriteable (Deadline deadline)=0
 Suspends current task until the data is available.
 
virtual size_t WriteAll (const void *buf, size_t len, Deadline deadline)=0
 Sends exactly len bytes of buf.
 
virtual size_t WriteAll (std::initializer_list< IoData > list, Deadline deadline)
 
impl::ContextAccessor * TryGetContextAccessor ()
 For internal use only.
 

Protected Member Functions

void SetWritableContextAccessor (impl::ContextAccessor *ca)
 

Member Function Documentation

◆ SetWritableContextAccessor()

void engine::io::WritableBase::SetWritableContextAccessor ( impl::ContextAccessor * ca)
inlineprotected

Definition at line 88 of file common.hpp.

◆ TryGetContextAccessor()

impl::ContextAccessor * engine::io::WritableBase::TryGetContextAccessor ( )
inline

For internal use only.

Definition at line 85 of file common.hpp.

◆ WaitWriteable()

virtual bool engine::io::WritableBase::WaitWriteable ( Deadline deadline)
pure virtual

Suspends current task until the data is available.

Implemented in engine::io::PipeWriter, engine::io::Socket, and engine::io::TlsWrapper.

◆ WriteAll() [1/2]

virtual size_t engine::io::WritableBase::WriteAll ( const void * buf,
size_t len,
Deadline deadline )
pure virtual

Sends exactly len bytes of buf.

Note
Can return less than len if stream is closed by peer.

Implemented in engine::io::PipeWriter, engine::io::Socket, and engine::io::TlsWrapper.

◆ WriteAll() [2/2]

virtual size_t engine::io::WritableBase::WriteAll ( std::initializer_list< IoData > list,
Deadline deadline )
inlinevirtual

Definition at line 75 of file common.hpp.


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