Pipe::CPipe Class Reference

Base class for all pipe implementations. More...

#include <pipe.h>

Inheritance diagram for Pipe::CPipe:

Public Member Functions
bool	Push (const std::string &str_)
	Pushes a string of data into the pipe.
bool	Push (u8 x_)
	Pushes a byte of data into the pipe.
void	SeekPop (size_t offset_=0)
	Sets the position for the next Pop operation.
bool	Pop (u8 &x_)
	Pops a byte of data from the pipe.

Protected Attributes
size_t	_pushed_in_bytes = 0
size_t	_poped_in_bytes = 0

Detailed Description

Base class for all pipe implementations.

Member Function Documentation

Pop()

bool Pipe::CPipe::Pop ( u8 & x_ )

inline

Pops a byte of data from the pipe.

Parameters

x_	The byte to pop.

Returns

true if the data was popped successfully, false otherwise.

Push() [1/2]

bool Pipe::CPipe::Push ( const std::string & str_ )

inline

Pushes a string of data into the pipe.

Parameters

str_	The string to push.

Returns

true if all data was pushed successfully, false otherwise.

Push() [2/2]

bool Pipe::CPipe::Push ( u8 x_ )

inline

Pushes a byte of data into the pipe.

Parameters

x_	The byte to push.

Returns

true if the data was pushed successfully, false otherwise.

SeekPop()

void Pipe::CPipe::SeekPop ( size_t offset_ = 0 )

inline

Sets the position for the next Pop operation.

Parameters

offset_

The offset to set for the next Pop operation.

---

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

• include/pipe.h