engine::io::PipeReader Class Reference

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

Detailed Description

Reading end of an unidirectional pipe.

Definition at line 20 of file pipe.hpp.

Inheritance diagram for engine::io::PipeReader:

Public Member Functions
bool	IsValid () const override
	Whether the reading end of the pipe is valid.
bool	WaitReadable (Deadline) override
size_t	ReadSome (void *buf, size_t len, Deadline deadline) override
size_t	ReadAll (void *buf, size_t len, Deadline deadline) override
int	Fd () const
	File descriptor corresponding to the read end of the pipe.
int	Release () noexcept
	Releases reading end file descriptor and invalidates it.
void	Close ()
virtual std::optional< size_t >	ReadNoblock (void *buf, size_t len)
AwaitableToken	GetAwaitableToken ()
	Satisfies engine::Awaitable, for use with engine::WaitAnyContext and friends.

Protected Member Functions
void	SetReadableAwaitableToken (AwaitableToken token)

Member Function Documentation

Close()

void engine::io::PipeReader::Close

(

)

Closes and invalidates the reading end of the pipe.

Warning

You should not call Close with pending I/O. This may work okay sometimes but it's loosely predictable.

GetAwaitableToken()

AwaitableToken engine::io::ReadAwaiter::GetAwaitableToken ( )

inlineinherited

Satisfies engine::Awaitable, for use with engine::WaitAnyContext and friends.

Definition at line 39 of file common.hpp.

IsValid()

bool engine::io::PipeReader::IsValid ( ) const

overridevirtual

Whether the reading end of the pipe is valid.

Implements engine::io::ReadableBase.

ReadAll()

size_t engine::io::PipeReader::ReadAll ( void * buf, size_t len, Deadline deadline )

nodiscardoverridevirtual

Receives exactly len bytes from the pipe.

Note

Can return less than len if pipe is closed by peer.

Returns

count of bytes read from the pipe

Implements engine::io::ReadableBase.

ReadNoblock()

virtual std::optional< size_t > engine::io::ReadableBase::ReadNoblock ( void * buf, size_t len )

inlinenodiscardvirtualinherited

Receives up to len (including zero) bytes from the stream.

Returns

filled-in optional on data presence (e.g. 0, 1, 2... bytes) empty optional otherwise

Reimplemented in engine::io::Socket, and engine::io::TlsWrapper.

Definition at line 65 of file common.hpp.

ReadSome()

size_t engine::io::PipeReader::ReadSome ( void * buf, size_t len, Deadline deadline )

nodiscardoverridevirtual

Receives at least one bytes from the pipe.

Returns

count of bytes read from the pipe

Implements engine::io::ReadableBase.

SetReadableAwaitableToken()

void engine::io::ReadAwaiter::SetReadableAwaitableToken ( AwaitableToken token )

inlineprotectedinherited

Definition at line 44 of file common.hpp.

WaitReadable()

bool engine::io::PipeReader::WaitReadable ( Deadline )

nodiscardoverridevirtual

Suspends current task until the pipe has data available.

Returns

false on timeout or on task cancellations; true otherwise.

Implements engine::io::ReadAwaiter.

Friends And Related Symbol Documentation

Pipe

friend class Pipe

friend

Definition at line 50 of file pipe.hpp.

---

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

• userver/engine/io/pipe.hpp