Electronics and Software
Engineering Innovation
Beam-lib  2.15.1

This class provides an interface for sending simple integer events via a pipe file descriptor. More...

#include <BEvent.h>

Public Member Functions

 BEventPipe ()
 
 ~BEventPipe ()
 
void clear ()
 Clear events pending. More...
 
int getFd ()
 
BUInt writeAvailable () const
 
BError write (const BEvent &event, BTimeout timeout=BTimeoutForever)
 Append an item onto the queue. More...
 
BUInt readAvailable () const
 
BError read (BEvent &event, BTimeout timeout=BTimeoutForever)
 Get an item from the queue. More...
 

Private Attributes

int ofds [2]
 File descriptors for pipe. More...
 

Detailed Description

This class provides an interface for sending simple integer events via a pipe file descriptor.

Constructor & Destructor Documentation

◆ BEventPipe()

BEventPipe::BEventPipe ( )

◆ ~BEventPipe()

BEventPipe::~BEventPipe ( )

Member Function Documentation

◆ clear()

void BEventPipe::clear ( )

Clear events pending.

◆ getFd()

int BEventPipe::getFd ( )

◆ read()

BError BEventPipe::read ( BEvent event,
BTimeout  timeout = BTimeoutForever 
)

Get an item from the queue.

◆ readAvailable()

BUInt BEventPipe::readAvailable ( ) const

◆ write()

BError BEventPipe::write ( const BEvent event,
BTimeout  timeout = BTimeoutForever 
)

Append an item onto the queue.

◆ writeAvailable()

BUInt BEventPipe::writeAvailable ( ) const

Member Data Documentation

◆ ofds

int BEventPipe::ofds[2]
private

File descriptors for pipe.


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