roo_io::RingPipe Class Reference

#include <ringpipe.h>

Public Member Functions
	RingPipe (size_t capacity)
size_t	write (const byte *data, size_t len)
size_t	writeFully (const byte *data, size_t len)
size_t	availableForWrite ()
size_t	tryWrite (const byte *data, size_t len)
size_t	read (byte *data, size_t len)
size_t	availableForRead ()
size_t	tryRead (byte *data, size_t len)
Status	inputStatus () const
Status	outputStatus () const
void	closeInput ()
void	closeOutput ()

Detailed Description

Definition at line 12 of file ringpipe.h.

Constructor & Destructor Documentation

RingPipe()

roo_io::RingPipe::RingPipe

(

size_t

capacity

)

Definition at line 5 of file ringpipe.cpp.

Member Function Documentation

availableForRead()

size_t roo_io::RingPipe::availableForRead

(

)

Definition at line 62 of file ringpipe.cpp.

References roo_io::RingBuffer::used().

Referenced by roo_io::RingPipeInputStream::available().

availableForWrite()

size_t roo_io::RingPipe::availableForWrite

(

)

Definition at line 33 of file ringpipe.cpp.

References roo_io::RingBuffer::free().

Referenced by roo_io::RingPipeOutputStream::availableForWrite().

closeInput()

void roo_io::RingPipe::closeInput

(

)

Definition at line 99 of file ringpipe.cpp.

References roo_io::RingBuffer::clear().

Referenced by roo_io::RingPipeInputStream::close().

closeOutput()

void roo_io::RingPipe::closeOutput

(

)

Definition at line 108 of file ringpipe.cpp.

Referenced by roo_io::RingPipeOutputStream::close().

inputStatus()

Status roo_io::RingPipe::inputStatus

(

)

const

Definition at line 77 of file ringpipe.cpp.

References roo_io::RingBuffer::empty(), roo_io::kClosed, roo_io::kEndOfStream, and roo_io::kOk.

Referenced by roo_io::RingPipeInputStream::status().

outputStatus()

Status roo_io::RingPipe::outputStatus

(

)

const

Definition at line 88 of file ringpipe.cpp.

References roo_io::kBrokenPipe, roo_io::kClosed, and roo_io::kOk.

Referenced by roo_io::RingPipeOutputStream::status().

read()

size_t roo_io::RingPipe::read	(	byte *	data,
		size_t	len
	)

Definition at line 48 of file ringpipe.cpp.

References roo_io::RingBuffer::empty(), and roo_io::RingBuffer::read().

Referenced by roo_io::RingPipeInputStream::read().

tryRead()

size_t roo_io::RingPipe::tryRead	(	byte *	data,
		size_t	len
	)

Definition at line 67 of file ringpipe.cpp.

References roo_io::RingBuffer::empty(), and roo_io::RingBuffer::read().

Referenced by roo_io::RingPipeInputStream::tryRead().

tryWrite()

size_t roo_io::RingPipe::tryWrite	(	const byte *	data,
		size_t	len
	)

Definition at line 38 of file ringpipe.cpp.

References roo_io::RingBuffer::full(), and roo_io::RingBuffer::write().

Referenced by roo_io::RingPipeOutputStream::tryWrite().

write()

size_t roo_io::RingPipe::write	(	const byte *	data,
		size_t	len
	)

Definition at line 8 of file ringpipe.cpp.

References roo_io::RingBuffer::full(), and roo_io::RingBuffer::write().

Referenced by roo_io::RingPipeOutputStream::write(), and writeFully().

writeFully()

size_t roo_io::RingPipe::writeFully	(	const byte *	data,
		size_t	len
	)

Definition at line 21 of file ringpipe.cpp.

References write().

---

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

• temp_repos/roo_io/src/roo_io/ringpipe/ringpipe.h
• temp_repos/roo_io/src/roo_io/ringpipe/ringpipe.cpp